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 class SVTXNumericField;
  31 class VCLXButton;
  32 class VCLXCheckBox;
  33 class VCLXRadioButton;
  34 class VCLXListBox;
  35 class VCLXFixedHyperlink;
  36 class VCLXFixedText;
  37 class VCLXScrollBar;
  38 class VCLXEdit;
  39 class VCLXComboBox;
  40 class VCLXToolBox;
  41 class VCLXHeaderBar;
  42 class VCLXWindow;
  43 class Menu;
  44
  45
  46 namespace toolkit
  47 {
  48
  49
  50     /** a function which is able to create a factory for the standard Accessible/Context
  51         components needed for standard toolkit controls
  52
  53         The returned pointer denotes an instance of the IAccessibleFactory, which has been acquired
  54         <em>once</em>. The caller is responsible for holding this reference as long as it needs the
  55         factory, and release it afterwards.
  56     */
  57     typedef void* (* GetStandardAccComponentFactory)( );
  58
  59
  60     //= IAccessibleFactory
  61
  62     class IAccessibleFactory : public virtual salhelper::SimpleReferenceObject
  63     {
  64     public:
  65         /** creates an accessible context for a button window
  66         */
  67         virtual css::uno::Reference< css::accessibility::XAccessibleContext >
  68             createAccessibleContext( VCLXButton* _pXWindow ) = 0;
  69
  70         /** creates an accessible context for a checkbox window
  71         */
  72         virtual css::uno::Reference< css::accessibility::XAccessibleContext >
  73             createAccessibleContext( VCLXCheckBox* _pXWindow ) = 0;
  74
  75         /** creates an accessible context for a radio button window
  76         */
  77         virtual css::uno::Reference< css::accessibility::XAccessibleContext >
  78             createAccessibleContext( VCLXRadioButton* _pXWindow ) = 0;
  79
  80         /** creates an accessible context for a listbox window
  81         */
  82         virtual css::uno::Reference< css::accessibility::XAccessibleContext >
  83             createAccessibleContext( VCLXListBox* _pXWindow ) = 0;
  84
  85         /** creates an accessible context for a fixed hyperlink window
  86         */
  87         virtual css::uno::Reference< css::accessibility::XAccessibleContext >
  88             createAccessibleContext( VCLXFixedHyperlink* _pXWindow ) = 0;
  89
  90         /** creates an accessible context for a fixed text window
  91         */
  92         virtual css::uno::Reference< css::accessibility::XAccessibleContext >
  93             createAccessibleContext( VCLXFixedText* _pXWindow ) = 0;
  94
  95         /** creates an accessible context for a scrollbar window
  96         */
  97         virtual css::uno::Reference< css::accessibility::XAccessibleContext >
  98             createAccessibleContext( VCLXScrollBar* _pXWindow ) = 0;
  99
 100         /** creates an accessible context for an edit window
 101         */
 102         virtual css::uno::Reference< css::accessibility::XAccessibleContext >
 103             createAccessibleContext( VCLXEdit* _pXWindow ) = 0;
 104
 105         /** creates an accessible context for a combo box window
 106         */
 107         virtual css::uno::Reference< css::accessibility::XAccessibleContext >
 108             createAccessibleContext( VCLXComboBox* _pXWindow ) = 0;
 109
 110         /** creates an accessible context for a toolbox window
 111         */
 112         virtual css::uno::Reference< css::accessibility::XAccessibleContext >
 113             createAccessibleContext( VCLXToolBox* _pXWindow ) = 0;
 114
 115         /** creates an accessible context for a headerbar window
 116         */
 117         virtual css::uno::Reference< css::accessibility::XAccessibleContext >
 118             createAccessibleContext( VCLXHeaderBar* _pXWindow ) = 0;
 119
 120         /** creates an accessible context for a numeric field
 121         */
 122         virtual css::uno::Reference< css::accessibility::XAccessibleContext >
 123             createAccessibleContext( SVTXNumericField* _pXWindow ) = 0;
 124
 125         /** creates an accessible context for a generic window
 126         */
 127         virtual css::uno::Reference< css::accessibility::XAccessibleContext >
 128             createAccessibleContext( VCLXWindow* _pXWindow ) = 0;
 129
 130         /** creates an accessible component for the given menu
 131         */
 132         virtual css::uno::Reference< css::accessibility::XAccessible >
 133             createAccessible( Menu* _pMenu, bool _bIsMenuBar ) = 0;
 134
 135     protected:
 136         virtual ~IAccessibleFactory() override {}
 137     };
 138
 139
 140 }   // namespace toolkit
 141
 142
 143 #endif // INCLUDED_TOOLKIT_HELPER_ACCESSIBLEFACTORY_HXX
 144
 145 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */