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
|
/*************************************************************************
*
* 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_SVTOOLS_MODULEOPTIONS_HXX
#define INCLUDED_SVTOOLS_MODULEOPTIONS_HXX
//_________________________________________________________________________________________________________________
// includes
//_________________________________________________________________________________________________________________
#include "unotools/unotoolsdllapi.h"
#include <salhelper/singletonref.hxx>
#include <com/sun/star/frame/XModel.hpp>
#include <com/sun/star/uno/Sequence.hxx>
#include <rtl/ustring.hxx>
#include <sal/types.h>
#include <osl/mutex.hxx>
#include <unotools/options.hxx>
//_________________________________________________________________________________________________________________
// const
//_________________________________________________________________________________________________________________
#define FEATUREFLAG_BASICIDE 0x00000020
#define FEATUREFLAG_MATH 0x00000100
#define FEATUREFLAG_CHART 0x00000200
#define FEATUREFLAG_CALC 0x00000800
#define FEATUREFLAG_DRAW 0x00001000
#define FEATUREFLAG_WRITER 0x00002000
#define FEATUREFLAG_IMPRESS 0x00008000
#define FEATUREFLAG_INSIGHT 0x00010000
//_________________________________________________________________________________________________________________
// 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 SvtModuleOptions_Impl;
//_________________________________________________________________________________________________________________
// declarations
//_________________________________________________________________________________________________________________
/*-************************************************************************************************************//**
@short collect informations about installation state of modules
@descr Use these class to get installation state of different office modules like writer, calc etc
Further you can ask for additional informations; e.g. name of standard template file, which
should be used by corresponding module; or short/long name of these module factory.
@implements -
@base -
@devstatus ready to use
@threadsafe yes
*//*-*************************************************************************************************************/
class UNOTOOLS_DLLPUBLIC SvtModuleOptions: public utl::detail::Options
{
//-------------------------------------------------------------------------------------------------------------
// public const declarations!
//-------------------------------------------------------------------------------------------------------------
public:
enum EModule
{
E_SWRITER = 0,
E_SCALC = 1,
E_SDRAW = 2,
E_SIMPRESS = 3,
E_SMATH = 4,
E_SCHART = 5,
E_SSTARTMODULE = 6,
E_SBASIC = 7,
E_SDATABASE = 8,
E_SWEB = 9,
E_SGLOBAL = 10
};
/*ATTENTION:
If you change these enum ... don't forget to change reading/writing and order of configuration values too!
See "SvtModuleOptions_Impl::impl_GetSetNames()" and his ctor for further informations.
*/
enum EFactory
{
E_UNKNOWN_FACTORY = -1,
E_WRITER = 0,
E_WRITERWEB = 1,
E_WRITERGLOBAL = 2,
E_CALC = 3,
E_DRAW = 4,
E_IMPRESS = 5,
E_MATH = 6,
E_CHART = 7,
E_STARTMODULE = 8,
E_DATABASE = 9,
E_BASIC = 10
};
//-------------------------------------------------------------------------------------------------------------
// public methods
//-------------------------------------------------------------------------------------------------------------
public:
//---------------------------------------------------------------------------------------------------------
// constructor / destructor
//---------------------------------------------------------------------------------------------------------
SvtModuleOptions();
virtual ~SvtModuleOptions();
//---------------------------------------------------------------------------------------------------------
// interface
//---------------------------------------------------------------------------------------------------------
sal_Bool IsModuleInstalled ( EModule eModule ) const;
::rtl::OUString GetModuleName ( EModule eModule ) const;
::rtl::OUString GetModuleName ( EFactory eFactory ) const;
::rtl::OUString GetFactoryName ( EFactory eFactory ) const;
::rtl::OUString GetFactoryShortName ( EFactory eFactory ) const;
::rtl::OUString GetFactoryStandardTemplate( EFactory eFactory ) const;
::rtl::OUString GetFactoryWindowAttributes( EFactory eFactory ) const;
::rtl::OUString GetFactoryEmptyDocumentURL( EFactory eFactory ) const;
::rtl::OUString GetFactoryDefaultFilter ( EFactory eFactory ) const;
sal_Bool IsDefaultFilterReadonly ( EFactory eFactory ) const;
sal_Int32 GetFactoryIcon ( EFactory eFactory ) const;
static sal_Bool ClassifyFactoryByName ( const ::rtl::OUString& sName ,
EFactory& eFactory );
void SetFactoryStandardTemplate( EFactory eFactory ,
const ::rtl::OUString& sTemplate );
void SetFactoryWindowAttributes( EFactory eFactory ,
const ::rtl::OUString& sAttributes);
void SetFactoryDefaultFilter ( EFactory eFactory ,
const ::rtl::OUString& sFilter );
//_______________________________________
/** @short return the corresponding application ID for the given
document service name.
*/
static EFactory ClassifyFactoryByServiceName(const ::rtl::OUString& sName);
//_______________________________________
/** @short return the corresponding application ID for the given
short name.
*/
static EFactory ClassifyFactoryByShortName(const ::rtl::OUString& sName);
//_______________________________________
/** @short return the corresponding application ID for the given properties.
@descr Because this search base on filters currently (till we have a better solution)
a result is not guaranteed everytimes. May a filter does not exists for the specified
content (but a FrameLoader which is not bound to any application!) ... or
the given properties describe a stream (and we make no deep detection inside here!).
@attention The module BASIC cant be detected here. Because it does not
has an own URL schema.
@param sURL
the complete URL!
@param lMediaDescriptor
additional informations
@return A suitable enum value. See EFactory above.
*/
static EFactory ClassifyFactoryByURL(const ::rtl::OUString& sURL ,
const ::com::sun::star::uno::Sequence< ::com::sun::star::beans::PropertyValue >& lMediaDescriptor);
//_______________________________________
/** @short return the corresponding application ID for the given properties.
@descr Here we try to use the list of supported service names of the given model
to find out the right application module.
@attention The module BASIC cant be detected here. Because it does not
support any model/ctrl/view paradigm.
@param xModel
the document model
@return A suitable enum value. See EFactory above.
*/
static EFactory ClassifyFactoryByModel(const ::com::sun::star::uno::Reference< ::com::sun::star::frame::XModel >& xModel);
::rtl::OUString GetDefaultModuleName();
//---------------------------------------------------------------------------------------------------------
// old interface ...
//---------------------------------------------------------------------------------------------------------
sal_Bool IsMath () const;
sal_Bool IsChart () const;
sal_Bool IsCalc () const;
sal_Bool IsDraw () const;
sal_Bool IsWriter () const;
sal_Bool IsImpress () const;
sal_Bool IsBasicIDE () const;
sal_Bool IsDataBase () const;
sal_uInt32 GetFeatures() const;
::com::sun::star::uno::Sequence < ::rtl::OUString > GetAllServiceNames();
//-------------------------------------------------------------------------------------------------------------
// private methods
//-------------------------------------------------------------------------------------------------------------
private:
UNOTOOLS_DLLPRIVATE static ::osl::Mutex& impl_GetOwnStaticMutex();
//-------------------------------------------------------------------------------------------------------------
// private member
//-------------------------------------------------------------------------------------------------------------
private:
/*Attention
Don't initialize these static member in these header!
a) Double defined symbols will be detected ...
b) and unresolved externals exist at linking time.
Do it in your source only.
*/
static SvtModuleOptions_Impl* m_pDataContainer ; /// impl. data container as dynamic pointer for smaller memory requirements!
static sal_Int32 m_nRefCount ; /// internal ref count mechanism
}; // class SvtModuleOptions
#endif // #ifndef INCLUDED_SVTOOLS_MODULEOPTIONS_HXX
|
