office-gobmx/toolkit/source/controls/accessiblecontrolcontext.cxx
Noel Grandin b9cc4575c6 replace createFromAscii with OUString literals in OAccessibleControlContext
Change-Id: I48c3dcff57beef905f1d72cef871e284de2da22a
Reviewed-on: https://gerrit.libreoffice.org/c/core/+/167117
Tested-by: Jenkins
Reviewed-by: Noel Grandin <noel.grandin@collabora.co.uk>
2024-05-04 20:11:39 +02:00

343 lines
11 KiB
C++

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed
* with this work for additional information regarding copyright
* ownership. The ASF licenses this file to you under the Apache
* License, Version 2.0 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of
* the License at http://www.apache.org/licenses/LICENSE-2.0 .
*/
#include <controls/accessiblecontrolcontext.hxx>
#include <com/sun/star/awt/XControl.hpp>
#include <com/sun/star/awt/XWindow.hpp>
#include <com/sun/star/beans/XPropertySet.hpp>
#include <com/sun/star/lang/IndexOutOfBoundsException.hpp>
#include <vcl/svapp.hxx>
#include <com/sun/star/accessibility/AccessibleStateType.hpp>
#include <com/sun/star/accessibility/AccessibleRole.hpp>
#include <toolkit/helper/vclunohelper.hxx>
#include <comphelper/accessiblecontexthelper.hxx>
#include <comphelper/diagnose_ex.hxx>
#include <vcl/window.hxx>
namespace toolkit
{
using ::comphelper::OContextEntryGuard;
using namespace ::com::sun::star;
using namespace ::com::sun::star::uno;
using namespace ::com::sun::star::lang;
using namespace ::com::sun::star::beans;
using namespace ::com::sun::star::accessibility;
//= OAccessibleControlContext
OAccessibleControlContext::OAccessibleControlContext()
{
// nothing to do here, we have a late ctor
}
OAccessibleControlContext::~OAccessibleControlContext()
{
ensureDisposed();
}
void OAccessibleControlContext::Init( const Reference< XAccessible >& _rxCreator )
{
OContextEntryGuard aGuard( this );
// retrieve the model of the control
OSL_ENSURE( !m_xControlModel.is(), "OAccessibleControlContext::Init: already know a control model...!???" );
Reference< awt::XControl > xControl( _rxCreator, UNO_QUERY );
if ( xControl.is() )
m_xControlModel.set(xControl->getModel(), css::uno::UNO_QUERY);
OSL_ENSURE( m_xControlModel.is(), "OAccessibleControlContext::Init: invalid creator (no control, or control without model!" );
if ( !m_xControlModel.is() )
throw DisposedException(); // caught by the caller (the create method)
// start listening at the model
startModelListening();
// announce the XAccessible to our base class
OAccessibleControlContext_Base::lateInit( _rxCreator );
}
rtl::Reference<OAccessibleControlContext> OAccessibleControlContext::create( const Reference< XAccessible >& _rxCreator )
{
rtl::Reference<OAccessibleControlContext> pNew;
try
{
pNew = new OAccessibleControlContext;
pNew->Init( _rxCreator );
}
catch( const Exception& )
{
TOOLS_WARN_EXCEPTION( "toolkit", "OAccessibleControlContext::create: caught an exception from the late ctor!" );
}
return pNew;
}
void OAccessibleControlContext::startModelListening( )
{
Reference< XComponent > xModelComp( m_xControlModel, UNO_QUERY );
OSL_ENSURE( xModelComp.is(), "OAccessibleControlContext::startModelListening: invalid model!" );
if ( xModelComp.is() )
xModelComp->addEventListener( this );
}
void OAccessibleControlContext::stopModelListening( )
{
Reference< XComponent > xModelComp( m_xControlModel, UNO_QUERY );
OSL_ENSURE( xModelComp.is(), "OAccessibleControlContext::stopModelListening: invalid model!" );
if ( xModelComp.is() )
xModelComp->removeEventListener( this );
}
sal_Int64 SAL_CALL OAccessibleControlContext::getAccessibleChildCount( )
{
// we do not have children
return 0;
}
Reference< XAccessible > SAL_CALL OAccessibleControlContext::getAccessibleChild( sal_Int64 )
{
// we do not have children
throw IndexOutOfBoundsException();
}
Reference< XAccessible > SAL_CALL OAccessibleControlContext::getAccessibleParent( )
{
return Reference< XAccessible >();
}
sal_Int16 SAL_CALL OAccessibleControlContext::getAccessibleRole( )
{
return AccessibleRole::SHAPE;
}
OUString SAL_CALL OAccessibleControlContext::getAccessibleDescription( )
{
OContextEntryGuard aGuard( this );
return getModelStringProperty( u"HelpText"_ustr );
}
OUString SAL_CALL OAccessibleControlContext::getAccessibleName( )
{
OContextEntryGuard aGuard( this );
return getModelStringProperty( u"Name"_ustr );
}
Reference< XAccessibleRelationSet > SAL_CALL OAccessibleControlContext::getAccessibleRelationSet( )
{
return nullptr;
}
sal_Int64 SAL_CALL OAccessibleControlContext::getAccessibleStateSet( )
{
::osl::MutexGuard aGuard( GetMutex() );
// no OContextEntryGuard here, as we do not want to throw an exception in case we're not alive anymore
sal_Int64 nStateSet = 0;
if ( isAlive() )
{
// no own states, only the ones which are foreign controlled
}
else
{ // only the DEFUNC state if we're already disposed
nStateSet |= AccessibleStateType::DEFUNC;
}
return nStateSet;
}
void SAL_CALL OAccessibleControlContext::disposing( const EventObject& _rSource )
{
OSL_ENSURE( Reference< XPropertySet >( _rSource.Source, UNO_QUERY ).get() == m_xControlModel.get(),
"OAccessibleControlContext::disposing: where did this come from?" );
stopModelListening( );
m_xControlModel.clear();
m_xModelPropsInfo.clear();
OAccessibleControlContext_Base::disposing();
}
OUString OAccessibleControlContext::getModelStringProperty( const OUString& _pPropertyName )
{
OUString sReturn;
try
{
if ( !m_xModelPropsInfo.is() && m_xControlModel.is() )
m_xModelPropsInfo = m_xControlModel->getPropertySetInfo();
OUString sPropertyName( _pPropertyName );
if ( m_xModelPropsInfo.is() && m_xModelPropsInfo->hasPropertyByName( sPropertyName ) )
m_xControlModel->getPropertyValue( sPropertyName ) >>= sReturn;
}
catch( const Exception& )
{
TOOLS_WARN_EXCEPTION( "toolkit", "OAccessibleControlContext::getModelStringProperty" );
}
return sReturn;
}
vcl::Window* OAccessibleControlContext::implGetWindow( Reference< awt::XWindow >* _pxUNOWindow ) const
{
Reference< awt::XControl > xControl( getAccessibleCreator(), UNO_QUERY );
Reference< awt::XWindow > xWindow;
if ( xControl.is() )
xWindow.set(xControl->getPeer(), css::uno::UNO_QUERY);
vcl::Window* pWindow = xWindow.is() ? VCLUnoHelper::GetWindow( xWindow ) : nullptr;
if ( _pxUNOWindow )
*_pxUNOWindow = xWindow;
return pWindow;
}
awt::Rectangle OAccessibleControlContext::implGetBounds( )
{
SolarMutexGuard aSolarGuard;
// want to do some VCL stuff here ...
OContextEntryGuard aGuard( this );
OSL_FAIL( "OAccessibleControlContext::implGetBounds: performance issue: forced to calc the size myself!" );
// In design mode (and this is what this class is for), the surrounding shape (if any) should handle this call
// The problem is that in design mode, our size may not be correct (in the drawing layer, controls are
// positioned/sized for painting only), and that calculation of our position is expensive
// what we know (or can obtain from somewhere):
// * the PosSize of our peer, relative to its parent window
// * the parent window which the PosSize is relative to
// * our foreign controlled accessible parent
// from this info, we can determine the position of our peer relative to the foreign parent
// our control
Reference< awt::XWindow > xWindow;
VclPtr< vcl::Window > pVCLWindow = implGetWindow( &xWindow );
awt::Rectangle aBounds( 0, 0, 0, 0 );
if ( xWindow.is() )
{
// ugly, but... though the XWindow has a getPosSize, it is impossible to determine the
// parent which this position/size is relative to. This means we must tunnel UNO and ask the
// implementation
vcl::Window* pVCLParent = pVCLWindow ? pVCLWindow->GetParent() : nullptr;
// the relative location of the window
::Point aWindowRelativePos( 0, 0);
if ( pVCLWindow )
aWindowRelativePos = pVCLWindow->GetPosPixel();
// the screen position of the "window parent" of the control
::Point aVCLParentScreenPos( 0, 0 );
if ( pVCLParent )
aVCLParentScreenPos = pVCLParent->GetPosPixel();
// now the size of the control
aBounds = xWindow->getPosSize();
// correct the pos
aBounds.X = aWindowRelativePos.X() + aVCLParentScreenPos.X();
aBounds.Y = aWindowRelativePos.Y() + aVCLParentScreenPos.Y();
}
return aBounds;
}
Reference< XAccessible > SAL_CALL OAccessibleControlContext::getAccessibleAtPoint( const awt::Point& /* _rPoint */ )
{
// no children at all
return nullptr;
}
void SAL_CALL OAccessibleControlContext::grabFocus( )
{
OSL_FAIL( "OAccessibleControlContext::grabFocus: !isFocusTraversable, but grabFocus!" );
}
sal_Int32 SAL_CALL OAccessibleControlContext::getForeground( )
{
SolarMutexGuard aSolarGuard;
// want to do some VCL stuff here ...
OContextEntryGuard aGuard( this );
VclPtr< vcl::Window > pWindow = implGetWindow();
Color nColor;
if ( pWindow )
{
if ( pWindow->IsControlForeground() )
nColor = pWindow->GetControlForeground();
else
{
vcl::Font aFont;
if ( pWindow->IsControlFont() )
aFont = pWindow->GetControlFont();
else
aFont = pWindow->GetFont();
nColor = aFont.GetColor();
}
}
return sal_Int32(nColor);
}
sal_Int32 SAL_CALL OAccessibleControlContext::getBackground( )
{
SolarMutexGuard aSolarGuard;
// want to do some VCL stuff here ...
OContextEntryGuard aGuard( this );
VclPtr< vcl::Window > pWindow = implGetWindow();
Color nColor;
if ( pWindow )
{
if ( pWindow->IsControlBackground() )
nColor = pWindow->GetControlBackground();
else
nColor = pWindow->GetBackground().GetColor();
}
return sal_Int32(nColor);
}
} //namespace toolkit
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */