accessibility/source/standard/vclxaccessiblemenu.cxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: vclxaccessiblemenu.cxx,v $
  10  * $Revision: 1.3 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 // MARKER(update_precomp.py): autogen include statement, do not remove
  32 #include "precompiled_accessibility.hxx"
  33
  34 // includes --------------------------------------------------------------
  35 #include <accessibility/standard/vclxaccessiblemenu.hxx>
  36
  37 #include <com/sun/star/accessibility/AccessibleRole.hpp>
  38 #include <vcl/menu.hxx>
  39
  40
  41 using namespace ::com::sun::star;
  42 using namespace ::com::sun::star::lang;
  43 using namespace ::com::sun::star::uno;
  44 using namespace ::com::sun::star::accessibility;
  45 using namespace ::comphelper;
  46
  47
  48 // -----------------------------------------------------------------------------
  49 // VCLXAccessibleMenu
  50 // -----------------------------------------------------------------------------
  51
  52 VCLXAccessibleMenu::VCLXAccessibleMenu( Menu* pParent, sal_uInt16 nItemPos, Menu* pMenu )
  53     :VCLXAccessibleMenuItem( pParent, nItemPos, pMenu )
  54 {
  55 }
  56
  57 // -----------------------------------------------------------------------------
  58
  59 VCLXAccessibleMenu::~VCLXAccessibleMenu()
  60 {
  61 }
  62
  63 // -----------------------------------------------------------------------------
  64
  65 sal_Bool VCLXAccessibleMenu::IsFocused()
  66 {
  67     sal_Bool bFocused = sal_False;
  68
  69     if ( IsHighlighted() && !IsChildHighlighted() )
  70         bFocused = sal_True;
  71
  72     return bFocused;
  73 }
  74
  75 // -----------------------------------------------------------------------------
  76
  77 sal_Bool VCLXAccessibleMenu::IsPopupMenuOpen()
  78 {
  79     sal_Bool bPopupMenuOpen = sal_False;
  80
  81     if ( m_pParent )
  82     {
  83         PopupMenu* pPopupMenu = m_pParent->GetPopupMenu( m_pParent->GetItemId( m_nItemPos ) );
  84         if ( pPopupMenu && pPopupMenu->IsMenuVisible() )
  85             bPopupMenuOpen = sal_True;
  86     }
  87
  88     return bPopupMenuOpen;
  89 }
  90
  91 // -----------------------------------------------------------------------------
  92 // XInterface
  93 // -----------------------------------------------------------------------------
  94
  95 IMPLEMENT_FORWARD_XINTERFACE2( VCLXAccessibleMenu, VCLXAccessibleMenuItem, VCLXAccessibleMenu_BASE )
  96
  97 // -----------------------------------------------------------------------------
  98 // XTypeProvider
  99 // -----------------------------------------------------------------------------
 100
 101 IMPLEMENT_FORWARD_XTYPEPROVIDER2( VCLXAccessibleMenu, VCLXAccessibleMenuItem, VCLXAccessibleMenu_BASE )
 102
 103 // -----------------------------------------------------------------------------
 104 // XServiceInfo
 105 // -----------------------------------------------------------------------------
 106
 107 ::rtl::OUString VCLXAccessibleMenu::getImplementationName() throw (RuntimeException)
 108 {
 109     return ::rtl::OUString::createFromAscii( "com.sun.star.comp.toolkit.AccessibleMenu" );
 110 }
 111
 112 // -----------------------------------------------------------------------------
 113
 114 Sequence< ::rtl::OUString > VCLXAccessibleMenu::getSupportedServiceNames() throw (RuntimeException)
 115 {
 116     Sequence< ::rtl::OUString > aNames(1);
 117     aNames[0] = ::rtl::OUString::createFromAscii( "com.sun.star.awt.AccessibleMenu" );
 118     return aNames;
 119 }
 120
 121 // -----------------------------------------------------------------------------
 122 // XAccessibleContext
 123 // -----------------------------------------------------------------------------
 124
 125 sal_Int32 VCLXAccessibleMenu::getAccessibleChildCount(  ) throw (RuntimeException)
 126 {
 127     OExternalLockGuard aGuard( this );
 128
 129     return GetChildCount();
 130 }
 131
 132 // -----------------------------------------------------------------------------
 133
 134 Reference< XAccessible > VCLXAccessibleMenu::getAccessibleChild( sal_Int32 i ) throw (IndexOutOfBoundsException, RuntimeException)
 135 {
 136     OExternalLockGuard aGuard( this );
 137
 138     if ( i < 0 || i >= GetChildCount() )
 139         throw IndexOutOfBoundsException();
 140
 141     return GetChild( i );
 142 }
 143
 144 // -----------------------------------------------------------------------------
 145
 146 sal_Int16 VCLXAccessibleMenu::getAccessibleRole(  ) throw (RuntimeException)
 147 {
 148     OExternalLockGuard aGuard( this );
 149
 150     return AccessibleRole::MENU;
 151 }
 152
 153 // -----------------------------------------------------------------------------
 154 // XAccessibleComponent
 155 // -----------------------------------------------------------------------------
 156
 157 Reference< XAccessible > VCLXAccessibleMenu::getAccessibleAtPoint( const awt::Point& rPoint ) throw (RuntimeException)
 158 {
 159     OExternalLockGuard aGuard( this );
 160
 161     return GetChildAt( rPoint );
 162 }
 163
 164 // -----------------------------------------------------------------------------
 165 // XAccessibleSelection
 166 // -----------------------------------------------------------------------------
 167
 168 void VCLXAccessibleMenu::selectAccessibleChild( sal_Int32 nChildIndex ) throw (IndexOutOfBoundsException, RuntimeException)
 169 {
 170     OExternalLockGuard aGuard( this );
 171
 172     if ( nChildIndex < 0 || nChildIndex >= GetChildCount() )
 173         throw IndexOutOfBoundsException();
 174
 175     SelectChild( nChildIndex );
 176 }
 177
 178 // -----------------------------------------------------------------------------
 179
 180 sal_Bool VCLXAccessibleMenu::isAccessibleChildSelected( sal_Int32 nChildIndex ) throw (IndexOutOfBoundsException, RuntimeException)
 181 {
 182     OExternalLockGuard aGuard( this );
 183
 184     if ( nChildIndex < 0 || nChildIndex >= GetChildCount() )
 185         throw IndexOutOfBoundsException();
 186
 187     return IsChildSelected( nChildIndex );
 188 }
 189
 190 // -----------------------------------------------------------------------------
 191
 192 void VCLXAccessibleMenu::clearAccessibleSelection(  ) throw (RuntimeException)
 193 {
 194     OExternalLockGuard aGuard( this );
 195
 196     DeSelectAll();
 197 }
 198
 199 // -----------------------------------------------------------------------------
 200
 201 void VCLXAccessibleMenu::selectAllAccessibleChildren(  ) throw (RuntimeException)
 202 {
 203     // This method makes no sense in a menu, and so does nothing.
 204 }
 205
 206 // -----------------------------------------------------------------------------
 207
 208 sal_Int32 VCLXAccessibleMenu::getSelectedAccessibleChildCount(  ) throw (RuntimeException)
 209 {
 210     OExternalLockGuard aGuard( this );
 211
 212     sal_Int32 nRet = 0;
 213
 214     for ( sal_Int32 i = 0, nCount = GetChildCount(); i < nCount; i++ )
 215     {
 216         if ( IsChildSelected( i ) )
 217             ++nRet;
 218     }
 219
 220     return nRet;
 221 }
 222
 223 // -----------------------------------------------------------------------------
 224
 225 Reference< XAccessible > VCLXAccessibleMenu::getSelectedAccessibleChild( sal_Int32 nSelectedChildIndex ) throw (IndexOutOfBoundsException, RuntimeException)
 226 {
 227     OExternalLockGuard aGuard( this );
 228
 229     if ( nSelectedChildIndex < 0 || nSelectedChildIndex >= getSelectedAccessibleChildCount() )
 230         throw IndexOutOfBoundsException();
 231
 232     Reference< XAccessible > xChild;
 233
 234     for ( sal_Int32 i = 0, j = 0, nCount = GetChildCount(); i < nCount; i++ )
 235     {
 236         if ( IsChildSelected( i ) && ( j++ == nSelectedChildIndex ) )
 237         {
 238             xChild = GetChild( i );
 239             break;
 240         }
 241     }
 242
 243     return xChild;
 244 }
 245
 246 // -----------------------------------------------------------------------------
 247
 248 void VCLXAccessibleMenu::deselectAccessibleChild( sal_Int32 nChildIndex ) throw (IndexOutOfBoundsException, RuntimeException)
 249 {
 250     OExternalLockGuard aGuard( this );
 251
 252     if ( nChildIndex < 0 || nChildIndex >= GetChildCount() )
 253         throw IndexOutOfBoundsException();
 254
 255     DeSelectAll();
 256 }
 257
 258 // -----------------------------------------------------------------------------