svx/inc/AccessibleSelectionBase.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: AccessibleSelectionBase.hxx,v $
  10  * $Revision: 1.6 $
  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 _SVX_ACCESSIBILITY_ACCESSIBLE_SELECTION_BASE_HXX
  32 #define _SVX_ACCESSIBILITY_ACCESSIBLE_SELECTION_BASE_HXX
  33
  34 #include <comphelper/accessibleselectionhelper.hxx>
  35 #include "svx/svxdllapi.h"
  36
  37 namespace accessibility
  38 {
  39 /** @descr
  40         This base class provides a base implementation of the
  41         <type>XAccessibleSelection</type> interface.
  42         The following methods have to be implemented if this
  43         class is used:
  44
  45         <method>implGetMutex</method>,
  46         <method>implGetAccessibleContext</method>,
  47         <method>implIsSelected</method>,
  48         <method>implSelect</method>,
  49 */
  50     class SVX_DLLPUBLIC AccessibleSelectionBase : public ::comphelper::OCommonAccessibleSelection,
  51                                     public ::com::sun::star::accessibility::XAccessibleSelection
  52     {
  53     protected:
  54
  55         virtual ::osl::Mutex&   implGetMutex() = 0;
  56
  57     public:
  58
  59         // XAccessibleSelection - default implementations
  60         virtual void SAL_CALL selectAccessibleChild( sal_Int32 nChildIndex ) throw (::com::sun::star::lang::IndexOutOfBoundsException, ::com::sun::star::uno::RuntimeException);
  61         virtual sal_Bool SAL_CALL isAccessibleChildSelected( sal_Int32 nChildIndex ) throw (::com::sun::star::lang::IndexOutOfBoundsException, ::com::sun::star::uno::RuntimeException);
  62         virtual void SAL_CALL clearAccessibleSelection(  ) throw (::com::sun::star::uno::RuntimeException);
  63         virtual void SAL_CALL selectAllAccessibleChildren(  ) throw (::com::sun::star::uno::RuntimeException);
  64         virtual sal_Int32 SAL_CALL getSelectedAccessibleChildCount(  ) throw (::com::sun::star::uno::RuntimeException);
  65         virtual ::com::sun::star::uno::Reference< ::com::sun::star::accessibility::XAccessible > SAL_CALL getSelectedAccessibleChild( sal_Int32 nSelectedChildIndex ) throw (::com::sun::star::lang::IndexOutOfBoundsException, ::com::sun::star::uno::RuntimeException);
  66         virtual void SAL_CALL deselectAccessibleChild( sal_Int32 nSelectedChildIndex ) throw (::com::sun::star::lang::IndexOutOfBoundsException, ::com::sun::star::uno::RuntimeException);
  67
  68     public:
  69
  70                                 AccessibleSelectionBase();
  71         virtual                 ~AccessibleSelectionBase();
  72     };
  73
  74 }
  75
  76 #endif // _SVX_ACCESSIBILITY_ACCESSIBLE_SELECTION_BASE_HXX