sd/source/ui/inc/AccessibleOutlineView.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 SD_ACCESSIBILITY_ACCESSIBLE_OUTLINE_VIEW_HXX
  21 #define SD_ACCESSIBILITY_ACCESSIBLE_OUTLINE_VIEW_HXX
  22
  23 #include "AccessibleDocumentViewBase.hxx"
  24 #include <svx/AccessibleTextHelper.hxx>
  25
  26 namespace sd {
  27 class OutlineViewShell;
  28 class Window;
  29 }
  30
  31 namespace accessibility {
  32
  33
  34 /** This class makes the Impress outline view accessible.
  35
  36     Please see the documentation of the base class for further
  37     explanations of the individual methods. This class is a mere
  38     wrapper around the AccessibleTextHelper class; as basically the
  39     Outline View is a big Outliner.
  40 */
  41 class AccessibleOutlineView
  42     : public AccessibleDocumentViewBase
  43 {
  44 public:
  45     AccessibleOutlineView (
  46         ::sd::Window* pSdWindow,
  47         ::sd::OutlineViewShell* pViewShell,
  48         const ::com::sun::star::uno::Reference<
  49         ::com::sun::star::frame::XController>& rxController,
  50         const ::com::sun::star::uno::Reference<
  51         ::com::sun::star::accessibility::XAccessible>& rxParent);
  52
  53     virtual ~AccessibleOutlineView  (void);
  54
  55     /** Complete the initialization begun in the constructor.
  56     */
  57     virtual void Init (void);
  58
  59
  60     //=====  IAccessibleViewForwarderListener  ================================
  61
  62     virtual void ViewForwarderChanged (ChangeType aChangeType,
  63         const IAccessibleViewForwarder* pViewForwarder);
  64
  65     //=====  XAccessibleContext  ==============================================
  66
  67     virtual sal_Int32 SAL_CALL
  68         getAccessibleChildCount (void)
  69         throw (::com::sun::star::uno::RuntimeException);
  70
  71     virtual ::com::sun::star::uno::Reference< ::com::sun::star::accessibility::XAccessible> SAL_CALL
  72         getAccessibleChild (sal_Int32 nIndex)
  73         throw (::com::sun::star::uno::RuntimeException);
  74
  75     //=====  XAccessibleEventBroadcaster  ========================================
  76
  77     virtual void SAL_CALL
  78         addAccessibleEventListener (
  79             const ::com::sun::star::uno::Reference<
  80                 ::com::sun::star::accessibility::XAccessibleEventListener >& xListener)
  81         throw (::com::sun::star::uno::RuntimeException);
  82
  83     virtual void SAL_CALL
  84         removeAccessibleEventListener (
  85             const ::com::sun::star::uno::Reference<
  86                 ::com::sun::star::accessibility::XAccessibleEventListener >& xListener)
  87         throw (::com::sun::star::uno::RuntimeException);
  88
  89     //=====  XServiceInfo  ====================================================
  90
  91     /** Returns an identifier for the implementation of this object.
  92     */
  93     virtual OUString SAL_CALL
  94         getImplementationName (void)
  95         throw (::com::sun::star::uno::RuntimeException);
  96
  97     //=====  lang::XEventListener  ============================================
  98
  99     virtual void SAL_CALL
 100         disposing (const ::com::sun::star::lang::EventObject& rEventObject)
 101         throw (::com::sun::star::uno::RuntimeException);
 102
 103     //=====  XPropertyChangeListener  =========================================
 104
 105     virtual void SAL_CALL
 106         propertyChange (const ::com::sun::star::beans::PropertyChangeEvent& rEventObject)
 107         throw (::com::sun::star::uno::RuntimeException);
 108
 109
 110 protected:
 111
 112     // overridden, as we hold the listeners ourselves
 113     virtual void FireEvent (const ::com::sun::star::accessibility::AccessibleEventObject& aEvent);
 114
 115     // overridden to detect focus changes
 116     virtual void Activated (void);
 117
 118     // overridden to detect focus changes
 119     virtual void Deactivated (void);
 120
 121     // declared, but not defined
 122     AccessibleOutlineView( const AccessibleOutlineView& );
 123     AccessibleOutlineView& operator= ( const AccessibleOutlineView& );
 124
 125     // This method is called from the component helper base class while disposing.
 126     virtual void SAL_CALL disposing (void);
 127
 128     /// Create an accessible name that contains the current view mode.
 129     virtual OUString
 130         CreateAccessibleName ()
 131         throw (::com::sun::star::uno::RuntimeException);
 132
 133     /// Create an accessible description that contains the current
 134     /// view mode.
 135     virtual OUString
 136         CreateAccessibleDescription ()
 137         throw (::com::sun::star::uno::RuntimeException);
 138
 139 private:
 140
 141     /// Invalidate text helper, updates visible children
 142     void UpdateChildren();
 143
 144     AccessibleTextHelper maTextHelper;
 145
 146 };
 147
 148 } // end of namespace accessibility
 149
 150 #endif
 151
 152 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */