include/toolkit/helper/accessiblefactory.hxx

   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_TOOLKIT_HELPER_ACCESSIBLEFACTORY_HXX
  21 #define INCLUDED_TOOLKIT_HELPER_ACCESSIBLEFACTORY_HXX
  22
  23 #include <com/sun/star/uno/Reference.hxx>
  24 #include <salhelper/simplereferenceobject.hxx>
  25
  26 namespace com::sun::star::accessibility {
  27     class XAccessible;
  28     class XAccessibleContext;
  29 }
  30
  31 namespace vcl {
  32     class Window;
  33 }
  34
  35 class ComboBox;
  36 class Edit;
  37 class FixedHyperlink;
  38 class FixedText;
  39 class FormattedField;
  40 class HeaderBar;
  41 class ListBox;
  42 class RadioButton;
  43 class ScrollBar;
  44
  45 #include <vcl/toolbox.hxx>
  46 #include <vcl/toolkit/button.hxx>
  47
  48
  49 namespace toolkit
  50 {
  51
  52
  53     /** a function which is able to create a factory for the standard Accessible/Context
  54         components needed for standard VCL controls
  55
  56         The returned pointer denotes an instance of the IAccessibleFactory, which has been acquired
  57         <em>once</em>. The caller is responsible for holding this reference as long as it needs the
  58         factory, and release it afterwards.
  59     */
  60     typedef void* (* GetStandardAccComponentFactory)( );
  61
  62
  63     //= IAccessibleFactory
  64
  65     class IAccessibleFactory : public virtual salhelper::SimpleReferenceObject
  66     {
  67     public:
  68         /** creates an accessible context for a button window
  69         */
  70         virtual css::uno::Reference< css::accessibility::XAccessibleContext >
  71             createAccessibleContext(PushButton* pButton) = 0;
  72
  73         /** creates an accessible context for a checkbox window
  74         */
  75         virtual css::uno::Reference< css::accessibility::XAccessibleContext >
  76             createAccessibleContext(CheckBox* pCheckBox) = 0;
  77
  78         /** creates an accessible context for a radio button window
  79         */
  80         virtual css::uno::Reference< css::accessibility::XAccessibleContext >
  81             createAccessibleContext(RadioButton* pRadioButton) = 0;
  82
  83         /** creates an accessible context for a listbox window
  84         */
  85         virtual css::uno::Reference< css::accessibility::XAccessibleContext >
  86             createAccessibleContext(ListBox* pListBox) = 0;
  87
  88         /** creates an accessible context for a fixed hyperlink window
  89         */
  90         virtual css::uno::Reference< css::accessibility::XAccessibleContext >
  91             createAccessibleContext(FixedHyperlink* pFixedHyperlink) = 0;
  92
  93         /** creates an accessible context for a fixed text window
  94         */
  95         virtual css::uno::Reference< css::accessibility::XAccessibleContext >
  96             createAccessibleContext(FixedText* pFixedText) = 0;
  97
  98         /** creates an accessible context for a scrollbar window
  99         */
 100         virtual css::uno::Reference< css::accessibility::XAccessibleContext >
 101             createAccessibleContext(ScrollBar* pScrollBar) = 0;
 102
 103         /** creates an accessible context for an edit window
 104         */
 105         virtual css::uno::Reference< css::accessibility::XAccessibleContext >
 106             createAccessibleContext(Edit* pEdit) = 0;
 107
 108         /** creates an accessible context for a combo box window
 109         */
 110         virtual css::uno::Reference< css::accessibility::XAccessibleContext >
 111             createAccessibleContext(ComboBox* pComboBox) = 0;
 112
 113         /** creates an accessible context for a toolbox window
 114         */
 115         virtual css::uno::Reference< css::accessibility::XAccessibleContext >
 116             createAccessibleContext(ToolBox* pToolBox) = 0;
 117
 118         /** creates an accessible context for a headerbar window
 119         */
 120         virtual css::uno::Reference< css::accessibility::XAccessibleContext >
 121             createAccessibleContext(HeaderBar* pHeaderBar) = 0;
 122
 123         /** creates an accessible context for a numeric field
 124         */
 125         virtual css::uno::Reference< css::accessibility::XAccessibleContext >
 126             createAccessibleContext(FormattedField* pFormattedField) = 0;
 127
 128         /** creates an accessible context for a generic window
 129         */
 130         virtual css::uno::Reference< css::accessibility::XAccessibleContext >
 131             createAccessibleContext(vcl::Window* pWindow) = 0;
 132
 133     protected:
 134         virtual ~IAccessibleFactory() override {}
 135     };
 136
 137
 138 }   // namespace toolkit
 139
 140
 141 #endif // INCLUDED_TOOLKIT_HELPER_ACCESSIBLEFACTORY_HXX
 142
 143 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */