xref: /aoo41x/main/sfx2/inc/sfx2/childwin.hxx (revision 353d8f4d)

/**************************************************************
 *
 * 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
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 *
 *************************************************************/


#ifndef _SFX_CHILDWIN_HXX
#define _SFX_CHILDWIN_HXX

#include "sal/config.h"
#include "sfx2/dllapi.h"
#include "sal/types.h"
#include <vcl/window.hxx>
#include <com/sun/star/frame/XFrame.hpp>

#ifdef ENABLE_INIMANAGER//MUSTINI
#include "inimgr.hxx"
#endif
#include <sfx2/shell.hxx>
#include <sfx2/chalign.hxx>

class SfxWorkWindow;
class SfxModule;
class SfxBindings;
class SfxShell;
class SfxChildWindow;
class SfxChildWindowContext;
class SfxChildWinContextArr_Impl;

//ASDBG #ifndef _XFRAME_REF
//ASDBG #define _XFRAME_REF
//ASDBG USR_DECLIMPL_REF( ::com::sun::star::frame::XFrame, ::com::sun::star::uno::XInterface );
//ASDBG #endif

#define SFX_CHILDWIN_ZOOMIN       0x01		// ganz eingeklapptes Float
#define SFX_CHILDWIN_SMALL		  0x02		// halb eingeklapptes Float
#define SFX_CHILDWIN_FORCEDOCK    0x04		// Float verboten
#define SFX_CHILDWIN_AUTOHIDE	  0x08		// DockingWindow im AutoHide-Modus
#define SFX_CHILDWIN_TASK         0x10		// ChildWindow innerhalb der Task
#define SFX_CHILDWIN_CANTGETFOCUS 0x20		// ChildWindow kann keinen Focus bekommen
#define SFX_CHILDWIN_ALWAYSAVAILABLE 0x40   // ChildWindow is never disabled
#define SFX_CHILDWIN_NEVERHIDE    0x80      // ChildWindow is can always made visible/is visible
#define CHILDWIN_NOPOS		      USHRT_MAX

// Konfiguration eines ChildWindows
struct SfxChildWinInfo
{
	sal_Bool				bVisible;
	Point				aPos;
	Size				aSize;
	sal_uInt16				nFlags;
	String				aExtraString;
    ByteString          aWinState;

						SfxChildWinInfo()
						{
							bVisible = sal_False;
							nFlags = 0;
						}
//#if 0 // _SOLAR__PRIVATE
	sal_Bool				GetExtraData_Impl( SfxChildAlignment	*pAlign,
										   SfxChildAlignment	*pLastAlign = 0,
										   Size 				*pSize = 0,
										   sal_uInt16				*pLine = 0,
										   sal_uInt16				*pPos = 0 ) const;
//#endif
};

// Factory-Methode eines ChildWindows
typedef SfxChildWindow* (*SfxChildWinCtor)( ::Window *pParentWindow,
											sal_uInt16 nId,
											SfxBindings *pBindings,
											SfxChildWinInfo *pInfo);

// Factory-Methode eines ChildWindowsContexts
typedef SfxChildWindowContext* (*SfxChildWinContextCtor)( ::Window *pParentWindow,
											SfxBindings *pBindings,
											SfxChildWinInfo *pInfo);
struct SfxChildWinContextFactory
{
	SfxChildWinContextCtor	pCtor;      // Factory-Methode
	sal_uInt16					nContextId;	// Identifier f"ur das SfxInterface
	SfxChildWinInfo 		aInfo;		// Konfiguration

	SfxChildWinContextFactory( SfxChildWinContextCtor pTheCtor, sal_uInt16 nID )
		: pCtor(pTheCtor)
		, nContextId(nID)
	{}
};

SV_DECL_PTRARR_DEL( SfxChildWinContextArr_Impl, SfxChildWinContextFactory*, 2, 2 )

