summaryrefslogtreecommitdiff
path: root/sfx2/inc/sfx2/childwin.hxx
blob: 8fda445b5615fb53befaf9062c33ad9740931e9c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 * 
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 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
#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;

#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;
                        }
    sal_Bool				GetExtraData_Impl( SfxChildAlignment	*pAlign,
                                           SfxChildAlignment	*pLastAlign = 0,
                                           Size 				*pSize = 0,
                                           sal_uInt16				*pLine = 0,
                                           sal_uInt16				*pPos = 0 ) const;
};

// 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 )
    {}

    ~SfxChildWinFactory()
    {
        delete pArr;
    }

};

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(); }
    virtual void				Hide();
    virtual void                Show( sal_uInt16 nFlags );
    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 > & );

    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* );
};

//------------------------------------------------------------------
//! 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* 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* 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* Class::CreateImpl( ::Window *pParent, \
                sal_uInt16 nId, SfxBindings *pBindings, SfxChildWinInfo* pInfo ) \
                {	\
                    SfxChildWindow *pWin = new Class(pParent, nId, pBindings, pInfo);\
                    return pWin; \
                } \
        sal_uInt16 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 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 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 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 Class::GetInfo() const \
        { 										\
            SfxChildWinInfo aInfo = SfxChildWindow::GetInfo();     \
            ((SfxToolbox*)GetWindow())->FillInfo( aInfo );  \
            return aInfo; }

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

#endif

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */