sc/source/ui/Accessibility/AccessibleEditObject.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: AccessibleEditObject.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_sc.hxx"
  33 #include "AccessibleEditObject.hxx"
  34 #include "scitems.hxx"
  35 #include <svx/eeitem.hxx>
  36 #include "unoguard.hxx"
  37 #include "AccessibleText.hxx"
  38 #include "editsrc.hxx"
  39 #include "scmod.hxx"
  40 #include "inputhdl.hxx"
  41
  42 #ifndef _UTL_ACCESSIBLESTATESETHELPER_HXX
  43 #include <unotools/accessiblestatesethelper.hxx>
  44 #endif
  45 #ifndef _COM_SUN_STAR_ACCESSIBILITY_XACCESSIBLEROLE_HPP_
  46 #include <com/sun/star/accessibility/AccessibleRole.hpp>
  47 #endif
  48 #ifndef _COM_SUN_STAR_ACCESSIBILITY_XACCESSIBLESTATETYPE_HPP_
  49 #include <com/sun/star/accessibility/AccessibleStateType.hpp>
  50 #endif
  51 #include <rtl/uuid.h>
  52 #include <tools/debug.hxx>
  53 #include <svx/AccessibleTextHelper.hxx>
  54 #include <svx/editview.hxx>
  55 #include <svx/editeng.hxx>
  56 #include <svx/svdmodel.hxx>
  57
  58 using namespace ::com::sun::star;
  59 using namespace ::com::sun::star::accessibility;
  60
  61 //=====  internal  ============================================================
  62
  63 ScAccessibleEditObject::ScAccessibleEditObject(
  64         const uno::Reference<XAccessible>& rxParent,
  65         EditView* pEditView, Window* pWin, const rtl::OUString& rName,
  66         const rtl::OUString& rDescription, EditObjectType eObjectType)
  67     :
  68     ScAccessibleContextBase(rxParent, AccessibleRole::TEXT_FRAME),
  69     mpTextHelper(NULL),
  70     mpEditView(pEditView),
  71     mpWindow(pWin),
  72     meObjectType(eObjectType),
  73     mbHasFocus(sal_False)
  74 {
  75     CreateTextHelper();
  76     SetName(rName);
  77     SetDescription(rDescription);
  78 }
  79
  80 ScAccessibleEditObject::~ScAccessibleEditObject()
  81 {
  82     if (!ScAccessibleContextBase::IsDefunc() && !rBHelper.bInDispose)
  83     {
  84         // increment refcount to prevent double call off dtor
  85         osl_incrementInterlockedCount( &m_refCount );
  86         // call dispose to inform object wich have a weak reference to this object
  87         dispose();
  88     }
  89 }
  90
  91 void SAL_CALL ScAccessibleEditObject::disposing()
  92 {
  93     ScUnoGuard aGuard;
  94     if (mpTextHelper)
  95         DELETEZ(mpTextHelper);
  96
  97     ScAccessibleContextBase::disposing();
  98 }
  99
 100 void ScAccessibleEditObject::LostFocus()
 101 {
 102     mbHasFocus = sal_False;
 103     if (mpTextHelper)
 104         mpTextHelper->SetFocus(sal_False);
 105     CommitFocusLost();
 106 }
 107
 108 void ScAccessibleEditObject::GotFocus()
 109 {
 110     mbHasFocus = sal_True;
 111     CommitFocusGained();
 112     if (mpTextHelper)
 113         mpTextHelper->SetFocus(sal_True);
 114 }
 115
 116     //=====  XAccessibleComponent  ============================================
 117
 118 uno::Reference< XAccessible > SAL_CALL ScAccessibleEditObject::getAccessibleAtPoint(
 119         const awt::Point& rPoint )
 120         throw (uno::RuntimeException)
 121 {
 122     uno::Reference<XAccessible> xRet;
 123     if (containsPoint(rPoint))
 124     {
 125          ScUnoGuard aGuard;
 126         IsObjectValid();
 127
 128         if(!mpTextHelper)
 129             CreateTextHelper();
 130
 131         xRet = mpTextHelper->GetAt(rPoint);
 132     }
 133
 134     return xRet;
 135 }
 136
 137 Rectangle ScAccessibleEditObject::GetBoundingBoxOnScreen(void) const
 138         throw (uno::RuntimeException)
 139 {
 140     Rectangle aScreenBounds;
 141
 142     if ( mpWindow )
 143     {
 144         if ( meObjectType == CellInEditMode )
 145         {
 146             if ( mpEditView && mpEditView->GetEditEngine() )
 147             {
 148                 MapMode aMapMode( mpEditView->GetEditEngine()->GetRefMapMode() );
 149                 aScreenBounds = mpWindow->LogicToPixel( mpEditView->GetOutputArea(), aMapMode );
 150                 Point aCellLoc = aScreenBounds.TopLeft();
 151                 Rectangle aWindowRect = mpWindow->GetWindowExtentsRelative( NULL );
 152                 Point aWindowLoc = aWindowRect.TopLeft();
 153                 Point aPos( aCellLoc.getX() + aWindowLoc.getX(), aCellLoc.getY() + aWindowLoc.getY() );
 154                 aScreenBounds.SetPos( aPos );
 155             }
 156         }
 157         else
 158         {
 159             aScreenBounds = mpWindow->GetWindowExtentsRelative( NULL );
 160         }
 161     }
 162
 163     return aScreenBounds;
 164 }
 165
 166 Rectangle ScAccessibleEditObject::GetBoundingBox(void) const
 167         throw (uno::RuntimeException)
 168 {
 169     Rectangle aBounds( GetBoundingBoxOnScreen() );
 170
 171     if ( mpWindow )
 172     {
 173         uno::Reference< XAccessible > xThis( mpWindow->GetAccessible() );
 174         if ( xThis.is() )
 175         {
 176             uno::Reference< XAccessibleContext > xContext( xThis->getAccessibleContext() );
 177             if ( xContext.is() )
 178             {
 179                 uno::Reference< XAccessible > xParent( xContext->getAccessibleParent() );
 180                 if ( xParent.is() )
 181                 {
 182                     uno::Reference< XAccessibleComponent > xParentComponent( xParent->getAccessibleContext(), uno::UNO_QUERY );
 183                     if ( xParentComponent.is() )
 184                     {
 185                         Point aScreenLoc = aBounds.TopLeft();
 186                         awt::Point aParentScreenLoc = xParentComponent->getLocationOnScreen();
 187                         Point aPos( aScreenLoc.getX() - aParentScreenLoc.X, aScreenLoc.getY() - aParentScreenLoc.Y );
 188                         aBounds.SetPos( aPos );
 189                     }
 190                 }
 191             }
 192         }
 193     }
 194
 195     return aBounds;
 196 }
 197
 198     //=====  XAccessibleContext  ==============================================
 199
 200 sal_Int32 SAL_CALL
 201     ScAccessibleEditObject::getAccessibleChildCount(void)
 202                     throw (uno::RuntimeException)
 203 {
 204     ScUnoGuard aGuard;
 205     IsObjectValid();
 206     if (!mpTextHelper)
 207         CreateTextHelper();
 208     return mpTextHelper->GetChildCount();
 209 }
 210
 211 uno::Reference< XAccessible > SAL_CALL
 212     ScAccessibleEditObject::getAccessibleChild(sal_Int32 nIndex)
 213         throw (uno::RuntimeException,
 214         lang::IndexOutOfBoundsException)
 215 {
 216     ScUnoGuard aGuard;
 217     IsObjectValid();
 218     if (!mpTextHelper)
 219         CreateTextHelper();
 220     return mpTextHelper->GetChild(nIndex);
 221 }
 222
 223 uno::Reference<XAccessibleStateSet> SAL_CALL
 224     ScAccessibleEditObject::getAccessibleStateSet(void)
 225     throw (uno::RuntimeException)
 226 {
 227     ScUnoGuard aGuard;
 228     uno::Reference<XAccessibleStateSet> xParentStates;
 229     if (getAccessibleParent().is())
 230     {
 231         uno::Reference<XAccessibleContext> xParentContext = getAccessibleParent()->getAccessibleContext();
 232         xParentStates = xParentContext->getAccessibleStateSet();
 233     }
 234     utl::AccessibleStateSetHelper* pStateSet = new utl::AccessibleStateSetHelper();
 235     if (IsDefunc(xParentStates))
 236         pStateSet->AddState(AccessibleStateType::DEFUNC);
 237     else
 238     {
 239         // all states are const, because this object exists only in one state
 240         pStateSet->AddState(AccessibleStateType::EDITABLE);
 241         pStateSet->AddState(AccessibleStateType::ENABLED);
 242         pStateSet->AddState(AccessibleStateType::SENSITIVE);
 243         pStateSet->AddState(AccessibleStateType::MULTI_LINE);
 244         pStateSet->AddState(AccessibleStateType::MULTI_SELECTABLE);
 245         pStateSet->AddState(AccessibleStateType::SHOWING);
 246         pStateSet->AddState(AccessibleStateType::VISIBLE);
 247     }
 248     return pStateSet;
 249 }
 250
 251 ::rtl::OUString SAL_CALL
 252     ScAccessibleEditObject::createAccessibleDescription(void)
 253     throw (uno::RuntimeException)
 254 {
 255 //    DBG_ERRORFILE("Should never be called, because is set in the constructor.")
 256     return rtl::OUString();
 257 }
 258
 259 ::rtl::OUString SAL_CALL
 260     ScAccessibleEditObject::createAccessibleName(void)
 261     throw (uno::RuntimeException)
 262 {
 263     DBG_ERRORFILE("Should never be called, because is set in the constructor.");
 264     return rtl::OUString();
 265 }
 266
 267     ///=====  XAccessibleEventBroadcaster  =====================================
 268
 269 void SAL_CALL
 270     ScAccessibleEditObject::addEventListener(const uno::Reference<XAccessibleEventListener>& xListener)
 271         throw (uno::RuntimeException)
 272 {
 273     if (!mpTextHelper)
 274         CreateTextHelper();
 275
 276     mpTextHelper->AddEventListener(xListener);
 277
 278     ScAccessibleContextBase::addEventListener(xListener);
 279 }
 280
 281 void SAL_CALL
 282     ScAccessibleEditObject::removeEventListener(const uno::Reference<XAccessibleEventListener>& xListener)
 283         throw (uno::RuntimeException)
 284 {
 285     if (!mpTextHelper)
 286         CreateTextHelper();
 287
 288     mpTextHelper->RemoveEventListener(xListener);
 289
 290     ScAccessibleContextBase::removeEventListener(xListener);
 291 }
 292
 293     //=====  XServiceInfo  ====================================================
 294
 295 ::rtl::OUString SAL_CALL ScAccessibleEditObject::getImplementationName(void)
 296         throw (uno::RuntimeException)
 297 {
 298     return rtl::OUString(RTL_CONSTASCII_USTRINGPARAM ("ScAccessibleEditObject"));
 299 }
 300
 301 //=====  XTypeProvider  =======================================================
 302
 303 uno::Sequence<sal_Int8> SAL_CALL
 304     ScAccessibleEditObject::getImplementationId(void)
 305     throw (uno::RuntimeException)
 306 {
 307     ScUnoGuard aGuard;
 308     IsObjectValid();
 309     static uno::Sequence<sal_Int8> aId;
 310     if (aId.getLength() == 0)
 311     {
 312         aId.realloc (16);
 313         rtl_createUuid (reinterpret_cast<sal_uInt8 *>(aId.getArray()), 0, sal_True);
 314     }
 315     return aId;
 316 }
 317
 318     //====  internal  =========================================================
 319
 320 sal_Bool ScAccessibleEditObject::IsDefunc(
 321     const uno::Reference<XAccessibleStateSet>& rxParentStates)
 322 {
 323     return ScAccessibleContextBase::IsDefunc() || !getAccessibleParent().is() ||
 324          (rxParentStates.is() && rxParentStates->contains(AccessibleStateType::DEFUNC));
 325 }
 326
 327 void ScAccessibleEditObject::CreateTextHelper()
 328 {
 329     if (!mpTextHelper)
 330     {
 331         ::std::auto_ptr < ScAccessibleTextData > pAccessibleTextData;
 332         if (meObjectType == CellInEditMode || meObjectType == EditControl)
 333         {
 334             pAccessibleTextData.reset
 335                 (new ScAccessibleEditObjectTextData(mpEditView, mpWindow));
 336         }
 337         else
 338         {
 339             pAccessibleTextData.reset
 340                 (new ScAccessibleEditLineTextData(NULL, mpWindow));
 341         }
 342
 343         ::std::auto_ptr< SvxEditSource > pEditSource (new ScAccessibilityEditSource(pAccessibleTextData));
 344         mpTextHelper = new ::accessibility::AccessibleTextHelper(pEditSource );
 345         mpTextHelper->SetEventSource(this);
 346         mpTextHelper->SetFocus(mbHasFocus);
 347
 348         // #i54814# activate cell in edit mode
 349         if( meObjectType == CellInEditMode )
 350         {
 351             // do not activate cell object, if top edit line is active
 352             const ScInputHandler* pInputHdl = SC_MOD()->GetInputHdl();
 353             if( pInputHdl && !pInputHdl->IsTopMode() )
 354             {
 355                 SdrHint aHint( HINT_BEGEDIT );
 356                 mpTextHelper->GetEditSource().GetBroadcaster().Broadcast( aHint );
 357             }
 358         }
 359     }
 360 }
 361