sc/source/ui/Accessibility/AccessiblePageHeader.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: AccessiblePageHeader.cxx,v $
  10  * $Revision: 1.22 $
  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_sc.hxx"
  33
  34 #include "AccessiblePageHeader.hxx"
  35 #include "AccessiblePageHeaderArea.hxx"
  36 #include "AccessibilityHints.hxx"
  37 #include "prevwsh.hxx"
  38 #include "unoguard.hxx"
  39 #include "miscuno.hxx"
  40 #include "prevloc.hxx"
  41 #include "document.hxx"
  42 #include "stlpool.hxx"
  43 #include "scitems.hxx"
  44 #include "attrib.hxx"
  45 #include "scresid.hxx"
  46 #ifndef SC_SC_HRC
  47 #include "sc.hrc"
  48 #endif
  49
  50 #include <com/sun/star/accessibility/AccessibleRole.hpp>
  51 #include <com/sun/star/accessibility/AccessibleStateType.hpp>
  52 #include <com/sun/star/accessibility/AccessibleEventId.hpp>
  53
  54 #include <vcl/window.hxx>
  55 #include <svtools/smplhint.hxx>
  56 #include <unotools/accessiblestatesethelper.hxx>
  57 #include <svtools/style.hxx>
  58 #include <svtools/itempool.hxx>
  59 #include <svx/editobj.hxx>
  60 #include <toolkit/helper/convert.hxx>
  61
  62 #include <algorithm>
  63
  64 using namespace ::com::sun::star;
  65 using namespace ::com::sun::star::accessibility;
  66
  67 const sal_uInt8     MAX_AREAS = 3;
  68
  69 //=====  internal  ============================================================
  70 struct Acquire
  71 {
  72     void operator() (ScAccessiblePageHeaderArea* pArea)
  73     {
  74         if (pArea)
  75             pArea->acquire();
  76     }
  77 };
  78
  79 struct Release
  80 {
  81     void operator() (ScAccessiblePageHeaderArea*& pArea)
  82     {
  83         if (pArea)
  84             pArea->release();
  85     }
  86 };
  87
  88 struct Dispose
  89 {
  90     void operator() (ScAccessiblePageHeaderArea*& pArea)
  91     {
  92         if (pArea)
  93         {
  94             pArea->dispose();
  95             pArea->release();
  96         }
  97         pArea = NULL;
  98     }
  99 };
 100
 101 ScAccessiblePageHeader::ScAccessiblePageHeader( const ::com::sun::star::uno::Reference<
 102                                 ::com::sun::star::accessibility::XAccessible>& rxParent,
 103                             ScPreviewShell* pViewShell, sal_Bool bHeader, sal_Int32 nIndex ) :
 104 ScAccessibleContextBase( rxParent, bHeader ? AccessibleRole::HEADER : AccessibleRole::FOOTER ),
 105     mpViewShell( pViewShell ),
 106     mnIndex( nIndex ),
 107     mbHeader( bHeader ),
 108     maAreas(MAX_AREAS, NULL),
 109     mnChildCount(-1)
 110 {
 111     if (mpViewShell)
 112         mpViewShell->AddAccessibilityObject(*this);
 113 }
 114
 115 ScAccessiblePageHeader::~ScAccessiblePageHeader()
 116 {
 117     if (!ScAccessibleContextBase::IsDefunc() && !rBHelper.bInDispose)
 118     {
 119         // increment refcount to prevent double call off dtor
 120         osl_incrementInterlockedCount( &m_refCount );
 121         dispose();
 122     }
 123 }
 124
 125 void SAL_CALL ScAccessiblePageHeader::disposing()
 126 {
 127     ScUnoGuard aGuard;
 128     if (mpViewShell)
 129     {
 130         mpViewShell->RemoveAccessibilityObject(*this);
 131         mpViewShell = NULL;
 132     }
 133     std::for_each(maAreas.begin(), maAreas.end(), Dispose());
 134
 135     ScAccessibleContextBase::disposing();
 136 }
 137
 138 //=====  SfxListener  =====================================================
 139
 140 void ScAccessiblePageHeader::Notify( SfxBroadcaster& rBC, const SfxHint& rHint )
 141 {
 142     if (rHint.ISA( SfxSimpleHint ) )
 143     {
 144         const SfxSimpleHint& rRef = (const SfxSimpleHint&)rHint;
 145         // only notify if child exist, otherwise it is not necessary
 146         if ((rRef.GetId() == SC_HINT_DATACHANGED))
 147         {
 148             ScHFAreas aOldAreas(maAreas);
 149             std::for_each(aOldAreas.begin(), aOldAreas.end(), Acquire());
 150             mnChildCount = -1;
 151             getAccessibleChildCount();
 152             for (sal_uInt8 i = 0; i < MAX_AREAS; ++i)
 153             {
 154                 if ((aOldAreas[i] && maAreas[i] && !ScGlobal::EETextObjEqual(aOldAreas[i]->GetEditTextObject(), maAreas[i]->GetEditTextObject())) ||
 155                     (aOldAreas[i] && !maAreas[i]) || (!aOldAreas[i] && maAreas[i]))
 156                 {
 157                     if (aOldAreas[i] && aOldAreas[i]->GetEditTextObject())
 158                     {
 159                         AccessibleEventObject aEvent;
 160                         aEvent.EventId = AccessibleEventId::CHILD;
 161                         aEvent.Source = uno::Reference< XAccessibleContext >(this);
 162                         aEvent.OldValue = uno::makeAny(uno::Reference<XAccessible>(aOldAreas[i]));
 163
 164                         CommitChange(aEvent); // child gone - event
 165                         aOldAreas[i]->dispose();
 166                     }
 167                     if (maAreas[i] && maAreas[i]->GetEditTextObject())
 168                     {
 169                         AccessibleEventObject aEvent;
 170                         aEvent.EventId = AccessibleEventId::CHILD;
 171                         aEvent.Source = uno::Reference< XAccessibleContext >(this);
 172                         aEvent.NewValue = uno::makeAny(uno::Reference<XAccessible>(maAreas[i]));
 173
 174                         CommitChange(aEvent); // new child - event
 175                     }
 176                 }
 177             }
 178             std::for_each(aOldAreas.begin(), aOldAreas.end(), Release());
 179         }
 180         else if (rRef.GetId() == SC_HINT_ACC_VISAREACHANGED)
 181         {
 182             AccessibleEventObject aEvent;
 183             aEvent.EventId = AccessibleEventId::VISIBLE_DATA_CHANGED;
 184             aEvent.Source = uno::Reference< XAccessibleContext >(this);
 185             CommitChange(aEvent);
 186         }
 187     }
 188
 189     ScAccessibleContextBase::Notify(rBC, rHint);
 190 }
 191
 192 //=====  XAccessibleComponent  ============================================
 193
 194 uno::Reference< XAccessible > SAL_CALL ScAccessiblePageHeader::getAccessibleAtPoint( const awt::Point& aPoint )
 195                                 throw (uno::RuntimeException)
 196 {
 197     uno::Reference<XAccessible> xRet;
 198
 199     if (containsPoint(aPoint))
 200     {
 201         ScUnoGuard aGuard;
 202         IsObjectValid();
 203
 204         sal_Int32 nCount(getAccessibleChildCount()); // fill the areas
 205
 206         if (nCount)
 207         {
 208             // return the first with content, because they have all the same Bounding Box
 209             sal_uInt8 i(0);
 210             while(!xRet.is() && i < MAX_AREAS)
 211             {
 212                 if (maAreas[i])
 213                     xRet = maAreas[i];
 214                 else
 215                     ++i;
 216             }
 217         }
 218     }
 219
 220     return xRet;
 221 }
 222
 223 void SAL_CALL ScAccessiblePageHeader::grabFocus() throw (uno::RuntimeException)
 224 {
 225      ScUnoGuard aGuard;
 226     IsObjectValid();
 227     if (getAccessibleParent().is())
 228     {
 229         uno::Reference<XAccessibleComponent> xAccessibleComponent(getAccessibleParent()->getAccessibleContext(), uno::UNO_QUERY);
 230         if (xAccessibleComponent.is())
 231             xAccessibleComponent->grabFocus();
 232     }
 233 }
 234
 235 //=====  XAccessibleContext  ==============================================
 236
 237 sal_Int32 SAL_CALL ScAccessiblePageHeader::getAccessibleChildCount() throw (uno::RuntimeException)
 238 {
 239     ScUnoGuard aGuard;
 240     IsObjectValid();
 241
 242     if((mnChildCount < 0) && mpViewShell)
 243     {
 244         mnChildCount = 0;
 245         ScDocument* pDoc = mpViewShell->GetDocument();
 246         if (pDoc)
 247         {
 248             // find out how many regions (left,center, right) are with content
 249
 250             SfxStyleSheetBase* pStyle = pDoc->GetStyleSheetPool()->Find(pDoc->GetPageStyle(mpViewShell->GetLocationData().GetPrintTab()), SFX_STYLE_FAMILY_PAGE);
 251             if (pStyle)
 252             {
 253                 sal_uInt16 nPageWhichId(0);
 254                 if (mbHeader)
 255                     nPageWhichId = mpViewShell->GetLocationData().IsHeaderLeft() ? ATTR_PAGE_HEADERLEFT : ATTR_PAGE_HEADERRIGHT;
 256                 else
 257                     nPageWhichId = mpViewShell->GetLocationData().IsFooterLeft() ? ATTR_PAGE_FOOTERLEFT : ATTR_PAGE_FOOTERRIGHT;
 258
 259                 const ScPageHFItem& rPageItem = static_cast<const ScPageHFItem&>(pStyle->GetItemSet().Get(nPageWhichId));
 260                 AddChild(rPageItem.GetLeftArea(), 0, SVX_ADJUST_LEFT);
 261                 AddChild(rPageItem.GetCenterArea(), 1, SVX_ADJUST_CENTER);
 262                 AddChild(rPageItem.GetRightArea(), 2, SVX_ADJUST_RIGHT);
 263             }
 264         }
 265     }
 266
 267     return mnChildCount;
 268 }
 269
 270 uno::Reference< XAccessible > SAL_CALL ScAccessiblePageHeader::getAccessibleChild( sal_Int32 nIndex )
 271                                 throw (lang::IndexOutOfBoundsException, uno::RuntimeException)
 272 {
 273     ScUnoGuard aGuard;
 274     IsObjectValid();
 275
 276     uno::Reference<XAccessible> xRet;
 277
 278     if(mnChildCount < 0)
 279         getAccessibleChildCount();
 280
 281     ScHFAreas::iterator aItr = maAreas.begin();
 282     ScHFAreas::iterator aEndItr = maAreas.end();
 283     while (!xRet.is() && (nIndex >= 0) && (aItr != aEndItr))
 284     {
 285         if (*aItr)
 286         {
 287             if (nIndex == 0)
 288                 xRet = *aItr;
 289             else
 290                 --nIndex;
 291         }
 292         else
 293             ++aItr;
 294     }
 295
 296     if ( !xRet.is() )
 297         throw lang::IndexOutOfBoundsException();
 298
 299     return xRet;
 300 }
 301
 302 sal_Int32 SAL_CALL ScAccessiblePageHeader::getAccessibleIndexInParent() throw (uno::RuntimeException)
 303 {
 304     return mnIndex;
 305 }
 306
 307 uno::Reference< XAccessibleStateSet > SAL_CALL ScAccessiblePageHeader::getAccessibleStateSet()
 308                                 throw (uno::RuntimeException)
 309 {
 310     ScUnoGuard aGuard;
 311     uno::Reference<XAccessibleStateSet> xParentStates;
 312     if (getAccessibleParent().is())
 313     {
 314         uno::Reference<XAccessibleContext> xParentContext = getAccessibleParent()->getAccessibleContext();
 315         xParentStates = xParentContext->getAccessibleStateSet();
 316     }
 317     utl::AccessibleStateSetHelper* pStateSet = new utl::AccessibleStateSetHelper();
 318     if (IsDefunc(xParentStates))
 319         pStateSet->AddState(AccessibleStateType::DEFUNC);
 320     else
 321     {
 322         pStateSet->AddState(AccessibleStateType::ENABLED);
 323         pStateSet->AddState(AccessibleStateType::OPAQUE);
 324         if (isShowing())
 325             pStateSet->AddState(AccessibleStateType::SHOWING);
 326         if (isVisible())
 327             pStateSet->AddState(AccessibleStateType::VISIBLE);
 328     }
 329     return pStateSet;
 330 }
 331
 332 //=====  XServiceInfo  ====================================================
 333
 334 rtl::OUString SAL_CALL ScAccessiblePageHeader::getImplementationName() throw(uno::RuntimeException)
 335 {
 336     return rtl::OUString(RTL_CONSTASCII_USTRINGPARAM("ScAccessiblePageHeader"));
 337 }
 338
 339 uno::Sequence<rtl::OUString> SAL_CALL ScAccessiblePageHeader::getSupportedServiceNames()
 340                                                     throw(uno::RuntimeException)
 341 {
 342     uno::Sequence< ::rtl::OUString > aSequence = ScAccessibleContextBase::getSupportedServiceNames();
 343     sal_Int32 nOldSize(aSequence.getLength());
 344     aSequence.realloc(nOldSize + 1);
 345     ::rtl::OUString* pNames = aSequence.getArray();
 346
 347     pNames[nOldSize] = rtl::OUString(RTL_CONSTASCII_USTRINGPARAM("com.sun.star.text.AccessibleHeaderFooterView"));
 348
 349     return aSequence;
 350 }
 351
 352 //====  internal  =========================================================
 353
 354 ::rtl::OUString SAL_CALL ScAccessiblePageHeader::createAccessibleDescription(void)
 355                     throw (uno::RuntimeException)
 356 {
 357     String sDesc(ScResId(mbHeader ? STR_ACC_HEADER_DESCR : STR_ACC_FOOTER_DESCR));
 358     sDesc.SearchAndReplaceAscii("%1", String(ScResId(SCSTR_UNKNOWN)));
 359     return rtl::OUString( sDesc );
 360 }
 361
 362 ::rtl::OUString SAL_CALL ScAccessiblePageHeader::createAccessibleName(void)
 363                     throw (uno::RuntimeException)
 364 {
 365     String sName(ScResId(mbHeader ? STR_ACC_HEADER_NAME : STR_ACC_FOOTER_NAME));
 366     sName.SearchAndReplaceAscii("%1", String(ScResId(SCSTR_UNKNOWN)));
 367     return rtl::OUString( sName );
 368 }
 369
 370 Rectangle ScAccessiblePageHeader::GetBoundingBoxOnScreen() const throw (uno::RuntimeException)
 371 {
 372     Rectangle aCellRect(GetBoundingBox());
 373     if (mpViewShell)
 374     {
 375         Window* pWindow = mpViewShell->GetWindow();
 376         if (pWindow)
 377         {
 378             Rectangle aRect = pWindow->GetWindowExtentsRelative(NULL);
 379             aCellRect.setX(aCellRect.getX() + aRect.getX());
 380             aCellRect.setY(aCellRect.getY() + aRect.getY());
 381         }
 382     }
 383     return aCellRect;
 384 }
 385
 386 Rectangle ScAccessiblePageHeader::GetBoundingBox() const throw (uno::RuntimeException)
 387 {
 388     Rectangle aRect;
 389     if (mpViewShell)
 390     {
 391         const ScPreviewLocationData& rData = mpViewShell->GetLocationData();
 392         if ( mbHeader )
 393             rData.GetHeaderPosition( aRect );
 394         else
 395             rData.GetFooterPosition( aRect );
 396
 397         // the Rectangle could contain negative coordinates so it should be cliped
 398         Rectangle aClipRect(Point(0, 0), aRect.GetSize());
 399         Window* pWindow = mpViewShell->GetWindow();
 400         if (pWindow)
 401             aClipRect = pWindow->GetWindowExtentsRelative(pWindow->GetAccessibleParentWindow());
 402         aRect = aClipRect.GetIntersection(aRect);
 403     }
 404     if (aRect.IsEmpty())
 405         aRect.SetSize(Size(-1, -1));
 406
 407     return aRect;
 408 }
 409
 410 sal_Bool ScAccessiblePageHeader::IsDefunc( const uno::Reference<XAccessibleStateSet>& rxParentStates )
 411 {
 412     return ScAccessibleContextBase::IsDefunc() || (mpViewShell == NULL) || !getAccessibleParent().is() ||
 413         (rxParentStates.is() && rxParentStates->contains(AccessibleStateType::DEFUNC));
 414 }
 415
 416 void ScAccessiblePageHeader::AddChild(const EditTextObject* pArea, sal_uInt32 nIndex, SvxAdjust eAdjust)
 417 {
 418     if (pArea && (pArea->GetText(0).Len() || (pArea->GetParagraphCount() > 1)))
 419     {
 420         if (maAreas[nIndex])
 421         {
 422             if (!ScGlobal::EETextObjEqual(maAreas[nIndex]->GetEditTextObject(), pArea))
 423             {
 424                 maAreas[nIndex]->release();
 425                 maAreas[nIndex] = new ScAccessiblePageHeaderArea(this, mpViewShell, pArea, mbHeader, eAdjust);
 426                 maAreas[nIndex]->acquire();
 427             }
 428         }
 429         else
 430         {
 431             maAreas[nIndex] = new ScAccessiblePageHeaderArea(this, mpViewShell, pArea, mbHeader, eAdjust);
 432             maAreas[nIndex]->acquire();
 433         }
 434         ++mnChildCount;
 435     }
 436     else
 437     {
 438         if (maAreas[nIndex])
 439         {
 440             maAreas[nIndex]->release();
 441             maAreas[nIndex] = NULL;
 442         }
 443     }
 444 }