xref: /trunk/main/sc/inc/AccessibleFilterMenu.hxx (revision 45c5a00162811bd03b87fcb4fe9996782f2b59ec)
1 /**************************************************************
2  *
3  * Licensed to the Apache Software Foundation (ASF) under one
4  * or more contributor license agreements.  See the NOTICE file
5  * distributed with this work for additional information
6  * regarding copyright ownership.  The ASF licenses this file
7  * to you under the Apache License, Version 2.0 (the
8  * "License"); you may not use this file except in compliance
9  * with the License.  You may obtain a copy of the License at
10  *
11  *   http://www.apache.org/licenses/LICENSE-2.0
12  *
13  * Unless required by applicable law or agreed to in writing,
14  * software distributed under the License is distributed on an
15  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16  * KIND, either express or implied.  See the License for the
17  * specific language governing permissions and limitations
18  * under the License.
19  *
20  *************************************************************/
21 
22 
23 
24 #ifndef SC_ACCESSIBLEFILTERMENU_HXX
25 #define SC_ACCESSIBLEFILTERMENU_HXX
26 
27 #include "AccessibleContextBase.hxx"
28 #include "cppuhelper/implbase1.hxx"
29 
30 #include <com/sun/star/accessibility/XAccessibleSelection.hpp>
31 #include <com/sun/star/accessibility/XAccessibleText.hpp>
32 #include <com/sun/star/accessibility/XAccessibleTextAttributes.hpp>
33 #include <com/sun/star/accessibility/TextSegment.hpp>
34 
35 #include <vector>
36 
37 namespace com { namespace sun { namespace star {
38     namespace accessibility {
39         struct AccessibleEventObject;
40     }
41 }}}
42 
43 class ScDocument;
44 class ScMenuFloatingWindow;
45 
46 typedef ::cppu::ImplHelper1<
47         ::com::sun::star::accessibility::XAccessibleSelection > ScAccessibleFilterMenu_BASE;
48 
49 class ScAccessibleFilterMenu :
50     public ScAccessibleContextBase,
51     public ScAccessibleFilterMenu_BASE
52 {
53 public:
54     explicit ScAccessibleFilterMenu(
55         const ::com::sun::star::uno::Reference<
56             ::com::sun::star::accessibility::XAccessible>& rxParent,
57             ScMenuFloatingWindow* pWin, const ::rtl::OUString& rName, size_t nMenuPos, ScDocument* pDoc);
58     virtual ~ScAccessibleFilterMenu();
59 
60     // XAccessibleComponent
61 
62     virtual ::com::sun::star::uno::Reference< ::com::sun::star::accessibility::XAccessible >
63         SAL_CALL getAccessibleAtPoint( const ::com::sun::star::awt::Point& rPoint );
64 
65     virtual sal_Bool SAL_CALL isVisible();
66 
67     virtual void SAL_CALL grabFocus();
68 
69     virtual sal_Int32 SAL_CALL getForeground();
70 
71     virtual sal_Int32 SAL_CALL getBackground();
72 
73     // XAccessibleContext
74 
75     virtual ::rtl::OUString SAL_CALL getAccessibleName();
76 
77     virtual sal_Int32 SAL_CALL getAccessibleChildCount();
78 
79     virtual ::com::sun::star::uno::Reference< ::com::sun::star::accessibility::XAccessible> SAL_CALL
80         getAccessibleChild(sal_Int32 nIndex);
81 
82     virtual ::com::sun::star::uno::Reference<
83         ::com::sun::star::accessibility::XAccessibleStateSet> SAL_CALL
84         getAccessibleStateSet();
85 
86     virtual ::rtl::OUString SAL_CALL getImplementationName();
87 
88     // XAccessibleEventBroadcaster
89 
90     using ScAccessibleContextBase::addEventListener;
91     using ScAccessibleContextBase::removeEventListener;
92 
93     virtual void SAL_CALL
94         addEventListener(
95             const ::com::sun::star::uno::Reference<
96                 ::com::sun::star::accessibility::XAccessibleEventListener>& xListener);
97 
98     //  Remove an existing event listener.
99     virtual void SAL_CALL
100         removeEventListener(
101             const ::com::sun::star::uno::Reference<
102                 ::com::sun::star::accessibility::XAccessibleEventListener>& xListener);
103 
104     // XAccessibleSelection
105 
106     virtual void SAL_CALL selectAccessibleChild(sal_Int32 nChildIndex);
107 
108     virtual sal_Bool SAL_CALL isAccessibleChildSelected(sal_Int32 nChildIndex);
109 
110     virtual void SAL_CALL clearAccessibleSelection();
111 
112     virtual void SAL_CALL selectAllAccessibleChildren();
113 
114     virtual ::sal_Int32 SAL_CALL getSelectedAccessibleChildCount();
115 
116     virtual ::com::sun::star::uno::Reference< ::com::sun::star::accessibility::XAccessible > SAL_CALL
117         getSelectedAccessibleChild(sal_Int32 nChildIndex);
118 
119     virtual void SAL_CALL deselectAccessibleChild(sal_Int32 nChildIndex);
120 
121     // XInterface
122 
123     virtual ::com::sun::star::uno::Any SAL_CALL queryInterface(
124         ::com::sun::star::uno::Type const & rType );
125 
126     virtual void SAL_CALL acquire() throw ();
127     virtual void SAL_CALL release() throw ();
128 
129     // XTypeProvider
130 
131     virtual ::com::sun::star::uno::Sequence<sal_Int8> SAL_CALL getImplementationId();
132 
133     // non-UNO methods
134 
135     void appendMenuItem(const ::rtl::OUString& rName, bool bEnabled, size_t nMenuPos);
136     void setMenuPos(size_t nMenuPos);
137     void setEnabled(bool bEnabled);
138 
139 protected:
140 
141     sal_Int32 getMenuItemCount() const;
142 
143     virtual Rectangle GetBoundingBoxOnScreen() const;
144 
145     virtual Rectangle GetBoundingBox() const;
146 
147 private:
148     bool isSelected() const;
149     bool isFocused() const;
150 
151     void updateStates();
152 
153 private:
154     ::std::vector< ::com::sun::star::uno::Reference< ::com::sun::star::accessibility::XAccessible > > maMenuItems;
155     ::com::sun::star::uno::Reference< ::com::sun::star::accessibility::XAccessibleStateSet > mxStateSet;
156 
157     size_t mnMenuPos;
158     ScMenuFloatingWindow* mpWindow;
159     ScDocument* mpDoc;
160 
161     bool mbEnabled:1;
162 };
163 
164 #endif
165