sd/source/ui/accessibility/AccessiblePageShape.cxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: AccessiblePageShape.cxx,v $
  10  * $Revision: 1.18 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 // MARKER(update_precomp.py): autogen include statement, do not remove
  32 #include "precompiled_sd.hxx"
  33 #include "AccessiblePageShape.hxx"
  34 #include <svx/AccessibleShapeInfo.hxx>
  35
  36 #ifndef _COM_SUN_STAR_ACCESSIBILITY_ACCESSIBLE_ROLE_HPP_
  37 #include <com/sun/star/accessibility/AccessibleRole.hpp>
  38 #endif
  39 #ifndef _COM_SUN_STAR_ACCESSIBILITY_ACCESSIBLE_STATE_TYPE_HPP_
  40 #include <com/sun/star/accessibility/AccessibleStateType.hpp>
  41 #endif
  42 #include <com/sun/star/beans/XPropertySet.hpp>
  43 #include <com/sun/star/container/XChild.hpp>
  44 #include <com/sun/star/drawing/XShapes.hpp>
  45 #include <com/sun/star/drawing/XShapeDescriptor.hpp>
  46 #include <com/sun/star/drawing/XMasterPageTarget.hpp>
  47 #include <com/sun/star/lang/IndexOutOfBoundsException.hpp>
  48
  49 using namespace ::com::sun::star;
  50 using namespace ::com::sun::star::uno;
  51 using namespace ::com::sun::star::accessibility;
  52 using ::com::sun::star::uno::Reference;
  53 using ::rtl::OUString;
  54
  55 #define A2S(pString) (::rtl::OUString(RTL_CONSTASCII_USTRINGPARAM(pString)))
  56
  57 namespace accessibility {
  58
  59 //=====  internal  ============================================================
  60
  61 AccessiblePageShape::AccessiblePageShape (
  62     const uno::Reference<drawing::XDrawPage>& rxPage,
  63     const uno::Reference<XAccessible>& rxParent,
  64     const AccessibleShapeTreeInfo& rShapeTreeInfo,
  65     long nIndex)
  66     : AccessibleShape (AccessibleShapeInfo (NULL, rxParent, nIndex), rShapeTreeInfo),
  67       mxPage (rxPage)
  68 {
  69     // The main part of the initialization is done in the init method which
  70     // has to be called from this constructor's caller.
  71 }
  72
  73
  74
  75
  76 AccessiblePageShape::~AccessiblePageShape (void)
  77 {
  78     OSL_TRACE ("~AccessiblePageShape");
  79 }
  80
  81
  82
  83
  84 void AccessiblePageShape::Init (void)
  85 {
  86     AccessibleShape::Init ();
  87 }
  88
  89
  90
  91
  92 //=====  XAccessibleContext  ==================================================
  93
  94 sal_Int32 SAL_CALL
  95        AccessiblePageShape::getAccessibleChildCount (void)
  96     throw ()
  97 {
  98     return 0;
  99 }
 100
 101
 102
 103
 104 /** Forward the request to the shape.  Return the requested shape or throw
 105     an exception for a wrong index.
 106 */
 107 uno::Reference<XAccessible> SAL_CALL
 108     AccessiblePageShape::getAccessibleChild( sal_Int32 )
 109     throw (::com::sun::star::uno::RuntimeException)
 110 {
 111     throw lang::IndexOutOfBoundsException (
 112         ::rtl::OUString::createFromAscii ("page shape has no children"),
 113         static_cast<uno::XWeak*>(this));
 114 }
 115
 116
 117
 118
 119 //=====  XAccessibleComponent  ================================================
 120
 121 awt::Rectangle SAL_CALL AccessiblePageShape::getBounds (void)
 122     throw (::com::sun::star::uno::RuntimeException)
 123 {
 124     ThrowIfDisposed ();
 125
 126     awt::Rectangle aBoundingBox;
 127
 128     if (maShapeTreeInfo.GetViewForwarder() != NULL)
 129     {
 130         uno::Reference<beans::XPropertySet> xSet (mxPage, uno::UNO_QUERY);
 131         if (xSet.is())
 132         {
 133             uno::Any aValue;
 134             awt::Point aPosition;
 135             awt::Size aSize;
 136
 137             aValue = xSet->getPropertyValue (
 138                 ::rtl::OUString (RTL_CONSTASCII_USTRINGPARAM("BorderLeft")));
 139             aValue >>= aBoundingBox.X;
 140             aValue = xSet->getPropertyValue (
 141                 ::rtl::OUString (RTL_CONSTASCII_USTRINGPARAM("BorderTop")));
 142             aValue >>= aBoundingBox.Y;
 143
 144             aValue = xSet->getPropertyValue (
 145                 ::rtl::OUString (RTL_CONSTASCII_USTRINGPARAM("Width")));
 146             aValue >>= aBoundingBox.Width;
 147             aValue = xSet->getPropertyValue (
 148                 ::rtl::OUString (RTL_CONSTASCII_USTRINGPARAM("Height")));
 149             aValue >>= aBoundingBox.Height;
 150         }
 151
 152         // Transform coordinates from internal to pixel.
 153         ::Size aPixelSize = maShapeTreeInfo.GetViewForwarder()->LogicToPixel (
 154             ::Size (aBoundingBox.Width, aBoundingBox.Height));
 155         ::Point aPixelPosition = maShapeTreeInfo.GetViewForwarder()->LogicToPixel (
 156             ::Point (aBoundingBox.X, aBoundingBox.Y));
 157
 158         // Clip the shape's bounding box with the bounding box of its parent.
 159         Reference<XAccessibleComponent> xParentComponent (
 160             getAccessibleParent(), uno::UNO_QUERY);
 161         if (xParentComponent.is())
 162         {
 163             // Make the coordinates relative to the parent.
 164             awt::Point aParentLocation (xParentComponent->getLocationOnScreen());
 165             int x = aPixelPosition.getX() - aParentLocation.X;
 166             int y = aPixelPosition.getY() - aParentLocation.Y;
 167
 168
 169             // Clip with parent (with coordinates relative to itself).
 170             ::Rectangle aBBox (
 171                 x, y, x + aPixelSize.getWidth(), y + aPixelSize.getHeight());
 172             awt::Size aParentSize (xParentComponent->getSize());
 173             ::Rectangle aParentBBox (0,0, aParentSize.Width, aParentSize.Height);
 174             aBBox = aBBox.GetIntersection (aParentBBox);
 175             aBoundingBox = awt::Rectangle (
 176                 aBBox.getX(),
 177                 aBBox.getY(),
 178                 aBBox.getWidth(),
 179                 aBBox.getHeight());
 180         }
 181         else
 182             aBoundingBox = awt::Rectangle (
 183                 aPixelPosition.getX(), aPixelPosition.getY(),
 184                 aPixelSize.getWidth(), aPixelSize.getHeight());
 185     }
 186
 187     return aBoundingBox;
 188 }
 189
 190
 191
 192
 193 sal_Int32 SAL_CALL AccessiblePageShape::getForeground (void)
 194     throw (::com::sun::star::uno::RuntimeException)
 195 {
 196     ThrowIfDisposed ();
 197     sal_Int32 nColor (0x0ffffffL);
 198
 199     try
 200     {
 201         uno::Reference<beans::XPropertySet> aSet (mxPage, uno::UNO_QUERY);
 202         if (aSet.is())
 203         {
 204             uno::Any aColor;
 205             aColor = aSet->getPropertyValue (::rtl::OUString::createFromAscii ("LineColor"));
 206             aColor >>= nColor;
 207         }
 208     }
 209     catch (::com::sun::star::beans::UnknownPropertyException)
 210     {
 211         // Ignore exception and return default color.
 212     }
 213     return nColor;
 214 }
 215
 216
 217
 218
 219 /** Extract the background color from the Background property of eithe the
 220     draw page or its master page.
 221 */
 222 sal_Int32 SAL_CALL AccessiblePageShape::getBackground (void)
 223     throw (::com::sun::star::uno::RuntimeException)
 224 {
 225     ThrowIfDisposed ();
 226     sal_Int32 nColor (0x01020ffL);
 227
 228     try
 229     {
 230         uno::Reference<beans::XPropertySet> xSet (mxPage, uno::UNO_QUERY);
 231         if (xSet.is())
 232         {
 233             uno::Any aBGSet;
 234             aBGSet = xSet->getPropertyValue (
 235                 ::rtl::OUString (RTL_CONSTASCII_USTRINGPARAM("Background")));
 236             Reference<beans::XPropertySet> xBGSet (aBGSet, uno::UNO_QUERY);
 237             if ( ! xBGSet.is())
 238             {
 239                 // Draw page has no Background property.  Try the master
 240                 // page instead.
 241                 Reference<drawing::XMasterPageTarget> xTarget (mxPage, uno::UNO_QUERY);
 242                 if (xTarget.is())
 243                 {
 244                     xSet = Reference<beans::XPropertySet> (xTarget->getMasterPage(),
 245                         uno::UNO_QUERY);
 246                     aBGSet = xSet->getPropertyValue (
 247                         ::rtl::OUString (RTL_CONSTASCII_USTRINGPARAM("Background")));
 248                     xBGSet = Reference<beans::XPropertySet> (aBGSet, uno::UNO_QUERY);
 249                 }
 250             }
 251             // Fetch the fill color.  Has to be extended to cope with
 252             // gradients, hashes, and bitmaps.
 253             if (xBGSet.is())
 254             {
 255                 uno::Any aColor;
 256                 aColor = xBGSet->getPropertyValue (::rtl::OUString::createFromAscii ("FillColor"));
 257                 aColor >>= nColor;
 258             }
 259             else
 260                 OSL_TRACE ("no Background property in page");
 261         }
 262     }
 263     catch (::com::sun::star::beans::UnknownPropertyException)
 264     {
 265         OSL_TRACE ("caught excption due to unknown property");
 266         // Ignore exception and return default color.
 267     }
 268     return nColor;
 269 }
 270
 271
 272
 273
 274 //=====  XServiceInfo  ========================================================
 275
 276 ::rtl::OUString SAL_CALL
 277     AccessiblePageShape::getImplementationName (void)
 278     throw (::com::sun::star::uno::RuntimeException)
 279 {
 280     ThrowIfDisposed ();
 281     return ::rtl::OUString(RTL_CONSTASCII_USTRINGPARAM("AccessiblePageShape"));
 282 }
 283
 284
 285
 286
 287 ::com::sun::star::uno::Sequence< ::rtl::OUString> SAL_CALL
 288     AccessiblePageShape::getSupportedServiceNames (void)
 289     throw (::com::sun::star::uno::RuntimeException)
 290 {
 291     ThrowIfDisposed ();
 292     return AccessibleShape::getSupportedServiceNames();
 293 }
 294
 295
 296
 297
 298 //=====  lang::XEventListener  ================================================
 299
 300 void SAL_CALL
 301     AccessiblePageShape::disposing (const ::com::sun::star::lang::EventObject& aEvent)
 302     throw (::com::sun::star::uno::RuntimeException)
 303 {
 304     ThrowIfDisposed ();
 305     AccessibleShape::disposing (aEvent);
 306 }
 307
 308
 309
 310
 311 //=====  XComponent  ==========================================================
 312
 313 void AccessiblePageShape::dispose (void)
 314     throw (::com::sun::star::uno::RuntimeException)
 315 {
 316     OSL_TRACE ("AccessiblePageShape::dispose");
 317
 318     // Unregister listeners.
 319     Reference<lang::XComponent> xComponent (mxShape, uno::UNO_QUERY);
 320     if (xComponent.is())
 321         xComponent->removeEventListener (this);
 322
 323     // Cleanup.
 324     mxShape = NULL;
 325
 326     // Call base classes.
 327     AccessibleContextBase::dispose ();
 328 }
 329
 330
 331
 332
 333 //=====  protected internal  ==================================================
 334
 335 ::rtl::OUString
 336     AccessiblePageShape::CreateAccessibleBaseName (void)
 337     throw (::com::sun::star::uno::RuntimeException)
 338 {
 339     return ::rtl::OUString (RTL_CONSTASCII_USTRINGPARAM("PageShape"));
 340 }
 341
 342
 343
 344
 345 ::rtl::OUString
 346     AccessiblePageShape::CreateAccessibleName (void)
 347     throw (::com::sun::star::uno::RuntimeException)
 348 {
 349     Reference<beans::XPropertySet> xPageProperties (mxPage, UNO_QUERY);
 350
 351     // Get name of the current slide.
 352     OUString sCurrentSlideName;
 353     try
 354     {
 355         if (xPageProperties.is())
 356         {
 357             xPageProperties->getPropertyValue(A2S("LinkDisplayName")) >>= sCurrentSlideName;
 358         }
 359     }
 360     catch (beans::UnknownPropertyException&)
 361     {
 362     }
 363
 364     return CreateAccessibleBaseName()+A2S(": ")+sCurrentSlideName;
 365 }
 366
 367
 368
 369
 370 ::rtl::OUString
 371     AccessiblePageShape::CreateAccessibleDescription (void)
 372     throw (::com::sun::star::uno::RuntimeException)
 373 {
 374     return ::rtl::OUString (RTL_CONSTASCII_USTRINGPARAM("Page Shape"));
 375 }
 376
 377
 378 } // end of namespace accessibility
 379
 380