struct SfxChildWinFactory
{
	SfxChildWinCtor 	pCtor;			// Factory-Methode
	sal_uInt16				nId;            // ChildWindow-Id ( SlotId )
	SfxChildWinInfo 	aInfo;          // Konfiguration
	sal_uInt16				nPos;           // ggf. Position im UI
	SfxChildWinContextArr_Impl *pArr;	// Array f"ur Contexte

	SfxChildWinFactory( SfxChildWinCtor pTheCtor, sal_uInt16 nID,
			sal_uInt16 n )
		: pCtor(pTheCtor)
		, nId( nID )
		, nPos(n)
		, pArr( NULL )
	{}

//#if 0 // _SOLAR__PRIVATE
	~SfxChildWinFactory()
	{
		delete pArr;
	}
//#else
	// Der WIN16-Compiler versucht dort zu "ubersetzen, wo dieser Header
	// included wird, und kann dann nat"urlich nicht linken, wenn inline ...
//	~SfxChildWinFactory();
//#endif
};

class FloatingWindow;
struct SfxChildWindow_Impl;
class SFX2_DLLPUBLIC SfxChildWindowContext
{
friend class SfxChildWindow;
    ::Window* 			pWindow;
	sal_uInt16			nContextId;

protected:
						SfxChildWindowContext( sal_uInt16 nId );

public:
	virtual 			~SfxChildWindowContext();

    void				SetWindow( ::Window* pWin )
						{ pWindow=pWin; }
    ::Window*			GetWindow() const
						{ return pWindow; }
	sal_uInt16				GetContextId() const
						{ return nContextId; }

	FloatingWindow*		GetFloatingWindow() const;
	SfxChildAlignment	GetAlignment() const;

	virtual void        Resizing( Size& rSize );
	virtual sal_Bool		Close();
    static void         RegisterChildWindowContext(SfxModule*, sal_uInt16, SfxChildWinContextFactory*);
};

class SFX2_DLLPUBLIC SfxChildWindow
{
    ::Window* 				pParent;		// parent window ( Topwindow )
	sal_uInt16				nType;			// ChildWindow-Id

protected:
	SfxChildAlignment   	eChildAlignment;// aktuelles ::com::sun::star::drawing::Alignment
    ::Window*             	pWindow;		// eigentlicher Inhalt
	SfxChildWindow_Impl*	pImp;			// Imp-Daten

private:
	SfxChildWindowContext*	pContext;		// bei kontextsensitiven ChildWindows:
											// weiteres window in pWindow
	SAL_DLLPRIVATE SfxChildWindowContext*
						GetContext() const
						{ return pContext; }

protected:
                        SfxChildWindow(::Window *pParentWindow, sal_uInt16 nId);

public:
	virtual 			~SfxChildWindow();
	void				Destroy();
    ::Window* 			GetWindow() const
						{ return pWindow; }
    ::Window* 			GetParent() const
						{ return pParent; }
	SfxChildAlignment	GetAlignment() const
						{ return eChildAlignment; }
	void				SetAlignment(SfxChildAlignment eAlign);
	Size				GetSizePixel() const
						{ return pWindow->GetSizePixel(); }
	void				SetPosSizePixel(const Point& rPoint, Size& rSize);
	Point				GetPosPixel()
						{ return pWindow->GetPosPixel(); }
//<!--Modified by PengYunQuan for Validity Cell Range Picker
	virtual void				Hide();
    virtual void                Show( sal_uInt16 nFlags );
//-->Modified by PengYunQuan for Validity Cell Range Picker
    sal_uInt16          GetFlags() const
						{ return GetInfo().nFlags; }
	sal_Bool				CanGetFocus() const;
	sal_uInt16				GetPosition();
	sal_uInt16				GetType()
						{ return nType; }

	void				CreateContext( sal_uInt16 nContextId, SfxBindings& );
	sal_uInt16				GetContextId() const
						{ return pContext ? pContext->GetContextId(): 0; }

    ::Window*			GetContextWindow() const
						{ return pContext ? pContext->GetWindow(): 0; }

    ::Window*			GetContextWindow( SfxModule *pModule ) const;

