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::accessibility;
  51 using ::com::sun::star::uno::Reference;
  52
  53 namespace accessibility {
  54
  55 //=====  internal  ============================================================
  56
  57 AccessiblePageShape::AccessiblePageShape (
  58     const uno::Reference<drawing::XDrawPage>& rxPage,
  59     const uno::Reference<XAccessible>& rxParent,
  60     const AccessibleShapeTreeInfo& rShapeTreeInfo,
  61     long nIndex)
  62     : AccessibleShape (AccessibleShapeInfo (NULL, rxParent, nIndex), rShapeTreeInfo),
  63       mxPage (rxPage)
  64 {
  65     // The main part of the initialization is done in the init method which
  66     // has to be called from this constructor's caller.
  67 }
  68
  69
  70
  71
  72 AccessiblePageShape::~AccessiblePageShape (void)
  73 {
  74     OSL_TRACE ("~AccessiblePageShape");
  75 }
  76
  77
  78
  79
  80 void AccessiblePageShape::Init (void)
  81 {
  82     AccessibleShape::Init ();
  83 }
  84
  85
  86
  87
  88 //=====  XAccessibleContext  ==================================================
  89
  90 sal_Int32 SAL_CALL
  91        AccessiblePageShape::getAccessibleChildCount (void)
  92     throw ()
  93 {
  94     return 0;
  95 }
  96
  97
  98
  99
 100 /** Forward the request to the shape.  Return the requested shape or throw
 101     an exception for a wrong index.
 102 */
 103 uno::Reference<XAccessible> SAL_CALL
 104     AccessiblePageShape::getAccessibleChild( sal_Int32 )
 105     throw (::com::sun::star::uno::RuntimeException)
 106 {
 107     throw lang::IndexOutOfBoundsException (
 108         ::rtl::OUString::createFromAscii ("page shape has no children"),
 109         static_cast<uno::XWeak*>(this));
 110 }
 111
 112
 113
 114
 115 //=====  XAccessibleComponent  ================================================
 116
 117 awt::Rectangle SAL_CALL AccessiblePageShape::getBounds (void)
 118     throw (::com::sun::star::uno::RuntimeException)
 119 {
 120     ThrowIfDisposed ();
 121
 122     awt::Rectangle aBoundingBox;
 123
 124     if (maShapeTreeInfo.GetViewForwarder() != NULL)
 125     {
 126         uno::Reference<beans::XPropertySet> xSet (mxPage, uno::UNO_QUERY);
 127         if (xSet.is())
 128         {
 129             uno::Any aValue;
 130             awt::Point aPosition;
 131             awt::Size aSize;
 132
 133             aValue = xSet->getPropertyValue (
 134                 ::rtl::OUString (RTL_CONSTASCII_USTRINGPARAM("BorderLeft")));
 135             aValue >>= aBoundingBox.X;
 136             aValue = xSet->getPropertyValue (
 137                 ::rtl::OUString (RTL_CONSTASCII_USTRINGPARAM("BorderTop")));
 138             aValue >>= aBoundingBox.Y;
 139
 140             aValue = xSet->getPropertyValue (
 141                 ::rtl::OUString (RTL_CONSTASCII_USTRINGPARAM("Width")));
 142             aValue >>= aBoundingBox.Width;
 143             aValue = xSet->getPropertyValue (
 144                 ::rtl::OUString (RTL_CONSTASCII_USTRINGPARAM("Height")));
 145             aValue >>= aBoundingBox.Height;
 146         }
 147
 148         // Transform coordinates from internal to pixel.
 149         ::Size aPixelSize = maShapeTreeInfo.GetViewForwarder()->LogicToPixel (
 150             ::Size (aBoundingBox.Width, aBoundingBox.Height));
 151         ::Point aPixelPosition = maShapeTreeInfo.GetViewForwarder()->LogicToPixel (
 152             ::Point (aBoundingBox.X, aBoundingBox.Y));
 153
 154         // Clip the shape's bounding box with the bounding box of its parent.
 155         Reference<XAccessibleComponent> xParentComponent (
 156             getAccessibleParent(), uno::UNO_QUERY);
 157         if (xParentComponent.is())
 158         {
 159             // Make the coordinates relative to the parent.
 160             awt::Point aParentLocation (xParentComponent->getLocationOnScreen());
 161             int x = aPixelPosition.getX() - aParentLocation.X;
 162             int y = aPixelPosition.getY() - aParentLocation.Y;
 163
 164
 165             // Clip with parent (with coordinates relative to itself).
 166             ::Rectangle aBBox (
 167                 x, y, x + aPixelSize.getWidth(), y + aPixelSize.getHeight());
 168             awt::Size aParentSize (xParentComponent->getSize());
 169             ::Rectangle aParentBBox (0,0, aParentSize.Width, aParentSize.Height);
 170             aBBox = aBBox.GetIntersection (aParentBBox);
 171             aBoundingBox = awt::Rectangle (
 172                 aBBox.getX(),
 173                 aBBox.getY(),
 174                 aBBox.getWidth(),
 175                 aBBox.getHeight());
 176         }
 177         else
 178             aBoundingBox = awt::Rectangle (
 179                 aPixelPosition.getX(), aPixelPosition.getY(),
 180                 aPixelSize.getWidth(), aPixelSize.getHeight());
 181     }
 182
 183     return aBoundingBox;
 184 }
 185
 186
 187
 188
 189 sal_Int32 SAL_CALL AccessiblePageShape::getForeground (void)
 190     throw (::com::sun::star::uno::RuntimeException)
 191 {
 192     ThrowIfDisposed ();
 193     sal_Int32 nColor (0x0ffffffL);
 194
 195     try
 196     {
 197         uno::Reference<beans::XPropertySet> aSet (mxPage, uno::UNO_QUERY);
 198         if (aSet.is())
 199         {
 200             uno::Any aColor;
 201             aColor = aSet->getPropertyValue (::rtl::OUString::createFromAscii ("LineColor"));
 202             aColor >>= nColor;
 203         }
 204     }
 205     catch (::com::sun::star::beans::UnknownPropertyException)
 206     {
 207         // Ignore exception and return default color.
 208     }
 209     return nColor;
 210 }
 211
 212
 213
 214
 215 /** Extract the background color from the Background property of eithe the
 216     draw page or its master page.
 217 */
 218 sal_Int32 SAL_CALL AccessiblePageShape::getBackground (void)
 219     throw (::com::sun::star::uno::RuntimeException)
 220 {
 221     ThrowIfDisposed ();
 222     sal_Int32 nColor (0x01020ffL);
 223
 224     try
 225     {
 226         uno::Reference<beans::XPropertySet> xSet (mxPage, uno::UNO_QUERY);
 227         if (xSet.is())
 228         {
 229             uno::Any aBGSet;
 230             aBGSet = xSet->getPropertyValue (
 231                 ::rtl::OUString (RTL_CONSTASCII_USTRINGPARAM("Background")));
 232             Reference<beans::XPropertySet> xBGSet (aBGSet, uno::UNO_QUERY);
 233             if ( ! xBGSet.is())
 234             {
 235                 // Draw page has no Background property.  Try the master
 236                 // page instead.
 237                 Reference<drawing::XMasterPageTarget> xTarget (mxPage, uno::UNO_QUERY);
 238                 if (xTarget.is())
 239                 {
 240                     xSet = Reference<beans::XPropertySet> (xTarget->getMasterPage(),
 241                         uno::UNO_QUERY);
 242                     aBGSet = xSet->getPropertyValue (
 243                         ::rtl::OUString (RTL_CONSTASCII_USTRINGPARAM("Background")));
 244                     xBGSet = Reference<beans::XPropertySet> (aBGSet, uno::UNO_QUERY);
 245                 }
 246             }
 247             // Fetch the fill color.  Has to be extended to cope with
 248             // gradients, hashes, and bitmaps.
 249             if (xBGSet.is())
 250             {
 251                 uno::Any aColor;
 252                 aColor = xBGSet->getPropertyValue (::rtl::OUString::createFromAscii ("FillColor"));
 253                 aColor >>= nColor;
 254             }
 255             else
 256                 OSL_TRACE ("no Background property in page");
 257         }
 258     }
 259     catch (::com::sun::star::beans::UnknownPropertyException)
 260     {
 261         OSL_TRACE ("caught excption due to unknown property");
 262         // Ignore exception and return default color.
 263     }
 264     return nColor;
 265 }
 266
 267
 268
 269
 270 //=====  XServiceInfo  ========================================================
 271
 272 ::rtl::OUString SAL_CALL
 273     AccessiblePageShape::getImplementationName (void)
 274     throw (::com::sun::star::uno::RuntimeException)
 275 {
 276     ThrowIfDisposed ();
 277     return ::rtl::OUString(RTL_CONSTASCII_USTRINGPARAM("AccessiblePageShape"));
 278 }
 279
 280
 281
 282
 283 ::com::sun::star::uno::Sequence< ::rtl::OUString> SAL_CALL
 284     AccessiblePageShape::getSupportedServiceNames (void)
 285     throw (::com::sun::star::uno::RuntimeException)
 286 {
 287     ThrowIfDisposed ();
 288     return AccessibleShape::getSupportedServiceNames();
 289 }
 290
 291
 292
 293
 294 //=====  lang::XEventListener  ================================================
 295
 296 void SAL_CALL
 297     AccessiblePageShape::disposing (const ::com::sun::star::lang::EventObject& aEvent)
 298     throw (::com::sun::star::uno::RuntimeException)
 299 {
 300     ThrowIfDisposed ();
 301     AccessibleShape::disposing (aEvent);
 302 }
 303
 304
 305
 306
 307 //=====  XComponent  ==========================================================
 308
 309 void AccessiblePageShape::dispose (void)
 310     throw (::com::sun::star::uno::RuntimeException)
 311 {
 312     OSL_TRACE ("AccessiblePageShape::dispose");
 313
 314     // Unregister listeners.
 315     Reference<lang::XComponent> xComponent (mxShape, uno::UNO_QUERY);
 316     if (xComponent.is())
 317         xComponent->removeEventListener (this);
 318
 319     // Cleanup.
 320     mxShape = NULL;
 321
 322     // Call base classes.
 323     AccessibleContextBase::dispose ();
 324 }
 325
 326
 327
 328
 329 //=====  protected internal  ==================================================
 330
 331 ::rtl::OUString
 332     AccessiblePageShape::CreateAccessibleBaseName (void)
 333     throw (::com::sun::star::uno::RuntimeException)
 334 {
 335     return ::rtl::OUString (RTL_CONSTASCII_USTRINGPARAM("PageShape"));
 336 }
 337
 338
 339
 340
 341 ::rtl::OUString
 342     AccessiblePageShape::CreateAccessibleName (void)
 343     throw (::com::sun::star::uno::RuntimeException)
 344 {
 345     return CreateAccessibleBaseName();
 346 }
 347
 348
 349
 350
 351 ::rtl::OUString
 352     AccessiblePageShape::CreateAccessibleDescription (void)
 353     throw (::com::sun::star::uno::RuntimeException)
 354 {
 355     return ::rtl::OUString (RTL_CONSTASCII_USTRINGPARAM("Page Shape"));
 356 }
 357
 358
 359 } // end of namespace accessibility
 360
 361