blob: 0fdbdfed474f88fad8f2f711fb7eb5d57d0c84ed [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_svtools.hxx"
#include <svtools/brwbox.hxx>
#include <svtools/AccessibleBrowseBoxObjType.hxx>
#include <tools/debug.hxx>
#include <tools/multisel.hxx>
#include "datwin.hxx"
#include "brwimpl.hxx"
#include <com/sun/star/accessibility/AccessibleStateType.hpp>
#include <com/sun/star/accessibility/AccessibleRole.hpp>
#include <toolkit/helper/vclunohelper.hxx>
// Accessibility ==============================================================
using ::rtl::OUString;
using namespace ::com::sun::star::uno;
using ::com::sun::star::accessibility::XAccessible;
using namespace ::com::sun::star::accessibility;
// ============================================================================
namespace svt
{
using namespace ::com::sun::star::lang;
using namespace utl;
Reference< XAccessible > getHeaderCell( BrowseBoxImpl::THeaderCellMap& _raHeaderCells,
sal_Int32 _nPos,
AccessibleBrowseBoxObjType _eType,
const Reference< XAccessible >& _rParent,
BrowseBox& _rBrowseBox,
IAccessibleFactory& rFactory
)
{
Reference< XAccessible > xRet;
BrowseBoxImpl::THeaderCellMap::iterator aFind = _raHeaderCells.find( _nPos );
if ( aFind == _raHeaderCells.end() )
{
Reference< XAccessible > xAccessible = rFactory.createAccessibleBrowseBoxHeaderCell(
_nPos,
_rParent,
_rBrowseBox,
NULL,
_eType
);
aFind = _raHeaderCells.insert( BrowseBoxImpl::THeaderCellMap::value_type( _nPos, xAccessible ) ).first;
}
if ( aFind != _raHeaderCells.end() )
xRet = aFind->second;
return xRet;
}
// ============================================================================
// ----------------------------------------------------------------------------
Reference< XAccessible > BrowseBoxImpl::getAccessibleHeaderBar( AccessibleBrowseBoxObjType _eObjType )
{
if ( m_pAccessible && m_pAccessible->isAlive() )
return m_pAccessible->getHeaderBar( _eObjType );
return NULL;
}
// ----------------------------------------------------------------------------
Reference< XAccessible > BrowseBoxImpl::getAccessibleTable( )
{
if ( m_pAccessible && m_pAccessible->isAlive() )
return m_pAccessible->getTable( );
return NULL;
}
}
// ============================================================================
Reference< XAccessible > BrowseBox::CreateAccessible()
{
Window* pParent = GetAccessibleParentWindow();
DBG_ASSERT( pParent, "BrowseBox::CreateAccessible - parent not found" );
if( pParent && !m_pImpl->m_pAccessible)
{
Reference< XAccessible > xAccParent = pParent->GetAccessible();
if( xAccParent.is() )
{
m_pImpl->m_pAccessible = getAccessibleFactory().createAccessibleBrowseBox(
xAccParent, *this
);
}
}
Reference< XAccessible > xAccessible;
if ( m_pImpl->m_pAccessible )
xAccessible = m_pImpl->m_pAccessible->getMyself();
return xAccessible;
}
// -----------------------------------------------------------------------------
// Children -------------------------------------------------------------------
Reference< XAccessible > BrowseBox::CreateAccessibleCell( sal_Int32 _nRow, sal_uInt16 _nColumnPos )
{
// BBINDEX_TABLE must be the table
OSL_ENSURE(m_pImpl->m_pAccessible,"Invalid call: Accessible is null");
return m_pImpl->m_aFactoryAccess.getFactory().createAccessibleBrowseBoxTableCell(
m_pImpl->getAccessibleTable(),
*this,
NULL,
_nRow,
_nColumnPos,
OFFSET_DEFAULT
);
}
// -----------------------------------------------------------------------------
Reference< XAccessible > BrowseBox::CreateAccessibleRowHeader( sal_Int32 _nRow )
{
return svt::getHeaderCell(
m_pImpl->m_aRowHeaderCellMap,
_nRow,
svt::BBTYPE_ROWHEADERCELL,
m_pImpl->getAccessibleHeaderBar(svt::BBTYPE_ROWHEADERBAR),
*this,
m_pImpl->m_aFactoryAccess.getFactory()
);
}
// -----------------------------------------------------------------------------
Reference< XAccessible > BrowseBox::CreateAccessibleColumnHeader( sal_uInt16 _nColumnPos )
{
return svt::getHeaderCell(
m_pImpl->m_aColHeaderCellMap,
_nColumnPos,
svt::BBTYPE_COLUMNHEADERCELL,
m_pImpl->getAccessibleHeaderBar(svt::BBTYPE_COLUMNHEADERBAR),
*this,
m_pImpl->m_aFactoryAccess.getFactory()
);
}
// -----------------------------------------------------------------------------
sal_Int32 BrowseBox::GetAccessibleControlCount() const
{
return 0;
}
// -----------------------------------------------------------------------------
Reference< XAccessible > BrowseBox::CreateAccessibleControl( sal_Int32 )
{
DBG_ASSERT( sal_False, "BrowseBox::CreateAccessibleControl: to be overwritten!" );
return NULL;
}
// -----------------------------------------------------------------------------
// Conversions ----------------------------------------------------------------
sal_Bool BrowseBox::ConvertPointToCellAddress(
sal_Int32& rnRow, sal_uInt16& rnColumnPos, const Point& rPoint )
{
//! TODO has to be checked
rnRow = GetRowAtYPosPixel(rPoint.Y());
rnColumnPos = GetColumnAtXPosPixel(rPoint.X());
return rnRow != BROWSER_INVALIDID && rnColumnPos != BROWSER_INVALIDID;
}
// -----------------------------------------------------------------------------
sal_Bool BrowseBox::ConvertPointToRowHeader( sal_Int32& rnRow, const Point& rPoint )
{
rnRow = GetRowAtYPosPixel(rPoint.Y());
// sal_uInt16 nColumnId = GetColumnAtXPosPixel(rPoint.X());
return rnRow != BROWSER_INVALIDID;// && nColumnId == 0;
}
// -----------------------------------------------------------------------------
sal_Bool BrowseBox::ConvertPointToColumnHeader( sal_uInt16& _rnColumnPos, const Point& _rPoint )
{
_rnColumnPos = GetColumnAtXPosPixel(_rPoint.X());
return _rnColumnPos != BROWSER_INVALIDID;
}
// -----------------------------------------------------------------------------
sal_Bool BrowseBox::ConvertPointToControlIndex( sal_Int32& _rnIndex, const Point& _rPoint )
{
//! TODO has to be checked
sal_Int32 nRow = 0;
sal_uInt16 nColumn = 0;
sal_Bool bRet = ConvertPointToCellAddress(nRow,nColumn,_rPoint);
if ( bRet )
_rnIndex = nRow * ColCount() + nColumn;
return bRet;
}
// -----------------------------------------------------------------------------
// Object data and state ------------------------------------------------------
OUString BrowseBox::GetAccessibleObjectName( ::svt::AccessibleBrowseBoxObjType eObjType,sal_Int32 _nPosition) const
{
OUString aRetText;
switch( eObjType )
{
case ::svt::BBTYPE_BROWSEBOX:
aRetText = OUString( RTL_CONSTASCII_USTRINGPARAM( "BrowseBox" ) );
break;
case ::svt::BBTYPE_TABLE:
aRetText = OUString( RTL_CONSTASCII_USTRINGPARAM( "Table" ) );
break;
case ::svt::BBTYPE_ROWHEADERBAR:
aRetText = OUString( RTL_CONSTASCII_USTRINGPARAM( "RowHeaderBar" ) );
break;
case ::svt::BBTYPE_COLUMNHEADERBAR:
aRetText = OUString( RTL_CONSTASCII_USTRINGPARAM( "ColumnHeaderBar" ) );
break;
case ::svt::BBTYPE_TABLECELL:
if( ColCount() !=0 && GetRowCount()!=0)
{
sal_Int32 columnId = _nPosition % ColCount() +1;
aRetText = OUString( GetColumnDescription( sal_Int16( columnId ) ) );
sal_Int32 rowId = _nPosition / GetRowCount() + 1;
aRetText += OUString::valueOf(rowId);
}
else
aRetText = OUString( RTL_CONSTASCII_USTRINGPARAM( "TableCell" ) );
#if OSL_DEBUG_LEVEL > 1
aRetText += OUString( RTL_CONSTASCII_USTRINGPARAM( " [" ) );
aRetText += OUString::valueOf(sal_Int32(GetCurRow()));
aRetText += OUString( RTL_CONSTASCII_USTRINGPARAM( "," ) );
aRetText += OUString::valueOf(sal_Int32(GetCurColumnId()));
aRetText += OUString( RTL_CONSTASCII_USTRINGPARAM( "]" ) );
#endif
break;
case ::svt::BBTYPE_ROWHEADERCELL:
{
sal_Int32 rowId = _nPosition + 1;
aRetText = OUString::valueOf( rowId );
}
#if OSL_DEBUG_LEVEL > 1
aRetText += OUString( RTL_CONSTASCII_USTRINGPARAM( " [" ) );
aRetText += OUString::valueOf(sal_Int32(GetCurRow()));
aRetText += OUString( RTL_CONSTASCII_USTRINGPARAM( "," ) );
aRetText += OUString::valueOf(sal_Int32(GetCurColumnId()));
aRetText += OUString( RTL_CONSTASCII_USTRINGPARAM( "]" ) );
#endif
break;
case ::svt::BBTYPE_COLUMNHEADERCELL:
aRetText = OUString( GetColumnDescription( sal_Int16( _nPosition ) ) );
#if OSL_DEBUG_LEVEL > 1
aRetText += OUString( RTL_CONSTASCII_USTRINGPARAM( " [" ) );
aRetText += OUString::valueOf(sal_Int32(GetCurRow()));
aRetText += OUString( RTL_CONSTASCII_USTRINGPARAM( "," ) );
aRetText += OUString::valueOf(sal_Int32(GetCurColumnId()));
aRetText += OUString( RTL_CONSTASCII_USTRINGPARAM( "]" ) );
#endif
break;
default:
OSL_ENSURE(0,"BrowseBox::GetAccessibleName: invalid enum!");
}
return aRetText;
}
// -----------------------------------------------------------------------------
OUString BrowseBox::GetAccessibleObjectDescription( ::svt::AccessibleBrowseBoxObjType eObjType,sal_Int32 ) const
{
OUString aRetText;
switch( eObjType )
{
case ::svt::BBTYPE_BROWSEBOX:
aRetText = OUString( RTL_CONSTASCII_USTRINGPARAM( "BrowseBox description" ) );
break;
case ::svt::BBTYPE_TABLE:
// aRetText = OUString( RTL_CONSTASCII_USTRINGPARAM( "TABLE description" ) );
break;
case ::svt::BBTYPE_ROWHEADERBAR:
// aRetText = OUString( RTL_CONSTASCII_USTRINGPARAM( "ROWHEADERBAR description" ) );
break;
case ::svt::BBTYPE_COLUMNHEADERBAR:
// aRetText = OUString( RTL_CONSTASCII_USTRINGPARAM( "COLUMNHEADERBAR description" ) );
break;
case ::svt::BBTYPE_TABLECELL:
// aRetText = OUString( RTL_CONSTASCII_USTRINGPARAM( "TABLECELL description" ) );
break;
case ::svt::BBTYPE_ROWHEADERCELL:
// aRetText = OUString( RTL_CONSTASCII_USTRINGPARAM( "ROWHEADERCELL description" ) );
break;
case ::svt::BBTYPE_COLUMNHEADERCELL:
// aRetText = OUString( RTL_CONSTASCII_USTRINGPARAM( "COLUMNHEADERCELL description" ) );
break;
case ::svt::BBTYPE_CHECKBOXCELL:
break;
}
return aRetText;
}
// -----------------------------------------------------------------------------
OUString BrowseBox::GetRowDescription( sal_Int32 ) const
{
return OUString();
}
// -----------------------------------------------------------------------------
OUString BrowseBox::GetColumnDescription( sal_uInt16 _nColumn ) const
{
return OUString( GetColumnTitle( GetColumnId( _nColumn ) ) );
}
// -----------------------------------------------------------------------------
void BrowseBox::FillAccessibleStateSet(
::utl::AccessibleStateSetHelper& rStateSet,
::svt::AccessibleBrowseBoxObjType eObjType ) const
{
switch( eObjType )
{
case ::svt::BBTYPE_BROWSEBOX:
case ::svt::BBTYPE_TABLE:
rStateSet.AddState( AccessibleStateType::FOCUSABLE );
if ( HasFocus() )
rStateSet.AddState( AccessibleStateType::FOCUSED );
if ( IsActive() )
rStateSet.AddState( AccessibleStateType::ACTIVE );
if ( GetUpdateMode() )
rStateSet.AddState( AccessibleStateType::EDITABLE );
if ( IsEnabled() )
{
rStateSet.AddState( AccessibleStateType::ENABLED );
rStateSet.AddState( AccessibleStateType::SENSITIVE );
}
if ( IsReallyVisible() )
rStateSet.AddState( AccessibleStateType::VISIBLE );
if ( eObjType == ::svt::BBTYPE_TABLE )
rStateSet.AddState( AccessibleStateType::MANAGES_DESCENDANTS );
break;
case ::svt::BBTYPE_ROWHEADERBAR:
rStateSet.AddState( AccessibleStateType::FOCUSABLE );
rStateSet.AddState( AccessibleStateType::VISIBLE );
if ( GetSelectRowCount() )
rStateSet.AddState( AccessibleStateType::FOCUSED );
rStateSet.AddState( AccessibleStateType::MANAGES_DESCENDANTS );
break;
case ::svt::BBTYPE_COLUMNHEADERBAR:
rStateSet.AddState( AccessibleStateType::FOCUSABLE );
rStateSet.AddState( AccessibleStateType::VISIBLE );
if ( GetSelectColumnCount() )
rStateSet.AddState( AccessibleStateType::FOCUSED );
rStateSet.AddState( AccessibleStateType::MANAGES_DESCENDANTS );
break;
case ::svt::BBTYPE_TABLECELL:
{
sal_Int32 nRow = GetCurRow();
sal_uInt16 nColumn = GetCurColumnId();
if ( IsFieldVisible(nRow,nColumn) )
rStateSet.AddState( AccessibleStateType::VISIBLE );
if ( !IsFrozen( nColumn ) )
rStateSet.AddState( AccessibleStateType::FOCUSABLE );
rStateSet.AddState( AccessibleStateType::TRANSIENT );
}
break;
case ::svt::BBTYPE_ROWHEADERCELL:
case ::svt::BBTYPE_COLUMNHEADERCELL:
case ::svt::BBTYPE_CHECKBOXCELL:
OSL_ENSURE(0,"Illegal call here!");
break;
}
}
// -----------------------------------------------------------------------
void BrowseBox::FillAccessibleStateSetForCell( ::utl::AccessibleStateSetHelper& _rStateSet,
sal_Int32 _nRow, sal_uInt16 _nColumnPos ) const
{
//! TODO check if the state is valid for table cells
if ( IsCellVisible( _nRow, _nColumnPos ) )
_rStateSet.AddState( AccessibleStateType::VISIBLE );
if ( GetCurrRow() == _nRow && GetCurrColumn() == _nColumnPos )
_rStateSet.AddState( AccessibleStateType::FOCUSED );
else // only transient when column is not focused
_rStateSet.AddState( AccessibleStateType::TRANSIENT );
}
// -----------------------------------------------------------------------------
void BrowseBox::GrabTableFocus()
{
GrabFocus();
}
// -----------------------------------------------------------------------------
String BrowseBox::GetCellText(long, sal_uInt16 ) const
{
DBG_ASSERT(0,"This method has to be implemented by the derived classes! BUG!!");
return String();
}
// -----------------------------------------------------------------------------
void BrowseBox::commitHeaderBarEvent(sal_Int16 nEventId,
const Any& rNewValue, const Any& rOldValue, sal_Bool _bColumnHeaderBar )
{
if ( isAccessibleAlive() )
m_pImpl->m_pAccessible->commitHeaderBarEvent( nEventId,
rNewValue, rOldValue, _bColumnHeaderBar );
}
// -----------------------------------------------------------------------------
void BrowseBox::commitTableEvent( sal_Int16 _nEventId, const Any& _rNewValue, const Any& _rOldValue )
{
if ( isAccessibleAlive() )
m_pImpl->m_pAccessible->commitTableEvent( _nEventId, _rNewValue, _rOldValue );
}
// -----------------------------------------------------------------------------
void BrowseBox::commitBrowseBoxEvent( sal_Int16 _nEventId, const Any& _rNewValue, const Any& _rOldValue )
{
if ( isAccessibleAlive() )
m_pImpl->m_pAccessible->commitEvent( _nEventId, _rNewValue, _rOldValue);
}
// -----------------------------------------------------------------------------
::svt::IAccessibleFactory& BrowseBox::getAccessibleFactory()
{
return m_pImpl->m_aFactoryAccess.getFactory();
}
// -----------------------------------------------------------------------------
sal_Bool BrowseBox::isAccessibleAlive( ) const
{
return ( NULL != m_pImpl->m_pAccessible ) && m_pImpl->m_pAccessible->isAlive();
}
// -----------------------------------------------------------------------------
// IAccessibleTableProvider
// -----------------------------------------------------------------------------
sal_Int32 BrowseBox::GetCurrRow() const
{
return GetCurRow();
}
// -----------------------------------------------------------------------------
sal_uInt16 BrowseBox::GetCurrColumn() const
{
return GetColumnPos( GetCurColumnId() );
}
// -----------------------------------------------------------------------------
sal_Bool BrowseBox::HasRowHeader() const
{
return ( GetColumnId( 0 ) == 0 ); // HandleColumn == RowHeader
}
// -----------------------------------------------------------------------------
sal_Bool BrowseBox::IsCellFocusable() const
{
return sal_True;
}
// -----------------------------------------------------------------------------
sal_Bool BrowseBox::GoToCell( sal_Int32 _nRow, sal_uInt16 _nColumn )
{
return GoToRowColumnId( _nRow, GetColumnId( _nColumn ) );
}
// -----------------------------------------------------------------------------
void BrowseBox::SelectColumn( sal_uInt16 _nColumn, sal_Bool _bSelect )
{
SelectColumnPos( _nColumn, _bSelect );
}
// -----------------------------------------------------------------------------
sal_Bool BrowseBox::IsColumnSelected( long _nColumn ) const
{
return ( pColSel && (0 <= _nColumn) && (_nColumn <= 0xFFF) ) ?
pColSel->IsSelected( static_cast< sal_uInt16 >( _nColumn ) ) :
sal_False;
}
// -----------------------------------------------------------------------------
sal_Int32 BrowseBox::GetSelectedRowCount() const
{
return GetSelectRowCount();
}
// -----------------------------------------------------------------------------
sal_Int32 BrowseBox::GetSelectedColumnCount() const
{
const MultiSelection* pColumnSel = GetColumnSelection();
return pColumnSel ? pColumnSel->GetSelectCount() : 0;
}
// -----------------------------------------------------------------------------
void BrowseBox::GetAllSelectedRows( ::com::sun::star::uno::Sequence< sal_Int32 >& _rRows ) const
{
sal_Int32 nCount = GetSelectRowCount();
if( nCount )
{
_rRows.realloc( nCount );
_rRows[ 0 ] = const_cast< BrowseBox* >( this )->FirstSelectedRow();
for( sal_Int32 nIndex = 1; nIndex < nCount; ++nIndex )
_rRows[ nIndex ] = const_cast< BrowseBox* >( this )->NextSelectedRow();
DBG_ASSERT( const_cast< BrowseBox* >( this )->NextSelectedRow() == BROWSER_ENDOFSELECTION,
"BrowseBox::GetAllSelectedRows - too many selected rows found" );
}
}
// -----------------------------------------------------------------------------
void BrowseBox::GetAllSelectedColumns( ::com::sun::star::uno::Sequence< sal_Int32 >& _rColumns ) const
{
const MultiSelection* pColumnSel = GetColumnSelection();
sal_Int32 nCount = GetSelectedColumnCount();
if( pColumnSel && nCount )
{
_rColumns.realloc( nCount );
sal_Int32 nIndex = 0;
sal_uInt32 nRangeCount = pColumnSel->GetRangeCount();
for( sal_uInt32 nRange = 0; nRange < nRangeCount; ++nRange )
{
const Range& rRange = pColumnSel->GetRange( nRange );
// loop has to include aRange.Max()
for( sal_Int32 nCol = rRange.Min(); nCol <= rRange.Max(); ++nCol )
{
DBG_ASSERT( nIndex < nCount,
"GetAllSelectedColumns - range overflow" );
_rColumns[ nIndex ] = nCol;
++nIndex;
}
}
}
}
// -----------------------------------------------------------------------------
sal_Bool BrowseBox::IsCellVisible( sal_Int32 _nRow, sal_uInt16 _nColumnPos ) const
{
return IsFieldVisible( _nRow, GetColumnId( _nColumnPos ) );
}
// -----------------------------------------------------------------------------
String BrowseBox::GetAccessibleCellText(long _nRow, sal_uInt16 _nColPos) const
{
return GetCellText( _nRow, GetColumnId( _nColPos ) );
}
// -----------------------------------------------------------------------------
sal_Bool BrowseBox::GetGlyphBoundRects( const Point& rOrigin, const String& rStr, int nIndex, int nLen, int nBase, MetricVector& rVector )
{
return Control::GetGlyphBoundRects( rOrigin, rStr, nIndex, nLen, nBase, rVector );
}
// -----------------------------------------------------------------------------
Rectangle BrowseBox::GetWindowExtentsRelative( Window *pRelativeWindow ) const
{
return Control::GetWindowExtentsRelative( pRelativeWindow );
}
// -----------------------------------------------------------------------------
void BrowseBox::GrabFocus()
{
Control::GrabFocus();
}
// -----------------------------------------------------------------------------
Reference< XAccessible > BrowseBox::GetAccessible( sal_Bool bCreate )
{
return Control::GetAccessible( bCreate );
}
// -----------------------------------------------------------------------------
Window* BrowseBox::GetAccessibleParentWindow() const
{
return Control::GetAccessibleParentWindow();
}
// -----------------------------------------------------------------------------
Window* BrowseBox::GetWindowInstance()
{
return this;
}