	virtual SfxChildWinInfo GetInfo() const;
	void				SaveStatus(const SfxChildWinInfo& rInfo);

    static void         RegisterChildWindow(SfxModule*, SfxChildWinFactory*);

    static SfxChildWindow* CreateChildWindow( sal_uInt16, ::Window*, SfxBindings*, SfxChildWinInfo&);
	void				SetHideNotDelete( sal_Bool bOn );
	sal_Bool				IsHideNotDelete() const;
	void				SetHideAtToggle( sal_Bool bOn );
	sal_Bool				IsHideAtToggle() const;
	sal_Bool				IsVisible() const;
	void				SetWantsFocus( sal_Bool );
	sal_Bool			WantsFocus() const;

	virtual sal_Bool	QueryClose();
	virtual com::sun::star::uno::Reference< ::com::sun::star::frame::XFrame > 			GetFrame();
	void				SetFrame( const ::com::sun::star::uno::Reference< ::com::sun::star::frame::XFrame > & );

//#if 0 // _SOLAR__PRIVATE
	SAL_DLLPRIVATE static void InitializeChildWinFactory_Impl(sal_uInt16, SfxChildWinInfo&);
	SAL_DLLPRIVATE void SetVisible_Impl( sal_Bool bVis );
	SAL_DLLPRIVATE void SetWorkWindow_Impl( SfxWorkWindow* );
	//SfxWorkWindow*		GetWorkWindow_Impl() const;
	SAL_DLLPRIVATE void Activate_Impl();
	SAL_DLLPRIVATE void Deactivate_Impl();

	SAL_DLLPRIVATE SfxChildWindowContext*
						GetContext_Impl() const
						{ return pContext; }
	SAL_DLLPRIVATE void SetFactory_Impl( SfxChildWinFactory* );
//#endif
};

//------------------------------------------------------------------
//! demn"achst hinf"allig !
#define SFX_DECL_CHILDWINDOW_CONTEXT(Class) \
        static	SfxChildWindowContext* CreateImpl(::Window *pParent, \
					SfxBindings *pBindings, SfxChildWinInfo* pInfo ); \
		static	void RegisterChildWindowContext(SfxModule *pMod=0); \

//! Das Macro der Zukunft ...
#define SFX_DECL_CHILDWINDOWCONTEXT(Class) \
        static	SfxChildWindowContext* CreateImpl(::Window *pParent, \
					SfxBindings *pBindings, SfxChildWinInfo* pInfo ); \
		static	void RegisterChildWindowContext(sal_uInt16, SfxModule *pMod=0); \

//! demn"achst hinf"allig !
#define SFX_IMPL_CHILDWINDOW_CONTEXT(Class, MyID, ShellClass) \
        SfxChildWindowContext* __EXPORT Class::CreateImpl( ::Window *pParent, \
				SfxBindings *pBindings, SfxChildWinInfo* pInfo ) \
		{	\
            SfxChildWindowContext *pContext = new Class(pParent, \
                    /* cast is safe here! */static_cast< sal_uInt16 >(ShellClass::GetInterfaceId()), \
                    pBindings,pInfo); \
			return pContext; \
		} \
		void	Class::RegisterChildWindowContext(SfxModule* pMod)	 \
		{	\
            SfxChildWinContextFactory *pFact = new SfxChildWinContextFactory( \
                Class::CreateImpl, \
                /* cast is safe here! */static_cast< sal_uInt16 >(ShellClass::GetInterfaceId()) );   \
            SfxChildWindowContext::RegisterChildWindowContext(pMod, MyID, pFact); \
		}

//! Das Macro der Zukunft ...
// CreateImpl mu\s noch als Parameter die Factory mitbekommen wg. ContextId
// Solange wird diese Id auf 0 gesetzt und in SfxChildWindow::CreateContext gepatched
#define SFX_IMPL_CHILDWINDOWCONTEXT(Class, MyID) \
        SfxChildWindowContext* __EXPORT Class::CreateImpl( ::Window *pParent, \
				SfxBindings *pBindings, SfxChildWinInfo* pInfo ) \
		{	\
			SfxChildWindowContext *pContext = new Class(pParent,0,pBindings,pInfo);\
			return pContext; \
		} \
		void	Class::RegisterChildWindowContext(sal_uInt16 nId, SfxModule* pMod)	 \
		{	\
			SfxChildWinContextFactory *pFact = new SfxChildWinContextFactory( \
				Class::CreateImpl, nId );   \
            SfxChildWindowContext::RegisterChildWindowContext(pMod, MyID, pFact); \
		}

