sc/source/ui/Accessibility/AccessiblePreviewHeaderCell.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: AccessiblePreviewHeaderCell.cxx,v $
  10  * $Revision: 1.26 $
  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 #include "scitems.hxx"
  34 #include <svx/eeitem.hxx>
  35 #include <tools/gen.hxx>
  36 #include "AccessibleText.hxx"
  37 #include "editsrc.hxx"
  38 #include <svx/AccessibleTextHelper.hxx>
  39 #include "AccessiblePreviewHeaderCell.hxx"
  40 #include "AccessibilityHints.hxx"
  41 #include "prevwsh.hxx"
  42 #include "unoguard.hxx"
  43 #include "miscuno.hxx"
  44 #include "prevloc.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
  53 #include <vcl/window.hxx>
  54 #include <svtools/smplhint.hxx>
  55 #include <unotools/accessiblestatesethelper.hxx>
  56 #include <comphelper/sequence.hxx>
  57 #include <toolkit/helper/convert.hxx>
  58
  59 using namespace ::com::sun::star;
  60 using namespace ::com::sun::star::accessibility;
  61
  62 //=====  internal  ============================================================
  63
  64 ScAccessiblePreviewHeaderCell::ScAccessiblePreviewHeaderCell( const ::com::sun::star::uno::Reference<
  65                                 ::com::sun::star::accessibility::XAccessible>& rxParent,
  66                             ScPreviewShell* pViewShell,
  67                             const ScAddress& rCellPos, sal_Bool bIsColHdr, sal_Bool bIsRowHdr,
  68                             sal_Int32 nIndex ) :
  69     ScAccessibleContextBase( rxParent, AccessibleRole::TABLE_CELL ),
  70     mpViewShell( pViewShell ),
  71     mpTextHelper( NULL ),
  72     mnIndex( nIndex ),
  73     maCellPos( rCellPos ),
  74     mbColumnHeader( bIsColHdr ),
  75     mbRowHeader( bIsRowHdr ),
  76     mpTableInfo( NULL )
  77 {
  78     if (mpViewShell)
  79         mpViewShell->AddAccessibilityObject(*this);
  80 }
  81
  82 ScAccessiblePreviewHeaderCell::~ScAccessiblePreviewHeaderCell()
  83 {
  84     if (mpViewShell)
  85         mpViewShell->RemoveAccessibilityObject(*this);
  86 }
  87
  88 void SAL_CALL ScAccessiblePreviewHeaderCell::disposing()
  89 {
  90     ScUnoGuard aGuard;
  91     if (mpViewShell)
  92     {
  93         mpViewShell->RemoveAccessibilityObject(*this);
  94         mpViewShell = NULL;
  95     }
  96
  97        if (mpTableInfo)
  98         DELETEZ (mpTableInfo);
  99
 100     ScAccessibleContextBase::disposing();
 101 }
 102
 103 //=====  SfxListener  =====================================================
 104
 105 void ScAccessiblePreviewHeaderCell::Notify( SfxBroadcaster& rBC, const SfxHint& rHint )
 106 {
 107     if (rHint.ISA( SfxSimpleHint ))
 108     {
 109         const SfxSimpleHint& rRef = (const SfxSimpleHint&)rHint;
 110         ULONG nId = rRef.GetId();
 111         if (nId == SC_HINT_ACC_VISAREACHANGED)
 112         {
 113             if (mpTextHelper)
 114                 mpTextHelper->UpdateChildren();
 115         }
 116         else if ( nId == SFX_HINT_DATACHANGED )
 117         {
 118             //  column / row layout may change with any document change,
 119             //  so it must be invalidated
 120             DELETEZ( mpTableInfo );
 121         }
 122     }
 123
 124     ScAccessibleContextBase::Notify(rBC, rHint);
 125 }
 126
 127 //=====  XInterface  =====================================================
 128
 129 uno::Any SAL_CALL ScAccessiblePreviewHeaderCell::queryInterface( uno::Type const & rType )
 130     throw (uno::RuntimeException)
 131 {
 132     uno::Any aAny (ScAccessiblePreviewHeaderCellImpl::queryInterface(rType));
 133     return aAny.hasValue() ? aAny : ScAccessibleContextBase::queryInterface(rType);
 134 }
 135
 136 void SAL_CALL ScAccessiblePreviewHeaderCell::acquire()
 137     throw ()
 138 {
 139     ScAccessibleContextBase::acquire();
 140 }
 141
 142 void SAL_CALL ScAccessiblePreviewHeaderCell::release()
 143     throw ()
 144 {
 145     ScAccessibleContextBase::release();
 146 }
 147
 148 //=====  XAccessibleValue  ================================================
 149
 150 uno::Any SAL_CALL ScAccessiblePreviewHeaderCell::getCurrentValue() throw (uno::RuntimeException)
 151 {
 152      ScUnoGuard aGuard;
 153     IsObjectValid();
 154
 155     double fValue(0.0);
 156     if (mbColumnHeader)
 157         fValue = maCellPos.Col();
 158     else
 159         fValue = maCellPos.Row();
 160
 161     uno::Any aAny;
 162     aAny <<= fValue;
 163     return aAny;
 164 }
 165
 166 sal_Bool SAL_CALL ScAccessiblePreviewHeaderCell::setCurrentValue( const uno::Any& /* aNumber */ )
 167                                                                 throw (uno::RuntimeException)
 168 {
 169     //  it is not possible to set a value
 170     return sal_False;
 171 }
 172
 173 uno::Any SAL_CALL ScAccessiblePreviewHeaderCell::getMaximumValue() throw (uno::RuntimeException)
 174 {
 175      ScUnoGuard aGuard;
 176     IsObjectValid();
 177
 178     double fValue(0.0);
 179     if (mbColumnHeader)
 180         fValue = MAXCOL;
 181     else
 182         fValue = MAXROW;
 183     uno::Any aAny;
 184     aAny <<= fValue;
 185     return aAny;
 186 }
 187
 188 uno::Any SAL_CALL ScAccessiblePreviewHeaderCell::getMinimumValue() throw (uno::RuntimeException)
 189 {
 190     double fValue(0.0);
 191     uno::Any aAny;
 192     aAny <<= fValue;
 193     return aAny;
 194 }
 195
 196 //=====  XAccessibleComponent  ============================================
 197
 198 uno::Reference< XAccessible > SAL_CALL ScAccessiblePreviewHeaderCell::getAccessibleAtPoint( const awt::Point& rPoint )
 199                                 throw (uno::RuntimeException)
 200 {
 201     uno::Reference<XAccessible> xRet;
 202     if (containsPoint(rPoint))
 203     {
 204          ScUnoGuard aGuard;
 205         IsObjectValid();
 206
 207         if(!mpTextHelper)
 208             CreateTextHelper();
 209
 210         xRet = mpTextHelper->GetAt(rPoint);
 211     }
 212
 213     return xRet;
 214 }
 215
 216 void SAL_CALL ScAccessiblePreviewHeaderCell::grabFocus() throw (uno::RuntimeException)
 217 {
 218      ScUnoGuard aGuard;
 219     IsObjectValid();
 220     if (getAccessibleParent().is())
 221     {
 222         uno::Reference<XAccessibleComponent> xAccessibleComponent(getAccessibleParent()->getAccessibleContext(), uno::UNO_QUERY);
 223         if (xAccessibleComponent.is())
 224             xAccessibleComponent->grabFocus();
 225     }
 226 }
 227
 228 //=====  XAccessibleContext  ==============================================
 229
 230 sal_Int32 SAL_CALL ScAccessiblePreviewHeaderCell::getAccessibleChildCount() throw(uno::RuntimeException)
 231 {
 232     ScUnoGuard aGuard;
 233     IsObjectValid();
 234     if (!mpTextHelper)
 235         CreateTextHelper();
 236     return mpTextHelper->GetChildCount();
 237 }
 238
 239 uno::Reference< XAccessible > SAL_CALL ScAccessiblePreviewHeaderCell::getAccessibleChild(sal_Int32 nIndex)
 240                             throw (uno::RuntimeException, lang::IndexOutOfBoundsException)
 241 {
 242     ScUnoGuard aGuard;
 243     IsObjectValid();
 244     if (!mpTextHelper)
 245         CreateTextHelper();
 246     return mpTextHelper->GetChild(nIndex);
 247 }
 248
 249 sal_Int32 SAL_CALL ScAccessiblePreviewHeaderCell::getAccessibleIndexInParent() throw (uno::RuntimeException)
 250 {
 251     return mnIndex;
 252 }
 253
 254 uno::Reference<XAccessibleStateSet> SAL_CALL ScAccessiblePreviewHeaderCell::getAccessibleStateSet()
 255                             throw(uno::RuntimeException)
 256 {
 257     ScUnoGuard aGuard;
 258
 259     uno::Reference<XAccessibleStateSet> xParentStates;
 260     if (getAccessibleParent().is())
 261     {
 262         uno::Reference<XAccessibleContext> xParentContext = getAccessibleParent()->getAccessibleContext();
 263         xParentStates = xParentContext->getAccessibleStateSet();
 264     }
 265     utl::AccessibleStateSetHelper* pStateSet = new utl::AccessibleStateSetHelper();
 266     if (IsDefunc(xParentStates))
 267         pStateSet->AddState(AccessibleStateType::DEFUNC);
 268     else
 269     {
 270         pStateSet->AddState(AccessibleStateType::ENABLED);
 271         pStateSet->AddState(AccessibleStateType::MULTI_LINE);
 272         if (isShowing())
 273             pStateSet->AddState(AccessibleStateType::SHOWING);
 274         pStateSet->AddState(AccessibleStateType::TRANSIENT);
 275         if (isVisible())
 276             pStateSet->AddState(AccessibleStateType::VISIBLE);
 277     }
 278     return pStateSet;
 279 }
 280
 281 //=====  XServiceInfo  ====================================================
 282
 283 rtl::OUString SAL_CALL ScAccessiblePreviewHeaderCell::getImplementationName() throw(uno::RuntimeException)
 284 {
 285     return rtl::OUString(RTL_CONSTASCII_USTRINGPARAM("ScAccessiblePreviewHeaderCell"));
 286 }
 287
 288 uno::Sequence<rtl::OUString> SAL_CALL ScAccessiblePreviewHeaderCell::getSupportedServiceNames()
 289                                                     throw(uno::RuntimeException)
 290 {
 291     uno::Sequence< ::rtl::OUString > aSequence = ScAccessibleContextBase::getSupportedServiceNames();
 292     sal_Int32 nOldSize(aSequence.getLength());
 293     aSequence.realloc(nOldSize + 1);
 294     ::rtl::OUString* pNames = aSequence.getArray();
 295
 296     pNames[nOldSize] = rtl::OUString(RTL_CONSTASCII_USTRINGPARAM("com.sun.star.table.AccessibleCellView"));
 297
 298     return aSequence;
 299 }
 300
 301 //=====  XTypeProvider  =======================================================
 302
 303 uno::Sequence< uno::Type > SAL_CALL ScAccessiblePreviewHeaderCell::getTypes()
 304         throw (uno::RuntimeException)
 305 {
 306     return comphelper::concatSequences(ScAccessiblePreviewHeaderCellImpl::getTypes(), ScAccessibleContextBase::getTypes());
 307 }
 308
 309 uno::Sequence<sal_Int8> SAL_CALL
 310     ScAccessiblePreviewHeaderCell::getImplementationId(void)
 311     throw (uno::RuntimeException)
 312 {
 313     ScUnoGuard aGuard;
 314     IsObjectValid();
 315     static uno::Sequence<sal_Int8> aId;
 316     if (aId.getLength() == 0)
 317     {
 318         aId.realloc (16);
 319         rtl_createUuid (reinterpret_cast<sal_uInt8 *>(aId.getArray()), 0, sal_True);
 320     }
 321     return aId;
 322 }
 323
 324 //====  internal  =========================================================
 325
 326 Rectangle ScAccessiblePreviewHeaderCell::GetBoundingBoxOnScreen() const throw (uno::RuntimeException)
 327 {
 328     Rectangle aCellRect;
 329
 330     FillTableInfo();
 331
 332     if (mpTableInfo)
 333     {
 334         const ScPreviewColRowInfo& rColInfo = mpTableInfo->GetColInfo()[maCellPos.Col()];
 335         const ScPreviewColRowInfo& rRowInfo = mpTableInfo->GetRowInfo()[maCellPos.Row()];
 336
 337         aCellRect = Rectangle( rColInfo.nPixelStart, rRowInfo.nPixelStart, rColInfo.nPixelEnd, rRowInfo.nPixelEnd );
 338     }
 339
 340     if (mpViewShell)
 341     {
 342         Window* pWindow = mpViewShell->GetWindow();
 343         if (pWindow)
 344         {
 345             Rectangle aRect = pWindow->GetWindowExtentsRelative(NULL);
 346             aCellRect.setX(aCellRect.getX() + aRect.getX());
 347             aCellRect.setY(aCellRect.getY() + aRect.getY());
 348         }
 349     }
 350     return aCellRect;
 351 }
 352
 353 Rectangle ScAccessiblePreviewHeaderCell::GetBoundingBox() const throw (uno::RuntimeException)
 354 {
 355     FillTableInfo();
 356
 357     if (mpTableInfo)
 358     {
 359         const ScPreviewColRowInfo& rColInfo = mpTableInfo->GetColInfo()[maCellPos.Col()];
 360         const ScPreviewColRowInfo& rRowInfo = mpTableInfo->GetRowInfo()[maCellPos.Row()];
 361
 362         Rectangle aCellRect( rColInfo.nPixelStart, rRowInfo.nPixelStart, rColInfo.nPixelEnd, rRowInfo.nPixelEnd );
 363         uno::Reference<XAccessible> xAccParent = const_cast<ScAccessiblePreviewHeaderCell*>(this)->getAccessibleParent();
 364         if (xAccParent.is())
 365         {
 366             uno::Reference<XAccessibleContext> xAccParentContext = xAccParent->getAccessibleContext();
 367             uno::Reference<XAccessibleComponent> xAccParentComp (xAccParentContext, uno::UNO_QUERY);
 368             if (xAccParentComp.is())
 369             {
 370                 Rectangle aParentRect (VCLRectangle(xAccParentComp->getBounds()));
 371                 aCellRect.setX(aCellRect.getX() - aParentRect.getX());
 372                 aCellRect.setY(aCellRect.getY() - aParentRect.getY());
 373             }
 374         }
 375         return aCellRect;
 376     }
 377     return Rectangle();
 378 }
 379
 380 rtl::OUString SAL_CALL ScAccessiblePreviewHeaderCell::createAccessibleDescription() throw(uno::RuntimeException)
 381 {
 382     rtl::OUString sDescription = String(ScResId(STR_ACC_HEADERCELL_DESCR));
 383     return sDescription;
 384 }
 385
 386 rtl::OUString SAL_CALL ScAccessiblePreviewHeaderCell::createAccessibleName() throw(uno::RuntimeException)
 387 {
 388     rtl::OUString sName = String(ScResId(STR_ACC_HEADERCELL_NAME));
 389
 390     if ( mbColumnHeader )
 391     {
 392         if ( mbRowHeader )
 393         {
 394             //! name for corner cell?
 395
 396 //                      sName = rtl::OUString(RTL_CONSTASCII_USTRINGPARAM("Column/Row Header"));
 397         }
 398         else
 399         {
 400             // name of column header
 401             sName += ScColToAlpha( maCellPos.Col() );
 402         }
 403     }
 404     else
 405     {
 406         // name of row header
 407         sName += rtl::OUString::valueOf( (sal_Int32) ( maCellPos.Row() + 1 ) );
 408     }
 409
 410     return sName;
 411 }
 412
 413 sal_Bool ScAccessiblePreviewHeaderCell::IsDefunc( const uno::Reference<XAccessibleStateSet>& rxParentStates )
 414 {
 415     return ScAccessibleContextBase::IsDefunc() || (mpViewShell == NULL) || !getAccessibleParent().is() ||
 416         (rxParentStates.is() && rxParentStates->contains(AccessibleStateType::DEFUNC));
 417 }
 418
 419 void ScAccessiblePreviewHeaderCell::CreateTextHelper()
 420 {
 421     if (!mpTextHelper)
 422     {
 423         ::std::auto_ptr < ScAccessibleTextData > pAccessiblePreviewHeaderCellTextData
 424             (new ScAccessiblePreviewHeaderCellTextData(mpViewShell, String(getAccessibleName()), maCellPos, mbColumnHeader, mbRowHeader));
 425         ::std::auto_ptr< SvxEditSource > pEditSource (new ScAccessibilityEditSource(pAccessiblePreviewHeaderCellTextData));
 426
 427         mpTextHelper = new ::accessibility::AccessibleTextHelper(pEditSource );
 428         mpTextHelper->SetEventSource(this);
 429     }
 430 }
 431
 432 void ScAccessiblePreviewHeaderCell::FillTableInfo() const
 433 {
 434     if ( mpViewShell && !mpTableInfo )
 435     {
 436         Size aOutputSize;
 437         Window* pWindow = mpViewShell->GetWindow();
 438         if ( pWindow )
 439             aOutputSize = pWindow->GetOutputSizePixel();
 440         Point aPoint;
 441         Rectangle aVisRect( aPoint, aOutputSize );
 442
 443         mpTableInfo = new ScPreviewTableInfo;
 444         mpViewShell->GetLocationData().GetTableInfo( aVisRect, *mpTableInfo );
 445     }
 446 }