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
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
|
/*************************************************************************
*
* 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 __FRAMEWORK_CLASSES_ADDONSOPTIONS_HXX_
#define __FRAMEWORK_CLASSES_ADDONSOPTIONS_HXX_
//_________________________________________________________________________________________________________________
// includes
//_________________________________________________________________________________________________________________
#include <sal/types.h>
#include <osl/mutex.hxx>
#include <vcl/image.hxx>
#include <vcl/bitmap.hxx>
#include <vcl/svapp.hxx>
#include <com/sun/star/uno/Sequence.h>
#include <com/sun/star/beans/PropertyValue.hpp>
//_________________________________________________________________________________________________________________
// types, enums, ...
//_________________________________________________________________________________________________________________
/*-************************************************************************************************************//**
@descr The method GetAddonsMenu() returns a list of property values.
Use follow defines to seperate values by names.
*//*-*************************************************************************************************************/
#define ADDONSMENUITEM_STRING_URL "URL"
#define ADDONSMENUITEM_STRING_TITLE "Title"
#define ADDONSMENUITEM_STRING_TARGET "Target"
#define ADDONSMENUITEM_STRING_IMAGEIDENTIFIER "ImageIdentifier"
#define ADDONSMENUITEM_STRING_CONTEXT "Context"
#define ADDONSMENUITEM_STRING_SUBMENU "Submenu"
#define ADDONSMENUITEM_STRING_CONTROLTYPE "ControlType"
#define ADDONSMENUITEM_STRING_WIDTH "Width"
#define ADDONSMENUITEM_URL_LEN 3
#define ADDONSMENUITEM_TITLE_LEN 5
#define ADDONSMENUITEM_TARGET_LEN 6
#define ADDONSMENUITEM_SUBMENU_LEN 7
#define ADDONSMENUITEM_CONTEXT_LEN 7
#define ADDONSMENUITEM_IMAGEIDENTIFIER_LEN 15
#define ADDONSMENUITEM_PROPERTYNAME_URL ::rtl::OUString(RTL_CONSTASCII_USTRINGPARAM(ADDONSMENUITEM_STRING_URL ))
#define ADDONSMENUITEM_PROPERTYNAME_TITLE ::rtl::OUString(RTL_CONSTASCII_USTRINGPARAM(ADDONSMENUITEM_STRING_TITLE ))
#define ADDONSMENUITEM_PROPERTYNAME_TARGET ::rtl::OUString(RTL_CONSTASCII_USTRINGPARAM(ADDONSMENUITEM_STRING_TARGET ))
#define ADDONSMENUITEM_PROPERTYNAME_IMAGEIDENTIFIER ::rtl::OUString(RTL_CONSTASCII_USTRINGPARAM(ADDONSMENUITEM_STRING_IMAGEIDENTIFIER ))
#define ADDONSMENUITEM_PROPERTYNAME_CONTEXT ::rtl::OUString(RTL_CONSTASCII_USTRINGPARAM(ADDONSMENUITEM_STRING_CONTEXT ))
#define ADDONSMENUITEM_PROPERTYNAME_SUBMENU ::rtl::OUString(RTL_CONSTASCII_USTRINGPARAM(ADDONSMENUITEM_STRING_SUBMENU ))
#define ADDONSMENUITEM_PROPERTYNAME_CONTROLTYPE ::rtl::OUString(RTL_CONSTASCII_USTRINGPARAM(ADDONSMENUITEM_STRING_CONTROLTYPE ))
#define ADDONSMENUITEM_PROPERTYNAME_WIDTH ::rtl::OUString(RTL_CONSTASCII_USTRINGPARAM(ADDONSMENUITEM_STRING_WIDTH ))
#define ADDONSPOPUPMENU_URL_PREFIX_STR "private:menu/Addon"
#define ADDONSPOPUPMENU_URL_PREFIX ::rtl::OUString(RTL_CONSTASCII_USTRINGPARAM( ADDONSPOPUPMENU_URL_PREFIX_STR ))
namespace framework
{
typedef ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Sequence< ::com::sun::star::beans::PropertyValue > > MergeMenuDefinition;
struct MergeMenuInstruction
{
::rtl::OUString aMergePoint;
::rtl::OUString aMergeCommand;
::rtl::OUString aMergeCommandParameter;
::rtl::OUString aMergeFallback;
::rtl::OUString aMergeContext;
::com::sun::star::uno::Sequence< ::com::sun::star::uno::Sequence< ::com::sun::star::beans::PropertyValue > > aMergeMenu;
};
typedef ::std::vector< MergeMenuInstruction > MergeMenuInstructionContainer;
struct MergeToolbarInstruction
{
::rtl::OUString aMergeToolbar;
::rtl::OUString aMergePoint;
::rtl::OUString aMergeCommand;
::rtl::OUString aMergeCommandParameter;
::rtl::OUString aMergeFallback;
::rtl::OUString aMergeContext;
::com::sun::star::uno::Sequence< ::com::sun::star::uno::Sequence< ::com::sun::star::beans::PropertyValue > > aMergeToolbarItems;
};
typedef ::std::vector< MergeToolbarInstruction > MergeToolbarInstructionContainer;
//_________________________________________________________________________________________________________________
// 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 AddonsOptions_Impl;
//_________________________________________________________________________________________________________________
// declarations
//_________________________________________________________________________________________________________________
/*-************************************************************************************************************//**
@short collect informations about menu features
@descr -
@implements -
@base -
@devstatus ready to use
*//*-*************************************************************************************************************/
class AddonsOptions
{
//-------------------------------------------------------------------------------------------------------------
// public methods
//-------------------------------------------------------------------------------------------------------------
public:
//---------------------------------------------------------------------------------------------------------
// 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 -
*//*-*****************************************************************************************************/
AddonsOptions();
~AddonsOptions();
//---------------------------------------------------------------------------------------------------------
// interface
//---------------------------------------------------------------------------------------------------------
/*-****************************************************************************************************//**
@short clears completely the addons menu
@descr Call this methods to clear the addons menu
To fill it again use AppendItem().
@seealso -
@param "eMenu" select right menu to clear.
@return -
@onerror -
*//*-*****************************************************************************************************/
void Clear();
/*-****************************************************************************************************//**
@short returns if an addons menu is available
@descr Call to retrieve if a addons menu is available
@return sal_True if there is a menu otherwise sal_False
*//*-*****************************************************************************************************/
sal_Bool HasAddonsMenu() const;
/*-****************************************************************************************************//**
@short returns if an addons help menu is available
@descr Call to retrieve if a addons menu is available
@return sal_True if there is a menu otherwise sal_False
*//*-*****************************************************************************************************/
sal_Bool HasAddonsHelpMenu() const;
/*-****************************************************************************************************//**
@short returns number of addons toolbars
@descr Call to retrieve the number of addons toolbars
@return number of addons toolbars
*//*-*****************************************************************************************************/
sal_Int32 GetAddonsToolBarCount() const ;
/*-****************************************************************************************************//**
@short returns the complete addons menu
@descr Call it to get all entries of the addon menu.
We return a list of all nodes with his names and properties.
@seealso -
@return A list of menu items is returned.
@onerror We return an empty list.
*//*-*****************************************************************************************************/
const ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Sequence< ::com::sun::star::beans::PropertyValue > >& GetAddonsMenu() const;
/*-****************************************************************************************************//**
@short Gets the menu bar part of all addon components registered
@descr -
@seealso -
@return A complete
@onerror We return sal_False
*//*-*****************************************************************************************************/
const ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Sequence< ::com::sun::star::beans::PropertyValue > >& GetAddonsMenuBarPart() const;
/*-****************************************************************************************************//**
@short Gets a toolbar part of an single addon
@descr -
@seealso -
@return A complete
@onerror We return sal_False
*//*-*****************************************************************************************************/
const ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Sequence< ::com::sun::star::beans::PropertyValue > >& GetAddonsToolBarPart( sal_uInt32 nIndex ) const;
/*-****************************************************************************************************//**
@short Gets a unique toolbar resource name of an single addon
@descr -
@seealso -
@return A complete
@onerror We return sal_False
*//*-*****************************************************************************************************/
const ::rtl::OUString GetAddonsToolbarResourceName( sal_uInt32 nIndex ) const;
/*-****************************************************************************************************//**
@short Retrieves all available merge instructions for the Office menu bar
@descr -
@seealso -
@return The filled MergeMenuDefinitionContaier
@onerror We return sal_False
*//*-*****************************************************************************************************/
const MergeMenuInstructionContainer& GetMergeMenuInstructions() const;
/*-****************************************************************************************************//**
@short Retrieves all available merge instructions for a single toolbar
@descr -
@seealso -
@return The filled
@onerror We return sal_False
*//*-*****************************************************************************************************/
bool GetMergeToolbarInstructions( const ::rtl::OUString& rToolbarName, MergeToolbarInstructionContainer& rToolbar ) const;
/*-****************************************************************************************************//**
@short Gets the Add-On help menu part of all addon components registered
@descr -
@seealso -
@return A complete
@onerror We return sal_False
*//*-*****************************************************************************************************/
const ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Sequence< ::com::sun::star::beans::PropertyValue > >& GetAddonsHelpMenu() const;
/*-****************************************************************************************************//**
@short Retrieve an image for a command URL which is defined inside the addon menu configuration
@descr Call it to retrieve an image for a command URL which is defined inside the addon menu configuration
@seealso -
@return An image which was defined in the configuration for the menu item. The image can be empty
no bitmap was defined for the request image properties.
@onerror An empty image
*//*-*****************************************************************************************************/
Image GetImageFromURL( const rtl::OUString& aURL, sal_Bool bBig, sal_Bool bHiContrast, sal_Bool bNoScale ) const;
Image GetImageFromURL( const rtl::OUString& aURL, sal_Bool bBig, sal_Bool bHiContrast ) const;
//-------------------------------------------------------------------------------------------------------------
// private methods
//-------------------------------------------------------------------------------------------------------------
/*-****************************************************************************************************//**
@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 -
*//*-*****************************************************************************************************/
static ::osl::Mutex& GetOwnStaticMutex();
/*-****************************************************************************************************//**
@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 -
*//*-*****************************************************************************************************/
DECL_STATIC_LINK( AddonsOptions, Notify, void* );
//-------------------------------------------------------------------------------------------------------------
// 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 AddonsOptions_Impl* m_pDataContainer ; /// impl. data container as dynamic pointer for smaller memory requirements!
static sal_Int32 m_nRefCount ; /// internal ref count mechanism
}; // class SvtMenuOptions
}
#endif // #ifndef __FRAMEWORK_CLASSES_ADDONSOPTIONS_HXX_
|
