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
|
/*************************************************************************
*
* 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 INCLUDED_unotools_CMDOPTIONS_HXX
#define INCLUDED_unotools_CMDOPTIONS_HXX
//_________________________________________________________________________________________________________________
// includes
//_________________________________________________________________________________________________________________
#include "unotools/unotoolsdllapi.h"
#include <sal/types.h>
#include <osl/mutex.hxx>
#include <com/sun/star/uno/Sequence.h>
#include <com/sun/star/frame/XFrame.hpp>
#include <rtl/ustring.hxx>
#include <unotools/options.hxx>
//_________________________________________________________________________________________________________________
// types, enums, ...
//_________________________________________________________________________________________________________________
/*-************************************************************************************************************//**
@descr The method GetList() returns a list of property values.
Use follow defines to seperate values by names.
*//*-*************************************************************************************************************/
#define CMDOPTIONS_PROPERTYNAME_URL ::rtl::OUString(RTL_CONSTASCII_USTRINGPARAM( "CommandURL" ))
//_________________________________________________________________________________________________________________
// forward declarations
//_________________________________________________________________________________________________________________
/*-************************************************************************************************************//**
@short forward declaration to our private date container implementation
@descr We use these class as internal member to support small memory requirements.
You can create the container if it is neccessary. The class which use these mechanism
is faster and smaller then a complete implementation!
*//*-*************************************************************************************************************/
class SvtCommandOptions_Impl;
//_________________________________________________________________________________________________________________
// declarations
//_________________________________________________________________________________________________________________
/*-************************************************************************************************************//**
@short collect informations about dynamic menus
@descr Make it possible to configure dynamic menu structures of menus like "new" or "wizard".
@implements -
@base -
@devstatus ready to use
*//*-*************************************************************************************************************/
class UNOTOOLS_DLLPUBLIC SvtCommandOptions: public utl::detail::Options
{
friend class SvtCommandOptions_Impl;
//-------------------------------------------------------------------------------------------------------------
// public methods
//-------------------------------------------------------------------------------------------------------------
public:
enum CmdOption
{
CMDOPTION_DISABLED,
CMDOPTION_NONE
};
//---------------------------------------------------------------------------------------------------------
// constructor / destructor
//---------------------------------------------------------------------------------------------------------
/*-****************************************************************************************************//**
@short standard constructor and destructor
@descr This will initialize an instance with default values.
We implement these class with a refcount mechanism! Every instance of this class increase it
at create and decrease it at delete time - but all instances use the same data container!
He is implemented as a static member ...
@seealso member m_nRefCount
@seealso member m_pDataContainer
@param -
@return -
@onerror -
*//*-*****************************************************************************************************/
SvtCommandOptions();
virtual ~SvtCommandOptions();
//---------------------------------------------------------------------------------------------------------
// interface
//---------------------------------------------------------------------------------------------------------
/*-****************************************************************************************************//**
@short clear complete sepcified list
@descr Call this methods to clear the whole list.
To fill it again use AppendItem().
@seealso -
@param "eMenu" select right menu to clear.
@return -
@onerror -
*//*-*****************************************************************************************************/
void Clear( CmdOption eOption );
/*-****************************************************************************************************//**
@short return complete specified list
@descr Call it to get all entries of an dynamic menu.
We return a list of all nodes with his names and properties.
@seealso -
@param "eOption" select the list to retrieve.
@return A list of command strings is returned.
@onerror We return an empty list.
*//*-*****************************************************************************************************/
sal_Bool HasEntries( CmdOption eOption ) const;
/*-****************************************************************************************************//**
@short Lookup if a command URL is inside a given list
@descr Lookup if a command URL is inside a given lst
@seealso -
@param "eOption" select right command list
@param "aCommandURL" a command URL that is used for the look up
@return "sal_True" if the command is inside the list otherwise "sal_False"
@onerror -
*//*-*****************************************************************************************************/
sal_Bool Lookup( CmdOption eOption, const ::rtl::OUString& aCommandURL ) const;
/*-****************************************************************************************************//**
@short return complete specified list
@descr Call it to get all entries of an dynamic menu.
We return a list of all nodes with his names and properties.
@seealso -
@param "eOption" select the list to retrieve.
@return A list of command strings is returned.
@onerror We return an empty list.
*//*-*****************************************************************************************************/
::com::sun::star::uno::Sequence< ::rtl::OUString > GetList( CmdOption eOption ) const;
/*-****************************************************************************************************//**
@short adds a new command to specified options list
@descr You can add a command to specified options list!
@seealso method Clear()
@param "eOption" specifies the command list
@param "sURL" URL for dispatch
@return -
@onerror -
*//*-*****************************************************************************************************/
void AddCommand( CmdOption eOption, const ::rtl::OUString& sURL );
/*-****************************************************************************************************//**
@short register an office frame, which must update its dispatches if
the underlying configuration was changed.
@descr To avoid using of "dead" frame objects or implementing
deregistration mechanism too, we use weak references to
the given frames.
@param "xFrame" points to the frame, which wish to be
notified, if configuration was changed.
@return -
@onerror -
*//*-*****************************************************************************************************/
void EstablisFrameCallback(const ::com::sun::star::uno::Reference< ::com::sun::star::frame::XFrame >& xFrame);
//-------------------------------------------------------------------------------------------------------------
// private methods
//-------------------------------------------------------------------------------------------------------------
private:
/*-****************************************************************************************************//**
@short return a reference to a static mutex
@descr These class is partially threadsafe (for de-/initialization only).
All access methods are'nt safe!
We create a static mutex only for one ime and use at different times.
@seealso -
@param -
@return A reference to a static mutex member.
@onerror -
*//*-*****************************************************************************************************/
UNOTOOLS_DLLPRIVATE static ::osl::Mutex& GetOwnStaticMutex();
//-------------------------------------------------------------------------------------------------------------
// private member
//-------------------------------------------------------------------------------------------------------------
private:
/*Attention
Don't initialize these static member in these header!
a) Double dfined symbols will be detected ...
b) and unresolved externals exist at linking time.
Do it in your source only.
*/
static SvtCommandOptions_Impl* m_pDataContainer ; /// impl. data container as dynamic pointer for smaller memory requirements!
static sal_Int32 m_nRefCount ; /// internal ref count mechanism
}; // class SvtCmdOptions
#endif // #ifndef INCLUDED_unotools_CMDOPTIONS_HXX
|
