include/vcl/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_VCL_ACCESSIBLEFACTORY_HXX
  21 #define INCLUDED_VCL_ACCESSIBLEFACTORY_HXX
  22
  23 #include <vcl/AccessibleBrowseBoxObjType.hxx>
  24
  25 #include <com/sun/star/uno/Reference.hxx>
  26
  27 #include <salhelper/simplereferenceobject.hxx>
  28 #include <tools/gen.hxx>
  29
  30 namespace com::sun::star {
  31     namespace accessibility {
  32         class XAccessible;
  33         class XAccessibleContext;
  34     }
  35     namespace awt {
  36         class XWindow;
  37     }
  38 }
  39
  40 namespace vcl { class IAccessibleBrowseBox; }
  41 namespace vcl { class IAccessibleTabListBox; }
  42 namespace vcl { class IAccessibleTableProvider; }
  43
  44 class SvHeaderTabListBox;
  45 class SvtIconChoiceCtrl;
  46 class TabBar;
  47 class SvTreeListBox;
  48 class VCLXWindow;
  49 class TextEngine;
  50 class TextView;
  51
  52 namespace vcl
  53 {
  54     namespace table
  55     {
  56         class IAccessibleTable;
  57         class IAccessibleTableControl;
  58     }
  59
  60     /** a function which is able to create a factory for the standard Accessible/Context
  61         components needed for standard toolkit controls
  62
  63         The returned pointer denotes an instance of the IAccessibleFactory, which has been acquired
  64         <em>once</em>. The caller is responsible for holding this reference as long as it needs the
  65         factory, and release it afterwards.
  66     */
  67     typedef void* (* GetSvtAccessibilityComponentFactory)( );
  68
  69
  70     //= IAccessibleFactory
  71
  72     class IAccessibleFactory : public virtual ::salhelper::SimpleReferenceObject
  73     {
  74     public:
  75         virtual vcl::IAccessibleTabListBox*
  76             createAccessibleTabListBox(
  77                 const css::uno::Reference< css::accessibility::XAccessible >& rxParent,
  78                 SvHeaderTabListBox& rBox
  79             ) const = 0;
  80         virtual css::uno::Reference< css::accessibility::XAccessible >
  81             createAccessibleTreeListBox(
  82                 SvTreeListBox& _rListBox,
  83                 const css::uno::Reference< css::accessibility::XAccessible >& _xParent
  84             ) const = 0;
  85         virtual css::uno::Reference< css::accessibility::XAccessible >
  86             createAccessibleIconView(
  87                 SvTreeListBox& _rListBox,
  88                 const css::uno::Reference< css::accessibility::XAccessible >& _xParent
  89             ) const = 0;
  90         virtual vcl::IAccessibleBrowseBox*
  91             createAccessibleBrowseBox(
  92                 const css::uno::Reference< css::accessibility::XAccessible >& _rxParent,
  93                 vcl::IAccessibleTableProvider& _rBrowseBox
  94             ) const = 0;
  95         virtual table::IAccessibleTableControl*
  96             createAccessibleTableControl(
  97                 const css::uno::Reference< css::accessibility::XAccessible >& _rxParent,
  98                 table::IAccessibleTable& _rTable
  99             ) const = 0;
 100
 101         virtual css::uno::Reference< css::accessibility::XAccessible >
 102             createAccessibleIconChoiceCtrl(
 103                 SvtIconChoiceCtrl& _rIconCtrl,
 104                 const css::uno::Reference< css::accessibility::XAccessible >& _xParent
 105             ) const = 0;
 106
 107         virtual css::uno::Reference< css::accessibility::XAccessible >
 108             createAccessibleTabBar(
 109                 TabBar& _rTabBar
 110             ) const = 0;
 111
 112         virtual css::uno::Reference< css::accessibility::XAccessibleContext >
 113             createAccessibleTextWindowContext(
 114                 VCLXWindow* pVclXWindow, TextEngine& rEngine, TextView& rView
 115             ) const = 0;
 116
 117         virtual css::uno::Reference< css::accessibility::XAccessible >
 118             createAccessibleBrowseBoxHeaderBar(
 119                 const css::uno::Reference< css::accessibility::XAccessible >& rxParent,
 120                 vcl::IAccessibleTableProvider& _rOwningTable,
 121                 AccessibleBrowseBoxObjType _eObjType
 122             ) const = 0;
 123
 124         virtual css::uno::Reference< css::accessibility::XAccessible >
 125             createAccessibleBrowseBoxTableCell(
 126                 const css::uno::Reference< css::accessibility::XAccessible >& _rxParent,
 127                 vcl::IAccessibleTableProvider& _rBrowseBox,
 128                 const css::uno::Reference< css::awt::XWindow >& _xFocusWindow,
 129                 sal_Int32 _nRowId,
 130                 sal_uInt16 _nColId,
 131                 sal_Int32 _nOffset
 132             ) const = 0;
 133
 134         virtual css::uno::Reference< css::accessibility::XAccessible >
 135             createAccessibleBrowseBoxHeaderCell(
 136                 sal_Int32 _nColumnRowId,
 137                 const css::uno::Reference< css::accessibility::XAccessible >& rxParent,
 138                 vcl::IAccessibleTableProvider& _rBrowseBox,
 139                 const css::uno::Reference< css::awt::XWindow >& _xFocusWindow,
 140                 AccessibleBrowseBoxObjType  _eObjType
 141             ) const = 0;
 142
 143         virtual css::uno::Reference< css::accessibility::XAccessible >
 144             createAccessibleCheckBoxCell(
 145                 const css::uno::Reference< css::accessibility::XAccessible >& _rxParent,
 146                 vcl::IAccessibleTableProvider& _rBrowseBox,
 147                 const css::uno::Reference< css::awt::XWindow >& _xFocusWindow,
 148                 sal_Int32 _nRowPos,
 149                 sal_uInt16 _nColPos,
 150                 const TriState& _eState,
 151                 bool _bIsTriState
 152             ) const = 0;
 153
 154         virtual css::uno::Reference< css::accessibility::XAccessible >
 155             createEditBrowseBoxTableCellAccess(
 156                 const css::uno::Reference< css::accessibility::XAccessible >& _rxParent,
 157                 const css::uno::Reference< css::accessibility::XAccessible >& _rxControlAccessible,
 158                 const css::uno::Reference< css::awt::XWindow >& _rxFocusWindow,
 159                 vcl::IAccessibleTableProvider& _rBrowseBox,
 160                 sal_Int32 _nRowPos,
 161                 sal_uInt16 _nColPos
 162             ) const = 0;
 163
 164     protected:
 165         virtual ~IAccessibleFactory() override {}
 166     };
 167
 168 }   // namespace vcl
 169
 170
 171 #endif // INCLUDED_VCL_ACCESSIBLEFACTORY_HXX
 172
 173 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */