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 ACCESSIBILITY_EXT_ACCESSIBLELISTBOXENTRY_HXX_ 25 #define ACCESSIBILITY_EXT_ACCESSIBLELISTBOXENTRY_HXX_ 26 27 #include <deque> 28 #include <com/sun/star/accessibility/XAccessible.hpp> 29 #include <com/sun/star/accessibility/XAccessibleComponent.hpp> 30 #include <com/sun/star/accessibility/XAccessibleContext.hpp> 31 #include <com/sun/star/accessibility/XAccessibleStateSet.hpp> 32 #include <com/sun/star/accessibility/XAccessibleEventBroadcaster.hpp> 33 #include <com/sun/star/accessibility/XAccessibleAction.hpp> 34 #include <com/sun/star/accessibility/XAccessibleSelection.hpp> 35 #include <com/sun/star/lang/DisposedException.hpp> 36 #include <com/sun/star/lang/XEventListener.hpp> 37 #include <com/sun/star/lang/XServiceInfo.hpp> 38 #include <cppuhelper/compbase8.hxx> 39 #include <comphelper/broadcasthelper.hxx> 40 #include <comphelper/accessibletexthelper.hxx> 41 #include <tools/gen.hxx> 42 #include "accessibility/extended/listboxaccessible.hxx" 43 44 // forward --------------------------------------------------------------- 45 46 namespace com { namespace sun { namespace star { namespace awt { 47 struct Point; 48 struct Rectangle; 49 struct Size; 50 class XFocusListener; 51 } } } } 52 53 class SvTreeListBox; 54 class SvLBoxEntry; 55 56 //........................................................................ 57 namespace accessibility 58 { 59 //........................................................................ 60 61 // class AccessibleListBoxEntry ------------------------------------------ 62 63 typedef ::cppu::WeakAggComponentImplHelper8< ::com::sun::star::accessibility::XAccessible 64 , ::com::sun::star::accessibility::XAccessibleContext 65 , ::com::sun::star::accessibility::XAccessibleComponent 66 , ::com::sun::star::accessibility::XAccessibleEventBroadcaster 67 , ::com::sun::star::accessibility::XAccessibleAction 68 , ::com::sun::star::accessibility::XAccessibleSelection 69 , ::com::sun::star::accessibility::XAccessibleText 70 , ::com::sun::star::lang::XServiceInfo > AccessibleListBoxEntry_BASE; 71 72 /** the class AccessibleListBoxEntry represents the class for an accessible object of a listbox entry */ 73 class AccessibleListBoxEntry:public ::comphelper::OBaseMutex 74 ,public AccessibleListBoxEntry_BASE 75 ,public ::comphelper::OCommonAccessibleText 76 ,public ListBoxAccessibleBase 77 { 78 friend class AccessibleListBox; 79 80 private: 81 /** The treelistbox control */ 82 SvTreeListBox* m_pListBox; 83 ::std::deque< sal_Int32 > m_aEntryPath; 84 85 protected: 86 /// client id in the AccessibleEventNotifier queue 87 sal_uInt32 m_nClientId; 88 89 ::com::sun::star::uno::WeakReference< ::com::sun::star::accessibility::XAccessible > 90 m_aParent; 91 92 private: 93 Rectangle GetBoundingBox_Impl() const; 94 Rectangle GetBoundingBoxOnScreen_Impl() const; 95 sal_Bool IsAlive_Impl() const; 96 sal_Bool IsShowing_Impl() const; 97 98 Rectangle GetBoundingBox() throw ( ::com::sun::star::lang::DisposedException ); 99 Rectangle GetBoundingBoxOnScreen() throw ( ::com::sun::star::lang::DisposedException ); 100 void EnsureIsAlive() const throw ( ::com::sun::star::lang::DisposedException ); 101 102 protected: 103 virtual ~AccessibleListBoxEntry(); 104 105 /** this function is called upon disposing the component 106 */ 107 virtual void SAL_CALL disposing(); 108 109 // ListBoxAccessible/XComponent 110 virtual void SAL_CALL dispose() throw ( ::com::sun::star::uno::RuntimeException ); 111 112 // OCommonAccessibleText 113 virtual ::rtl::OUString implGetText(); 114 virtual ::com::sun::star::lang::Locale implGetLocale(); 115 virtual void implGetSelection( sal_Int32& nStartIndex, sal_Int32& nEndIndex ); 116 117 public: 118 /** Ctor() 119 @param _rListBox 120 the view control 121 @param _pEntry 122 the entry 123 @param _xParent 124 is our parent accessible object 125 */ 126 AccessibleListBoxEntry( SvTreeListBox& _rListBox, SvLBoxEntry* _pEntry, 127 const ::com::sun::star::uno::Reference< 128 ::com::sun::star::accessibility::XAccessible >& _xParent ); 129 130 protected: 131 // XTypeProvider 132 virtual ::com::sun::star::uno::Sequence< sal_Int8 > SAL_CALL getImplementationId() throw (::com::sun::star::uno::RuntimeException); 133 134 // XServiceInfo 135 virtual ::rtl::OUString SAL_CALL getImplementationName() throw(com::sun::star::uno::RuntimeException); 136 virtual sal_Bool SAL_CALL supportsService( const ::rtl::OUString& ServiceName ) throw (::com::sun::star::uno::RuntimeException); 137 virtual ::com::sun::star::uno::Sequence< ::rtl::OUString > SAL_CALL getSupportedServiceNames() throw(com::sun::star::uno::RuntimeException); 138 139 // XServiceInfo - static methods 140 static com::sun::star::uno::Sequence< ::rtl::OUString > getSupportedServiceNames_Static(void) throw(com::sun::star::uno::RuntimeException); 141 static ::rtl::OUString getImplementationName_Static(void) throw(com::sun::star::uno::RuntimeException); 142 143 // XAccessible 144 virtual ::com::sun::star::uno::Reference< ::com::sun::star::accessibility::XAccessibleContext > SAL_CALL getAccessibleContext( ) throw (::com::sun::star::uno::RuntimeException); 145 146 // XAccessibleContext 147 virtual sal_Int32 SAL_CALL getAccessibleChildCount( ) throw (::com::sun::star::uno::RuntimeException); 148 virtual ::com::sun::star::uno::Reference< ::com::sun::star::accessibility::XAccessible > SAL_CALL getAccessibleChild( sal_Int32 i ) throw ( ::com::sun::star::lang::IndexOutOfBoundsException, 149 ::com::sun::star::uno::RuntimeException ); 150 virtual ::com::sun::star::uno::Reference< ::com::sun::star::accessibility::XAccessible > SAL_CALL getAccessibleParent( ) throw (::com::sun::star::uno::RuntimeException); 151 virtual sal_Int32 SAL_CALL getAccessibleIndexInParent( ) throw (::com::sun::star::uno::RuntimeException); 152 virtual sal_Int16 SAL_CALL getAccessibleRole( ) throw (::com::sun::star::uno::RuntimeException); 153 virtual ::rtl::OUString SAL_CALL getAccessibleDescription( ) throw (::com::sun::star::uno::RuntimeException); 154 virtual ::rtl::OUString SAL_CALL getAccessibleName( ) throw (::com::sun::star::uno::RuntimeException); 155 virtual ::com::sun::star::uno::Reference< ::com::sun::star::accessibility::XAccessibleRelationSet > SAL_CALL getAccessibleRelationSet( ) throw (::com::sun::star::uno::RuntimeException); 156 virtual ::com::sun::star::uno::Reference< ::com::sun::star::accessibility::XAccessibleStateSet > SAL_CALL getAccessibleStateSet( ) throw (::com::sun::star::uno::RuntimeException); 157 virtual ::com::sun::star::lang::Locale SAL_CALL getLocale( ) throw (::com::sun::star::accessibility::IllegalAccessibleComponentStateException, ::com::sun::star::uno::RuntimeException); 158 159 // XAccessibleComponent 160 virtual sal_Bool SAL_CALL containsPoint( const ::com::sun::star::awt::Point& aPoint ) throw (::com::sun::star::uno::RuntimeException); 161 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); 162 virtual ::com::sun::star::awt::Rectangle SAL_CALL getBounds( ) throw (::com::sun::star::uno::RuntimeException); 163 virtual ::com::sun::star::awt::Point SAL_CALL getLocation( ) throw (::com::sun::star::uno::RuntimeException); 164 virtual ::com::sun::star::awt::Point SAL_CALL getLocationOnScreen( ) throw (::com::sun::star::uno::RuntimeException); 165 virtual ::com::sun::star::awt::Size SAL_CALL getSize( ) throw (::com::sun::star::uno::RuntimeException); 166 virtual void SAL_CALL grabFocus( ) throw (::com::sun::star::uno::RuntimeException); 167 virtual sal_Int32 SAL_CALL getForeground( ) throw (::com::sun::star::uno::RuntimeException); 168 virtual sal_Int32 SAL_CALL getBackground( ) throw (::com::sun::star::uno::RuntimeException); 169 170 // XAccessibleText 171 virtual sal_Int32 SAL_CALL getCaretPosition() throw (::com::sun::star::uno::RuntimeException); 172 virtual sal_Bool SAL_CALL setCaretPosition( sal_Int32 nIndex ) throw (::com::sun::star::lang::IndexOutOfBoundsException, ::com::sun::star::uno::RuntimeException); 173 virtual sal_Unicode SAL_CALL getCharacter( sal_Int32 nIndex ) throw (::com::sun::star::lang::IndexOutOfBoundsException, ::com::sun::star::uno::RuntimeException); 174 virtual ::com::sun::star::uno::Sequence< ::com::sun::star::beans::PropertyValue > SAL_CALL getCharacterAttributes( sal_Int32 nIndex, const ::com::sun::star::uno::Sequence< ::rtl::OUString >& aRequestedAttributes ) throw (::com::sun::star::lang::IndexOutOfBoundsException, ::com::sun::star::uno::RuntimeException); 175 virtual ::com::sun::star::awt::Rectangle SAL_CALL getCharacterBounds( sal_Int32 nIndex ) throw (::com::sun::star::lang::IndexOutOfBoundsException, ::com::sun::star::uno::RuntimeException); 176 virtual sal_Int32 SAL_CALL getCharacterCount() throw (::com::sun::star::uno::RuntimeException); 177 virtual sal_Int32 SAL_CALL getIndexAtPoint( const ::com::sun::star::awt::Point& aPoint ) throw (::com::sun::star::uno::RuntimeException); 178 virtual ::rtl::OUString SAL_CALL getSelectedText() throw (::com::sun::star::uno::RuntimeException); 179 virtual sal_Int32 SAL_CALL getSelectionStart() throw (::com::sun::star::uno::RuntimeException); 180 virtual sal_Int32 SAL_CALL getSelectionEnd() throw (::com::sun::star::uno::RuntimeException); 181 virtual sal_Bool SAL_CALL setSelection( sal_Int32 nStartIndex, sal_Int32 nEndIndex ) throw (::com::sun::star::lang::IndexOutOfBoundsException, ::com::sun::star::uno::RuntimeException); 182 virtual ::rtl::OUString SAL_CALL getText() throw (::com::sun::star::uno::RuntimeException); 183 virtual ::rtl::OUString SAL_CALL getTextRange( sal_Int32 nStartIndex, sal_Int32 nEndIndex ) throw (::com::sun::star::lang::IndexOutOfBoundsException, ::com::sun::star::uno::RuntimeException); 184 virtual ::com::sun::star::accessibility::TextSegment SAL_CALL getTextAtIndex( sal_Int32 nIndex, sal_Int16 aTextType ) throw (::com::sun::star::lang::IndexOutOfBoundsException, ::com::sun::star::lang::IllegalArgumentException, ::com::sun::star::uno::RuntimeException); 185 virtual ::com::sun::star::accessibility::TextSegment SAL_CALL getTextBeforeIndex( sal_Int32 nIndex, sal_Int16 aTextType ) throw (::com::sun::star::lang::IndexOutOfBoundsException, ::com::sun::star::lang::IllegalArgumentException, ::com::sun::star::uno::RuntimeException); 186 virtual ::com::sun::star::accessibility::TextSegment SAL_CALL getTextBehindIndex( sal_Int32 nIndex, sal_Int16 aTextType ) throw (::com::sun::star::lang::IndexOutOfBoundsException, ::com::sun::star::lang::IllegalArgumentException, ::com::sun::star::uno::RuntimeException); 187 virtual sal_Bool SAL_CALL copyText( sal_Int32 nStartIndex, sal_Int32 nEndIndex ) throw (::com::sun::star::lang::IndexOutOfBoundsException, ::com::sun::star::uno::RuntimeException); 188 189 // XAccessibleEventBroadcaster 190 using cppu::WeakAggComponentImplHelperBase::addEventListener; 191 virtual void SAL_CALL addEventListener( const ::com::sun::star::uno::Reference< ::com::sun::star::accessibility::XAccessibleEventListener >& xListener ) throw (::com::sun::star::uno::RuntimeException); 192 using cppu::WeakAggComponentImplHelperBase::removeEventListener; 193 virtual void SAL_CALL removeEventListener( const ::com::sun::star::uno::Reference< ::com::sun::star::accessibility::XAccessibleEventListener >& xListener ) throw (::com::sun::star::uno::RuntimeException); 194 195 // XAccessibleAction 196 virtual sal_Int32 SAL_CALL getAccessibleActionCount( ) throw (::com::sun::star::uno::RuntimeException); 197 virtual sal_Bool SAL_CALL doAccessibleAction( sal_Int32 nIndex ) throw (::com::sun::star::lang::IndexOutOfBoundsException, ::com::sun::star::uno::RuntimeException); 198 virtual ::rtl::OUString SAL_CALL getAccessibleActionDescription( sal_Int32 nIndex ) throw (::com::sun::star::lang::IndexOutOfBoundsException, ::com::sun::star::uno::RuntimeException); 199 virtual ::com::sun::star::uno::Reference< ::com::sun::star::accessibility::XAccessibleKeyBinding > SAL_CALL getAccessibleActionKeyBinding( sal_Int32 nIndex ) throw (::com::sun::star::lang::IndexOutOfBoundsException, ::com::sun::star::uno::RuntimeException); 200 201 // XAccessibleSelection 202 void SAL_CALL selectAccessibleChild( sal_Int32 nChildIndex ) throw (::com::sun::star::lang::IndexOutOfBoundsException, ::com::sun::star::uno::RuntimeException); 203 sal_Bool SAL_CALL isAccessibleChildSelected( sal_Int32 nChildIndex ) throw (::com::sun::star::lang::IndexOutOfBoundsException, ::com::sun::star::uno::RuntimeException); 204 void SAL_CALL clearAccessibleSelection( ) throw (::com::sun::star::uno::RuntimeException); 205 void SAL_CALL selectAllAccessibleChildren( ) throw (::com::sun::star::uno::RuntimeException); 206 sal_Int32 SAL_CALL getSelectedAccessibleChildCount( ) throw (::com::sun::star::uno::RuntimeException); 207 ::com::sun::star::uno::Reference< ::com::sun::star::accessibility::XAccessible > SAL_CALL getSelectedAccessibleChild( sal_Int32 nSelectedChildIndex ) throw (::com::sun::star::lang::IndexOutOfBoundsException, ::com::sun::star::uno::RuntimeException); 208 void SAL_CALL deselectAccessibleChild( sal_Int32 nSelectedChildIndex ) throw (::com::sun::star::lang::IndexOutOfBoundsException, ::com::sun::star::uno::RuntimeException); 209 210 private: 211 ::com::sun::star::uno::Reference< ::com::sun::star::accessibility::XAccessible > implGetParentAccessible( ) const; 212 }; 213 214 //........................................................................ 215 }// namespace accessibility 216 //........................................................................ 217 218 #endif // ACCESSIBILITY_EXT_ACCESSIBLELISTBOXENTRY_HXX_ 219 220