sc/source/ui/inc/AccessibleEditObject.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
  21 #ifndef _SC_ACCESSIBLEEDITOBJECT_HXX
  22 #define _SC_ACCESSIBLEEDITOBJECT_HXX
  23
  24 #include "AccessibleContextBase.hxx"
  25
  26 namespace accessibility
  27 {
  28     class AccessibleTextHelper;
  29 }
  30 class EditView;
  31 class Window;
  32
  33 /** @descr
  34         This base class provides an implementation of the
  35         <code>AccessibleCell</code> service.
  36 */
  37 class ScAccessibleEditObject
  38     :   public  ScAccessibleContextBase
  39 {
  40 public:
  41     enum EditObjectType
  42     {
  43         CellInEditMode,
  44         EditLine,
  45         EditControl
  46     };
  47
  48     ScAccessibleEditObject(
  49         const ::com::sun::star::uno::Reference<
  50         ::com::sun::star::accessibility::XAccessible>& rxParent,
  51         EditView* pEditView, Window* pWin, const OUString& rName,
  52         const OUString& rDescription, EditObjectType eObjectType);
  53
  54 protected:
  55     virtual ~ScAccessibleEditObject();
  56
  57     using ScAccessibleContextBase::IsDefunc;
  58
  59 public:
  60     using ScAccessibleContextBase::disposing;
  61
  62     virtual void SAL_CALL disposing();
  63
  64     virtual void LostFocus();
  65
  66     virtual void GotFocus();
  67
  68     ///=====  XAccessibleComponent  ============================================
  69
  70     virtual ::com::sun::star::uno::Reference< ::com::sun::star::accessibility::XAccessible >
  71         SAL_CALL getAccessibleAtPoint(
  72         const ::com::sun::star::awt::Point& rPoint )
  73         throw (::com::sun::star::uno::RuntimeException);
  74
  75 protected:
  76     /// Return the object's current bounding box relative to the desktop.
  77     virtual Rectangle GetBoundingBoxOnScreen(void) const
  78         throw (::com::sun::star::uno::RuntimeException);
  79
  80     /// Return the object's current bounding box relative to the parent object.
  81     virtual Rectangle GetBoundingBox(void) const
  82         throw (::com::sun::star::uno::RuntimeException);
  83
  84 public:
  85     ///=====  XAccessibleContext  ==============================================
  86
  87     /// Return the number of currently visible children.
  88     // is overloaded to calculate this on demand
  89     virtual sal_Int32 SAL_CALL
  90         getAccessibleChildCount(void)
  91                     throw (::com::sun::star::uno::RuntimeException);
  92
  93     /// Return the specified child or NULL if index is invalid.
  94     // is overloaded to calculate this on demand
  95     virtual ::com::sun::star::uno::Reference< ::com::sun::star::accessibility::XAccessible> SAL_CALL
  96         getAccessibleChild(sal_Int32 nIndex)
  97         throw (::com::sun::star::uno::RuntimeException,
  98                 ::com::sun::star::lang::IndexOutOfBoundsException);
  99
 100     /// Return the set of current states.
 101     virtual ::com::sun::star::uno::Reference<
 102             ::com::sun::star::accessibility::XAccessibleStateSet> SAL_CALL
 103         getAccessibleStateSet(void)
 104         throw (::com::sun::star::uno::RuntimeException);
 105
 106 protected:
 107     /// Return this object's description.
 108     virtual OUString SAL_CALL
 109         createAccessibleDescription(void)
 110         throw (::com::sun::star::uno::RuntimeException);
 111
 112     /// Return the object's current name.
 113     virtual OUString SAL_CALL
 114         createAccessibleName(void)
 115         throw (::com::sun::star::uno::RuntimeException);
 116
 117 public:
 118     ///=====  XAccessibleEventBroadcaster  =====================================
 119
 120     /** Add listener that is informed of future changes of name,
 121           description and so on events.
 122     */
 123     virtual void SAL_CALL
 124         addAccessibleEventListener(
 125             const ::com::sun::star::uno::Reference<
 126                 ::com::sun::star::accessibility::XAccessibleEventListener>& xListener)
 127         throw (com::sun::star::uno::RuntimeException);
 128
 129     //  Remove an existing event listener.
 130     virtual void SAL_CALL
 131         removeAccessibleEventListener(
 132             const ::com::sun::star::uno::Reference<
 133                 ::com::sun::star::accessibility::XAccessibleEventListener>& xListener)
 134         throw (com::sun::star::uno::RuntimeException);
 135
 136     ///=====  XServiceInfo  ====================================================
 137
 138     /** Returns an identifier for the implementation of this object.
 139     */
 140     virtual OUString SAL_CALL
 141         getImplementationName(void)
 142         throw (::com::sun::star::uno::RuntimeException);
 143
 144     ///=====  XTypeProvider  ===================================================
 145
 146     /** Returns a implementation id.
 147     */
 148     virtual ::com::sun::star::uno::Sequence<sal_Int8> SAL_CALL
 149         getImplementationId(void)
 150         throw (::com::sun::star::uno::RuntimeException);
 151
 152 private:
 153     accessibility::AccessibleTextHelper* mpTextHelper;
 154     EditView* mpEditView;
 155     Window* mpWindow;
 156     EditObjectType meObjectType;
 157     sal_Bool mbHasFocus;
 158
 159     sal_Bool IsDefunc(
 160         const com::sun::star::uno::Reference<
 161         ::com::sun::star::accessibility::XAccessibleStateSet>& rxParentStates);
 162
 163     void CreateTextHelper();
 164 };
 165
 166
 167 #endif
 168
 169 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */