sw/source/core/access/accselectionhelper.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: accselectionhelper.hxx,v $
  10  * $Revision: 1.9 $
  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 #ifndef _ACCSELECTIONHELPER_HXX_
  31 #define _ACCSELECTIONHELPER_HXX_
  32 class SwAccessibleContext;
  33 class SwFEShell;
  34 #include <com/sun/star/accessibility/XAccessibleSelection.hpp>
  35
  36 class SwAccessibleSelectionHelper
  37 {
  38     /// the context on which this helper works
  39     SwAccessibleContext& rContext;
  40
  41
  42     /// get FE-Shell
  43     SwFEShell* GetFEShell();
  44
  45     void throwIndexOutOfBoundsException()
  46         throw ( ::com::sun::star::lang::IndexOutOfBoundsException );
  47
  48 public:
  49
  50     SwAccessibleSelectionHelper( SwAccessibleContext& rContext );
  51     ~SwAccessibleSelectionHelper();
  52
  53
  54     //=====  XAccessibleSelection  ============================================
  55
  56     void selectAccessibleChild(
  57         sal_Int32 nChildIndex )
  58         throw ( ::com::sun::star::lang::IndexOutOfBoundsException,
  59                 ::com::sun::star::uno::RuntimeException );
  60
  61     sal_Bool isAccessibleChildSelected(
  62         sal_Int32 nChildIndex )
  63         throw ( ::com::sun::star::lang::IndexOutOfBoundsException,
  64                 ::com::sun::star::uno::RuntimeException );
  65     void clearAccessibleSelection(  )
  66         throw ( ::com::sun::star::uno::RuntimeException );
  67     void selectAllAccessibleChildren(  )
  68         throw ( ::com::sun::star::uno::RuntimeException );
  69     sal_Int32 getSelectedAccessibleChildCount(  )
  70         throw ( ::com::sun::star::uno::RuntimeException );
  71     ::com::sun::star::uno::Reference< ::com::sun::star::accessibility::XAccessible > getSelectedAccessibleChild(
  72         sal_Int32 nSelectedChildIndex )
  73         throw ( ::com::sun::star::lang::IndexOutOfBoundsException,
  74                 ::com::sun::star::uno::RuntimeException);
  75     // --> OD 2004-11-16 #111714# - index has to be treated as global child index.
  76     void deselectAccessibleChild(
  77         sal_Int32 nChildIndex )
  78         throw ( ::com::sun::star::lang::IndexOutOfBoundsException,
  79                 ::com::sun::star::uno::RuntimeException );
  80 };
  81
  82
  83 #endif
  84