blob: 3e7f6bc4dad1333d32879ac8b3723432326911be [file] [log] [blame]
/**************************************************************
*
* 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
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*
*************************************************************/
// MARKER(update_precomp.py): autogen include statement, do not remove
#include "precompiled_accessibility.hxx"
#include "accessibility/extended/AccessibleBrowseBox.hxx"
#include "accessibility/extended/AccessibleBrowseBoxTable.hxx"
#include "accessibility/extended/AccessibleBrowseBoxHeaderBar.hxx"
#include <svtools/accessibletableprovider.hxx>
#include <comphelper/types.hxx>
#include <toolkit/helper/vclunohelper.hxx>
// ============================================================================
namespace accessibility
{
// ============================================================================
using ::rtl::OUString;
using namespace ::com::sun::star::uno;
using namespace ::com::sun::star;
using namespace ::com::sun::star::lang;
using namespace ::com::sun::star::accessibility;
using namespace ::svt;
// ============================================================================
class AccessibleBrowseBoxImpl
{
public:
/// the XAccessible which created the AccessibleBrowseBox
WeakReference< XAccessible > m_aCreator;
/** The data table child. */
Reference<
::com::sun::star::accessibility::XAccessible > mxTable;
AccessibleBrowseBoxTable* m_pTable;
/** The header bar for rows ("handle column"). */
Reference<
::com::sun::star::accessibility::XAccessible > mxRowHeaderBar;
AccessibleBrowseBoxHeaderBar* m_pRowHeaderBar;
/** The header bar for columns (first row of the table). */
Reference<
::com::sun::star::accessibility::XAccessible > mxColumnHeaderBar;
AccessibleBrowseBoxHeaderBar* m_pColumnHeaderBar;
};
// Ctor/Dtor/disposing --------------------------------------------------------
DBG_NAME( AccessibleBrowseBox )
AccessibleBrowseBox::AccessibleBrowseBox(
const Reference< XAccessible >& _rxParent, const Reference< XAccessible >& _rxCreator,
IAccessibleTableProvider& _rBrowseBox )
: AccessibleBrowseBoxBase( _rxParent, _rBrowseBox,NULL, BBTYPE_BROWSEBOX )
{
DBG_CTOR( AccessibleBrowseBox, NULL );
m_pImpl.reset( new AccessibleBrowseBoxImpl() );
m_pImpl->m_aCreator = _rxCreator;
m_xFocusWindow = VCLUnoHelper::GetInterface(mpBrowseBox->GetWindowInstance());
}
// -----------------------------------------------------------------------------
void AccessibleBrowseBox::setCreator( const Reference< XAccessible >& _rxCreator )
{
#if OSL_DEBUG_LEVEL > 0
Reference< XAccessible > xCreator = (Reference< XAccessible >)m_pImpl->m_aCreator;
DBG_ASSERT( !xCreator.is(), "accessibility/extended/AccessibleBrowseBox::setCreator: creator already set!" );
#endif
m_pImpl->m_aCreator = _rxCreator;
}
// -----------------------------------------------------------------------------
AccessibleBrowseBox::~AccessibleBrowseBox()
{
DBG_DTOR( AccessibleBrowseBox, NULL );
}
// -----------------------------------------------------------------------------
void SAL_CALL AccessibleBrowseBox::disposing()
{
::osl::MutexGuard aGuard( getOslMutex() );
m_pImpl->m_pTable = NULL;
m_pImpl->m_pColumnHeaderBar = NULL;
m_pImpl->m_pRowHeaderBar = NULL;
m_pImpl->m_aCreator = Reference< XAccessible >();
Reference< XAccessible > xTable = m_pImpl->mxTable;
Reference< XComponent > xComp( m_pImpl->mxTable, UNO_QUERY );
if ( xComp.is() )
{
xComp->dispose();
}
//! ::comphelper::disposeComponent(m_pImpl->mxTable);
::comphelper::disposeComponent(m_pImpl->mxRowHeaderBar);
::comphelper::disposeComponent(m_pImpl->mxColumnHeaderBar);
AccessibleBrowseBoxBase::disposing();
}
// -----------------------------------------------------------------------------
// XAccessibleContext ---------------------------------------------------------
sal_Int32 SAL_CALL AccessibleBrowseBox::getAccessibleChildCount()
throw ( uno::RuntimeException )
{
BBSolarGuard aSolarGuard;
::osl::MutexGuard aGuard( getOslMutex() );
ensureIsAlive();
return BBINDEX_FIRSTCONTROL + mpBrowseBox->GetAccessibleControlCount();
}
// -----------------------------------------------------------------------------
Reference< XAccessible > SAL_CALL
AccessibleBrowseBox::getAccessibleChild( sal_Int32 nChildIndex )
throw ( lang::IndexOutOfBoundsException, uno::RuntimeException )
{
BBSolarGuard aSolarGuard;
::osl::MutexGuard aGuard( getOslMutex() );
ensureIsAlive();
Reference< XAccessible > xRet;
if( nChildIndex >= 0 )
{
if( nChildIndex < BBINDEX_FIRSTCONTROL )
xRet = implGetFixedChild( nChildIndex );
else
{
// additional controls
nChildIndex -= BBINDEX_FIRSTCONTROL;
if( nChildIndex < mpBrowseBox->GetAccessibleControlCount() )
xRet = mpBrowseBox->CreateAccessibleControl( nChildIndex );
}
}
if( !xRet.is() )
throw lang::IndexOutOfBoundsException();
return xRet;
}
// -----------------------------------------------------------------------------
//sal_Int16 SAL_CALL AccessibleBrowseBox::getAccessibleRole()
// throw ( uno::RuntimeException )
//{
// ensureIsAlive();
// return AccessibleRole::PANEL;
//}
// -----------------------------------------------------------------------------
// XAccessibleComponent -------------------------------------------------------
Reference< XAccessible > SAL_CALL
AccessibleBrowseBox::getAccessibleAtPoint( const awt::Point& rPoint )
throw ( uno::RuntimeException )
{
BBSolarGuard aSolarGuard;
::osl::MutexGuard aGuard( getOslMutex() );
ensureIsAlive();
Reference< XAccessible > xChild;
sal_Int32 nIndex = 0;
if( mpBrowseBox->ConvertPointToControlIndex( nIndex, VCLPoint( rPoint ) ) )
xChild = mpBrowseBox->CreateAccessibleControl( nIndex );
else
{
// try whether point is in one of the fixed children
// (table, header bars, corner control)
Point aPoint( VCLPoint( rPoint ) );
for( nIndex = 0; (nIndex < BBINDEX_FIRSTCONTROL) && !xChild.is(); ++nIndex )
{
Reference< XAccessible > xCurrChild( implGetFixedChild( nIndex ) );
Reference< XAccessibleComponent >
xCurrChildComp( xCurrChild, uno::UNO_QUERY );
if( xCurrChildComp.is() &&
VCLRectangle( xCurrChildComp->getBounds() ).IsInside( aPoint ) )
xChild = xCurrChild;
}
}
return xChild;
}
// -----------------------------------------------------------------------------
void SAL_CALL AccessibleBrowseBox::grabFocus()
throw ( uno::RuntimeException )
{
BBSolarGuard aSolarGuard;
::osl::MutexGuard aGuard( getOslMutex() );
ensureIsAlive();
mpBrowseBox->GrabFocus();
}
// -----------------------------------------------------------------------------
Any SAL_CALL AccessibleBrowseBox::getAccessibleKeyBinding()
throw ( uno::RuntimeException )
{
ensureIsAlive();
return Any();
}
// -----------------------------------------------------------------------------
// XServiceInfo ---------------------------------------------------------------
OUString SAL_CALL AccessibleBrowseBox::getImplementationName()
throw ( uno::RuntimeException )
{
return OUString( RTL_CONSTASCII_USTRINGPARAM( "com.sun.star.comp.svtools.AccessibleBrowseBox" ) );
}
// -----------------------------------------------------------------------------
// internal virtual methods ---------------------------------------------------
Rectangle AccessibleBrowseBox::implGetBoundingBox()
{
Window* pParent = mpBrowseBox->GetAccessibleParentWindow();
DBG_ASSERT( pParent, "implGetBoundingBox - missing parent window" );
return mpBrowseBox->GetWindowExtentsRelative( pParent );
}
// -----------------------------------------------------------------------------
Rectangle AccessibleBrowseBox::implGetBoundingBoxOnScreen()
{
return mpBrowseBox->GetWindowExtentsRelative( NULL );
}
// -----------------------------------------------------------------------------
// internal helper methods ----------------------------------------------------
Reference< XAccessible > AccessibleBrowseBox::implGetTable()
{
if( !m_pImpl->mxTable.is() )
{
m_pImpl->m_pTable = createAccessibleTable();
m_pImpl->mxTable = m_pImpl->m_pTable;
}
return m_pImpl->mxTable;
}
// -----------------------------------------------------------------------------
Reference< XAccessible >
AccessibleBrowseBox::implGetHeaderBar( AccessibleBrowseBoxObjType eObjType )
{
Reference< XAccessible > xRet;
Reference< XAccessible >* pxMember = NULL;
if( eObjType == BBTYPE_ROWHEADERBAR )
pxMember = &m_pImpl->mxRowHeaderBar;
else if( eObjType == BBTYPE_COLUMNHEADERBAR )
pxMember = &m_pImpl->mxColumnHeaderBar;
if( pxMember )
{
if( !pxMember->is() )
{
AccessibleBrowseBoxHeaderBar* pHeaderBar = new AccessibleBrowseBoxHeaderBar(
(Reference< XAccessible >)m_pImpl->m_aCreator, *mpBrowseBox, eObjType );
if ( BBTYPE_COLUMNHEADERBAR == eObjType)
m_pImpl->m_pColumnHeaderBar = pHeaderBar;
else
m_pImpl->m_pRowHeaderBar = pHeaderBar;
*pxMember = pHeaderBar;
}
xRet = *pxMember;
}
return xRet;
}
// -----------------------------------------------------------------------------
Reference< XAccessible >
AccessibleBrowseBox::implGetFixedChild( sal_Int32 nChildIndex )
{
Reference< XAccessible > xRet;
switch( nChildIndex )
{
case BBINDEX_COLUMNHEADERBAR:
xRet = implGetHeaderBar( BBTYPE_COLUMNHEADERBAR );
break;
case BBINDEX_ROWHEADERBAR:
xRet = implGetHeaderBar( BBTYPE_ROWHEADERBAR );
break;
case BBINDEX_TABLE:
xRet = implGetTable();
break;
}
return xRet;
}
// -----------------------------------------------------------------------------
AccessibleBrowseBoxTable* AccessibleBrowseBox::createAccessibleTable()
{
Reference< XAccessible > xCreator = (Reference< XAccessible >)m_pImpl->m_aCreator;
DBG_ASSERT( xCreator.is(), "accessibility/extended/AccessibleBrowseBox::createAccessibleTable: my creator died - how this?" );
return new AccessibleBrowseBoxTable( xCreator, *mpBrowseBox );
}
// -----------------------------------------------------------------------------
void AccessibleBrowseBox::commitTableEvent(sal_Int16 _nEventId,const Any& _rNewValue,const Any& _rOldValue)
{
if ( m_pImpl->mxTable.is() )
{
m_pImpl->m_pTable->commitEvent(_nEventId,_rNewValue,_rOldValue);
}
}
// -----------------------------------------------------------------------------
void AccessibleBrowseBox::commitHeaderBarEvent( sal_Int16 _nEventId,
const Any& _rNewValue,
const Any& _rOldValue,sal_Bool _bColumnHeaderBar)
{
Reference< XAccessible > xHeaderBar = _bColumnHeaderBar ? m_pImpl->mxColumnHeaderBar : m_pImpl->mxRowHeaderBar;
AccessibleBrowseBoxHeaderBar* pHeaderBar = _bColumnHeaderBar ? m_pImpl->m_pColumnHeaderBar : m_pImpl->m_pRowHeaderBar;
if ( xHeaderBar.is() )
pHeaderBar->commitEvent(_nEventId,_rNewValue,_rOldValue);
}
// ============================================================================
// = AccessibleBrowseBoxAccess
// ============================================================================
DBG_NAME( AccessibleBrowseBoxAccess )
// -----------------------------------------------------------------------------
AccessibleBrowseBoxAccess::AccessibleBrowseBoxAccess( const Reference< XAccessible >& _rxParent, IAccessibleTableProvider& _rBrowseBox )
:m_xParent( _rxParent )
,m_rBrowseBox( _rBrowseBox )
,m_pContext( NULL )
{
DBG_CTOR( AccessibleBrowseBoxAccess, NULL );
}
// -----------------------------------------------------------------------------
AccessibleBrowseBoxAccess::~AccessibleBrowseBoxAccess()
{
DBG_DTOR( AccessibleBrowseBoxAccess, NULL );
}
// -----------------------------------------------------------------------------
void AccessibleBrowseBoxAccess::dispose()
{
::osl::MutexGuard aGuard( m_aMutex );
m_pContext = NULL;
::comphelper::disposeComponent( m_xContext );
}
// -----------------------------------------------------------------------------
Reference< XAccessibleContext > SAL_CALL AccessibleBrowseBoxAccess::getAccessibleContext() throw ( RuntimeException )
{
::osl::MutexGuard aGuard( m_aMutex );
DBG_ASSERT( ( m_pContext && m_xContext.is() ) || ( !m_pContext && !m_xContext.is() ),
"accessibility/extended/AccessibleBrowseBoxAccess::getAccessibleContext: inconsistency!" );
// if the context died meanwhile (we're no listener, so it won't tell us explicitily when this happens),
// then reset an re-create.
if ( m_pContext && !m_pContext->isAlive() )
m_xContext = m_pContext = NULL;
if ( !m_xContext.is() )
m_xContext = m_pContext = new AccessibleBrowseBox( m_xParent, this, m_rBrowseBox );
return m_xContext;
}
// -----------------------------------------------------------------------------
bool AccessibleBrowseBoxAccess::isContextAlive() const
{
return ( NULL != m_pContext ) && m_pContext->isAlive();
}
// ============================================================================
} // namespace accessibility