#define SFX_DECL_CHILDWINDOW(Class) \
	public	:	\
        static	SfxChildWindow* CreateImpl(::Window *pParent, sal_uInt16 nId, \
					SfxBindings *pBindings, SfxChildWinInfo* pInfo ); \
		static	void RegisterChildWindow (sal_Bool bVisible=sal_False, SfxModule *pMod=NULL, sal_uInt16 nFlags=0); \
		static	sal_uInt16 GetChildWindowId ();\
		virtual	SfxChildWinInfo GetInfo() const

#define SFX_IMPL_CHILDWINDOW(Class, MyID) \
		SFX_IMPL_POS_CHILDWINDOW(Class, MyID, CHILDWIN_NOPOS)

#define SFX_IMPL_POS_CHILDWINDOW(Class, MyID, Pos) \
        SfxChildWindow* __EXPORT Class::CreateImpl( ::Window *pParent, \
				sal_uInt16 nId, SfxBindings *pBindings, SfxChildWinInfo* pInfo ) \
				{	\
					SfxChildWindow *pWin = new Class(pParent, nId, pBindings, pInfo);\
					return pWin; \
				} \
		sal_uInt16	__EXPORT Class::GetChildWindowId () \
				{ return MyID; } \
		void	Class::RegisterChildWindow (sal_Bool bVis, SfxModule *pMod, sal_uInt16 nFlags)	 \
				{	\
					SfxChildWinFactory *pFact = new SfxChildWinFactory( \
						Class::CreateImpl, MyID, Pos );   \
					pFact->aInfo.nFlags |= nFlags;	\
					pFact->aInfo.bVisible = bVis;		  \
                    SfxChildWindow::RegisterChildWindow(pMod, pFact); \
				}

#define SFX_IMPL_FLOATINGWINDOW(Class, MyID)	\
		SFX_IMPL_CHILDWINDOW(Class, MyID)		\
		SfxChildWinInfo __EXPORT Class::GetInfo() const \
		{ 										\
			SfxChildWinInfo aInfo = SfxChildWindow::GetInfo();     \
			((SfxFloatingWindow*)GetWindow())->FillInfo( aInfo );  \
			return aInfo; }

#define SFX_IMPL_MODELESSDIALOG(Class, MyID)	\
		SFX_IMPL_CHILDWINDOW(Class, MyID)		\
		SfxChildWinInfo __EXPORT Class::GetInfo() const \
		{ 										\
			SfxChildWinInfo aInfo = SfxChildWindow::GetInfo();     \
			((SfxModelessDialog*)GetWindow())->FillInfo( aInfo );  \
			return aInfo; }

#define SFX_IMPL_DOCKINGWINDOW(Class, MyID)	\
		SFX_IMPL_CHILDWINDOW(Class, MyID)		\
		SfxChildWinInfo __EXPORT Class::GetInfo() const \
		{ 										\
			SfxChildWinInfo aInfo = SfxChildWindow::GetInfo();     \
			((SfxDockingWindow*)GetWindow())->FillInfo( aInfo );  \
			return aInfo; }

#define SFX_IMPL_TOOLBOX(Class, MyID)	\
		SFX_IMPL_CHILDWINDOW(Class, MyID)		\
		SfxChildWinInfo __EXPORT Class::GetInfo() const \
		{ 										\
			SfxChildWinInfo aInfo = SfxChildWindow::GetInfo();     \
			((SfxToolbox*)GetWindow())->FillInfo( aInfo );  \
			return aInfo; }

//------------------------------------------------------------------

#endif