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