sd/source/ui/inc/AccessibleScrollPanel.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: AccessibleScrollPanel.hxx,v $
  10  * $Revision: 1.4 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef SD_ACCESSIBILITY_ACCESSIBLE_SCROLL_PANEL_HXX
  32 #define SD_ACCESSIBILITY_ACCESSIBLE_SCROLL_PANEL_HXX
  33
  34 #include "AccessibleTreeNode.hxx"
  35
  36 namespace sd { namespace toolpanel {
  37 class ScrollPanel;
  38 } }
  39
  40
  41 namespace accessibility {
  42
  43 /** This derived class handles the accessible children different from its
  44     base class.  It adds the scroll bars as children when they are visible.
  45 */
  46 class AccessibleScrollPanel
  47     : public AccessibleTreeNode
  48 {
  49 public:
  50     AccessibleScrollPanel (
  51         ::sd::toolpanel::ScrollPanel& rScrollPanel,
  52         const ::rtl::OUString& rsName,
  53         const ::rtl::OUString& rsDescription);
  54     ~AccessibleScrollPanel (void);
  55
  56     //=====  XAccessibleContext  ==============================================
  57
  58     /// Return the number of currently visible children.
  59     virtual sal_Int32 SAL_CALL
  60         getAccessibleChildCount (void) throw (::com::sun::star::uno::RuntimeException);
  61
  62     /// Return the specified child or throw exception.
  63     virtual ::com::sun::star::uno::Reference<
  64         ::com::sun::star::accessibility::XAccessible> SAL_CALL
  65         getAccessibleChild (sal_Int32 nIndex)
  66         throw (::com::sun::star::lang::IndexOutOfBoundsException,
  67             ::com::sun::star::uno::RuntimeException);
  68
  69     //=====  XServiceInfo  ====================================================
  70
  71     /** Returns an identifier for the implementation of this object.
  72     */
  73     virtual ::rtl::OUString SAL_CALL
  74         getImplementationName (void)
  75         throw (::com::sun::star::uno::RuntimeException);
  76
  77 private:
  78     ::sd::toolpanel::ScrollPanel& GetScrollPanel (void) const;
  79 };
  80
  81 } // end of namespace accessibility
  82
  83 #endif