LibreOffice Module accessibility (master) 1
vclxaccessibletabpage.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
20#pragma once
21
22#include <com/sun/star/accessibility/AccessibleScrollType.hpp>
23#include <com/sun/star/accessibility/XAccessible.hpp>
24#include <com/sun/star/lang/XServiceInfo.hpp>
27#include <vcl/vclptr.hxx>
28
29
30class TabControl;
31
32
33
35
36class VCLXAccessibleTabPage final : public cppu::ImplInheritanceHelper<
37 AccessibleTextHelper_BASE,
38 css::accessibility::XAccessible,
39 css::lang::XServiceInfo>
40{
42
43private:
45 sal_uInt16 m_nPageId;
48 OUString m_sPageText;
49
51
52 bool IsFocused() const;
53 bool IsSelected() const;
54
55 void SetFocused( bool bFocused );
56 void SetSelected( bool bSelected );
57 void SetPageText( const OUString& sPageText );
58 OUString GetPageText();
59
60 void Update( bool bNew );
61
62 sal_uInt16 GetPageId() const { return m_nPageId; }
63
64 void FillAccessibleStateSet( sal_Int64& rStateSet );
65
66 // OCommonAccessibleComponent
67 virtual css::awt::Rectangle implGetBounds( ) override;
68
69 // OCommonAccessibleText
70 virtual OUString implGetText() override;
71 virtual css::lang::Locale implGetLocale() override;
72 virtual void implGetSelection( sal_Int32& nStartIndex, sal_Int32& nEndIndex ) override;
73
74 // XComponent
75 virtual void SAL_CALL disposing() override;
76
77public:
78 VCLXAccessibleTabPage( TabControl* pTabControl, sal_uInt16 nPageId );
79 virtual ~VCLXAccessibleTabPage() override;
80
81 // XServiceInfo
82 virtual OUString SAL_CALL getImplementationName() override;
83 virtual sal_Bool SAL_CALL supportsService( const OUString& rServiceName ) override;
84 virtual css::uno::Sequence< OUString > SAL_CALL getSupportedServiceNames() override;
85
86 // XAccessible
87 virtual css::uno::Reference< css::accessibility::XAccessibleContext > SAL_CALL getAccessibleContext( ) override;
88
89 // XAccessibleContext
90 virtual sal_Int64 SAL_CALL getAccessibleChildCount( ) override;
91 virtual css::uno::Reference< css::accessibility::XAccessible > SAL_CALL getAccessibleChild( sal_Int64 i ) override;
92 virtual css::uno::Reference< css::accessibility::XAccessible > SAL_CALL getAccessibleParent( ) override;
93 virtual sal_Int64 SAL_CALL getAccessibleIndexInParent( ) override;
94 virtual sal_Int16 SAL_CALL getAccessibleRole( ) override;
95 virtual OUString SAL_CALL getAccessibleDescription( ) override;
96 virtual OUString SAL_CALL getAccessibleName( ) override;
97 virtual css::uno::Reference< css::accessibility::XAccessibleRelationSet > SAL_CALL getAccessibleRelationSet( ) override;
98 virtual sal_Int64 SAL_CALL getAccessibleStateSet( ) override;
99 virtual css::lang::Locale SAL_CALL getLocale( ) override;
100
101 // XAccessibleComponent
102 virtual css::uno::Reference< css::accessibility::XAccessible > SAL_CALL getAccessibleAtPoint( const css::awt::Point& aPoint ) override;
103 virtual void SAL_CALL grabFocus( ) override;
104 virtual sal_Int32 SAL_CALL getForeground( ) override;
105 virtual sal_Int32 SAL_CALL getBackground( ) override;
106
107 // XAccessibleExtendedComponent
108 virtual css::uno::Reference< css::awt::XFont > SAL_CALL getFont( ) override;
109 virtual OUString SAL_CALL getTitledBorderText( ) override;
110 virtual OUString SAL_CALL getToolTipText( ) override;
111
112 // XAccessibleText
113 virtual OUString SAL_CALL getText() override;
114 virtual sal_Unicode SAL_CALL getCharacter( sal_Int32 nIndex ) override;
115 virtual sal_Int32 SAL_CALL getCharacterCount() override;
116 virtual sal_Int32 SAL_CALL getCaretPosition() override;
117 virtual sal_Bool SAL_CALL setCaretPosition( sal_Int32 nIndex ) override;
118 virtual css::uno::Sequence< css::beans::PropertyValue > SAL_CALL getCharacterAttributes( sal_Int32 nIndex, const css::uno::Sequence< OUString >& aRequestedAttributes ) override;
119 virtual css::awt::Rectangle SAL_CALL getCharacterBounds( sal_Int32 nIndex ) override;
120 virtual sal_Int32 SAL_CALL getIndexAtPoint( const css::awt::Point& aPoint ) override;
121 virtual sal_Bool SAL_CALL setSelection( sal_Int32 nStartIndex, sal_Int32 nEndIndex ) override;
122 virtual sal_Bool SAL_CALL copyText( sal_Int32 nStartIndex, sal_Int32 nEndIndex ) override;
123 virtual OUString SAL_CALL getTextRange(sal_Int32 nStartIndex, sal_Int32 nEndIndex) override;
124 virtual sal_Bool SAL_CALL scrollSubstringTo( sal_Int32 nStartIndex, sal_Int32 nEndIndex, css::accessibility::AccessibleScrollType aScrollType) override;
125};
126
127
128/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
virtual css::uno::Sequence< OUString > SAL_CALL getSupportedServiceNames() override
virtual sal_Bool SAL_CALL copyText(sal_Int32 nStartIndex, sal_Int32 nEndIndex) override
VclPtr< TabControl > m_pTabControl
virtual sal_Bool SAL_CALL supportsService(const OUString &rServiceName) override
virtual ~VCLXAccessibleTabPage() override
virtual sal_Int32 SAL_CALL getBackground() override
virtual css::uno::Reference< css::accessibility::XAccessible > SAL_CALL getAccessibleParent() override
virtual OUString SAL_CALL getTitledBorderText() override
void FillAccessibleStateSet(sal_Int64 &rStateSet)
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 sal_Int32 SAL_CALL getCaretPosition() override
virtual sal_Unicode SAL_CALL getCharacter(sal_Int32 nIndex) override
void SetFocused(bool bFocused)
virtual void SAL_CALL grabFocus() override
virtual css::uno::Reference< css::accessibility::XAccessible > SAL_CALL getAccessibleChild(sal_Int64 i) override
virtual sal_Bool SAL_CALL scrollSubstringTo(sal_Int32 nStartIndex, sal_Int32 nEndIndex, css::accessibility::AccessibleScrollType aScrollType) override
virtual css::uno::Sequence< css::beans::PropertyValue > SAL_CALL getCharacterAttributes(sal_Int32 nIndex, const css::uno::Sequence< OUString > &aRequestedAttributes) override
VCLXAccessibleTabPage(TabControl *pTabControl, sal_uInt16 nPageId)
virtual OUString SAL_CALL getImplementationName() override
virtual sal_Int16 SAL_CALL getAccessibleRole() override
virtual css::uno::Reference< css::accessibility::XAccessibleContext > SAL_CALL getAccessibleContext() override
virtual sal_Int32 SAL_CALL getCharacterCount() override
void SetPageText(const OUString &sPageText)
virtual OUString SAL_CALL getTextRange(sal_Int32 nStartIndex, sal_Int32 nEndIndex) override
virtual sal_Int32 SAL_CALL getForeground() override
virtual css::uno::Reference< css::awt::XFont > SAL_CALL getFont() override
virtual OUString SAL_CALL getAccessibleDescription() override
virtual css::awt::Rectangle SAL_CALL getCharacterBounds(sal_Int32 nIndex) override
virtual sal_Int64 SAL_CALL getAccessibleChildCount() override
virtual css::uno::Reference< css::accessibility::XAccessibleRelationSet > SAL_CALL getAccessibleRelationSet() override
void SetSelected(bool bSelected)
virtual OUString SAL_CALL getText() override
virtual css::lang::Locale implGetLocale() override
virtual sal_Int64 SAL_CALL getAccessibleIndexInParent() override
virtual sal_Int32 SAL_CALL getIndexAtPoint(const css::awt::Point &aPoint) override
virtual void SAL_CALL disposing() override
virtual css::lang::Locale SAL_CALL getLocale() override
virtual css::awt::Rectangle implGetBounds() override
virtual OUString SAL_CALL getAccessibleName() override
virtual sal_Bool SAL_CALL setCaretPosition(sal_Int32 nIndex) override
virtual sal_Bool SAL_CALL setSelection(sal_Int32 nStartIndex, sal_Int32 nEndIndex) override
virtual OUString SAL_CALL getToolTipText() override
virtual sal_Int64 SAL_CALL getAccessibleStateSet() override
sal_uInt16 GetPageId() const
virtual OUString implGetText() override
unsigned char sal_Bool
sal_uInt16 sal_Unicode
::comphelper::OAccessibleTextHelper AccessibleTextHelper_BASE