AT_SPI_IDL: Accessibility_State.idl Source File

00001 /* 
00002  * AT-SPI - Assistive Technology Service Provider Interface 
00003  * (Gnome Accessibility Project; http://developer.gnome.org/projects/gap)
00004  *
00005  * Copyright 2001 Sun Microsystems Inc.
00006  *
00007  * This library is free software; you can redistribute it and/or
00008  * modify it under the terms of the GNU Library General Public
00009  * License as published by the Free Software Foundation; either
00010  * version 2 of the License, or (at your option) any later version.
00011  *
00012  * This library is distributed in the hope that it will be useful,
00013  * but WITHOUT ANY WARRANTY; without even the implied warranty of
00014  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00015  * Library General Public License for more details.
00016  *
00017  * You should have received a copy of the GNU Library General Public
00018  * License along with this library; if not, write to the
00019  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
00020  * Boston, MA 02111-1307, USA.
00021  */
00022 
00023 #ifndef _ACCESSIBILITY_STATE_IDL
00024 #define _ACCESSIBILITY_STATE_IDL
00025 
00026 module Accessibility {
00027 
00028   enum StateType {
00029   STATE_INVALID,
00031   STATE_ACTIVE,
00033   STATE_ARMED,
00038   STATE_BUSY,
00040   STATE_CHECKED,
00042   STATE_COLLAPSED,
00045   STATE_DEFUNCT,
00047   STATE_EDITABLE,
00052   STATE_ENABLED,
00054   STATE_EXPANDABLE,
00056   STATE_EXPANDED,
00062   STATE_FOCUSABLE,
00064   STATE_FOCUSED,
00066   STATE_HAS_TOOLTIP,
00068   STATE_HORIZONTAL,
00070   STATE_ICONIFIED,
00075   STATE_MODAL,
00077   STATE_MULTI_LINE,
00083   STATE_MULTISELECTABLE,
00087   STATE_OPAQUE,
00089   STATE_PRESSED,
00091   STATE_RESIZABLE,
00097   STATE_SELECTABLE,
00103   STATE_SELECTED,
00111   STATE_SENSITIVE,
00118   STATE_SHOWING,
00120   STATE_SINGLE_LINE,
00124   STATE_STALE,
00126   STATE_TRANSIENT,
00130   STATE_VERTICAL,
00139   STATE_VISIBLE,
00151   STATE_MANAGES_DESCENDANTS,
00162   STATE_INDETERMINATE,
00167   STATE_REQUIRED,
00168 
00180   STATE_ANIMATED,
00188   STATE_INVALID_ENTRY,
00201   STATE_SUPPORTS_TYPEAHEAD,
00212   STATE_SELECTABLE_TEXT,
00213 
00217   STATE_LAST_DEFINED
00218   };
00219 
00220   typedef sequence <StateType> StateSeq;
00221 
00227   interface StateSet : Bonobo::Unknown {
00228 
00233     boolean             contains (in StateType state);
00234 
00236     void                add (in StateType state);
00237 
00239     void                remove (in StateType state);
00240 
00245     boolean             equals (in StateSet stateSet);
00246 
00250     StateSet            compare (in StateSet compareState);
00251 
00253     boolean             isEmpty ();
00254 
00256     /* Private */
00257     StateSeq getStates ();
00258 
00264     void unImplemented ();
00265     void unImplemented2 ();
00266     void unImplemented3 ();
00267     void unImplemented4 ();
00269   };
00270 };
00271 
00272 #endif