svx/source/inc/charmapacc.hxx

   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: charmapacc.hxx,v $
  10  * $Revision: 1.8 $
  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 #include <vos/mutex.hxx>
  32 #include <tools/list.hxx>
  33 #include <tools/color.hxx>
  34 #include <tools/string.hxx>
  35 #ifndef _IMAGE_HXX
  36 #include <vcl/image.hxx>
  37 #endif
  38 #include <rtl/uuid.h>
  39 #include <comphelper/accessibleselectionhelper.hxx>
  40 #include <com/sun/star/accessibility/XAccessibleTable.hpp>
  41
  42 #include <vector>
  43 class SvxShowCharSet;
  44
  45 namespace svx
  46 {
  47     typedef     ::cppu::ImplHelper1     <       ::com::sun::star::accessibility::XAccessible
  48                                 >       OAccessibleHelper_Base_2;
  49
  50     class SvxShowCharSetAcc;
  51     /** The class SvxShowCharSetVirtualAcc is used as a virtual class which contains the table and the scrollbar.
  52         In the vcl control, the table and the scrollbar exists in one class. This is not feasible for the accessibility api.
  53     */
  54     class SvxShowCharSetVirtualAcc : public ::comphelper::OAccessibleComponentHelper,
  55                                      public OAccessibleHelper_Base_2
  56     {
  57         SvxShowCharSet*         mpParent; // the vcl control
  58         SvxShowCharSetAcc*      m_pTable; // the table, which holds the characters shown by the vcl control
  59         ::com::sun::star::uno::Reference< ::com::sun::star::accessibility::XAccessible > m_xAcc; // the ref to the table
  60     protected:
  61         virtual ~SvxShowCharSetVirtualAcc();
  62
  63         virtual void SAL_CALL disposing();
  64
  65         virtual ::com::sun::star::awt::Rectangle SAL_CALL implGetBounds(  ) throw (::com::sun::star::uno::RuntimeException);
  66     public:
  67         SvxShowCharSetVirtualAcc( SvxShowCharSet* pParent );
  68
  69         // XInterface
  70         DECLARE_XINTERFACE( )
  71         DECLARE_XTYPEPROVIDER( )
  72
  73         // XAccessibleComponent
  74         virtual void SAL_CALL grabFocus(  ) throw (::com::sun::star::uno::RuntimeException);
  75         virtual ::com::sun::star::uno::Any SAL_CALL getAccessibleKeyBinding(  ) throw (::com::sun::star::uno::RuntimeException);
  76         virtual ::com::sun::star::uno::Reference< ::com::sun::star::accessibility::XAccessible > SAL_CALL getAccessibleAtPoint( const ::com::sun::star::awt::Point& aPoint ) throw (::com::sun::star::uno::RuntimeException);
  77         //OAccessibleContextHelper
  78         // XAccessibleContext - still waiting to be overwritten
  79         virtual sal_Int32 SAL_CALL getAccessibleChildCount(  ) throw (::com::sun::star::uno::RuntimeException);
  80         virtual ::com::sun::star::uno::Reference< ::com::sun::star::accessibility::XAccessible > SAL_CALL getAccessibleChild( sal_Int32 i ) throw (::com::sun::star::lang::IndexOutOfBoundsException, ::com::sun::star::uno::RuntimeException);
  81         virtual ::com::sun::star::uno::Reference< ::com::sun::star::accessibility::XAccessible > SAL_CALL getAccessibleParent(  ) throw (::com::sun::star::uno::RuntimeException);
  82         virtual sal_Int16 SAL_CALL getAccessibleRole(  ) throw (::com::sun::star::uno::RuntimeException);
  83         virtual ::rtl::OUString SAL_CALL getAccessibleDescription(  ) throw (::com::sun::star::uno::RuntimeException);
  84         virtual ::rtl::OUString SAL_CALL getAccessibleName(  ) throw (::com::sun::star::uno::RuntimeException);
  85         virtual ::com::sun::star::uno::Reference< ::com::sun::star::accessibility::XAccessibleRelationSet > SAL_CALL getAccessibleRelationSet(  ) throw (::com::sun::star::uno::RuntimeException);
  86         virtual ::com::sun::star::uno::Reference< ::com::sun::star::accessibility::XAccessibleStateSet > SAL_CALL getAccessibleStateSet(  ) throw (::com::sun::star::uno::RuntimeException);
  87
  88         virtual ::com::sun::star::uno::Reference< ::com::sun::star::accessibility::XAccessibleContext > SAL_CALL getAccessibleContext(  ) throw (::com::sun::star::uno::RuntimeException) { return this; }
  89         virtual sal_Int32 SAL_CALL getForeground(  ) throw (::com::sun::star::uno::RuntimeException);
  90         virtual sal_Int32 SAL_CALL getBackground(  ) throw (::com::sun::star::uno::RuntimeException);
  91
  92
  93         // call the fireEvent method from the table when it exists.
  94         void SAL_CALL fireEvent(
  95                     const sal_Int16 _nEventId,
  96                     const ::com::sun::star::uno::Any& _rOldValue,
  97                     const ::com::sun::star::uno::Any& _rNewValue
  98                 );
  99
 100         // simple access methods
 101         inline SvxShowCharSetAcc*       getTable() const { return m_pTable; }
 102         inline SvxShowCharSet* getCharSetControl() const { return mpParent; }
 103     };
 104
 105
 106     class SvxShowCharSetItemAcc;
 107     // ----------------
 108     // - SvxShowCharSetItem -
 109     // ----------------
 110     /** Simple struct to hold some information about the single items of the table.
 111     */
 112     struct SvxShowCharSetItem
 113     {
 114         SvxShowCharSet&                         mrParent;
 115         USHORT                                          mnId;
 116         XubString                                       maText;
 117         Rectangle                                       maRect;
 118         SvxShowCharSetItemAcc*          m_pItem;
 119         SvxShowCharSetAcc*                      m_pParent;
 120         ::com::sun::star::uno::Reference< ::com::sun::star::accessibility::XAccessible > m_xAcc;
 121
 122         SvxShowCharSetItem( SvxShowCharSet& rParent,SvxShowCharSetAcc*  _pParent,USHORT _nPos );
 123         ~SvxShowCharSetItem();
 124
 125         ::com::sun::star::uno::Reference< ::com::sun::star::accessibility::XAccessible >    GetAccessible();
 126          void                                                                                       ClearAccessible();
 127     };
 128
 129     // -----------------------------------------------------------------------------
 130
 131     typedef     ::cppu::ImplHelper2     <       ::com::sun::star::accessibility::XAccessible,
 132                                     ::com::sun::star::accessibility::XAccessibleTable
 133                                 >       OAccessibleHelper_Base;
 134     // ---------------
 135     // - SvxShowCharSetAcc -
 136     // ---------------
 137     /** The table implemtentation of the vcl control.
 138     */
 139
 140     class SvxShowCharSetAcc : public ::comphelper::OAccessibleSelectionHelper,
 141                               public OAccessibleHelper_Base
 142     {
 143         ::std::vector< ::com::sun::star::uno::Reference< ::com::sun::star::accessibility::XAccessible > > m_aChildren;
 144         SvxShowCharSetVirtualAcc* m_pParent; // the virtual parent
 145     protected:
 146         virtual void SAL_CALL disposing();
 147     public:
 148         SvxShowCharSetAcc( SvxShowCharSetVirtualAcc* _pParent );
 149
 150         DECLARE_XINTERFACE( )
 151         DECLARE_XTYPEPROVIDER( )
 152
 153         // XAccessibleComponent
 154         virtual void SAL_CALL grabFocus(  ) throw (::com::sun::star::uno::RuntimeException);
 155         virtual ::com::sun::star::uno::Any SAL_CALL getAccessibleKeyBinding(  ) throw (::com::sun::star::uno::RuntimeException);
 156         virtual ::com::sun::star::uno::Reference< ::com::sun::star::accessibility::XAccessible > SAL_CALL getAccessibleAtPoint( const ::com::sun::star::awt::Point& aPoint ) throw (::com::sun::star::uno::RuntimeException);
 157
 158         //OAccessibleContextHelper
 159         // XAccessibleContext - still waiting to be overwritten
 160         virtual sal_Int32 SAL_CALL getAccessibleChildCount(  ) throw (::com::sun::star::uno::RuntimeException);
 161         virtual ::com::sun::star::uno::Reference< ::com::sun::star::accessibility::XAccessible > SAL_CALL getAccessibleChild( sal_Int32 i ) throw (::com::sun::star::lang::IndexOutOfBoundsException, ::com::sun::star::uno::RuntimeException);
 162         virtual ::com::sun::star::uno::Reference< ::com::sun::star::accessibility::XAccessible > SAL_CALL getAccessibleParent(  ) throw (::com::sun::star::uno::RuntimeException);
 163         virtual sal_Int16 SAL_CALL getAccessibleRole(  ) throw (::com::sun::star::uno::RuntimeException);
 164         virtual ::rtl::OUString SAL_CALL getAccessibleDescription(  ) throw (::com::sun::star::uno::RuntimeException);
 165         virtual ::rtl::OUString SAL_CALL getAccessibleName(  ) throw (::com::sun::star::uno::RuntimeException);
 166         virtual ::com::sun::star::uno::Reference< ::com::sun::star::accessibility::XAccessibleRelationSet > SAL_CALL getAccessibleRelationSet(  ) throw (::com::sun::star::uno::RuntimeException);
 167         virtual ::com::sun::star::uno::Reference< ::com::sun::star::accessibility::XAccessibleStateSet > SAL_CALL getAccessibleStateSet(  ) throw (::com::sun::star::uno::RuntimeException);
 168
 169         virtual ::com::sun::star::uno::Reference< ::com::sun::star::accessibility::XAccessibleContext > SAL_CALL getAccessibleContext(  ) throw (::com::sun::star::uno::RuntimeException) { return this; }
 170         virtual sal_Int32 SAL_CALL getForeground(  ) throw (::com::sun::star::uno::RuntimeException);
 171         virtual sal_Int32 SAL_CALL getBackground(  ) throw (::com::sun::star::uno::RuntimeException);
 172
 173         // XAccessibleTable
 174         virtual sal_Int32 SAL_CALL getAccessibleRowCount(  ) throw (::com::sun::star::uno::RuntimeException);
 175         virtual sal_Int32 SAL_CALL getAccessibleColumnCount(  ) throw (::com::sun::star::uno::RuntimeException);
 176         virtual ::rtl::OUString SAL_CALL getAccessibleRowDescription( sal_Int32 nRow ) throw (::com::sun::star::lang::IndexOutOfBoundsException, ::com::sun::star::uno::RuntimeException);
 177         virtual ::rtl::OUString SAL_CALL getAccessibleColumnDescription( sal_Int32 nColumn ) throw (::com::sun::star::lang::IndexOutOfBoundsException, ::com::sun::star::uno::RuntimeException);
 178         virtual sal_Int32 SAL_CALL getAccessibleRowExtentAt( sal_Int32 nRow, sal_Int32 nColumn ) throw (::com::sun::star::lang::IndexOutOfBoundsException, ::com::sun::star::uno::RuntimeException);
 179         virtual sal_Int32 SAL_CALL getAccessibleColumnExtentAt( sal_Int32 nRow, sal_Int32 nColumn ) throw (::com::sun::star::lang::IndexOutOfBoundsException, ::com::sun::star::uno::RuntimeException);
 180         virtual ::com::sun::star::uno::Reference< ::com::sun::star::accessibility::XAccessibleTable > SAL_CALL getAccessibleRowHeaders(  ) throw (::com::sun::star::uno::RuntimeException);
 181         virtual ::com::sun::star::uno::Reference< ::com::sun::star::accessibility::XAccessibleTable > SAL_CALL getAccessibleColumnHeaders(  ) throw (::com::sun::star::uno::RuntimeException);
 182         virtual ::com::sun::star::uno::Sequence< sal_Int32 > SAL_CALL getSelectedAccessibleRows(  ) throw (::com::sun::star::uno::RuntimeException);
 183         virtual ::com::sun::star::uno::Sequence< sal_Int32 > SAL_CALL getSelectedAccessibleColumns(  ) throw (::com::sun::star::uno::RuntimeException);
 184         virtual sal_Bool SAL_CALL isAccessibleRowSelected( sal_Int32 nRow ) throw (::com::sun::star::lang::IndexOutOfBoundsException, ::com::sun::star::uno::RuntimeException);
 185         virtual sal_Bool SAL_CALL isAccessibleColumnSelected( sal_Int32 nColumn ) throw (::com::sun::star::lang::IndexOutOfBoundsException, ::com::sun::star::uno::RuntimeException);
 186         virtual ::com::sun::star::uno::Reference< ::com::sun::star::accessibility::XAccessible > SAL_CALL getAccessibleCellAt( sal_Int32 nRow, sal_Int32 nColumn ) throw (::com::sun::star::lang::IndexOutOfBoundsException, ::com::sun::star::uno::RuntimeException);
 187         virtual ::com::sun::star::uno::Reference< ::com::sun::star::accessibility::XAccessible > SAL_CALL getAccessibleCaption(  ) throw (::com::sun::star::uno::RuntimeException);
 188         virtual ::com::sun::star::uno::Reference< ::com::sun::star::accessibility::XAccessible > SAL_CALL getAccessibleSummary(  ) throw (::com::sun::star::uno::RuntimeException);
 189         virtual sal_Bool SAL_CALL isAccessibleSelected( sal_Int32 nRow, sal_Int32 nColumn ) throw (::com::sun::star::lang::IndexOutOfBoundsException, ::com::sun::star::uno::RuntimeException);
 190         virtual sal_Int32 SAL_CALL getAccessibleIndex( sal_Int32 nRow, sal_Int32 nColumn ) throw (::com::sun::star::lang::IndexOutOfBoundsException, ::com::sun::star::uno::RuntimeException);
 191         virtual sal_Int32 SAL_CALL getAccessibleRow( sal_Int32 nChildIndex ) throw (::com::sun::star::lang::IndexOutOfBoundsException, ::com::sun::star::uno::RuntimeException);
 192         virtual sal_Int32 SAL_CALL getAccessibleColumn( sal_Int32 nChildIndex ) throw (::com::sun::star::lang::IndexOutOfBoundsException, ::com::sun::star::uno::RuntimeException);
 193
 194
 195         inline void SAL_CALL fireEvent(
 196                     const sal_Int16 _nEventId,
 197                     const ::com::sun::star::uno::Any& _rOldValue,
 198                     const ::com::sun::star::uno::Any& _rNewValue
 199                 )
 200         {
 201             NotifyAccessibleEvent(_nEventId,_rOldValue,_rNewValue);
 202         }
 203     protected:
 204
 205         virtual ~SvxShowCharSetAcc();
 206
 207         // OCommonAccessibleSelection
 208         // return if the specified child is visible => watch for special ChildIndexes (ACCESSIBLE_SELECTION_CHILD_xxx)
 209         virtual sal_Bool
 210             implIsSelected( sal_Int32 nAccessibleChildIndex )
 211             throw (::com::sun::star::uno::RuntimeException);
 212
 213         // select the specified child => watch for special ChildIndexes (ACCESSIBLE_SELECTION_CHILD_xxx)
 214         virtual void
 215             implSelect( sal_Int32 nAccessibleChildIndex, sal_Bool bSelect )
 216             throw (::com::sun::star::lang::IndexOutOfBoundsException, ::com::sun::star::uno::RuntimeException);
 217
 218         // OCommonAccessibleComponent
 219         /// implements the calculation of the bounding rectangle - still waiting to be overwritten
 220         virtual ::com::sun::star::awt::Rectangle SAL_CALL implGetBounds(  ) throw (::com::sun::star::uno::RuntimeException);
 221     };
 222
 223     // ----------------
 224     // - SvxShowCharSetItemAcc -
 225     // ----------------
 226     /** The child implementation of the table.
 227     */
 228     class SvxShowCharSetItemAcc : public ::comphelper::OAccessibleComponentHelper,
 229                                   public OAccessibleHelper_Base_2
 230     {
 231     private:
 232         SvxShowCharSetItem*     mpParent;
 233     protected:
 234         virtual ~SvxShowCharSetItemAcc();
 235
 236         // OCommonAccessibleComponent
 237         /// implements the calculation of the bounding rectangle - still waiting to be overwritten
 238         virtual ::com::sun::star::awt::Rectangle SAL_CALL implGetBounds(  ) throw (::com::sun::star::uno::RuntimeException);
 239     public:
 240
 241         // XInterface
 242         DECLARE_XINTERFACE( )
 243         DECLARE_XTYPEPROVIDER( )
 244
 245         SvxShowCharSetItemAcc( SvxShowCharSetItem* pParent );
 246
 247         void    ParentDestroyed();
 248
 249         // XAccessibleComponent
 250         virtual void SAL_CALL grabFocus(  ) throw (::com::sun::star::uno::RuntimeException);
 251         virtual ::com::sun::star::uno::Any SAL_CALL getAccessibleKeyBinding(  ) throw (::com::sun::star::uno::RuntimeException);
 252         virtual ::com::sun::star::uno::Reference< ::com::sun::star::accessibility::XAccessible > SAL_CALL getAccessibleAtPoint( const ::com::sun::star::awt::Point& aPoint ) throw (::com::sun::star::uno::RuntimeException);
 253
 254         //OAccessibleContextHelper
 255         // XAccessibleContext - still waiting to be overwritten
 256         virtual sal_Int32 SAL_CALL getAccessibleChildCount(  ) throw (::com::sun::star::uno::RuntimeException);
 257         virtual ::com::sun::star::uno::Reference< ::com::sun::star::accessibility::XAccessible > SAL_CALL getAccessibleChild( sal_Int32 i ) throw (::com::sun::star::lang::IndexOutOfBoundsException, ::com::sun::star::uno::RuntimeException);
 258         virtual ::com::sun::star::uno::Reference< ::com::sun::star::accessibility::XAccessible > SAL_CALL getAccessibleParent(  ) throw (::com::sun::star::uno::RuntimeException);
 259         virtual sal_Int16 SAL_CALL getAccessibleRole(  ) throw (::com::sun::star::uno::RuntimeException);
 260         virtual ::rtl::OUString SAL_CALL getAccessibleDescription(  ) throw (::com::sun::star::uno::RuntimeException);
 261         virtual ::rtl::OUString SAL_CALL getAccessibleName(  ) throw (::com::sun::star::uno::RuntimeException);
 262         virtual ::com::sun::star::uno::Reference< ::com::sun::star::accessibility::XAccessibleRelationSet > SAL_CALL getAccessibleRelationSet(  ) throw (::com::sun::star::uno::RuntimeException);
 263         virtual ::com::sun::star::uno::Reference< ::com::sun::star::accessibility::XAccessibleStateSet > SAL_CALL getAccessibleStateSet(  ) throw (::com::sun::star::uno::RuntimeException);
 264
 265         virtual ::com::sun::star::uno::Reference< ::com::sun::star::accessibility::XAccessibleContext > SAL_CALL getAccessibleContext(  ) throw (::com::sun::star::uno::RuntimeException) { return this; }
 266
 267         virtual sal_Int32 SAL_CALL getForeground(  ) throw (::com::sun::star::uno::RuntimeException) { return mpParent->m_pParent->getForeground(); }
 268         virtual sal_Int32 SAL_CALL getBackground(  ) throw (::com::sun::star::uno::RuntimeException) { return mpParent->m_pParent->getBackground(); }
 269
 270         inline void SAL_CALL fireEvent(
 271                     const sal_Int16 _nEventId,
 272                     const ::com::sun::star::uno::Any& _rOldValue,
 273                     const ::com::sun::star::uno::Any& _rNewValue
 274                 )
 275         {
 276             NotifyAccessibleEvent(_nEventId,_rOldValue,_rNewValue);
 277         }
 278     };
 279 }
 280
 281