/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed
* with this work for additional information regarding copyright
* ownership. The ASF licenses this file to you under the Apache
* License, Version 2.0 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of
* the License at http://www.apache.org/licenses/LICENSE-2.0 .
*/
#ifndef INCLUDED_SFX2_FRAME_HXX
#define INCLUDED_SFX2_FRAME_HXX
#ifndef TF_NEWDESKTOP
#define TF_NEWDESKTOP 1
#endif
#include <sal/config.h>
#include <sfx2/dllapi.h>
#include <sal/types.h>
#include <com/sun/star/uno/Reference.h>
#include <com/sun/star/uno/Any.hxx>
#include <com/sun/star/uno/Sequence.hxx>
namespace com
{
namespace sun
{
namespace star
{
namespace awt
{
class XWindow;
}
namespace frame
{
class XFrame;
class XFrameLoader;
class XController;
class XDispatchProviderInterceptor;
}
namespace beans
{
struct PropertyValue;
}
}
}
}
#include <comphelper/namedvaluecollection.hxx>
#include <rtl/ustring.hxx>
#include <svl/brdcst.hxx>
#include <svl/poolitem.hxx>
#include <tools/ref.hxx>
#include <vector>
class SvBorder;
class SfxWorkWindow;
class Window;
class SfxFrame;
class SfxFrame_Impl;
class SfxObjectShell;
class SfxObjectFactory;
class SfxViewFrame;
class SfxFrameDescriptor;
class SfxFrameSetDescriptor;
class SfxDispatcher;
class Rectangle;
class SfxRequest;
class SfxUnoControllerItem;
class SvCompatWeakHdl;
class SystemWindow;
class SfxFrame;
typedef ::std::vector<SfxFrame*> SfxFrameArr_Impl;
typedef ::std::vector<OUString> TargetList;
#define SFXFRAME_HASTITLE 0x0001
// SfxFrame is a management class for windows and their content.
// A SfxApplication represent a hierarchy of SfxFrames, with which the actual
// content in the derived classes is defined. The base class SfxFrame
// implements two aspects of frames: naming and control of its lifespan.
// Inside a frame hierarchy the parent frame always controls the lifespan of
// its child frames, even though they usually are not even produced by the
// parent. By calling DoCloser() on any frame in the hierarchy,
// a part of the "framework" can be removed, where frames unsubscribe
// from their parent frames.
class SFX2_DLLPUBLIC SfxFrame
{
friend class SfxFrameIterator;
friend class SfxFrameWindow_Impl;
private:
SfxFrame* pParentFrame;
SfxFrameArr_Impl* pChildArr;
SfxFrame_Impl* pImp;
Window* pWindow;
protected:
bool Close();
virtual ~SfxFrame();
SAL_DLLPRIVATE void RemoveChildFrame_Impl( SfxFrame* );
SfxFrame( ); // not implemented
SAL_DLLPRIVATE SfxFrame( Window& i_rContainerWindow, bool bHidden );
public:
TYPEINFO();
static SfxFrame* Create( const ::com::sun::star::uno::Reference< ::com::sun::star::frame::XFrame >& xFrame );
static ::com::sun::star::uno::Reference< ::com::sun::star::frame::XFrame >
CreateBlankFrame();
static SfxFrame* Create( SfxObjectShell& rDoc, Window& rWindow, sal_uInt16 nViewId, bool bHidden );
SvCompatWeakHdl* GetHdl();
Window& GetWindow() const;
void CancelTransfers( bool bCancelLoadEnv = true );
bool DoClose();
sal_uInt16 GetChildFrameCount() const;
SfxFrame* GetChildFrame( sal_uInt16 nPos ) const;
SfxFrame* GetParentFrame() const
{ return pParentFrame; }
void SetPresentationMode( bool bSet );
SystemWindow* GetSystemWindow() const;
static SfxFrame* GetFirst();
static SfxFrame* GetNext( SfxFrame& );
static const SfxPoolItem*
OpenDocumentSynchron( SfxItemSet& aSet, const ::com::sun::star::uno::Reference< ::com::sun::star::frame::XFrame >& i_rTargetFrame );
SfxObjectShell* GetCurrentDocument() const;
SfxViewFrame* GetCurrentViewFrame() const;
SfxFrame& GetTopFrame() const;
bool IsParent( SfxFrame* ) const;
sal_uInt32 GetFrameType() const;
void GetTargetList( TargetList& ) const;
SAL_DLLPRIVATE SfxFrame* GetContainingDocFrame_Impl( SfxFrame* pSelf );
void UpdateDescriptor( SfxObjectShell *pDoc );
void Resize();
bool HasComponent() const;
::com::sun::star::uno::Reference< ::com::sun::star::awt::XWindow >
GetComponent() const;
void ReleaseComponent();
::com::sun::star::uno::Reference< ::com::sun::star::frame::XFrame >
GetFrameInterface() const;
void Appear();
void AppearWithUpdate();
::com::sun::star::uno::Reference< ::com::sun::star::frame::XController >
GetController() const;
bool IsInPlace() const;
SAL_DLLPRIVATE bool DoClose_Impl();
SAL_DLLPRIVATE void SetFrameInterface_Impl( const ::com::sun::star::uno::Reference< ::com::sun::star::frame::XFrame >& rFrame );
SAL_DLLPRIVATE void ReleasingComponent_Impl( bool bSet );
SAL_DLLPRIVATE void GetViewData_Impl();
SAL_DLLPRIVATE void SetFrameType_Impl( sal_uInt32 );
SAL_DLLPRIVATE bool PrepareClose_Impl( bool bUI );
SAL_DLLPRIVATE bool DocIsModified_Impl();
SAL_DLLPRIVATE void SetCurrentViewFrame_Impl( SfxViewFrame* );
SAL_DLLPRIVATE bool IsClosing_Impl() const;
SAL_DLLPRIVATE void SetIsClosing_Impl();
// Methods for accessing the current set
SAL_DLLPRIVATE SfxFrameDescriptor* GetDescriptor() const;
SAL_DLLPRIVATE void Lock_Impl( bool bLock );
SAL_DLLPRIVATE SfxDispatcher* GetDispatcher_Impl() const;
SAL_DLLPRIVATE bool IsAutoLoadLocked_Impl() const;
SAL_DLLPRIVATE static void InsertTopFrame_Impl( SfxFrame* pFrame );
SAL_DLLPRIVATE static void RemoveTopFrame_Impl( SfxFrame* pFrame );
SAL_DLLPRIVATE void SetOwnsBindings_Impl( bool bSet );
SAL_DLLPRIVATE bool OwnsBindings_Impl() const;
SAL_DLLPRIVATE void InvalidateUnoControllers_Impl();
SAL_DLLPRIVATE void RegisterUnoController_Impl( SfxUnoControllerItem* );
SAL_DLLPRIVATE void ReleaseUnoController_Impl( SfxUnoControllerItem* );
SAL_DLLPRIVATE SfxWorkWindow* GetWorkWindow_Impl() const;
SAL_DLLPRIVATE void SetToolSpaceBorderPixel_Impl( const SvBorder& );
SAL_DLLPRIVATE Rectangle GetTopOuterRectPixel_Impl() const;
SAL_DLLPRIVATE void CreateWorkWindow_Impl();
SAL_DLLPRIVATE void GrabFocusOnComponent_Impl();
SAL_DLLPRIVATE void SetInPlace_Impl( bool );
SAL_DLLPRIVATE void PrepareForDoc_Impl( SfxObjectShell& i_rDoc );
SAL_DLLPRIVATE void LockResize_Impl( bool bLock );
SAL_DLLPRIVATE void SetMenuBarOn_Impl( bool bOn );
SAL_DLLPRIVATE bool IsMenuBarOn_Impl() const;
SAL_DLLPRIVATE SystemWindow* GetTopWindow_Impl() const;
SAL_DLLPRIVATE bool IsMarkedHidden_Impl() const;
private:
SAL_DLLPRIVATE void Construct_Impl();
};
SV_DECL_COMPAT_WEAK( SfxFrame )
class SfxFrameIterator
{
const SfxFrame* pFrame;
bool bRecursive;
SfxFrame* NextSibling_Impl( SfxFrame& rPrev );
public:
SfxFrameIterator( const SfxFrame& rFrame, bool bRecursive=true );
SfxFrame* FirstFrame();
SfxFrame* NextFrame( SfxFrame& rPrev );
};
class SFX2_DLLPUBLIC SfxFrameItem: public SfxPoolItem
{
SfxFrame* pFrame;
SfxFrameWeak wFrame;
SAL_DLLPRIVATE void SetFramePtr_Impl( SfxFrame* /*pFrameP*/ ) { pFrame = wFrame; }
public:
TYPEINFO_OVERRIDE();
SfxFrameItem( sal_uInt16 nWhich, SfxViewFrame *p );
SfxFrameItem( SfxFrame *p=0 );
SfxFrameItem( sal_uInt16 nWhich, SfxFrame *p );
virtual bool operator==( const SfxPoolItem& ) const SAL_OVERRIDE;
virtual OUString GetValueText() const;
virtual SfxPoolItem* Clone( SfxItemPool *pPool = 0 ) const SAL_OVERRIDE;
virtual bool QueryValue( com::sun::star::uno::Any& rVal, sal_uInt8 nMemberId = 0 ) const SAL_OVERRIDE;
virtual bool PutValue( const com::sun::star::uno::Any& rVal, sal_uInt8 nMemberId = 0 ) SAL_OVERRIDE;
bool FrameKilled() const { return &wFrame != pFrame; }
SfxFrame* GetFrame() const
{ return wFrame; }
};
class SFX2_DLLPUBLIC SfxUsrAnyItem : public SfxPoolItem
{
::com::sun::star::uno::Any aValue;
public:
TYPEINFO_OVERRIDE();
SfxUsrAnyItem( sal_uInt16 nWhich, const ::com::sun::star::uno::Any& rAny );
::com::sun::star::uno::Any GetValue() const
{ return aValue; }
virtual bool operator==( const SfxPoolItem& ) const SAL_OVERRIDE;
virtual SfxPoolItem* Clone( SfxItemPool *pPool = 0 ) const SAL_OVERRIDE;
virtual bool QueryValue( com::sun::star::uno::Any& rVal, sal_uInt8 nMemberId = 0 ) const SAL_OVERRIDE;
virtual bool PutValue( const com::sun::star::uno::Any& rVal, sal_uInt8 nMemberId = 0 ) SAL_OVERRIDE;
};
class SFX2_DLLPUBLIC SfxUnoFrameItem : public SfxPoolItem
{
::com::sun::star::uno::Reference< ::com::sun::star::frame::XFrame >
m_xFrame;
public:
TYPEINFO_OVERRIDE();
SfxUnoFrameItem();
SfxUnoFrameItem( sal_uInt16 nWhich, const ::com::sun::star::uno::Reference< ::com::sun::star::frame::XFrame >& i_rFrame );
const ::com::sun::star::uno::Reference< ::com::sun::star::frame::XFrame >&
GetFrame() const
{ return m_xFrame; }
virtual bool operator==( const SfxPoolItem& ) const SAL_OVERRIDE;
virtual SfxPoolItem* Clone( SfxItemPool *pPool = 0 ) const SAL_OVERRIDE;
virtual bool QueryValue( com::sun::star::uno::Any& rVal, sal_uInt8 nMemberId = 0 ) const SAL_OVERRIDE;
virtual bool PutValue( const com::sun::star::uno::Any& rVal, sal_uInt8 nMemberId = 0 ) SAL_OVERRIDE;
};
typedef SfxUsrAnyItem SfxUnoAnyItem;
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */