office-gobmx/accessibility/source/extended/accessiblelistbox.cxx
2011-04-22 14:35:13 +02:00

433 lines
18 KiB
C++

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2000, 2010 Oracle and/or its affiliates.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* This file is part of OpenOffice.org.
*
* OpenOffice.org is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License version 3
* only, as published by the Free Software Foundation.
*
* OpenOffice.org is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License version 3 for more details
* (a copy is included in the LICENSE file that accompanied this code).
*
* You should have received a copy of the GNU Lesser General Public License
* version 3 along with OpenOffice.org. If not, see
* <http://www.openoffice.org/license.html>
* for a copy of the LGPLv3 License.
*
************************************************************************/
// MARKER(update_precomp.py): autogen include statement, do not remove
#include "precompiled_accessibility.hxx"
#include <accessibility/extended/accessiblelistbox.hxx>
#include <accessibility/extended/accessiblelistboxentry.hxx>
#include <svtools/svtreebx.hxx>
#include <com/sun/star/awt/Point.hpp>
#include <com/sun/star/awt/Rectangle.hpp>
#include <com/sun/star/awt/Size.hpp>
#include <com/sun/star/accessibility/AccessibleEventId.hpp>
#include <com/sun/star/accessibility/AccessibleRole.hpp>
#include <com/sun/star/accessibility/AccessibleStateType.hpp>
#include <tools/debug.hxx>
#include <vcl/svapp.hxx>
#include <toolkit/awt/vclxwindow.hxx>
#include <toolkit/helper/convert.hxx>
#include <unotools/accessiblestatesethelper.hxx>
//........................................................................
namespace accessibility
{
//........................................................................
// class AccessibleListBox -----------------------------------------------------
using namespace ::com::sun::star::accessibility;
using namespace ::com::sun::star::uno;
using namespace ::com::sun::star::lang;
using namespace ::com::sun::star;
DBG_NAME(AccessibleListBox)
// -----------------------------------------------------------------------------
// Ctor() and Dtor()
// -----------------------------------------------------------------------------
AccessibleListBox::AccessibleListBox( SvTreeListBox& _rListBox, const Reference< XAccessible >& _xParent ) :
VCLXAccessibleComponent( _rListBox.GetWindowPeer() ),
m_xParent( _xParent )
{
DBG_CTOR( AccessibleListBox, NULL );
}
// -----------------------------------------------------------------------------
AccessibleListBox::~AccessibleListBox()
{
DBG_DTOR( AccessibleListBox, NULL );
if ( isAlive() )
{
// increment ref count to prevent double call of Dtor
osl_incrementInterlockedCount( &m_refCount );
dispose();
}
}
IMPLEMENT_FORWARD_XINTERFACE2(AccessibleListBox, VCLXAccessibleComponent, AccessibleListBox_BASE)
IMPLEMENT_FORWARD_XTYPEPROVIDER2(AccessibleListBox, VCLXAccessibleComponent, AccessibleListBox_BASE)
// -----------------------------------------------------------------------------
SvTreeListBox* AccessibleListBox::getListBox() const
{
return static_cast< SvTreeListBox* >( const_cast<AccessibleListBox*>(this)->GetWindow() );
}
// -----------------------------------------------------------------------------
void AccessibleListBox::ProcessWindowEvent( const VclWindowEvent& rVclWindowEvent )
{
if ( isAlive() )
{
switch ( rVclWindowEvent.GetId() )
{
case VCLEVENT_CHECKBOX_TOGGLE :
{
if ( getListBox() && getListBox()->HasFocus() )
{
SvLBoxEntry* pEntry = static_cast< SvLBoxEntry* >( rVclWindowEvent.GetData() );
if ( !pEntry )
pEntry = getListBox()->GetCurEntry();
if ( pEntry )
{
Reference< XAccessible > xChild = new AccessibleListBoxEntry( *getListBox(), pEntry, this );
uno::Any aOldValue, aNewValue;
aNewValue <<= xChild;
NotifyAccessibleEvent( AccessibleEventId::ACTIVE_DESCENDANT_CHANGED, aOldValue, aNewValue );
}
}
break;
}
case VCLEVENT_LISTBOX_SELECT :
{
// First send an event that tells the listeners of a
// modified selection. The active descendant event is
// send after that so that the receiving AT has time to
// read the text or name of the active child.
NotifyAccessibleEvent( AccessibleEventId::SELECTION_CHANGED, Any(), Any() );
if ( getListBox() && getListBox()->HasFocus() )
{
SvLBoxEntry* pEntry = static_cast< SvLBoxEntry* >( rVclWindowEvent.GetData() );
if ( pEntry )
{
Reference< XAccessible > xChild = new AccessibleListBoxEntry( *getListBox(), pEntry, this );
uno::Any aOldValue, aNewValue;
aNewValue <<= xChild;
NotifyAccessibleEvent( AccessibleEventId::ACTIVE_DESCENDANT_CHANGED, aOldValue, aNewValue );
}
}
break;
// #i92103#
case VCLEVENT_ITEM_EXPANDED :
case VCLEVENT_ITEM_COLLAPSED :
{
SvLBoxEntry* pEntry = static_cast< SvLBoxEntry* >( rVclWindowEvent.GetData() );
if ( pEntry )
{
AccessibleListBoxEntry* pAccListBoxEntry =
new AccessibleListBoxEntry( *getListBox(), pEntry, this );
Reference< XAccessible > xChild = pAccListBoxEntry;
const short nAccEvent =
( rVclWindowEvent.GetId() == VCLEVENT_ITEM_EXPANDED )
? AccessibleEventId::LISTBOX_ENTRY_EXPANDED
: AccessibleEventId::LISTBOX_ENTRY_COLLAPSED;
uno::Any aListBoxEntry;
aListBoxEntry <<= xChild;
NotifyAccessibleEvent( nAccEvent, Any(), aListBoxEntry );
if ( getListBox() && getListBox()->HasFocus() )
{
NotifyAccessibleEvent( AccessibleEventId::ACTIVE_DESCENDANT_CHANGED, Any(), aListBoxEntry );
}
}
break;
}
}
default:
VCLXAccessibleComponent::ProcessWindowEvent (rVclWindowEvent);
}
}
}
// -----------------------------------------------------------------------------
void AccessibleListBox::ProcessWindowChildEvent( const VclWindowEvent& rVclWindowEvent )
{
switch ( rVclWindowEvent.GetId() )
{
case VCLEVENT_WINDOW_SHOW:
case VCLEVENT_WINDOW_HIDE:
{
}
break;
default:
{
VCLXAccessibleComponent::ProcessWindowChildEvent( rVclWindowEvent );
}
break;
}
}
// -----------------------------------------------------------------------------
// XComponent
// -----------------------------------------------------------------------------
void SAL_CALL AccessibleListBox::disposing()
{
::osl::MutexGuard aGuard( m_aMutex );
VCLXAccessibleComponent::disposing();
m_xParent = NULL;
}
// -----------------------------------------------------------------------------
// XServiceInfo
// -----------------------------------------------------------------------------
::rtl::OUString SAL_CALL AccessibleListBox::getImplementationName() throw(RuntimeException)
{
return getImplementationName_Static();
}
// -----------------------------------------------------------------------------
Sequence< ::rtl::OUString > SAL_CALL AccessibleListBox::getSupportedServiceNames() throw(RuntimeException)
{
return getSupportedServiceNames_Static();
}
// -----------------------------------------------------------------------------
sal_Bool SAL_CALL AccessibleListBox::supportsService( const ::rtl::OUString& _rServiceName ) throw (RuntimeException)
{
Sequence< ::rtl::OUString > aSupported( getSupportedServiceNames() );
const ::rtl::OUString* pSupported = aSupported.getConstArray();
const ::rtl::OUString* pEnd = pSupported + aSupported.getLength();
for ( ; pSupported != pEnd && !pSupported->equals(_rServiceName); ++pSupported )
;
return pSupported != pEnd;
}
// -----------------------------------------------------------------------------
// XServiceInfo - static methods
// -----------------------------------------------------------------------------
Sequence< ::rtl::OUString > AccessibleListBox::getSupportedServiceNames_Static(void) throw( RuntimeException )
{
Sequence< ::rtl::OUString > aSupported(3);
aSupported[0] = ::rtl::OUString( RTL_CONSTASCII_USTRINGPARAM("com.sun.star.accessibility.AccessibleContext") );
aSupported[1] = ::rtl::OUString( RTL_CONSTASCII_USTRINGPARAM("com.sun.star.accessibility.AccessibleComponent") );
aSupported[2] = ::rtl::OUString( RTL_CONSTASCII_USTRINGPARAM("com.sun.star.awt.AccessibleTreeListBox") );
return aSupported;
}
// -----------------------------------------------------------------------------
::rtl::OUString AccessibleListBox::getImplementationName_Static(void) throw( RuntimeException )
{
return ::rtl::OUString( RTL_CONSTASCII_USTRINGPARAM("com.sun.star.comp.svtools.AccessibleTreeListBox") );
}
// -----------------------------------------------------------------------------
// XAccessible
// -----------------------------------------------------------------------------
Reference< XAccessibleContext > SAL_CALL AccessibleListBox::getAccessibleContext( ) throw (RuntimeException)
{
ensureAlive();
return this;
}
// -----------------------------------------------------------------------------
// XAccessibleContext
// -----------------------------------------------------------------------------
sal_Int32 SAL_CALL AccessibleListBox::getAccessibleChildCount( ) throw (RuntimeException)
{
::comphelper::OExternalLockGuard aGuard( this );
ensureAlive();
sal_Int32 nCount = 0;
SvTreeListBox* pSvTreeListBox = getListBox();
if ( pSvTreeListBox )
nCount = pSvTreeListBox->GetLevelChildCount( NULL );
return nCount;
}
// -----------------------------------------------------------------------------
Reference< XAccessible > SAL_CALL AccessibleListBox::getAccessibleChild( sal_Int32 i ) throw (IndexOutOfBoundsException,RuntimeException)
{
::comphelper::OExternalLockGuard aGuard( this );
ensureAlive();
SvLBoxEntry* pEntry = getListBox()->GetEntry(i);
if ( !pEntry )
throw IndexOutOfBoundsException();
return new AccessibleListBoxEntry( *getListBox(), pEntry, this );
}
// -----------------------------------------------------------------------------
Reference< XAccessible > SAL_CALL AccessibleListBox::getAccessibleParent( ) throw (RuntimeException)
{
::osl::MutexGuard aGuard( m_aMutex );
ensureAlive();
return m_xParent;
}
// -----------------------------------------------------------------------------
sal_Int16 SAL_CALL AccessibleListBox::getAccessibleRole( ) throw (RuntimeException)
{
return AccessibleRole::TREE;
}
// -----------------------------------------------------------------------------
::rtl::OUString SAL_CALL AccessibleListBox::getAccessibleDescription( ) throw (RuntimeException)
{
::comphelper::OExternalLockGuard aGuard( this );
ensureAlive();
return getListBox()->GetAccessibleDescription();
}
// -----------------------------------------------------------------------------
::rtl::OUString SAL_CALL AccessibleListBox::getAccessibleName( ) throw (RuntimeException)
{
::comphelper::OExternalLockGuard aGuard( this );
ensureAlive();
return getListBox()->GetAccessibleName();
}
// -----------------------------------------------------------------------------
// XAccessibleSelection
// -----------------------------------------------------------------------------
void SAL_CALL AccessibleListBox::selectAccessibleChild( sal_Int32 nChildIndex ) throw (IndexOutOfBoundsException, RuntimeException)
{
::comphelper::OExternalLockGuard aGuard( this );
ensureAlive();
SvLBoxEntry* pEntry = getListBox()->GetEntry( nChildIndex );
if ( !pEntry )
throw IndexOutOfBoundsException();
getListBox()->Select( pEntry, sal_True );
}
// -----------------------------------------------------------------------------
sal_Bool SAL_CALL AccessibleListBox::isAccessibleChildSelected( sal_Int32 nChildIndex ) throw (IndexOutOfBoundsException, RuntimeException)
{
::comphelper::OExternalLockGuard aGuard( this );
ensureAlive();
SvLBoxEntry* pEntry = getListBox()->GetEntry( nChildIndex );
if ( !pEntry )
throw IndexOutOfBoundsException();
return getListBox()->IsSelected( pEntry );
}
// -----------------------------------------------------------------------------
void SAL_CALL AccessibleListBox::clearAccessibleSelection( ) throw (RuntimeException)
{
::comphelper::OExternalLockGuard aGuard( this );
ensureAlive();
sal_Int32 i, nCount = 0;
nCount = getListBox()->GetLevelChildCount( NULL );
for ( i = 0; i < nCount; ++i )
{
SvLBoxEntry* pEntry = getListBox()->GetEntry( i );
if ( getListBox()->IsSelected( pEntry ) )
getListBox()->Select( pEntry, sal_False );
}
}
// -----------------------------------------------------------------------------
void SAL_CALL AccessibleListBox::selectAllAccessibleChildren( ) throw (RuntimeException)
{
::comphelper::OExternalLockGuard aGuard( this );
ensureAlive();
sal_Int32 i, nCount = 0;
nCount = getListBox()->GetLevelChildCount( NULL );
for ( i = 0; i < nCount; ++i )
{
SvLBoxEntry* pEntry = getListBox()->GetEntry( i );
if ( !getListBox()->IsSelected( pEntry ) )
getListBox()->Select( pEntry, sal_True );
}
}
// -----------------------------------------------------------------------------
sal_Int32 SAL_CALL AccessibleListBox::getSelectedAccessibleChildCount( ) throw (RuntimeException)
{
::comphelper::OExternalLockGuard aGuard( this );
ensureAlive();
sal_Int32 i, nSelCount = 0, nCount = 0;
nCount = getListBox()->GetLevelChildCount( NULL );
for ( i = 0; i < nCount; ++i )
{
SvLBoxEntry* pEntry = getListBox()->GetEntry( i );
if ( getListBox()->IsSelected( pEntry ) )
++nSelCount;
}
return nSelCount;
}
// -----------------------------------------------------------------------------
Reference< XAccessible > SAL_CALL AccessibleListBox::getSelectedAccessibleChild( sal_Int32 nSelectedChildIndex ) throw (IndexOutOfBoundsException, RuntimeException)
{
::comphelper::OExternalLockGuard aGuard( this );
ensureAlive();
if ( nSelectedChildIndex < 0 || nSelectedChildIndex >= getSelectedAccessibleChildCount() )
throw IndexOutOfBoundsException();
Reference< XAccessible > xChild;
sal_Int32 i, nSelCount = 0, nCount = 0;
nCount = getListBox()->GetLevelChildCount( NULL );
for ( i = 0; i < nCount; ++i )
{
SvLBoxEntry* pEntry = getListBox()->GetEntry( i );
if ( getListBox()->IsSelected( pEntry ) )
++nSelCount;
if ( nSelCount == ( nSelectedChildIndex + 1 ) )
{
xChild = new AccessibleListBoxEntry( *getListBox(), pEntry, this );
break;
}
}
return xChild;
}
// -----------------------------------------------------------------------------
void SAL_CALL AccessibleListBox::deselectAccessibleChild( sal_Int32 nSelectedChildIndex ) throw (IndexOutOfBoundsException, RuntimeException)
{
::comphelper::OExternalLockGuard aGuard( this );
ensureAlive();
SvLBoxEntry* pEntry = getListBox()->GetEntry( nSelectedChildIndex );
if ( !pEntry )
throw IndexOutOfBoundsException();
getListBox()->Select( pEntry, sal_False );
}
// -----------------------------------------------------------------------------
void AccessibleListBox::FillAccessibleStateSet( utl::AccessibleStateSetHelper& rStateSet )
{
VCLXAccessibleComponent::FillAccessibleStateSet( rStateSet );
if ( getListBox() && isAlive() )
{
rStateSet.AddState( AccessibleStateType::FOCUSABLE );
rStateSet.AddState( AccessibleStateType::MANAGES_DESCENDANTS );
if ( getListBox()->GetSelectionMode() == MULTIPLE_SELECTION )
rStateSet.AddState( AccessibleStateType::MULTI_SELECTABLE );
}
}
//........................................................................
}// namespace accessibility
//........................................................................
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */