Line data Source code
1 : /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2 : /*
3 : * This file is part of the LibreOffice project.
4 : *
5 : * This Source Code Form is subject to the terms of the Mozilla Public
6 : * License, v. 2.0. If a copy of the MPL was not distributed with this
7 : * file, You can obtain one at http://mozilla.org/MPL/2.0/.
8 : *
9 : * This file incorporates work covered by the following license notice:
10 : *
11 : * Licensed to the Apache Software Foundation (ASF) under one or more
12 : * contributor license agreements. See the NOTICE file distributed
13 : * with this work for additional information regarding copyright
14 : * ownership. The ASF licenses this file to you under the Apache
15 : * License, Version 2.0 (the "License"); you may not use this file
16 : * except in compliance with the License. You may obtain a copy of
17 : * the License at http://www.apache.org/licenses/LICENSE-2.0 .
18 : */
19 :
20 :
21 : #include "svx/DescriptionGenerator.hxx"
22 : #include <com/sun/star/beans/PropertyState.hpp>
23 : #include <com/sun/star/beans/XPropertySet.hpp>
24 : #include <com/sun/star/beans/XPropertyState.hpp>
25 : #include <com/sun/star/container/XChild.hpp>
26 : #include <com/sun/star/container/XNameContainer.hpp>
27 : #include <com/sun/star/container/XNameAccess.hpp>
28 : #include <com/sun/star/container/XNamed.hpp>
29 : #include <com/sun/star/drawing/FillStyle.hpp>
30 : #include <com/sun/star/drawing/XShapes.hpp>
31 : #include <com/sun/star/drawing/XShapeDescriptor.hpp>
32 : #include <com/sun/star/lang/IndexOutOfBoundsException.hpp>
33 : #include <com/sun/star/lang/XMultiServiceFactory.hpp>
34 : #include <com/sun/star/style/XStyle.hpp>
35 : #include <comphelper/processfactory.hxx>
36 : #include <osl/mutex.hxx>
37 : #include <vcl/svapp.hxx>
38 :
39 : #include <com/sun/star/uno/Exception.hpp>
40 :
41 : // Includes for string resources.
42 : #include "accessibility.hrc"
43 : #include "svx/svdstr.hrc"
44 : #include <svx/dialmgr.hxx>
45 : #include <tools/string.hxx>
46 :
47 : #include <svx/xdef.hxx>
48 : #include "svx/unoapi.hxx"
49 : #include "lookupcolorname.hxx"
50 :
51 : using namespace ::rtl;
52 : using namespace ::com::sun::star;
53 :
54 :
55 : namespace accessibility {
56 :
57 :
58 0 : DescriptionGenerator::DescriptionGenerator (
59 : const uno::Reference<drawing::XShape>& xShape)
60 : : mxShape (xShape),
61 : mxSet (mxShape, uno::UNO_QUERY),
62 0 : mbIsFirstProperty (true)
63 : {
64 0 : }
65 :
66 :
67 :
68 :
69 0 : DescriptionGenerator::~DescriptionGenerator (void)
70 : {
71 0 : }
72 :
73 :
74 :
75 :
76 0 : void DescriptionGenerator::Initialize (sal_Int32 nResourceId)
77 : {
78 : // Get the string from the resource for the specified id.
79 0 : OUString sPrefix;
80 : {
81 0 : SolarMutexGuard aGuard;
82 0 : sPrefix = OUString (SVX_RESSTR (nResourceId));
83 : }
84 :
85 : // Forward the call with the resulting string.
86 0 : Initialize (sPrefix);
87 0 : }
88 :
89 :
90 :
91 :
92 0 : void DescriptionGenerator::Initialize (::rtl::OUString sPrefix)
93 : {
94 0 : msDescription = sPrefix;
95 0 : if (mxSet.is())
96 : {
97 : {
98 0 : SolarMutexGuard aGuard;
99 :
100 0 : msDescription.append (sal_Unicode (' '));
101 0 : msDescription.append (OUString (SVX_RESSTR(RID_SVXSTR_A11Y_WITH)));
102 0 : msDescription.append (sal_Unicode (' '));
103 :
104 0 : msDescription.append (OUString (SVX_RESSTR (RID_SVXSTR_A11Y_STYLE)));
105 0 : msDescription.append (sal_Unicode ('='));
106 : }
107 :
108 : try
109 : {
110 0 : if (mxSet.is())
111 : {
112 0 : uno::Any aValue = mxSet->getPropertyValue (OUString(RTL_CONSTASCII_USTRINGPARAM("Style")) );
113 0 : uno::Reference<container::XNamed> xStyle (aValue, uno::UNO_QUERY);
114 0 : if (xStyle.is())
115 0 : msDescription.append (xStyle->getName());
116 : }
117 : else
118 : msDescription.append (
119 0 : OUString(RTL_CONSTASCII_USTRINGPARAM("<no style>")) );
120 : }
121 0 : catch (const ::com::sun::star::beans::UnknownPropertyException &)
122 : {
123 : msDescription.append (
124 0 : OUString(RTL_CONSTASCII_USTRINGPARAM("<unknown>")) );
125 : }
126 : }
127 0 : }
128 :
129 :
130 :
131 :
132 0 : ::rtl::OUString DescriptionGenerator::operator() (void)
133 : {
134 0 : msDescription.append (sal_Unicode ('.'));
135 0 : return msDescription.makeStringAndClear();
136 : }
137 :
138 :
139 :
140 :
141 0 : void DescriptionGenerator::AddProperty (
142 : const OUString& sPropertyName,
143 : PropertyType aType,
144 : const sal_Int32 nLocalizedNameId,
145 : long nWhichId)
146 : {
147 0 : OUString sLocalizedName;
148 : {
149 0 : SolarMutexGuard aGuard;
150 0 : sLocalizedName = SVX_RESSTR (nLocalizedNameId);
151 : }
152 0 : AddProperty (sPropertyName, aType, sLocalizedName, nWhichId);
153 0 : }
154 :
155 :
156 :
157 :
158 0 : void DescriptionGenerator::AddProperty (const OUString& sPropertyName,
159 : PropertyType aType, const OUString& sLocalizedName, long nWhichId)
160 : {
161 0 : uno::Reference<beans::XPropertyState> xState (mxShape, uno::UNO_QUERY);
162 0 : if (xState.is()
163 0 : && xState->getPropertyState(sPropertyName)!=beans::PropertyState_DEFAULT_VALUE)
164 0 : if (mxSet.is())
165 : {
166 : // Append a seperator from previous Properties.
167 0 : if ( ! mbIsFirstProperty)
168 0 : msDescription.append (sal_Unicode (','));
169 : else
170 : {
171 0 : SolarMutexGuard aGuard;
172 :
173 0 : msDescription.append (sal_Unicode (' '));
174 0 : msDescription.append (OUString (SVX_RESSTR(RID_SVXSTR_A11Y_AND)));
175 0 : msDescription.append (sal_Unicode (' '));
176 0 : mbIsFirstProperty = false;
177 : }
178 :
179 : // Delegate to type specific property handling.
180 0 : switch (aType)
181 : {
182 : case COLOR:
183 0 : AddColor (sPropertyName, sLocalizedName);
184 0 : break;
185 : case INTEGER:
186 0 : AddInteger (sPropertyName, sLocalizedName);
187 0 : break;
188 : case STRING:
189 0 : AddString (sPropertyName, sLocalizedName, nWhichId);
190 0 : break;
191 : case FILL_STYLE:
192 0 : AddFillStyle (sPropertyName, sLocalizedName);
193 0 : break;
194 : }
195 0 : }
196 0 : }
197 :
198 :
199 :
200 :
201 0 : void DescriptionGenerator::AppendString (const ::rtl::OUString& sString)
202 : {
203 0 : msDescription.append (sString);
204 0 : }
205 :
206 :
207 :
208 :
209 0 : void DescriptionGenerator::AddLineProperties (void)
210 : {
211 : AddProperty (OUString(RTL_CONSTASCII_USTRINGPARAM("LineColor")),
212 : DescriptionGenerator::COLOR,
213 0 : SIP_XA_LINECOLOR);
214 : AddProperty (OUString(RTL_CONSTASCII_USTRINGPARAM("LineDashName")),
215 : DescriptionGenerator::STRING,
216 : SIP_XA_LINEDASH,
217 0 : XATTR_LINEDASH);
218 : AddProperty (OUString(RTL_CONSTASCII_USTRINGPARAM("LineWidth")),
219 : DescriptionGenerator::INTEGER,
220 0 : SIP_XA_LINEWIDTH);
221 0 : }
222 :
223 :
224 :
225 :
226 : /** The fill style is described by the property "FillStyle". Depending on
227 : its value a hatch-, gradient-, or bitmap name is appended.
228 : */
229 0 : void DescriptionGenerator::AddFillProperties (void)
230 : {
231 : AddProperty (OUString(RTL_CONSTASCII_USTRINGPARAM("FillStyle")),
232 : DescriptionGenerator::FILL_STYLE,
233 0 : SIP_XA_FILLSTYLE);
234 0 : }
235 :
236 :
237 :
238 :
239 0 : void DescriptionGenerator::Add3DProperties (void)
240 : {
241 : AddProperty (OUString(RTL_CONSTASCII_USTRINGPARAM("D3DMaterialColor")),
242 : DescriptionGenerator::COLOR,
243 0 : RID_SVXSTR_A11Y_3D_MATERIAL_COLOR);
244 0 : AddLineProperties ();
245 0 : AddFillProperties ();
246 0 : }
247 :
248 :
249 :
250 :
251 0 : void DescriptionGenerator::AddTextProperties (void)
252 : {
253 : AddProperty (OUString(RTL_CONSTASCII_USTRINGPARAM("CharColor")),
254 0 : DescriptionGenerator::COLOR);
255 0 : AddFillProperties ();
256 0 : }
257 :
258 :
259 :
260 :
261 : /** Search for the given color in the global color table. If found append
262 : its name to the description. Otherwise append its RGB tuple.
263 : */
264 0 : void DescriptionGenerator::AddColor (const OUString& sPropertyName,
265 : const OUString& sLocalizedName)
266 : {
267 0 : msDescription.append (sLocalizedName);
268 0 : msDescription.append (sal_Unicode('='));
269 :
270 : try
271 : {
272 :
273 0 : long nValue(0);
274 0 : if (mxSet.is())
275 : {
276 0 : uno::Any aValue = mxSet->getPropertyValue (sPropertyName);
277 0 : aValue >>= nValue;
278 : }
279 :
280 0 : msDescription.append (lookUpColorName(nValue));
281 : }
282 0 : catch (const ::com::sun::star::beans::UnknownPropertyException &)
283 : {
284 : msDescription.append (
285 0 : OUString(RTL_CONSTASCII_USTRINGPARAM("<unknown>")) );
286 : }
287 0 : }
288 :
289 :
290 :
291 :
292 0 : void DescriptionGenerator::AddInteger (const OUString& sPropertyName,
293 : const OUString& sLocalizedName)
294 : {
295 0 : msDescription.append (sLocalizedName);
296 0 : msDescription.append (sal_Unicode('='));
297 :
298 : try
299 : {
300 0 : if (mxSet.is())
301 : {
302 0 : uno::Any aValue = mxSet->getPropertyValue (sPropertyName);
303 0 : long nValue = 0;
304 0 : aValue >>= nValue;
305 0 : msDescription.append (nValue);
306 : }
307 : }
308 0 : catch (const ::com::sun::star::beans::UnknownPropertyException &)
309 : {
310 : msDescription.append (
311 0 : OUString(RTL_CONSTASCII_USTRINGPARAM("<unknown>")) );
312 : }
313 0 : }
314 :
315 :
316 :
317 :
318 0 : void DescriptionGenerator::AddString (const OUString& sPropertyName,
319 : const OUString& sLocalizedName, long nWhichId)
320 : {
321 0 : msDescription.append (sLocalizedName);
322 0 : msDescription.append (sal_Unicode('='));
323 :
324 : try
325 : {
326 0 : if (mxSet.is())
327 : {
328 0 : uno::Any aValue = mxSet->getPropertyValue (sPropertyName);
329 0 : OUString sValue;
330 0 : aValue >>= sValue;
331 :
332 0 : if (nWhichId >= 0)
333 : {
334 0 : SolarMutexGuard aGuard;
335 : OUString sLocalizedValue =
336 0 : SvxUnogetInternalNameForItem(sal::static_int_cast<sal_Int16>(nWhichId),
337 0 : sValue);
338 0 : msDescription.append (sLocalizedValue);
339 : }
340 : else
341 0 : msDescription.append (sValue);
342 : }
343 : }
344 0 : catch (const ::com::sun::star::beans::UnknownPropertyException &)
345 : {
346 : msDescription.append (
347 0 : OUString(RTL_CONSTASCII_USTRINGPARAM("<unknown>")) );
348 : }
349 0 : }
350 :
351 :
352 :
353 :
354 0 : void DescriptionGenerator::AddFillStyle (const OUString& sPropertyName,
355 : const OUString& sLocalizedName)
356 : {
357 0 : msDescription.append (sLocalizedName);
358 0 : msDescription.append (sal_Unicode('='));
359 :
360 : try
361 : {
362 0 : if (mxSet.is())
363 : {
364 0 : uno::Any aValue = mxSet->getPropertyValue (sPropertyName);
365 : drawing::FillStyle aFillStyle;
366 0 : aValue >>= aFillStyle;
367 :
368 : // Get the fill style name from the resource.
369 0 : OUString sFillStyleName;
370 : {
371 0 : SolarMutexGuard aGuard;
372 0 : switch (aFillStyle)
373 : {
374 : case drawing::FillStyle_NONE:
375 0 : sFillStyleName = SVX_RESSTR(RID_SVXSTR_A11Y_FILLSTYLE_NONE);
376 0 : break;
377 : case drawing::FillStyle_SOLID:
378 0 : sFillStyleName = SVX_RESSTR(RID_SVXSTR_A11Y_FILLSTYLE_SOLID);
379 0 : break;
380 : case drawing::FillStyle_GRADIENT:
381 0 : sFillStyleName = SVX_RESSTR(RID_SVXSTR_A11Y_FILLSTYLE_GRADIENT);
382 0 : break;
383 : case drawing::FillStyle_HATCH:
384 0 : sFillStyleName = SVX_RESSTR(RID_SVXSTR_A11Y_FILLSTYLE_HATCH);
385 0 : break;
386 : case drawing::FillStyle_BITMAP:
387 0 : sFillStyleName = SVX_RESSTR(RID_SVXSTR_A11Y_FILLSTYLE_BITMAP);
388 0 : break;
389 : case drawing::FillStyle_MAKE_FIXED_SIZE:
390 0 : break;
391 0 : }
392 : }
393 0 : msDescription.append (sFillStyleName);
394 :
395 : // Append the appropriate properties.
396 0 : switch (aFillStyle)
397 : {
398 : case drawing::FillStyle_NONE:
399 0 : break;
400 : case drawing::FillStyle_SOLID:
401 : AddProperty (OUString(RTL_CONSTASCII_USTRINGPARAM("FillColor")),
402 : COLOR,
403 0 : SIP_XA_FILLCOLOR);
404 0 : break;
405 : case drawing::FillStyle_GRADIENT:
406 : AddProperty (OUString(RTL_CONSTASCII_USTRINGPARAM("FillGradientName")),
407 : STRING,
408 : SIP_XA_FILLGRADIENT,
409 0 : XATTR_FILLGRADIENT);
410 0 : break;
411 : case drawing::FillStyle_HATCH:
412 : AddProperty (OUString(RTL_CONSTASCII_USTRINGPARAM("FillColor")),
413 : COLOR,
414 0 : SIP_XA_FILLCOLOR);
415 : AddProperty (OUString(RTL_CONSTASCII_USTRINGPARAM("FillHatchName")),
416 : STRING,
417 : SIP_XA_FILLHATCH,
418 0 : XATTR_FILLHATCH);
419 0 : break;
420 : case drawing::FillStyle_BITMAP:
421 : AddProperty (OUString(RTL_CONSTASCII_USTRINGPARAM("FillBitmapName")),
422 : STRING,
423 : SIP_XA_FILLBITMAP,
424 0 : XATTR_FILLBITMAP);
425 0 : break;
426 : case drawing::FillStyle_MAKE_FIXED_SIZE:
427 0 : break;
428 0 : }
429 : }
430 : }
431 0 : catch (const ::com::sun::star::beans::UnknownPropertyException &)
432 : {
433 : msDescription.append (
434 0 : OUString(RTL_CONSTASCII_USTRINGPARAM("<unknown>")) );
435 : }
436 0 : }
437 :
438 : } // end of namespace accessibility
439 :
440 : /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
