include/svx/AccessibleOLEShape.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_SVX_ACCESSIBLEOLESHAPE_HXX
  21 #define INCLUDED_SVX_ACCESSIBLEOLESHAPE_HXX
  22
  23 #include <svx/AccessibleShape.hxx>
  24
  25 #include <com/sun/star/accessibility/XAccessibleAction.hpp>
  26 #include <svx/svxdllapi.h>
  27
  28 namespace accessibility {
  29
  30 /** @descr
  31         This class makes OLE objects accessible.  With respect to its
  32         base class AccessibleShape it supports the additional
  33         XAccessibleAction interface.
  34 */
  35 class SVX_DLLPUBLIC AccessibleOLEShape
  36     :   public AccessibleShape,
  37         public ::com::sun::star::accessibility::XAccessibleAction
  38 {
  39 public:
  40     //=====  internal  ========================================================
  41     AccessibleOLEShape (
  42         const AccessibleShapeInfo& rShapeInfo,
  43         const AccessibleShapeTreeInfo& rShapeTreeInfo);
  44     virtual ~AccessibleOLEShape (void);
  45
  46     //=====  XAccessibleAction  ===============================================
  47
  48     sal_Int32 SAL_CALL getAccessibleActionCount (void)
  49         throw (::com::sun::star::uno::RuntimeException);
  50
  51     sal_Bool SAL_CALL doAccessibleAction (sal_Int32 nIndex)
  52         throw (::com::sun::star::lang::IndexOutOfBoundsException,
  53             ::com::sun::star::uno::RuntimeException);
  54
  55     OUString SAL_CALL getAccessibleActionDescription (sal_Int32 nIndex)
  56         throw (::com::sun::star::lang::IndexOutOfBoundsException,
  57             ::com::sun::star::uno::RuntimeException);
  58
  59     ::com::sun::star::uno::Reference<
  60         ::com::sun::star::accessibility::XAccessibleKeyBinding> SAL_CALL getAccessibleActionKeyBinding (
  61             sal_Int32 nIndex)
  62         throw (::com::sun::star::lang::IndexOutOfBoundsException,
  63             ::com::sun::star::uno::RuntimeException);
  64
  65     //=====  XInterface  ======================================================
  66
  67     virtual com::sun::star::uno::Any SAL_CALL
  68         queryInterface (const com::sun::star::uno::Type & rType)
  69         throw (::com::sun::star::uno::RuntimeException);
  70
  71     virtual void SAL_CALL
  72         acquire (void)
  73         throw ();
  74
  75     virtual void SAL_CALL
  76         release (void)
  77         throw ();
  78
  79     //=====  XServiceInfo  ====================================================
  80
  81     virtual OUString SAL_CALL
  82         getImplementationName (void)
  83         throw (::com::sun::star::uno::RuntimeException);
  84
  85     virtual ::com::sun::star::uno::Sequence< OUString> SAL_CALL
  86         getSupportedServiceNames (void)
  87         throw (::com::sun::star::uno::RuntimeException);
  88
  89     //=====  XTypeProvider  ===================================================
  90
  91     virtual ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Type> SAL_CALL
  92         getTypes (void)
  93         throw (::com::sun::star::uno::RuntimeException);
  94
  95 protected:
  96     /// Create a name string that contains the accessible name.
  97     virtual OUString
  98         CreateAccessibleBaseName ()
  99         throw (::com::sun::star::uno::RuntimeException);
 100
 101     /// Create a description string that contains the accessible description.
 102     virtual OUString
 103         CreateAccessibleDescription ()
 104         throw (::com::sun::star::uno::RuntimeException);
 105
 106 private:
 107     /** Don't use the default constructor.  Use the public constructor that
 108         takes the original shape and the parent as arguments instead.
 109     */
 110     SVX_DLLPRIVATE AccessibleOLEShape (void);
 111
 112     /// Don't use the constructor.  Not yet implemented.
 113     SVX_DLLPRIVATE AccessibleOLEShape (const AccessibleOLEShape&);
 114
 115     /// Don't use the assignment operator.  Not yet implemented.
 116     SVX_DLLPRIVATE AccessibleOLEShape& operator= (const AccessibleOLEShape&);
 117 };
 118
 119 } // end of namespace accessibility
 120
 121 #endif
 122
 123 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */