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
|
/* -*- 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_TBXCTRL_HXX
#define INCLUDED_SFX2_TBXCTRL_HXX
#include <sal/config.h>
#include <sfx2/dllapi.h>
#include <sal/types.h>
#include <vcl/timer.hxx>
#include <vcl/menu.hxx>
#include <vcl/fixed.hxx>
#include <vcl/floatwin.hxx>
#include <comphelper/processfactory.hxx>
#include <cppuhelper/implbase.hxx>
#include <sfx2/ctrlitem.hxx>
#include <sfx2/sfxstatuslistener.hxx>
#include <svtools/toolboxcontroller.hxx>
#include <svtools/framestatuslistener.hxx>
#include <com/sun/star/lang/XMultiServiceFactory.hpp>
#include <com/sun/star/frame/XDispatchProvider.hpp>
#include <com/sun/star/frame/XFrame.hpp>
#include <com/sun/star/frame/XSubToolbarController.hpp>
class SfxToolBoxControl;
class SfxModule;
svt::ToolboxController* SAL_CALL SfxToolBoxControllerFactory( const css::uno::Reference< css::frame::XFrame >& rFrame, ToolBox* pToolbox, unsigned short nID, const OUString& aCommandURL );
typedef SfxToolBoxControl* (*SfxToolBoxControlCtor)( sal_uInt16 nSlotId, sal_uInt16 nId, ToolBox& rBox );
struct SfxTbxCtrlFactory
{
SfxToolBoxControlCtor pCtor;
TypeId nTypeId;
sal_uInt16 nSlotId;
SfxTbxCtrlFactory( SfxToolBoxControlCtor pTheCtor,
TypeId nTheTypeId, sal_uInt16 nTheSlotId ):
pCtor(pTheCtor),
nTypeId(nTheTypeId),
nSlotId(nTheSlotId)
{}
};
/* Floating windows that can be torn from tool boxes should be derived from
this class. Since it is also derived from SfxControllerItem, its instances
will also receive the StateChanged calls.
*/
class SfxFrameStatusListener;
class SFX2_DLLPUBLIC SfxPopupWindow: public FloatingWindow
{
friend class SfxFrameStatusListener;
bool m_bFloating;
bool m_bCascading;
Link<SfxPopupWindow*,void> m_aDeleteLink;
sal_uInt16 m_nId;
css::uno::Reference< css::frame::XFrame > m_xFrame;
SfxFrameStatusListener* m_pStatusListener;
css::uno::Reference< css::lang::XComponent > m_xStatusListener;
private:
SfxFrameStatusListener* GetOrCreateStatusListener();
SfxPopupWindow(SfxPopupWindow &) = delete;
void operator =(SfxPopupWindow &) = delete;
void Delete();
protected:
virtual void PopupModeEnd() override;
virtual bool Close() override;
void DeleteFloatingWindow();
sal_uInt16 GetId() const { return m_nId; }
const css::uno::Reference< css::frame::XFrame >& GetFrame() const { return m_xFrame; }
void BindListener();
void UnbindListener();
void AddStatusListener( const OUString& rCommandURL );
// SfxStatusListenerInterface
using FloatingWindow::StateChanged;
virtual void StateChanged( sal_uInt16 nSID, SfxItemState eState,
const SfxPoolItem* pState );
public:
SfxPopupWindow( sal_uInt16 nId,
const css::uno::Reference< css::frame::XFrame >& rFrame,
WinBits nBits );
SfxPopupWindow(sal_uInt16 nId,
const OString& rID, const OUString& rUIXMLDescription,
const css::uno::Reference<css::frame::XFrame> &rFrame =
css::uno::Reference<css::frame::XFrame>());
SfxPopupWindow(sal_uInt16 nId, vcl::Window *pParent,
const OString& rID, const OUString& rUIXMLDescription,
const css::uno::Reference<css::frame::XFrame> &rFrame =
css::uno::Reference<css::frame::XFrame>());
SfxPopupWindow( sal_uInt16 nId,
const css::uno::Reference< css::frame::XFrame >& rFrame,
vcl::Window* pParentWindow,
WinBits nBits );
virtual ~SfxPopupWindow();
virtual void dispose() override;
virtual void MouseMove( const MouseEvent& rMEvt ) override;
void StartCascading();
SAL_DLLPRIVATE void SetDeleteLink_Impl( const Link<SfxPopupWindow*,void>& rLink )
{
m_aDeleteLink = rLink;
}
};
#define SFX_DECL_TOOLBOX_CONTROL() \
static SfxToolBoxControl* CreateImpl( sal_uInt16 nSlotId, sal_uInt16 nId, ToolBox &rTbx ); \
static void RegisterControl(sal_uInt16 nSlotId = 0, SfxModule *pMod=nullptr)
/* For special ToolBox controls, such as a font selection box or toolbox
tear-off floating windows, an appropriate Item-Subclass of SfxTooBoxControl
has to be implemented.
This class has to be registered in SfxApplication:Init() with the static
control method RegisterControl(). The SFx then automatically creates these
controls in the toolbox, if the associated slots are of the specific type.
*/
struct SfxToolBoxControl_Impl;
class SFX2_DLLPUBLIC SfxToolBoxControl:
public cppu::ImplInheritanceHelper<
svt::ToolboxController, css::frame::XSubToolbarController>
{
friend class SfxToolbox;
friend class SfxPopupWindow;
friend struct SfxTbxCtrlFactory;
SfxToolBoxControl_Impl* pImpl;
protected:
DECL_LINK_TYPED( PopupModeEndHdl, FloatingWindow*, void );
DECL_LINK_TYPED( ClosePopupWindow, SfxPopupWindow *, void );
// old SfxToolBoxControl methods
virtual void StateChanged( sal_uInt16 nSID, SfxItemState eState, const SfxPoolItem* pState );
virtual void Select( sal_uInt16 nSelectModifier );
virtual void DoubleClick();
virtual void Click();
virtual VclPtr<SfxPopupWindow> CreatePopupWindow();
virtual VclPtr<vcl::Window> CreateItemWindow( vcl::Window *pParent );
// Must be called by subclass to set a new popup window instance
void SetPopupWindow( SfxPopupWindow* pWindow );
// helper methods
bool hasBigImages() const;
public:
// XEventListener
using ::cppu::OPropertySetHelper::disposing;
virtual void SAL_CALL disposing( const css::lang::EventObject& aEvent ) throw( css::uno::RuntimeException, std::exception ) override;
// XComponent
virtual void SAL_CALL dispose() throw (css::uno::RuntimeException, std::exception) override;
// new controller API
// XStatusListener
virtual void SAL_CALL statusChanged( const css::frame::FeatureStateEvent& Event )
throw ( css::uno::RuntimeException, std::exception ) override;
// XToolbarController
virtual void SAL_CALL execute( sal_Int16 KeyModifier )
throw (css::uno::RuntimeException, std::exception) override;
virtual void SAL_CALL click()
throw (css::uno::RuntimeException, std::exception) override;
virtual void SAL_CALL doubleClick()
throw (css::uno::RuntimeException, std::exception) override;
virtual css::uno::Reference< css::awt::XWindow > SAL_CALL createPopupWindow()
throw (css::uno::RuntimeException, std::exception) override;
virtual css::uno::Reference< css::awt::XWindow > SAL_CALL createItemWindow( const css::uno::Reference< css::awt::XWindow >& rParent )
throw (css::uno::RuntimeException, std::exception) override;
// XSubToolbarController
virtual sal_Bool SAL_CALL opensSubToolbar( ) throw (css::uno::RuntimeException, std::exception) override;
virtual OUString SAL_CALL getSubToolbarName( ) throw (css::uno::RuntimeException, std::exception) override;
virtual void SAL_CALL functionSelected( const OUString& aCommand ) throw (css::uno::RuntimeException, std::exception) override;
virtual void SAL_CALL updateImage( ) throw (css::uno::RuntimeException, std::exception) override;
public:
SFX_DECL_TOOLBOX_CONTROL();
SfxToolBoxControl( sal_uInt16 nSlotID, sal_uInt16 nId, ToolBox& rBox, bool bShowStrings = false );
virtual ~SfxToolBoxControl();
ToolBox& GetToolBox() const;
unsigned short GetId() const;
unsigned short GetSlotId() const;
void Dispatch( const OUString& aCommand,
css::uno::Sequence< css::beans::PropertyValue >& aArgs );
static void Dispatch( const css::uno::Reference< css::frame::XDispatchProvider >& rDispatchProvider,
const OUString& rCommand,
css::uno::Sequence< css::beans::PropertyValue >& aArgs );
static SfxItemState GetItemState( const SfxPoolItem* pState );
static SfxToolBoxControl* CreateControl( sal_uInt16 nSlotId, sal_uInt16 nTbxId, ToolBox *pBox, SfxModule *pMod );
static void RegisterToolBoxControl( SfxModule*, SfxTbxCtrlFactory*);
};
#define SFX_IMPL_TOOLBOX_CONTROL(Class, nItemClass) \
SfxToolBoxControl* Class::CreateImpl( sal_uInt16 nSlotId, sal_uInt16 nId, ToolBox &rTbx ) \
{ return new Class( nSlotId, nId, rTbx ); } \
void Class::RegisterControl(sal_uInt16 nSlotId, SfxModule *pMod) \
{ SfxToolBoxControl::RegisterToolBoxControl( pMod, new SfxTbxCtrlFactory( \
Class::CreateImpl, TYPE(nItemClass), nSlotId ) ); }
#define SFX_IMPL_TOOLBOX_CONTROL_ARG(Class, nItemClass, Arg) \
SfxToolBoxControl* Class::CreateImpl( sal_uInt16 nSlotId, sal_uInt16 nId, ToolBox &rTbx ) \
{ return new Class( nSlotId, nId, rTbx, Arg); } \
void Class::RegisterControl(sal_uInt16 nSlotId, SfxModule *pMod) \
{ SfxToolBoxControl::RegisterToolBoxControl( pMod, new SfxTbxCtrlFactory( \
Class::CreateImpl, TYPE(nItemClass), nSlotId ) ); }
class SfxDragButton_Impl : public FixedImage
{
public:
SfxDragButton_Impl( vcl::Window *pParent );
virtual void Command ( const CommandEvent& rCEvt ) override;
virtual void MouseMove( const MouseEvent& rMEvt ) override;
virtual void MouseButtonDown( const MouseEvent& rMEvt ) override;
};
class SfxDragToolBoxControl_Impl : public SfxToolBoxControl
{
public:
SfxDragToolBoxControl_Impl( sal_uInt16 nId, ToolBox& rBox );
virtual VclPtr<vcl::Window> CreateItemWindow( vcl::Window *pParent ) override;
virtual void Select(sal_uInt16 nSelectModifier) override;
};
/** Toolbox that implements recent files menu for the Open file toolbar button.
To use that, the appropriate Sfx*Item (like Open, OpenFromCalc, or
OpenFromWriter) has to have SlotType = SfxStringItem, and the appropriate
module initialization has to call RegisterControl().
*/
class SfxRecentFilesToolBoxControl : public SfxToolBoxControl
{
public:
// We don't use SFX_DECL_TOOLBOX_CONTROL() here as we need to have this
// RegisterControl() marked as SFX2_DLLPUBLIC
static SfxToolBoxControl* CreateImpl( sal_uInt16 nSlotId, sal_uInt16 nId, ToolBox &rTbx );
static void SFX2_DLLPUBLIC RegisterControl(sal_uInt16 nSlotId = 0, SfxModule *pMod=nullptr);
SfxRecentFilesToolBoxControl( sal_uInt16 nSlotId, sal_uInt16 nId, ToolBox& rBox );
virtual ~SfxRecentFilesToolBoxControl();
protected:
virtual VclPtr<SfxPopupWindow> CreatePopupWindow() override;
};
class SfxSaveAsToolBoxControl : public SfxToolBoxControl
{
public:
// We don't use SFX_DECL_TOOLBOX_CONTROL() here as we need to have this
// RegisterControl() marked as SFX2_DLLPUBLIC
static SfxToolBoxControl* CreateImpl( sal_uInt16 nSlotId, sal_uInt16 nId, ToolBox &rTbx );
static void SFX2_DLLPUBLIC RegisterControl(sal_uInt16 nSlotId = 0, SfxModule *pMod=nullptr);
SfxSaveAsToolBoxControl( sal_uInt16 nSlotId, sal_uInt16 nId, ToolBox& rBox );
virtual ~SfxSaveAsToolBoxControl();
protected:
virtual VclPtr<SfxPopupWindow> CreatePopupWindow() override;
};
class SfxReloadToolBoxControl_Impl : public SfxToolBoxControl
{
protected:
virtual void Select(sal_uInt16 nSelectModifier ) override;
public:
SfxReloadToolBoxControl_Impl( sal_uInt16 nSlotId, sal_uInt16 nId, ToolBox& rBox );
};
class SfxPopupMenuManager;
class SfxAddonsToolBoxControl_Impl : public SfxToolBoxControl
/* [Description]
Internal helper class to provide the addons popup menu through the addons
toolbox button.
*/
{
bool bBigImages;
PopupMenu* pMenu;
bool m_bShowMenuImages;
protected:
virtual void Click() override;
virtual void Select(sal_uInt16 nSelectModifier) override;
virtual void StateChanged( sal_uInt16 nSID, SfxItemState eState, const SfxPoolItem* pState ) override;
public:
SfxAddonsToolBoxControl_Impl( sal_uInt16 nSlotId, sal_uInt16 nId, ToolBox& rBox );
virtual ~SfxAddonsToolBoxControl_Impl();
};
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
