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
|
/* -*- 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_COMPATIBILITY_HXX
#define INCLUDED_UNOTOOLS_COMPATIBILITY_HXX
#include <sal/types.h>
#include <osl/mutex.hxx>
#include <com/sun/star/uno/Sequence.h>
#include <com/sun/star/beans/PropertyValue.hpp>
#include <unotools/options.hxx>
#include <unotools/unotoolsdllapi.h>
#include <rtl/ustring.hxx>
#include <memory>
/*-************************************************************************************************************
@descr Struct to hold information about one compatibility entry
*//*-*************************************************************************************************************/
class UNOTOOLS_DLLPUBLIC SvtCompatibilityEntry
{
public:
/*-************************************************************************************************************
@descr The method SvtCompatibilityOptions::GetList() returns a list of property values.
Use follow enum class to separate values by names.
Sync it with sPropertyName in SvtCompatibilityEntry::getName()
*//*-*************************************************************************************************************/
enum class Index
{
/* Should be in the start. Do not remove it. */
Name,
Module,
/* Editable list of compatibility options. */
UsePrtMetrics,
AddSpacing,
AddSpacingAtPages,
UseOurTabStops,
NoExtLeading,
UseLineSpacing,
AddTableSpacing,
UseObjectPositioning,
UseOurTextWrapping,
ConsiderWrappingStyle,
ExpandWordSpace,
ProtectForm,
MsWordTrailingBlanks,
SubtractFlysAnchoredAtFlys,
EmptyDbFieldHidesPara,
/* Should be at the end. Do not remove it. */
INVALID
};
SvtCompatibilityEntry();
static OUString getName( const Index rIdx );
static OUString getUserEntryName()
{
return OUString( "_user" );
}
static OUString getDefaultEntryName()
{
return OUString( "_default" );
}
static Index getIndex( const OUString& rName )
{
for ( int i = static_cast<int>(Index::Name); i < static_cast<int>(Index::INVALID); ++i )
if ( getName( Index(i) ) == rName )
return Index(i);
/* SvtCompatibilityEntry::getIndex() Undeclared compatibility property name */
assert(false);
return Index::INVALID;
}
static size_t getElementCount()
{
return static_cast<size_t>(Index::INVALID);
}
css::uno::Any getValue( const Index rIdx ) const
{
if ( static_cast<size_t>(rIdx) < getElementCount() )
{
return m_aPropertyValue[ static_cast<int>(rIdx) ];
} else
{
/* Wrong index. */
assert( false );
return css::uno::Any();
}
}
template<typename T>
T getValue( const Index rIdx ) const
{
T aValue = T();
if ( static_cast<size_t>(rIdx) < getElementCount() )
{
m_aPropertyValue[ static_cast<int>(rIdx) ] >>= aValue;
} else
{
/* Wrong index. */
assert( false );
}
return aValue;
}
void setValue( const Index rIdx, css::uno::Any const & rValue )
{
if ( static_cast<size_t>(rIdx) < getElementCount() )
{
m_aPropertyValue[ static_cast<int>(rIdx) ] = rValue;
} else
{
/* Wrong index. */
assert( false );
}
}
template<typename T>
void setValue( const Index rIdx, T rValue )
{
if ( static_cast<size_t>(rIdx) < getElementCount() )
{
m_aPropertyValue[ static_cast<int>(rIdx) ] = css::uno::Any(rValue);
} else
{
/* Wrong index. */
assert( false );
}
}
bool isDefaultEntry() const
{
return m_bDefaultEntry;
}
void setDefaultEntry( bool rValue )
{
m_bDefaultEntry = rValue;
}
private:
std::vector<css::uno::Any> m_aPropertyValue;
bool m_bDefaultEntry;
};
/*-************************************************************************************************************
@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 necessary. The class which use these mechanism
is faster and smaller then a complete implementation!
*//*-*************************************************************************************************************/
class SvtCompatibilityOptions_Impl;
/*-************************************************************************************************************
@short collect information about dynamic menus
@descr Make it possible to configure dynamic menu structures of menus like "new" or "wizard".
@devstatus ready to use
*//*-*************************************************************************************************************/
class UNOTOOLS_DLLPUBLIC SvtCompatibilityOptions: public utl::detail::Options
{
public:
SvtCompatibilityOptions();
virtual ~SvtCompatibilityOptions() override;
/*-****************************************************************************************************
@short append a new item
@descr
@seealso method Clear()
@param "aItem" SvtCompatibilityEntry
*//*-*****************************************************************************************************/
void AppendItem( const SvtCompatibilityEntry& aItem );
/*-****************************************************************************************************
@short clear complete specified list
@descr Call this methods to clear the whole list.
*//*-*****************************************************************************************************/
void Clear();
void SetDefault( SvtCompatibilityEntry::Index rIdx, bool rValue );
bool GetDefault( SvtCompatibilityEntry::Index rIdx ) const;
/*-****************************************************************************************************
@short return complete specified list
@descr Call it to get all entries of compatibility options.
We return a list of all nodes with its names and properties.
@return A list of compatibility options is returned.
@onerror We return an empty list.
*//*-*****************************************************************************************************/
css::uno::Sequence< css::uno::Sequence< css::beans::PropertyValue > > GetList() const;
private:
std::shared_ptr<SvtCompatibilityOptions_Impl> m_pImpl;
/*-****************************************************************************************************
@short return a reference to a static mutex
@descr These class is partially threadsafe (for de-/initialization only).
All access methods aren't safe!
We create a static mutex only for one ime and use at different times.
@return A reference to a static mutex member.
*//*-*****************************************************************************************************/
UNOTOOLS_DLLPRIVATE static osl::Mutex& GetOwnStaticMutex();
};
#endif // INCLUDED_UNOTOOLS_COMPATIBILITY_HXX
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
