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
|
/* -*- 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_CHILDWIN_HXX
#define INCLUDED_SFX2_CHILDWIN_HXX
#include <memory>
#include <sal/config.h>
#include <sfx2/dllapi.h>
#include <sal/types.h>
#include <o3tl/typed_flags_set.hxx>
#include <vcl/window.hxx>
#include <com/sun/star/frame/XFrame.hpp>
#include <sfx2/shell.hxx>
#include <sfx2/chalign.hxx>
#include <sfx2/bindings.hxx>
// complete SfxBindings for complete SfxChildWinCtor, SfxChildWinContextCtor
// under -fsanitize=function
class SfxWorkWindow;
class SfxModule;
class SfxShell;
class SfxChildWindow;
class SfxChildWindowContext;
enum class SfxChildWindowFlags
{
NONE = 0x00,
ZOOMIN = 0x01, // Fully retracted Float
FORCEDOCK = 0x04, // Float forbidden
TASK = 0x10, // ChildWindow inside the Task
CANTGETFOCUS = 0x20, // ChildWindow can not get focus
ALWAYSAVAILABLE = 0x40, // ChildWindow is never disabled
NEVERHIDE = 0x80 // ChildWindow is can always made
// visible/is visible
};
namespace o3tl
{
template<> struct typed_flags<SfxChildWindowFlags> : is_typed_flags<SfxChildWindowFlags, 0xf5> {};
}
#define CHILDWIN_NOPOS USHRT_MAX
// ChildWindow Configuration
struct SAL_DLLPUBLIC_RTTI SfxChildWinInfo
{
bool bVisible;
Point aPos;
Size aSize;
SfxChildWindowFlags nFlags;
OUString aExtraString;
OUString aModule;
OString aWinState;
SfxChildWinInfo()
{
bVisible = false;
nFlags = SfxChildWindowFlags::NONE;
}
bool GetExtraData_Impl( SfxChildAlignment *pAlign ) const;
};
// ChildWindow factory methods
typedef SfxChildWindow* (*SfxChildWinCtor)( vcl::Window *pParentWindow,
sal_uInt16 nId,
SfxBindings *pBindings,
SfxChildWinInfo *pInfo);
// ChildWindowsContexts factory methods
typedef SfxChildWindowContext* (*SfxChildWinContextCtor)( vcl::Window *pParentWindow,
SfxBindings *pBindings,
SfxChildWinInfo *pInfo);
struct SfxChildWinContextFactory
{
SfxChildWinContextCtor pCtor; // Factory method
sal_uInt16 nContextId; // Identifier for SfxInterface
SfxChildWinContextFactory( SfxChildWinContextCtor pTheCtor, sal_uInt16 nID )
: pCtor(pTheCtor)
, nContextId(nID)
{}
};
class SfxChildWinContextArr_Impl;
struct SFX2_DLLPUBLIC SfxChildWinFactory
{
SfxChildWinCtor pCtor; // Factory method
sal_uInt16 nId; // ChildWindow-Id ( SlotId )
SfxChildWinInfo aInfo; // Configuration
sal_uInt16 nPos; // Position in UI
std::unique_ptr<SfxChildWinContextArr_Impl> pArr; // Array for Contexts
SfxChildWinFactory( SfxChildWinCtor pTheCtor, sal_uInt16 nID, sal_uInt16 n );
~SfxChildWinFactory();
};
class FloatingWindow;
struct SfxChildWindow_Impl;
class SFX2_DLLPUBLIC SfxChildWindowContext
{
friend class SfxChildWindow;
VclPtr<vcl::Window> pWindow;
sal_uInt16 nContextId;
protected:
SfxChildWindowContext( sal_uInt16 nId );
public:
virtual ~SfxChildWindowContext();
void SetWindow( vcl::Window* pWin )
{ pWindow=pWin; }
vcl::Window* GetWindow() const
{ return pWindow; }
sal_uInt16 GetContextId() const
{ return nContextId; }
static FloatingWindow* GetFloatingWindow(vcl::Window *pParent);
static void RegisterChildWindowContext(SfxModule*, sal_uInt16, SfxChildWinContextFactory*);
};
class SFX2_DLLPUBLIC SfxChildWindow
{
VclPtr<vcl::Window> pParent; // parent window ( Topwindow )
sal_uInt16 nType; // ChildWindow-Id
VclPtr<vcl::Window> pWindow; // actual contents
SfxChildAlignment eChildAlignment; // Current css::drawing::Alignment
std::unique_ptr< SfxChildWindow_Impl> pImpl; // Implementation data
SfxChildWindowContext* pContext; // With context-sensitive ChildWindows:
// Another window in pWindow
SAL_DLLPRIVATE void ClearWorkwin();
protected:
void SetWindow(const VclPtr<vcl::Window>& p) { pWindow = p; }
SfxChildWindow(vcl::Window *pParentWindow, sal_uInt16 nId);
public:
virtual ~SfxChildWindow();
void Destroy();
vcl::Window* GetWindow() const
{ return pWindow; }
vcl::Window* GetParent() const
{ return pParent; }
SfxChildAlignment GetAlignment() const
{ return eChildAlignment; }
void SetAlignment(SfxChildAlignment eAlign);
Size GetSizePixel() const
{ return pWindow->GetSizePixel(); }
virtual void Hide();
virtual void Show( ShowFlags nFlags );
sal_uInt16 GetPosition();
sal_uInt16 GetType()
{ return nType; }
void CreateContext( sal_uInt16 nContextId, SfxBindings& );
sal_uInt16 GetContextId() const
{ return pContext ? pContext->GetContextId(): 0; }
vcl::Window* GetContextWindow() const
{ return pContext ? pContext->GetWindow(): nullptr; }
vcl::Window* GetContextWindow( SfxModule const *pModule ) const;
virtual SfxChildWinInfo GetInfo() const;
void SaveStatus(const SfxChildWinInfo& rInfo);
static void RegisterChildWindow(SfxModule*, SfxChildWinFactory*);
static SfxChildWindow* CreateChildWindow( sal_uInt16, vcl::Window*, SfxBindings*, SfxChildWinInfo const &);
void SetHideNotDelete( bool bOn );
bool IsHideNotDelete() const;
bool IsVisible() const;
void SetWantsFocus( bool );
bool WantsFocus() const;
virtual bool QueryClose();
const css::uno::Reference< css::frame::XFrame >& GetFrame();
void SetFrame( const css::uno::Reference< css::frame::XFrame > & );
SAL_DLLPRIVATE static void InitializeChildWinFactory_Impl(sal_uInt16, SfxChildWinInfo&);
void SetVisible_Impl( bool bVis );
SAL_DLLPRIVATE void SetWorkWindow_Impl( SfxWorkWindow* );
SAL_DLLPRIVATE void Activate_Impl();
SAL_DLLPRIVATE SfxChildWindowContext*
GetContext_Impl() const
{ return pContext; }
SAL_DLLPRIVATE void SetFactory_Impl( SfxChildWinFactory* );
};
//! The Macro of the future ...
#define SFX_DECL_CHILDWINDOWCONTEXT(Class) \
static SfxChildWindowContext* CreateImpl(vcl::Window *pParent, \
SfxBindings *pBindings, SfxChildWinInfo* pInfo ); \
static void RegisterChildWindowContext(sal_uInt16, SfxModule *pMod=nullptr); \
//! The Macro of the future ...
// As a parameter and because of ContextId, CreateImpl must be handed the
// factory. As long as Id is set to 0 and patched in
// SfxChildWindow::CreateContext
#define SFX_IMPL_CHILDWINDOWCONTEXT(Class, MyID) \
SfxChildWindowContext* Class::CreateImpl( vcl::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(vcl::Window *pParent, sal_uInt16 nId, \
SfxBindings *pBindings, SfxChildWinInfo* pInfo ); \
static void RegisterChildWindow (bool bVisible=false, SfxModule *pMod=nullptr, SfxChildWindowFlags nFlags=SfxChildWindowFlags::NONE); \
virtual SfxChildWinInfo GetInfo() const override
#define SFX_DECL_CHILDWINDOW_WITHID(Class) \
SFX_DECL_CHILDWINDOW(Class); \
static sal_uInt16 GetChildWindowId ()\
#define SFX_IMPL_CHILDWINDOW(Class, MyID) \
SFX_IMPL_POS_CHILDWINDOW(Class, MyID, CHILDWIN_NOPOS)
#define SFX_IMPL_CHILDWINDOW_WITHID(Class, MyID) \
SFX_IMPL_POS_CHILDWINDOW_WITHID(Class, MyID, CHILDWIN_NOPOS)
#define SFX_IMPL_POS_CHILDWINDOW(Class, MyID, Pos) \
SfxChildWindow* Class::CreateImpl( vcl::Window *pParent, \
sal_uInt16 nId, SfxBindings *pBindings, SfxChildWinInfo* pInfo ) \
{ \
SfxChildWindow *pWin = new Class(pParent, nId, pBindings, pInfo);\
return pWin; \
} \
void Class::RegisterChildWindow (bool bVis, SfxModule *pMod, SfxChildWindowFlags nFlags) \
{ \
SfxChildWinFactory *pFact = new SfxChildWinFactory( \
Class::CreateImpl, MyID, Pos ); \
pFact->aInfo.nFlags |= nFlags; \
pFact->aInfo.bVisible = bVis; \
SfxChildWindow::RegisterChildWindow(pMod, pFact); \
}
#define SFX_IMPL_POS_CHILDWINDOW_WITHID(Class, MyID, Pos) \
SFX_IMPL_POS_CHILDWINDOW(Class, MyID, Pos) \
sal_uInt16 Class::GetChildWindowId () \
{ return MyID; } \
#define SFX_IMPL_FLOATINGWINDOW(Class, MyID) \
SFX_IMPL_CHILDWINDOW(Class, MyID) \
SfxChildWinInfo Class::GetInfo() const \
{ \
SfxChildWinInfo aInfo = SfxChildWindow::GetInfo(); \
static_cast<SfxFloatingWindow*>(GetWindow())->FillInfo( aInfo ); \
return aInfo; }
#define SFX_IMPL_FLOATINGWINDOW_WITHID(Class, MyID) \
SFX_IMPL_CHILDWINDOW_WITHID(Class, MyID) \
SfxChildWinInfo Class::GetInfo() const \
{ \
SfxChildWinInfo aInfo = SfxChildWindow::GetInfo(); \
static_cast<SfxFloatingWindow*>(GetWindow())->FillInfo( aInfo ); \
return aInfo; }
#define SFX_IMPL_MODELESSDIALOG_WITHID(Class, MyID) \
SFX_IMPL_CHILDWINDOW_WITHID(Class, MyID) \
SfxChildWinInfo Class::GetInfo() const \
{ \
SfxChildWinInfo aInfo = SfxChildWindow::GetInfo(); \
static_cast<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(); \
static_cast<SfxDockingWindow*>(GetWindow())->FillInfo( aInfo ); \
return aInfo; }
#define SFX_IMPL_DOCKINGWINDOW_WITHID(Class, MyID) \
SFX_IMPL_CHILDWINDOW_WITHID(Class, MyID) \
SfxChildWinInfo Class::GetInfo() const \
{ \
SfxChildWinInfo aInfo = SfxChildWindow::GetInfo(); \
static_cast<SfxDockingWindow*>(GetWindow())->FillInfo( aInfo ); \
return aInfo; }
bool GetPosSizeFromString( const OUString& rStr, Point& rPos, Size& rSize );
bool GetSplitSizeFromString( const OUString& rStr, Size& rSize );
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
