sc/inc/AccessibleFilterMenu.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: AccessibleDataPilotControl.hxx,v $
  10  * $Revision: 1.6 $
  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 #ifndef SC_ACCESSIBLEFILTERMENU_HXX
  32 #define SC_ACCESSIBLEFILTERMENU_HXX
  33
  34 #include "AccessibleContextBase.hxx"
  35 #include "cppuhelper/implbase1.hxx"
  36
  37 #include <com/sun/star/accessibility/XAccessibleSelection.hpp>
  38 #include <com/sun/star/accessibility/XAccessibleText.hpp>
  39 #include <com/sun/star/accessibility/XAccessibleTextAttributes.hpp>
  40 #include <com/sun/star/accessibility/TextSegment.hpp>
  41
  42 #include <vector>
  43
  44 namespace com { namespace sun { namespace star {
  45     namespace accessibility {
  46         struct AccessibleEventObject;
  47     }
  48 }}}
  49
  50 class ScDocument;
  51 class ScMenuFloatingWindow;
  52
  53 typedef ::cppu::ImplHelper1<
  54         ::com::sun::star::accessibility::XAccessibleSelection > ScAccessibleFilterMenu_BASE;
  55
  56 class ScAccessibleFilterMenu :
  57     public ScAccessibleContextBase,
  58     public ScAccessibleFilterMenu_BASE
  59 {
  60 public:
  61     explicit ScAccessibleFilterMenu(
  62         const ::com::sun::star::uno::Reference<
  63             ::com::sun::star::accessibility::XAccessible>& rxParent,
  64             ScMenuFloatingWindow* pWin, const ::rtl::OUString& rName, size_t nMenuPos, ScDocument* pDoc);
  65     virtual ~ScAccessibleFilterMenu();
  66
  67         // XAccessibleComponent
  68
  69     virtual ::com::sun::star::uno::Reference< ::com::sun::star::accessibility::XAccessible >
  70                 SAL_CALL getAccessibleAtPoint( const ::com::sun::star::awt::Point& rPoint )
  71                     throw (::com::sun::star::uno::RuntimeException);
  72
  73     virtual sal_Bool SAL_CALL isVisible()
  74                 throw (::com::sun::star::uno::RuntimeException);
  75
  76     virtual void SAL_CALL grabFocus()
  77                 throw (::com::sun::star::uno::RuntimeException);
  78
  79     virtual sal_Int32 SAL_CALL getForeground()
  80         throw (::com::sun::star::uno::RuntimeException);
  81
  82     virtual sal_Int32 SAL_CALL getBackground()
  83         throw (::com::sun::star::uno::RuntimeException);
  84
  85         // XAccessibleContext
  86
  87         virtual ::rtl::OUString SAL_CALL getAccessibleName()
  88         throw (::com::sun::star::uno::RuntimeException);
  89
  90     virtual sal_Int32 SAL_CALL getAccessibleChildCount()
  91         throw (::com::sun::star::uno::RuntimeException);
  92
  93     virtual ::com::sun::star::uno::Reference< ::com::sun::star::accessibility::XAccessible> SAL_CALL
  94         getAccessibleChild(sal_Int32 nIndex)
  95             throw (::com::sun::star::uno::RuntimeException, ::com::sun::star::lang::IndexOutOfBoundsException);
  96
  97         virtual ::com::sun::star::uno::Reference<
  98         ::com::sun::star::accessibility::XAccessibleStateSet> SAL_CALL
  99         getAccessibleStateSet()
 100             throw (::com::sun::star::uno::RuntimeException);
 101
 102         virtual ::rtl::OUString SAL_CALL getImplementationName()
 103         throw (::com::sun::star::uno::RuntimeException);
 104
 105     // XAccessibleEventBroadcaster
 106
 107         virtual void SAL_CALL
 108         addEventListener(
 109                 const ::com::sun::star::uno::Reference<
 110                 ::com::sun::star::accessibility::XAccessibleEventListener>& xListener)
 111         throw (com::sun::star::uno::RuntimeException);
 112
 113     //  Remove an existing event listener.
 114         virtual void SAL_CALL
 115         removeEventListener(
 116                         const ::com::sun::star::uno::Reference<
 117                 ::com::sun::star::accessibility::XAccessibleEventListener>& xListener)
 118         throw (com::sun::star::uno::RuntimeException);
 119
 120     // XAccessibleSelection
 121
 122     virtual void SAL_CALL selectAccessibleChild(sal_Int32 nChildIndex)
 123         throw (::com::sun::star::lang::IndexOutOfBoundsException, ::com::sun::star::uno::RuntimeException);
 124
 125     virtual sal_Bool SAL_CALL isAccessibleChildSelected(sal_Int32 nChildIndex)
 126         throw (::com::sun::star::lang::IndexOutOfBoundsException, ::com::sun::star::uno::RuntimeException);
 127
 128     virtual void SAL_CALL clearAccessibleSelection()
 129         throw (::com::sun::star::uno::RuntimeException);
 130
 131     virtual void SAL_CALL selectAllAccessibleChildren()
 132         throw (::com::sun::star::uno::RuntimeException);
 133
 134     virtual ::sal_Int32 SAL_CALL getSelectedAccessibleChildCount()
 135         throw (::com::sun::star::uno::RuntimeException);
 136
 137     virtual ::com::sun::star::uno::Reference< ::com::sun::star::accessibility::XAccessible > SAL_CALL
 138         getSelectedAccessibleChild(sal_Int32 nChildIndex)
 139             throw (::com::sun::star::lang::IndexOutOfBoundsException, ::com::sun::star::uno::RuntimeException);
 140
 141     virtual void SAL_CALL deselectAccessibleChild(sal_Int32 nChildIndex)
 142         throw (::com::sun::star::lang::IndexOutOfBoundsException, ::com::sun::star::uno::RuntimeException);
 143
 144     // XInterface
 145
 146         virtual ::com::sun::star::uno::Any SAL_CALL queryInterface(
 147                 ::com::sun::star::uno::Type const & rType )
 148                     throw (::com::sun::star::uno::RuntimeException);
 149
 150         virtual void SAL_CALL acquire() throw ();
 151         virtual void SAL_CALL release() throw ();
 152
 153     // XTypeProvider
 154
 155     virtual ::com::sun::star::uno::Sequence<sal_Int8> SAL_CALL getImplementationId()
 156         throw (::com::sun::star::uno::RuntimeException);
 157
 158     // non-UNO methods
 159
 160     void appendMenuItem(const ::rtl::OUString& rName, bool bEnabled, size_t nMenuPos);
 161     void setMenuPos(size_t nMenuPos);
 162     void setEnabled(bool bEnabled);
 163
 164 protected:
 165
 166     sal_Int32 getMenuItemCount() const;
 167
 168         virtual Rectangle GetBoundingBoxOnScreen() const
 169                 throw (::com::sun::star::uno::RuntimeException);
 170
 171         virtual Rectangle GetBoundingBox() const
 172                 throw (::com::sun::star::uno::RuntimeException);
 173
 174 private:
 175     bool isSelected() const;
 176     bool isFocused() const;
 177
 178     void updateStates();
 179
 180 private:
 181     ::std::vector< ::com::sun::star::uno::Reference< ::com::sun::star::accessibility::XAccessible > > maMenuItems;
 182     ::com::sun::star::uno::Reference< ::com::sun::star::accessibility::XAccessibleStateSet > mxStateSet;
 183
 184     size_t mnMenuPos;
 185     ScMenuFloatingWindow* mpWindow;
 186     ScDocument* mpDoc;
 187
 188     bool mbEnabled:1;
 189 };
 190
 191 #endif