LibreOffice Module comphelper (master)  1
accessibleselectionhelper.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 #ifndef INCLUDED_COMPHELPER_ACCESSIBLESELECTIONHELPER_HXX
21 #define INCLUDED_COMPHELPER_ACCESSIBLESELECTIONHELPER_HXX
22 
23 #include <comphelper/uno3.hxx>
25 #include <cppuhelper/implbase1.hxx>
26 #include <com/sun/star/accessibility/XAccessibleSelection.hpp>
28 
29 #define ACCESSIBLE_SELECTION_CHILD_ALL (sal_Int32(-1))
30 #define ACCESSIBLE_SELECTION_CHILD_SELF ((sal_Int32)-2)
31 
32 
33 namespace comphelper
34 {
35 
36 
37  //= OCommonAccessibleSelection
38 
43  {
44  protected:
45 
47 
49 
50  protected:
51 
52  // access to context - still waiting to be overwritten
54  virtual css::uno::Reference< css::accessibility::XAccessibleContext >
55  implGetAccessibleContext() = 0;
56 
57  // return if the specified child is visible => watch for special ChildIndexes (ACCESSIBLE_SELECTION_CHILD_xxx)
59  virtual bool
60  implIsSelected( sal_Int32 nAccessibleChildIndex ) = 0;
61 
62  // select the specified child => watch for special ChildIndexes (ACCESSIBLE_SELECTION_CHILD_xxx)
64  virtual void
65  implSelect( sal_Int32 nAccessibleChildIndex, bool bSelect ) = 0;
66 
67  protected:
68 
74  void selectAccessibleChild( sal_Int32 nChildIndex );
77  bool isAccessibleChildSelected( sal_Int32 nChildIndex );
79  void clearAccessibleSelection( );
81  void selectAllAccessibleChildren( );
83  sal_Int32 getSelectedAccessibleChildCount( );
86  css::uno::Reference< css::accessibility::XAccessible > getSelectedAccessibleChild( sal_Int32 nSelectedChildIndex );
89  void deselectAccessibleChild( sal_Int32 nSelectedChildIndex );
90  };
91 
92 
93  //= OAccessibleSelectionHelper
94 
95 
96  typedef ::cppu::ImplHelper1< css::accessibility::XAccessibleSelection > OAccessibleSelectionHelper_Base;
97 
103  public OAccessibleSelectionHelper_Base
104  {
105  protected:
106 
108 
109  // return ourself here by default
110  virtual css::uno::Reference< css::accessibility::XAccessibleContext > implGetAccessibleContext() override;
111 
112  public:
113 
114  // XInterface
117 
118  // XAccessibleSelection - default implementations
119  virtual void SAL_CALL selectAccessibleChild( sal_Int32 nChildIndex ) override;
120  virtual sal_Bool SAL_CALL isAccessibleChildSelected( sal_Int32 nChildIndex ) override;
121  virtual void SAL_CALL clearAccessibleSelection( ) override;
122  virtual void SAL_CALL selectAllAccessibleChildren( ) override;
123  virtual sal_Int32 SAL_CALL getSelectedAccessibleChildCount( ) override;
124  virtual css::uno::Reference< css::accessibility::XAccessible > SAL_CALL getSelectedAccessibleChild( sal_Int32 nSelectedChildIndex ) override;
125  virtual void SAL_CALL deselectAccessibleChild( sal_Int32 nSelectedChildIndex ) override;
126  };
127 
128 
129 } // namespace comphelper
130 
131 
132 #endif // INCLUDED_COMPHELPER_ACCESSIBLESELECTIONHELPER_HXX
133 
134 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
::cppu::ImplHelper1< css::accessibility::XAccessibleSelection > OAccessibleSelectionHelper_Base
base class encapsulating common functionality for the helper classes implementing the XAccessibleSele...
a helper class for implementing an AccessibleSelection which at the same time supports an XAccessible...
a helper class for implementing an AccessibleContext which at the same time supports an XAccessibleCo...
#define DECLARE_XTYPEPROVIDER()
Definition: uno3.hxx:126
unsigned char sal_Bool
#define COMPHELPER_DLLPUBLIC
#define DECLARE_XINTERFACE()
Definition: uno3.hxx:90