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
|
/* -*- 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_UNOTOOLS_VIEWOPTIONS_HXX
#define INCLUDED_UNOTOOLS_VIEWOPTIONS_HXX
#include <unotools/unotoolsdllapi.h>
#include <com/sun/star/uno/Sequence.hxx>
#include <sal/types.h>
#include <rtl/ustring.hxx>
#include <unotools/options.hxx>
namespace com::sun::star::beans { struct NamedValue; }
namespace osl { class Mutex; }
class SvtViewOptionsBase_Impl;
/*-************************************************************************************************************
@descr Use these enum values to specify right list in configuration in which your view data are saved.
*//*-*************************************************************************************************************/
enum class EViewType
{
Dialog = 0,
TabDialog = 1,
TabPage = 2,
Window = 3
};
/*-************************************************************************************************************
@short collect information about view features
@descr We support different basetypes of views like dialogs, tab-dialogs, tab-pages and normal windows.
You must specify your basetype by using right enum value and must give us a valid name for your
subkey in registry! We support some fix features for some bastypes and user data as string for all!
see also configuration package "org.openoffice.Office.Views/..." for further information.
template of configuration:
DialogType
/WindowState [string]
/UserData [set of any scalar types]
TabDialogType
/WindowState [string]
/UserData [set of any scalar types]
/PageID [int]
TabPageType
/WindowState [string]
/UserData [set of any scalar types]
WindowType
/WindowState [string]
/UserData [set of any scalar types]
/Visible [boolean]
structure of configuration:
org.openoffice.Office.Views [package]
/Dialogs [set]
/Dialog_FileOpen [DialogType]
/Dialog_ImportGraphics [DialogType]
...
/Dialog_<YourName> [DialogType]
/TabDialogs [set]
/TabDialog_001 [TabDialogType]
/TabDialog_Blubber [TabDialogType]
...
/TabDialog_<YourName> [TabDialogType]
/TabPages [set]
/TabPage_XXX [TabPageType]
/TabPage_Date [TabPageType]
...
/TabPage_<YourName> [TabPageType]
/Windows [set]
/Window_User [WindowType]
/Window_Options [WindowType]
...
/Window_<YourName> [WindowType]
@devstatus ready to use
*//*-*************************************************************************************************************/
class SAL_WARN_UNUSED UNOTOOLS_DLLPUBLIC SvtViewOptions final : public utl::detail::Options
{
// public methods
public:
// constructor / destructor
/*-****************************************************************************************************
@short standard constructor and destructor
@descr This will de-/initialize an instance with default values.
You must give us the basic type of your view and a name which specify right entry
in dynamical configuration list. If entry not exist, we create a new one!
@seealso enum EViewType
@param "eType" specify type of your view and is used to use right data container!
@param "sViewName" specify the name of your view and is the key name in data list too.
@onerror An assertion is thrown in debug version. Otherwise we do nothing!
*//*-*****************************************************************************************************/
SvtViewOptions( EViewType eType ,
const OUString& sViewName );
virtual ~SvtViewOptions() override;
/*-****************************************************************************************************
@short support preload of these config item
@descr Sometimes we need preloading of these configuration data without real using of it.
*//*-*****************************************************************************************************/
static void AcquireOptions();
static void ReleaseOptions();
// interface
/*-****************************************************************************************************
@short use it to get information about existing entries in configuration
@descr The methods to set/get the position or size will create a new entry automatically if
it not already exist and work with default values!
If this a problem for you - you MUST call these method before and
you must make up your own mind about that.
@onerror No error should occur.
*//*-*****************************************************************************************************/
bool Exists() const;
/*-****************************************************************************************************
@short use it to delete an entry of dynamic view set
@descr You can use this method to delete an existing node in configuration.
But if you call a Set- or Get- method again on this instance
the item is created again! If you do nothing after this call
your view will die relay in configuration...
@seealso method Exist()
*//*-*****************************************************************************************************/
void Delete();
/*-****************************************************************************************************
@short use it to set/get the window state of your view
@descr These value describe position/size and some other states of a window.
Use it with right vcl methods directly. Normally it's not necessary to
parse given string!
@seealso vcl methods
*//*-*****************************************************************************************************/
OUString GetWindowState( ) const;
void SetWindowState( const OUString& sState );
/*-****************************************************************************************************
@short use it to set/get the page number which was the last active one
@descr It's only supported for: - tab-dialogs
If you call it for other ones you will get an assertion in debug version.
In a product version we do nothing!
@onerror An assertion is thrown in debug version. Otherwise we do nothing!
*//*-*****************************************************************************************************/
OString GetPageID() const;
void SetPageID(const OString& rID);
/*-****************************************************************************************************
@short use it to set/get the visual state of a window
@descr It's only supported for: - windows
If you call it for other ones you will get an assertion in debug version.
In a product version we do nothing!
@onerror An assertion is thrown in debug version. Otherwise we do nothing!
*//*-*****************************************************************************************************/
bool IsVisible ( ) const;
void SetVisible( bool bState );
/** Return true if the "Visible" property actually has a non-nil value
(IsVisible will somewhat arbitrarily return false if the property is
nil.)
*/
bool HasVisible() const;
/*-****************************************************************************************************
@short use it to set/get the extended user data (consisting of a set of named scalar values)
@descr It's supported for ALL types!
Every view can handle its own user defined data set.
@onerror In the non-product version, an assertion is made. In a product version, errors are silently ignored.
*//*-*****************************************************************************************************/
css::uno::Sequence< css::beans::NamedValue > GetUserData( ) const;
void SetUserData( const css::uno::Sequence< css::beans::NamedValue >& lData );
/*-****************************************************************************************************
@short use it to set/get ONE special user data item directly
@descr Normally you can work on full user data list by using "Set/GetUserData()".
With this function you have an access on special list entries directly without any
@onerror In the non-product version, an assertion is made. In a product version, errors are silently ignored.
*//*-*****************************************************************************************************/
css::uno::Any GetUserItem( const OUString& sName ) const;
void SetUserItem( const OUString& sName ,
const css::uno::Any& aValue );
// private methods
private:
/*-****************************************************************************************************
@short return a reference to a static mutex
@descr These class is threadsafe.
We create a static mutex only for one time and use it to protect our refcount and container
member!
@return A reference to a static mutex member.
*//*-*****************************************************************************************************/
UNOTOOLS_DLLPRIVATE static ::osl::Mutex& GetOwnStaticMutex();
// private member
private:
/// specify which list of views in configuration is used! This can't be a static value!!!
/// ... because we need this value to work with right static data container.
EViewType m_eViewType;
OUString m_sViewName;
/*Attention
Don't initialize these static members in these headers!
a) Double defined symbols will be detected ...
b) and unresolved externals exist at linking time.
Do it in your source only.
*/
static SvtViewOptionsBase_Impl* m_pDataContainer_Dialogs; /// hold data for all dialogs
static sal_Int32 m_nRefCount_Dialogs;
static SvtViewOptionsBase_Impl* m_pDataContainer_TabDialogs; /// hold data for all tab-dialogs
static sal_Int32 m_nRefCount_TabDialogs;
static SvtViewOptionsBase_Impl* m_pDataContainer_TabPages; /// hold data for all tab-pages
static sal_Int32 m_nRefCount_TabPages;
static SvtViewOptionsBase_Impl* m_pDataContainer_Windows; /// hold data for all windows
static sal_Int32 m_nRefCount_Windows;
}; // class SvtViewOptions
#endif // INCLUDED_UNOTOOLS_VIEWOPTIONS_HXX
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
