toolkit/source/controls/accessiblecontrolcontext.cxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #include <toolkit/controls/accessiblecontrolcontext.hxx>
  21 #include <unotools/accessiblestatesethelper.hxx>
  22 #include <com/sun/star/awt/XControl.hpp>
  23 #include <com/sun/star/awt/XWindow.hpp>
  24 #include <com/sun/star/beans/XPropertySet.hpp>
  25 #include <com/sun/star/lang/IndexOutOfBoundsException.hpp>
  26 #include <vcl/svapp.hxx>
  27 #include <com/sun/star/accessibility/AccessibleStateType.hpp>
  28 #include <com/sun/star/accessibility/AccessibleRole.hpp>
  29 #include <toolkit/helper/vclunohelper.hxx>
  30 #include <vcl/window.hxx>
  31
  32
  33 namespace toolkit
  34 {
  35
  36
  37     using ::comphelper::OContextEntryGuard;
  38     using namespace ::com::sun::star;
  39     using namespace ::com::sun::star::uno;
  40     using namespace ::com::sun::star::lang;
  41     using namespace ::com::sun::star::beans;
  42     using namespace ::com::sun::star::accessibility;
  43
  44
  45     //= OAccessibleControlContext
  46
  47
  48     OAccessibleControlContext::OAccessibleControlContext()
  49     {
  50         // nothing to do here, we have a late ctor
  51     }
  52
  53
  54     OAccessibleControlContext::~OAccessibleControlContext()
  55     {
  56         ensureDisposed();
  57     }
  58
  59
  60     IMPLEMENT_FORWARD_XINTERFACE3( OAccessibleControlContext, OAccessibleControlContext_Base, OAccessibleImplementationAccess, OAccessibleControlContext_IBase )
  61     IMPLEMENT_FORWARD_XTYPEPROVIDER3( OAccessibleControlContext, OAccessibleControlContext_Base, OAccessibleImplementationAccess, OAccessibleControlContext_IBase )
  62         // (order matters: the first is the class name, the second is the class doing the ref counting)
  63
  64
  65     void OAccessibleControlContext::Init( const Reference< XAccessible >& _rxCreator )
  66     {
  67         OContextEntryGuard aGuard( this );
  68
  69         // retrieve the model of the control
  70         OSL_ENSURE( !m_xControlModel.is(), "OAccessibleControlContext::Init: already know a control model....!???" );
  71
  72         Reference< awt::XControl > xControl( _rxCreator, UNO_QUERY );
  73         if ( xControl.is() )
  74             m_xControlModel.set(xControl->getModel(), css::uno::UNO_QUERY);
  75         OSL_ENSURE( m_xControlModel.is(), "OAccessibleControlContext::Init: invalid creator (no control, or control without model!" );
  76         if ( !m_xControlModel.is() )
  77             throw DisposedException();  // caught by the caller (the create method)
  78
  79         // start listening at the model
  80         startModelListening();
  81
  82         // announce the XAccessible to our base class
  83         OAccessibleControlContext_Base::lateInit( _rxCreator );
  84     }
  85
  86
  87     OAccessibleControlContext* OAccessibleControlContext::create( const Reference< XAccessible >& _rxCreator )
  88     {
  89         OAccessibleControlContext* pNew = nullptr;
  90         try
  91         {
  92             pNew = new OAccessibleControlContext;
  93             pNew->Init( _rxCreator );
  94         }
  95         catch( const Exception& )
  96         {
  97             OSL_FAIL( "OAccessibleControlContext::create: caught an exception from the late ctor!" );
  98         }
  99         return pNew;
 100     }
 101
 102
 103     void OAccessibleControlContext::startModelListening( )
 104     {
 105         Reference< XComponent > xModelComp( m_xControlModel, UNO_QUERY );
 106         OSL_ENSURE( xModelComp.is(), "OAccessibleControlContext::startModelListening: invalid model!" );
 107         if ( xModelComp.is() )
 108             xModelComp->addEventListener( this );
 109     }
 110
 111
 112     void OAccessibleControlContext::stopModelListening( )
 113     {
 114         Reference< XComponent > xModelComp( m_xControlModel, UNO_QUERY );
 115         OSL_ENSURE( xModelComp.is(), "OAccessibleControlContext::stopModelListening: invalid model!" );
 116         if ( xModelComp.is() )
 117             xModelComp->removeEventListener( this );
 118     }
 119
 120
 121     sal_Int32 SAL_CALL OAccessibleControlContext::getAccessibleChildCount(  )
 122     {
 123         // we do not have children
 124         return 0;
 125     }
 126
 127
 128     Reference< XAccessible > SAL_CALL OAccessibleControlContext::getAccessibleChild( sal_Int32 )
 129     {
 130         // we do not have children
 131         throw IndexOutOfBoundsException();
 132     }
 133
 134
 135     Reference< XAccessible > SAL_CALL OAccessibleControlContext::getAccessibleParent(  )
 136     {
 137         return Reference< XAccessible >();
 138     }
 139
 140
 141     sal_Int16 SAL_CALL OAccessibleControlContext::getAccessibleRole(  )
 142     {
 143         return AccessibleRole::SHAPE;
 144     }
 145
 146
 147     OUString SAL_CALL OAccessibleControlContext::getAccessibleDescription(  )
 148     {
 149         OContextEntryGuard aGuard( this );
 150         return getModelStringProperty( "HelpText" );
 151     }
 152
 153
 154     OUString SAL_CALL OAccessibleControlContext::getAccessibleName(  )
 155     {
 156         OContextEntryGuard aGuard( this );
 157         return getModelStringProperty( "Name" );
 158     }
 159
 160
 161     Reference< XAccessibleRelationSet > SAL_CALL OAccessibleControlContext::getAccessibleRelationSet(  )
 162     {
 163         return nullptr;
 164     }
 165
 166
 167     Reference< XAccessibleStateSet > SAL_CALL OAccessibleControlContext::getAccessibleStateSet(  )
 168     {
 169         ::osl::MutexGuard aGuard( GetMutex() );
 170             // no OContextEntryGuard here, as we do not want to throw an exception in case we're not alive anymore
 171
 172         ::utl::AccessibleStateSetHelper* pStateSet = nullptr;
 173         if ( isAlive() )
 174         {
 175             // no own states, only the ones which are foreign controlled
 176             pStateSet = new ::utl::AccessibleStateSetHelper( 0 );
 177         }
 178         else
 179         {   // only the DEFUNC state if we're already disposed
 180             pStateSet = new ::utl::AccessibleStateSetHelper;
 181             pStateSet->AddState( AccessibleStateType::DEFUNC );
 182         }
 183         return pStateSet;
 184     }
 185
 186
 187     void SAL_CALL OAccessibleControlContext::disposing( const EventObject& _rSource )
 188     {
 189         OSL_ENSURE( Reference< XPropertySet >( _rSource.Source, UNO_QUERY ).get() == m_xControlModel.get(),
 190             "OAccessibleControlContext::disposing: where did this come from?" );
 191
 192         stopModelListening( );
 193         m_xControlModel.clear();
 194         m_xModelPropsInfo.clear();
 195
 196         OAccessibleControlContext_Base::disposing();
 197     }
 198
 199
 200     OUString OAccessibleControlContext::getModelStringProperty( const sal_Char* _pPropertyName )
 201     {
 202         OUString sReturn;
 203         try
 204         {
 205             if ( !m_xModelPropsInfo.is() && m_xControlModel.is() )
 206                 m_xModelPropsInfo = m_xControlModel->getPropertySetInfo();
 207
 208             OUString sPropertyName( OUString::createFromAscii( _pPropertyName ) );
 209             if ( m_xModelPropsInfo.is() && m_xModelPropsInfo->hasPropertyByName( sPropertyName ) )
 210                 m_xControlModel->getPropertyValue( sPropertyName ) >>= sReturn;
 211         }
 212         catch( const Exception& )
 213         {
 214             OSL_FAIL( "OAccessibleControlContext::getModelStringProperty: caught an exception!" );
 215         }
 216         return sReturn;
 217     }
 218
 219
 220     VclPtr< vcl::Window > OAccessibleControlContext::implGetWindow( Reference< awt::XWindow >* _pxUNOWindow ) const
 221     {
 222         Reference< awt::XControl > xControl( getAccessibleCreator(), UNO_QUERY );
 223         Reference< awt::XWindow > xWindow;
 224         if ( xControl.is() )
 225             xWindow.set(xControl->getPeer(), css::uno::UNO_QUERY);
 226
 227         VclPtr< vcl::Window > pWindow = xWindow.is() ? VCLUnoHelper::GetWindow( xWindow ) : VclPtr< vcl::Window >();
 228
 229         if ( _pxUNOWindow )
 230             *_pxUNOWindow = xWindow;
 231
 232         return pWindow;
 233     }
 234
 235
 236     awt::Rectangle OAccessibleControlContext::implGetBounds(  )
 237     {
 238         SolarMutexGuard aSolarGuard;
 239             // want to do some VCL stuff here ...
 240         OContextEntryGuard aGuard( this );
 241
 242         OSL_FAIL( "OAccessibleControlContext::implGetBounds: performance issue: forced to calc the size myself!" );
 243         // In design mode (and this is what this class is for), the surrounding shape (if any) should handle this call
 244         // The problem is that in design mode, our size may not be correct (in the drawing layer, controls are
 245         // positioned/sized for painting only), and that calculation of our position is expensive
 246
 247         // what we know (or can obtain from somewhere):
 248         // * the PosSize of our peer, relative to its parent window
 249         // * the parent window which the PosSize is relative to
 250         // * our foreign controlled accessible parent
 251         // from this info, we can determine the position of our peer relative to the foreign parent
 252
 253         // our control
 254         Reference< awt::XWindow > xWindow;
 255         VclPtr< vcl::Window > pVCLWindow = implGetWindow( &xWindow );
 256
 257         awt::Rectangle aBounds( 0, 0, 0, 0 );
 258         if ( xWindow.is() )
 259         {
 260             // ugly, but .... though the XWindow has a getPosSize, it is impossible to determine the
 261             // parent which this position/size is relative to. This means we must tunnel UNO and ask the
 262             // implementation
 263             vcl::Window* pVCLParent = pVCLWindow ? pVCLWindow->GetParent() : nullptr;
 264
 265             // the relative location of the window
 266             ::Point aWindowRelativePos( 0, 0);
 267             if ( pVCLWindow )
 268                 aWindowRelativePos = pVCLWindow->GetPosPixel();
 269
 270             // the screen position of the "window parent" of the control
 271             ::Point aVCLParentScreenPos( 0, 0 );
 272             if ( pVCLParent )
 273                 aVCLParentScreenPos = pVCLParent->GetPosPixel();
 274
 275             // now the size of the control
 276             aBounds = xWindow->getPosSize();
 277
 278             // correct the pos
 279             aBounds.X = aWindowRelativePos.X() + aVCLParentScreenPos.X();
 280             aBounds.Y = aWindowRelativePos.Y() + aVCLParentScreenPos.Y();
 281         }
 282
 283         return aBounds;
 284     }
 285
 286
 287     Reference< XAccessible > SAL_CALL OAccessibleControlContext::getAccessibleAtPoint( const awt::Point& /* _rPoint */ )
 288     {
 289         // no children at all
 290         return nullptr;
 291     }
 292
 293
 294     void SAL_CALL OAccessibleControlContext::grabFocus(  )
 295     {
 296         OSL_FAIL( "OAccessibleControlContext::grabFocus: !isFocusTraversable, but grabFocus!" );
 297     }
 298
 299
 300     sal_Int32 SAL_CALL OAccessibleControlContext::getForeground(  )
 301     {
 302         SolarMutexGuard aSolarGuard;
 303             // want to do some VCL stuff here ...
 304         OContextEntryGuard aGuard( this );
 305
 306         VclPtr< vcl::Window > pWindow = implGetWindow();
 307         Color nColor;
 308         if ( pWindow )
 309         {
 310             if ( pWindow->IsControlForeground() )
 311                 nColor = pWindow->GetControlForeground();
 312             else
 313             {
 314                 vcl::Font aFont;
 315                 if ( pWindow->IsControlFont() )
 316                     aFont = pWindow->GetControlFont();
 317                 else
 318                     aFont = pWindow->GetFont();
 319                 nColor = aFont.GetColor();
 320             }
 321         }
 322         return sal_Int32(nColor);
 323     }
 324
 325
 326     sal_Int32 SAL_CALL OAccessibleControlContext::getBackground(  )
 327     {
 328         SolarMutexGuard aSolarGuard;
 329             // want to do some VCL stuff here ...
 330         OContextEntryGuard aGuard( this );
 331
 332         VclPtr< vcl::Window > pWindow = implGetWindow();
 333         Color nColor;
 334         if ( pWindow )
 335         {
 336             if ( pWindow->IsControlBackground() )
 337                 nColor = pWindow->GetControlBackground();
 338             else
 339                 nColor = pWindow->GetBackground().GetColor();
 340         }
 341
 342         return sal_Int32(nColor);
 343     }
 344
 345
 346 }   //namespace toolkit
 347
 348
 349 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */