LibreOffice Module accessibility (master) 1
vclxaccessibletoolboxitem.hxx
Go to the documentation of this file.
1/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2/*
3 * This file is part of the LibreOffice project.
4 *
5 * This Source Code Form is subject to the terms of the Mozilla Public
6 * License, v. 2.0. If a copy of the MPL was not distributed with this
7 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
8 *
9 * This file incorporates work covered by the following license notice:
10 *
11 * Licensed to the Apache Software Foundation (ASF) under one or more
12 * contributor license agreements. See the NOTICE file distributed
13 * with this work for additional information regarding copyright
14 * ownership. The ASF licenses this file to you under the Apache
15 * License, Version 2.0 (the "License"); you may not use this file
16 * except in compliance with the License. You may obtain a copy of
17 * the License at http://www.apache.org/licenses/LICENSE-2.0 .
18 */
19#pragma once
20
21#include <com/sun/star/accessibility/AccessibleScrollType.hpp>
22#include <com/sun/star/accessibility/XAccessible.hpp>
23#include <com/sun/star/accessibility/XAccessibleAction.hpp>
24#include <com/sun/star/accessibility/XAccessibleContext.hpp>
25#include <com/sun/star/accessibility/XAccessibleValue.hpp>
26#include <com/sun/star/lang/XServiceInfo.hpp>
29#include <vcl/toolbox.hxx>
30#include <vcl/vclptr.hxx>
31
32
34
35class VCLXAccessibleToolBoxItem final : public cppu::ImplInheritanceHelper<
36 AccessibleTextHelper_BASE,
37 css::accessibility::XAccessible,
38 css::accessibility::XAccessibleAction,
39 css::accessibility::XAccessibleValue,
40 css::lang::XServiceInfo>
41{
42private:
43 OUString m_sOldName;
46 sal_Int16 m_nRole;
51
52 css::uno::Reference< css::accessibility::XAccessible > m_xChild;
53 OUString GetText() const;
54
55public:
56 sal_Int32 getIndexInParent() const { return m_nIndexInParent; }
57 void setIndexInParent( sal_Int32 _nNewIndex ) { m_nIndexInParent = _nNewIndex; }
58
59private:
60 virtual ~VCLXAccessibleToolBoxItem() override;
61
62 virtual void SAL_CALL disposing() override;
63
65 virtual css::awt::Rectangle implGetBounds( ) override;
66
67 // OCommonAccessibleText
68 virtual OUString implGetText() override;
69 virtual css::lang::Locale implGetLocale() override;
70 virtual void implGetSelection( sal_Int32& nStartIndex, sal_Int32& nEndIndex ) override;
71
72public:
73 VCLXAccessibleToolBoxItem( ToolBox* _pToolBox, sal_Int32 _nPos );
74
75 void SetFocus( bool _bFocus );
76 bool HasFocus() const { return m_bHasFocus; }
77 void SetChecked( bool _bCheck );
78 void SetIndeterminate( bool _bIndeterminate );
79 void ReleaseToolBox() { m_pToolBox = nullptr; }
80 void NameChanged();
81 void SetChild( const css::uno::Reference< css::accessibility::XAccessible >& _xChild );
82 const css::uno::Reference< css::accessibility::XAccessible >&
83 GetChild() const { return m_xChild; }
84 void NotifyChildEvent( const css::uno::Reference< css::accessibility::XAccessible >& _xChild, bool _bShow );
85
86 void ToggleEnableState();
87
88 // XInterface
89 css::uno::Any SAL_CALL queryInterface(css::uno::Type const & aType) override;
90
91 // XServiceInfo
92 virtual OUString SAL_CALL getImplementationName() override;
93 virtual sal_Bool SAL_CALL supportsService( const OUString& rServiceName ) override;
94 virtual css::uno::Sequence< OUString > SAL_CALL getSupportedServiceNames() override;
95
96 // XAccessible
97 virtual css::uno::Reference< css::accessibility::XAccessibleContext > SAL_CALL getAccessibleContext( ) override;
98
99 // XAccessibleContext
100 virtual sal_Int64 SAL_CALL getAccessibleChildCount( ) override;
101 virtual css::uno::Reference< css::accessibility::XAccessible > SAL_CALL getAccessibleChild( sal_Int64 i ) override;
102 virtual css::uno::Reference< css::accessibility::XAccessible > SAL_CALL getAccessibleParent( ) override;
103 virtual sal_Int64 SAL_CALL getAccessibleIndexInParent( ) override;
104 virtual sal_Int16 SAL_CALL getAccessibleRole( ) override;
105 virtual OUString SAL_CALL getAccessibleDescription( ) override;
106 virtual OUString SAL_CALL getAccessibleName( ) override;
107 virtual css::uno::Reference< css::accessibility::XAccessibleRelationSet > SAL_CALL getAccessibleRelationSet( ) override;
108 virtual sal_Int64 SAL_CALL getAccessibleStateSet( ) override;
109
110 // XAccessibleText
111 virtual OUString SAL_CALL getText() override;
112 virtual sal_Unicode SAL_CALL getCharacter( sal_Int32 nIndex ) override;
113 virtual sal_Int32 SAL_CALL getCharacterCount() override;
114 virtual sal_Int32 SAL_CALL getCaretPosition() override;
115 virtual sal_Bool SAL_CALL setCaretPosition( sal_Int32 nIndex ) override;
116 virtual css::uno::Sequence< css::beans::PropertyValue > SAL_CALL getCharacterAttributes( sal_Int32 nIndex, const css::uno::Sequence< OUString >& aRequestedAttributes ) override;
117 virtual css::awt::Rectangle SAL_CALL getCharacterBounds( sal_Int32 nIndex ) override;
118 virtual sal_Int32 SAL_CALL getIndexAtPoint( const css::awt::Point& aPoint ) override;
119 virtual sal_Bool SAL_CALL setSelection( sal_Int32 nStartIndex, sal_Int32 nEndIndex ) override;
120 virtual sal_Bool SAL_CALL copyText( sal_Int32 nStartIndex, sal_Int32 nEndIndex ) override;
121 virtual OUString SAL_CALL getTextRange( sal_Int32 nStartIndex, sal_Int32 nEndIndex ) override;
122 virtual sal_Bool SAL_CALL scrollSubstringTo( sal_Int32 nStartIndex, sal_Int32 nEndIndex, css::accessibility::AccessibleScrollType aScrollType) override;
123
124 // XAccessibleComponent
125 virtual css::uno::Reference< css::accessibility::XAccessible > SAL_CALL getAccessibleAtPoint( const css::awt::Point& aPoint ) override;
126 virtual void SAL_CALL grabFocus( ) override;
127 virtual sal_Int32 SAL_CALL getForeground( ) override;
128 virtual sal_Int32 SAL_CALL getBackground( ) override;
129
130 // XAccessibleExtendedComponent
131 virtual css::uno::Reference< css::awt::XFont > SAL_CALL getFont( ) override;
132 virtual OUString SAL_CALL getTitledBorderText( ) override;
133 virtual OUString SAL_CALL getToolTipText( ) override;
134
135 // XAccessibleAction
136 virtual sal_Int32 SAL_CALL getAccessibleActionCount( ) override;
137 virtual sal_Bool SAL_CALL doAccessibleAction ( sal_Int32 nIndex ) override;
138 virtual OUString SAL_CALL getAccessibleActionDescription ( sal_Int32 nIndex ) override;
139 virtual css::uno::Reference< css::accessibility::XAccessibleKeyBinding > SAL_CALL getAccessibleActionKeyBinding( sal_Int32 nIndex ) override;
140
141 // XAccessibleValue
142 virtual css::uno::Any SAL_CALL getCurrentValue( ) override;
143 virtual sal_Bool SAL_CALL setCurrentValue( const css::uno::Any& aNumber ) override;
144 virtual css::uno::Any SAL_CALL getMaximumValue( ) override;
145 virtual css::uno::Any SAL_CALL getMinimumValue( ) override;
146 virtual css::uno::Any SAL_CALL getMinimumIncrement( ) override;
147};
148
149
150/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
virtual css::awt::Rectangle implGetBounds() override
implements the calculation of the bounding rectangle
virtual css::uno::Any SAL_CALL getMinimumIncrement() override
virtual void SAL_CALL grabFocus() override
virtual css::uno::Sequence< css::beans::PropertyValue > SAL_CALL getCharacterAttributes(sal_Int32 nIndex, const css::uno::Sequence< OUString > &aRequestedAttributes) override
VCLXAccessibleToolBoxItem(ToolBox *_pToolBox, sal_Int32 _nPos)
virtual sal_Int64 SAL_CALL getAccessibleChildCount() override
virtual css::uno::Sequence< OUString > SAL_CALL getSupportedServiceNames() override
css::uno::Any SAL_CALL queryInterface(css::uno::Type const &aType) override
virtual sal_Unicode SAL_CALL getCharacter(sal_Int32 nIndex) override
virtual sal_Bool SAL_CALL setCaretPosition(sal_Int32 nIndex) override
void SetIndeterminate(bool _bIndeterminate)
virtual css::uno::Any SAL_CALL getMaximumValue() override
virtual sal_Bool SAL_CALL setCurrentValue(const css::uno::Any &aNumber) override
virtual void SAL_CALL disposing() override
virtual sal_Int32 SAL_CALL getBackground() override
void setIndexInParent(sal_Int32 _nNewIndex)
virtual css::awt::Rectangle SAL_CALL getCharacterBounds(sal_Int32 nIndex) override
virtual css::uno::Reference< css::accessibility::XAccessible > SAL_CALL getAccessibleParent() override
virtual sal_Int32 SAL_CALL getCharacterCount() override
virtual sal_Int32 SAL_CALL getAccessibleActionCount() override
virtual sal_Int32 SAL_CALL getCaretPosition() override
virtual css::lang::Locale implGetLocale() override
virtual css::uno::Reference< css::accessibility::XAccessibleKeyBinding > SAL_CALL getAccessibleActionKeyBinding(sal_Int32 nIndex) override
virtual OUString implGetText() override
virtual OUString SAL_CALL getToolTipText() override
virtual OUString SAL_CALL getAccessibleDescription() override
const css::uno::Reference< css::accessibility::XAccessible > & GetChild() const
virtual sal_Bool SAL_CALL supportsService(const OUString &rServiceName) override
virtual OUString SAL_CALL getAccessibleActionDescription(sal_Int32 nIndex) override
void NotifyChildEvent(const css::uno::Reference< css::accessibility::XAccessible > &_xChild, bool _bShow)
virtual sal_Bool SAL_CALL copyText(sal_Int32 nStartIndex, sal_Int32 nEndIndex) override
virtual css::uno::Reference< css::accessibility::XAccessible > SAL_CALL getAccessibleAtPoint(const css::awt::Point &aPoint) override
virtual void implGetSelection(sal_Int32 &nStartIndex, sal_Int32 &nEndIndex) override
virtual css::uno::Any SAL_CALL getCurrentValue() override
css::uno::Reference< css::accessibility::XAccessible > m_xChild
virtual OUString SAL_CALL getText() override
virtual sal_Int32 SAL_CALL getIndexAtPoint(const css::awt::Point &aPoint) override
virtual OUString SAL_CALL getAccessibleName() override
virtual sal_Bool SAL_CALL setSelection(sal_Int32 nStartIndex, sal_Int32 nEndIndex) override
virtual OUString SAL_CALL getTextRange(sal_Int32 nStartIndex, sal_Int32 nEndIndex) override
virtual sal_Int64 SAL_CALL getAccessibleStateSet() override
virtual css::uno::Reference< css::awt::XFont > SAL_CALL getFont() override
virtual css::uno::Reference< css::accessibility::XAccessibleRelationSet > SAL_CALL getAccessibleRelationSet() override
void SetChild(const css::uno::Reference< css::accessibility::XAccessible > &_xChild)
virtual css::uno::Any SAL_CALL getMinimumValue() override
virtual sal_Int64 SAL_CALL getAccessibleIndexInParent() override
virtual css::uno::Reference< css::accessibility::XAccessible > SAL_CALL getAccessibleChild(sal_Int64 i) override
virtual sal_Bool SAL_CALL doAccessibleAction(sal_Int32 nIndex) override
virtual sal_Int32 SAL_CALL getForeground() override
virtual sal_Int16 SAL_CALL getAccessibleRole() override
virtual OUString SAL_CALL getImplementationName() override
virtual css::uno::Reference< css::accessibility::XAccessibleContext > SAL_CALL getAccessibleContext() override
virtual OUString SAL_CALL getTitledBorderText() override
virtual sal_Bool SAL_CALL scrollSubstringTo(sal_Int32 nStartIndex, sal_Int32 nEndIndex, css::accessibility::AccessibleScrollType aScrollType) override
unsigned char sal_Bool
sal_uInt16 sal_Unicode
::comphelper::OAccessibleTextHelper AccessibleTextHelper_BASE