offapi/com/sun/star/accessibility/XAccessibleStateSet.idl

   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: XAccessibleStateSet.idl,v $
  10  * $Revision: 1.7 $
  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 __com_sun_star_accessibility_XAccessibleStateSet_idl__
  32 #define __com_sun_star_accessibility_XAccessibleStateSet_idl__
  33
  34 #ifndef __com_sun_star_accessibility_AccessibleStateType_idl__
  35 #include <com/sun/star/accessibility/AccessibleStateType.idl>
  36 #endif
  37
  38 #ifndef __com_sun_star_uno_XInterface_idl__
  39 #include <com/sun/star/uno/XInterface.idl>
  40 #endif
  41
  42 module com { module sun { module star { module accessibility {
  43
  44  published interface XAccessible;
  45
  46 /** Implement this interface to represent a set of states.
  47
  48     <p>The interface <type>XAccessibleStateSet</type> represents a set of
  49     states of an accessible object.  It can hold any combination of states
  50     defined by the constants collection
  51     <type>AccessibleStateType</type>.</p>
  52
  53     @since OOo 1.1.2
  54 */
  55 published interface XAccessibleStateSet : ::com::sun::star::uno::XInterface
  56 {
  57     /** Checks whether the current state set is empty.
  58
  59         @return
  60             Returns <TRUE/> if there is no state in this state set and
  61             <FALSE/> if there is at least one set state in it.
  62     */
  63     boolean isEmpty ();
  64
  65     /** Checks if the given state is a member of the state set of the called
  66         object.
  67
  68         @param aState
  69             The state for which to check membership.  This has to be one of
  70             the constants of <type>AccessibleStateType</type>.
  71
  72         @return
  73             Returns <TRUE/> if the given state is a memeber of this object's
  74             state set and <FALSE/> otherwise.
  75     */
  76     boolean contains ([in] short aState);
  77
  78     /** Checks if all of the given states are in the state set of the called
  79         object.
  80
  81         @param aStateSet
  82             This sequence of states is interpreted as set and every of its
  83             members, duplicates are ignored, is checked for membership in
  84             this object's state set.  Each state has to be one of the
  85             constants of <type>AccessibleStateType</type>.
  86
  87         @return
  88             Returns <TRUE/> if all states of the given state set are members
  89             of this object's state set.  <FALSE/> is returned if at least
  90             one of the states in the given state is not a member of this
  91             object's state set.
  92     */
  93     boolean containsAll ([in] sequence<short> aStateSet);
  94
  95     /** Get all currently set states as a sequence of state ids.
  96
  97         <p>The purpose of this function is to reduce the communication
  98         between accessibility objects and AT.  Without this function an
  99         AT-Tool had to call <member>contains()</member> for every state
 100         type.  Now a single call is sufficient.</p>
 101
 102         @return
 103             The returned sequence contains one entry for every currently set
 104             state.  This entry is the id of that state.  The order of the
 105             states in the sequence is undefined.
 106     */
 107     sequence<short> getStates ();
 108 };
 109
 110 }; }; }; };
 111
 112 #endif