svx/source/accessibility/DescriptionGenerator.cxx

   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
  46 #include <svx/xdef.hxx>
  47 #include "svx/unoapi.hxx"
  48 #include "lookupcolorname.hxx"
  49
  50 using namespace ::com::sun::star;
  51
  52
  53 namespace accessibility {
  54
  55
  56 DescriptionGenerator::DescriptionGenerator (
  57     const uno::Reference<drawing::XShape>& xShape)
  58     : mxShape (xShape),
  59       mxSet (mxShape, uno::UNO_QUERY),
  60       mbIsFirstProperty (true)
  61 {
  62 }
  63
  64
  65
  66
  67 DescriptionGenerator::~DescriptionGenerator()
  68 {
  69 }
  70
  71
  72
  73
  74 void DescriptionGenerator::Initialize (sal_Int32 nResourceId)
  75 {
  76     // Get the string from the resource for the specified id.
  77     OUString sPrefix;
  78     {
  79         SolarMutexGuard aGuard;
  80         sPrefix = OUString (SVX_RESSTR (nResourceId));
  81     }
  82
  83     // Forward the call with the resulting string.
  84     Initialize (sPrefix);
  85 }
  86
  87
  88
  89
  90 void DescriptionGenerator::Initialize (const OUString& sPrefix)
  91 {
  92     msDescription = sPrefix;
  93     if (mxSet.is())
  94     {
  95         {
  96             SolarMutexGuard aGuard;
  97
  98             msDescription.append(' ');
  99             msDescription.append(OUString (SVX_RESSTR(RID_SVXSTR_A11Y_WITH)));
 100             msDescription.append(' ');
 101
 102             msDescription.append(OUString (SVX_RESSTR (RID_SVXSTR_A11Y_STYLE)));
 103             msDescription.append('=');
 104         }
 105
 106         try
 107         {
 108             if (mxSet.is())
 109             {
 110                 uno::Any aValue = mxSet->getPropertyValue ("Style");
 111                 uno::Reference<container::XNamed> xStyle (aValue, uno::UNO_QUERY);
 112                 if (xStyle.is())
 113                     msDescription.append (xStyle->getName());
 114             }
 115             else
 116                 msDescription.append ("<no style>");
 117         }
 118         catch (const ::com::sun::star::beans::UnknownPropertyException &)
 119         {
 120             msDescription.append ("<unknown>");
 121         }
 122     }
 123 }
 124
 125
 126
 127
 128 OUString DescriptionGenerator::operator() (void)
 129 {
 130     msDescription.append('.');
 131     return msDescription.makeStringAndClear();
 132 }
 133
 134
 135
 136
 137 void DescriptionGenerator::AddProperty (
 138     const OUString& sPropertyName,
 139     PropertyType aType,
 140     const sal_Int32 nLocalizedNameId,
 141     long nWhichId)
 142 {
 143     OUString sLocalizedName;
 144     {
 145         SolarMutexGuard aGuard;
 146         sLocalizedName = SVX_RESSTR (nLocalizedNameId);
 147     }
 148     AddProperty (sPropertyName, aType, sLocalizedName, nWhichId);
 149 }
 150
 151
 152
 153
 154 void DescriptionGenerator::AddProperty (const OUString& sPropertyName,
 155     PropertyType aType, const OUString& sLocalizedName, long nWhichId)
 156 {
 157     uno::Reference<beans::XPropertyState> xState (mxShape, uno::UNO_QUERY);
 158     if (xState.is()
 159         && xState->getPropertyState(sPropertyName)!=beans::PropertyState_DEFAULT_VALUE)
 160         if (mxSet.is())
 161         {
 162             // Append a separator from previous Properties.
 163             if ( ! mbIsFirstProperty)
 164                 msDescription.append(',');
 165             else
 166             {
 167                 SolarMutexGuard aGuard;
 168
 169                 msDescription.append(' ');
 170                 msDescription.append(OUString (SVX_RESSTR(RID_SVXSTR_A11Y_AND)));
 171                 msDescription.append(' ');
 172                 mbIsFirstProperty = false;
 173             }
 174
 175             // Delegate to type specific property handling.
 176             switch (aType)
 177             {
 178                 case COLOR:
 179                     AddColor (sPropertyName, sLocalizedName);
 180                     break;
 181                 case INTEGER:
 182                     AddInteger (sPropertyName, sLocalizedName);
 183                     break;
 184                 case STRING:
 185                     AddString (sPropertyName, sLocalizedName, nWhichId);
 186                     break;
 187                 case FILL_STYLE:
 188                     AddFillStyle (sPropertyName, sLocalizedName);
 189                     break;
 190             }
 191         }
 192 }
 193
 194
 195
 196
 197 void DescriptionGenerator::AppendString (const OUString& sString)
 198 {
 199     msDescription.append (sString);
 200 }
 201
 202
 203
 204
 205 void DescriptionGenerator::AddLineProperties()
 206 {
 207     AddProperty ("LineColor", DescriptionGenerator::COLOR, SIP_XA_LINECOLOR);
 208     AddProperty ("LineDashName", DescriptionGenerator::STRING,
 209                  SIP_XA_LINEDASH, XATTR_LINEDASH);
 210     AddProperty ("LineWidth", DescriptionGenerator::INTEGER, SIP_XA_LINEWIDTH);
 211 }
 212
 213
 214
 215
 216 /** The fill style is described by the property "FillStyle".  Depending on
 217     its value a hatch-, gradient-, or bitmap name is appended.
 218 */
 219 void DescriptionGenerator::AddFillProperties()
 220 {
 221     AddProperty ("FillStyle", DescriptionGenerator::FILL_STYLE, SIP_XA_FILLSTYLE);
 222 }
 223
 224
 225
 226
 227 void DescriptionGenerator::Add3DProperties()
 228 {
 229     AddProperty ("D3DMaterialColor", DescriptionGenerator::COLOR,
 230         RID_SVXSTR_A11Y_3D_MATERIAL_COLOR);
 231     AddLineProperties ();
 232     AddFillProperties ();
 233 }
 234
 235
 236
 237
 238 void DescriptionGenerator::AddTextProperties()
 239 {
 240     AddProperty ("CharColor", DescriptionGenerator::COLOR);
 241     AddFillProperties ();
 242 }
 243
 244
 245
 246
 247 /** Search for the given color in the global color table.  If found append
 248     its name to the description.  Otherwise append its RGB tuple.
 249 */
 250 void DescriptionGenerator::AddColor (const OUString& sPropertyName,
 251     const OUString& sLocalizedName)
 252 {
 253     msDescription.append(sLocalizedName);
 254     msDescription.append('=');
 255
 256     try
 257     {
 258
 259         long nValue(0);
 260         if (mxSet.is())
 261         {
 262             uno::Any aValue = mxSet->getPropertyValue (sPropertyName);
 263             aValue >>= nValue;
 264         }
 265
 266         msDescription.append (lookUpColorName(nValue));
 267     }
 268     catch (const ::com::sun::star::beans::UnknownPropertyException &)
 269     {
 270         msDescription.append ("<unknown>");
 271     }
 272 }
 273
 274
 275
 276
 277 void DescriptionGenerator::AddInteger (const OUString& sPropertyName,
 278     const OUString& sLocalizedName)
 279 {
 280     msDescription.append(sLocalizedName);
 281     msDescription.append('=');
 282
 283     try
 284     {
 285         if (mxSet.is())
 286         {
 287             uno::Any aValue = mxSet->getPropertyValue (sPropertyName);
 288             long nValue = 0;
 289             aValue >>= nValue;
 290             msDescription.append (nValue);
 291         }
 292     }
 293     catch (const ::com::sun::star::beans::UnknownPropertyException &)
 294     {
 295         msDescription.append ("<unknown>");
 296     }
 297 }
 298
 299
 300
 301
 302 void DescriptionGenerator::AddString (const OUString& sPropertyName,
 303     const OUString& sLocalizedName, long nWhichId)
 304 {
 305     msDescription.append(sLocalizedName);
 306     msDescription.append('=');
 307
 308     try
 309     {
 310         if (mxSet.is())
 311         {
 312             uno::Any aValue = mxSet->getPropertyValue (sPropertyName);
 313             OUString sValue;
 314             aValue >>= sValue;
 315
 316             if (nWhichId >= 0)
 317             {
 318                 SolarMutexGuard aGuard;
 319                 OUString sLocalizedValue =
 320                     SvxUnogetInternalNameForItem(sal::static_int_cast<sal_Int16>(nWhichId),
 321                                               sValue);
 322                 msDescription.append (sLocalizedValue);
 323             }
 324             else
 325                 msDescription.append (sValue);
 326         }
 327     }
 328     catch (const ::com::sun::star::beans::UnknownPropertyException &)
 329     {
 330         msDescription.append ("<unknown>");
 331     }
 332 }
 333
 334
 335
 336
 337 void DescriptionGenerator::AddFillStyle (const OUString& sPropertyName,
 338     const OUString& sLocalizedName)
 339 {
 340     msDescription.append(sLocalizedName);
 341     msDescription.append('=');
 342
 343     try
 344     {
 345         if (mxSet.is())
 346         {
 347             uno::Any aValue = mxSet->getPropertyValue (sPropertyName);
 348             drawing::FillStyle aFillStyle;
 349             aValue >>= aFillStyle;
 350
 351             // Get the fill style name from the resource.
 352             OUString sFillStyleName;
 353             {
 354                 SolarMutexGuard aGuard;
 355                 switch (aFillStyle)
 356                 {
 357                     case drawing::FillStyle_NONE:
 358                         sFillStyleName = SVX_RESSTR(RID_SVXSTR_A11Y_FILLSTYLE_NONE);
 359                         break;
 360                     case drawing::FillStyle_SOLID:
 361                         sFillStyleName = SVX_RESSTR(RID_SVXSTR_A11Y_FILLSTYLE_SOLID);
 362                         break;
 363                     case drawing::FillStyle_GRADIENT:
 364                         sFillStyleName = SVX_RESSTR(RID_SVXSTR_A11Y_FILLSTYLE_GRADIENT);
 365                         break;
 366                     case drawing::FillStyle_HATCH:
 367                         sFillStyleName = SVX_RESSTR(RID_SVXSTR_A11Y_FILLSTYLE_HATCH);
 368                         break;
 369                     case drawing::FillStyle_BITMAP:
 370                         sFillStyleName = SVX_RESSTR(RID_SVXSTR_A11Y_FILLSTYLE_BITMAP);
 371                         break;
 372                     case drawing::FillStyle_MAKE_FIXED_SIZE:
 373                         break;
 374                 }
 375             }
 376             msDescription.append (sFillStyleName);
 377
 378             // Append the appropriate properties.
 379             switch (aFillStyle)
 380             {
 381                 case drawing::FillStyle_NONE:
 382                     break;
 383                 case drawing::FillStyle_SOLID:
 384                     AddProperty ("FillColor", COLOR, SIP_XA_FILLCOLOR);
 385                     break;
 386                 case drawing::FillStyle_GRADIENT:
 387                     AddProperty ("FillGradientName", STRING, SIP_XA_FILLGRADIENT,
 388                         XATTR_FILLGRADIENT);
 389                     break;
 390                 case drawing::FillStyle_HATCH:
 391                     AddProperty ("FillColor", COLOR, SIP_XA_FILLCOLOR);
 392                     AddProperty ("FillHatchName", STRING, SIP_XA_FILLHATCH,
 393                         XATTR_FILLHATCH);
 394                     break;
 395                 case drawing::FillStyle_BITMAP:
 396                     AddProperty ("FillBitmapName", STRING, SIP_XA_FILLBITMAP,
 397                         XATTR_FILLBITMAP);
 398                     break;
 399                 case drawing::FillStyle_MAKE_FIXED_SIZE:
 400                     break;
 401             }
 402         }
 403     }
 404     catch (const ::com::sun::star::beans::UnknownPropertyException &)
 405     {
 406         msDescription.append ("<unknown>");
 407     }
 408 }
 409
 410 } // end of namespace accessibility
 411
 412 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */