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
|
/* -*- 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_TABDLG_HXX
#define INCLUDED_SFX2_TABDLG_HXX
#include <memory>
#include <sal/config.h>
#include <sfx2/dllapi.h>
#include <sal/types.h>
#include <vcl/button.hxx>
#include <vcl/layout.hxx>
#include <vcl/tabctrl.hxx>
#include <vcl/tabdlg.hxx>
#include <vcl/tabpage.hxx>
#include <svl/itempool.hxx>
#include <svl/itemset.hxx>
#include <com/sun/star/frame/XFrame.hpp>
#include <o3tl/typed_flags_set.hxx>
class SfxPoolItem;
class SfxTabDialog;
class SfxViewFrame;
class SfxTabPage;
class SfxBindings;
typedef VclPtr<SfxTabPage> (*CreateTabPage)(vcl::Window *pParent, const SfxItemSet *rAttrSet);
typedef const sal_uInt16* (*GetTabPageRanges)(); // provides international Which-value
struct TabPageImpl;
struct TabDlg_Impl;
#define RET_USER 100
#define RET_USER_CANCEL 101
class SFX2_DLLPUBLIC SfxTabDialogItem: public SfxSetItem
{
public:
SfxTabDialogItem( sal_uInt16 nId, const SfxItemSet& rItemSet );
SfxTabDialogItem(const SfxTabDialogItem& rAttr, SfxItemPool* pItemPool);
virtual SfxPoolItem* Clone(SfxItemPool* pToPool = nullptr) const override;
virtual SfxPoolItem* Create(SvStream& rStream, sal_uInt16 nVersion) const override;
};
class SFX2_DLLPUBLIC SfxTabDialog : public TabDialog
{
private:
friend class SfxTabPage;
friend class SfxTabDialogController;
friend class SfxTabDialogUIObject;
VclPtr<VclBox> m_pBox;
VclPtr<TabControl> m_pTabCtrl;
VclPtr<PushButton> m_pOKBtn;
VclPtr<PushButton> m_pApplyBtn;
VclPtr<PushButton> m_pUserBtn;
VclPtr<CancelButton> m_pCancelBtn;
VclPtr<HelpButton> m_pHelpBtn;
VclPtr<PushButton> m_pResetBtn;
VclPtr<PushButton> m_pBaseFmtBtn;
bool m_bOwnsOKBtn;
bool m_bOwnsCancelBtn;
bool m_bOwnsHelpBtn;
bool m_bOwnsResetBtn;
bool m_bOwnsBaseFmtBtn;
SfxItemSet* m_pSet;
std::unique_ptr<SfxItemSet> m_pOutSet;
std::unique_ptr< TabDlg_Impl > m_pImpl;
sal_uInt16* m_pRanges;
sal_uInt16 m_nAppPageId;
bool m_bStandardPushed;
DECL_DLLPRIVATE_LINK(ActivatePageHdl, TabControl*, void );
DECL_DLLPRIVATE_LINK(DeactivatePageHdl, TabControl*, bool );
DECL_DLLPRIVATE_LINK(OkHdl, Button*, void);
DECL_DLLPRIVATE_LINK(ResetHdl, Button*, void);
DECL_DLLPRIVATE_LINK(BaseFmtHdl, Button*, void);
DECL_DLLPRIVATE_LINK(UserHdl, Button*, void);
DECL_DLLPRIVATE_LINK(CancelHdl, Button*, void);
SAL_DLLPRIVATE void Init_Impl(bool bFmtFlag);
protected:
virtual short Ok();
// Is deleted in Sfx!
virtual SfxItemSet* CreateInputItemSet( sal_uInt16 nId );
// Is not deleted in Sfx!
virtual void RefreshInputSet();
virtual void PageCreated( sal_uInt16 nId, SfxTabPage &rPage );
VclPtr<VclButtonBox> m_pActionArea;
SfxItemSet* m_pExampleSet;
SfxItemSet* GetInputSetImpl();
SfxTabPage* GetTabPage( sal_uInt16 nPageId ) const;
/** prepare to leave the current page. Calls the DeactivatePage method of the current page, (if necessary),
handles the item sets to copy.
@return sal_True if it is allowed to leave the current page, sal_False otherwise
*/
bool PrepareLeaveCurrentPage();
/** save the position of the TabDialog and which tab page is the currently active one
*/
void SavePosAndId();
public:
SfxTabDialog(vcl::Window* pParent,
const OUString& rID, const OUString& rUIXMLDescription,
const SfxItemSet * = nullptr, bool bEditFmt = false);
virtual ~SfxTabDialog() override;
virtual void dispose() override;
sal_uInt16 AddTabPage( const OString& rName, // Name of the label for the page in the notebook .ui
CreateTabPage pCreateFunc, // != 0
GetTabPageRanges pRangesFunc); // can be 0
sal_uInt16 AddTabPage ( const OString &rName, // Name of the label for the page in the notebook .ui
sal_uInt16 nPageCreateId ); // Identifier of the Factory Method to create the page
void AddTabPage( sal_uInt16 nId,
const OUString &rRiderText,
CreateTabPage pCreateFunc, // != 0
GetTabPageRanges pRangesFunc, // can be 0
sal_uInt16 nPos = TAB_APPEND);
void AddTabPage( sal_uInt16 nId,
const OUString &rRiderText);
void RemoveTabPage( const OString& rName ); // Name of the label for the page in the notebook .ui
void RemoveTabPage( sal_uInt16 nId );
void SetCurPageId(sal_uInt16 nId)
{
m_nAppPageId = nId;
}
void SetCurPageId(const OString& rName)
{
m_nAppPageId = m_pTabCtrl->GetPageId(rName);
}
sal_uInt16 GetCurPageId() const
{
return m_pTabCtrl->GetCurPageId();
}
SfxTabPage* GetCurTabPage() const
{
return GetTabPage(m_pTabCtrl->GetCurPageId());
}
virtual OString GetScreenshotId() const override;
OUString const & GetPageText( sal_uInt16 nPageId ) const
{
return m_pTabCtrl->GetPageText(nPageId);
}
void ShowPage( sal_uInt16 nId );
// may provide local slots converted by Map
const sal_uInt16* GetInputRanges( const SfxItemPool& );
void SetInputSet( const SfxItemSet* pInSet );
const SfxItemSet* GetOutputItemSet() const { return m_pOutSet.get(); }
const PushButton& GetOKButton() const { return *m_pOKBtn; }
PushButton& GetOKButton() { return *m_pOKBtn; }
const CancelButton& GetCancelButton() const { return *m_pCancelBtn; }
CancelButton& GetCancelButton() { return *m_pCancelBtn; }
const PushButton* GetUserButton() const { return m_pUserBtn; }
PushButton* GetUserButton() { return m_pUserBtn; }
void RemoveResetButton();
void RemoveStandardButton();
short Execute() override;
void StartExecuteModal( const Link<Dialog&,void>& rEndDialogHdl ) override;
bool StartExecuteAsync( VclAbstractDialog::AsyncContext &rCtx ) override;
void Start();
const SfxItemSet* GetExampleSet() const { return m_pExampleSet; }
SfxItemSet* GetExampleSet() { return m_pExampleSet; }
void SetApplyHandler(const Link<Button*,void>& _rHdl);
SAL_DLLPRIVATE void Start_Impl();
//calls Ok without closing dialog
bool Apply();
virtual FactoryFunction GetUITestFactory() const override;
// Screenshot interface
virtual std::vector<OString> getAllPageUIXMLDescriptions() const override;
virtual bool selectPageByUIXMLDescription(const OString& rUIXMLDescription) override;
};
namespace sfx { class ItemConnectionBase; }
enum class DeactivateRC {
KeepPage = 0x00, // Error handling; page does not change
// 2. Fill an itemset for update
// parent examples, this pointer can be NULL all the time!
LeavePage = 0x01,
// Set, refresh and update other Page
RefreshSet = 0x02
};
namespace o3tl {
template<> struct typed_flags<DeactivateRC> : is_typed_flags<DeactivateRC, 0x03> {};
}
class SFX2_DLLPUBLIC SfxTabPage: public TabPage
{
friend class SfxTabDialog;
private:
const SfxItemSet* pSet;
OUString aUserString;
bool bHasExchangeSupport;
std::unique_ptr< TabPageImpl > pImpl;
protected:
SfxTabPage(vcl::Window *pParent, const OString& rID, const OUString& rUIXMLDescription, const SfxItemSet *rAttrSet);
sal_uInt16 GetWhich( sal_uInt16 nSlot, bool bDeep = true ) const
{ return pSet->GetPool()->GetWhich( nSlot, bDeep ); }
const SfxPoolItem* GetOldItem( const SfxItemSet& rSet, sal_uInt16 nSlot, bool bDeep = true );
template<class T> const T* GetOldItem( const SfxItemSet& rSet, TypedWhichId<T> nSlot, bool bDeep = true )
{
return static_cast<const T*>(GetOldItem(rSet, sal_uInt16(nSlot), bDeep));
}
SfxTabDialog* GetTabDialog() const;
void AddItemConnection( sfx::ItemConnectionBase* pConnection );
public:
virtual ~SfxTabPage() override;
virtual void dispose() override;
const SfxItemSet& GetItemSet() const { return *pSet; }
virtual bool FillItemSet( SfxItemSet* );
virtual void Reset( const SfxItemSet* );
bool HasExchangeSupport() const
{ return bHasExchangeSupport; }
void SetExchangeSupport()
{ bHasExchangeSupport = true; }
using TabPage::ActivatePage;
using TabPage::DeactivatePage;
virtual void ActivatePage( const SfxItemSet& );
virtual DeactivateRC DeactivatePage( SfxItemSet* pSet );
void SetUserData(const OUString& rString)
{ aUserString = rString; }
const OUString& GetUserData() { return aUserString; }
virtual void FillUserData();
virtual bool IsReadOnly() const;
virtual void PageCreated (const SfxAllItemSet& aSet);
virtual void ChangesApplied();
static const SfxPoolItem* GetItem( const SfxItemSet& rSet, sal_uInt16 nSlot, bool bDeep = true );
template<class T> static const T* GetItem( const SfxItemSet& rSet, TypedWhichId<T> nSlot, bool bDeep = true )
{
return static_cast<const T*>(GetItem(rSet, sal_uInt16(nSlot), bDeep));
}
void SetFrame(const css::uno::Reference< css::frame::XFrame >& xFrame);
css::uno::Reference< css::frame::XFrame > GetFrame();
};
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
