Line data    Source code

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