offapi/com/sun/star/awt/AccessibleButton.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: AccessibleButton.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_awt_AccessibleButton_idl__
  32 #define __com_sun_star_awt_AccessibleButton_idl__
  33
  34 #ifndef __com_sun_star_accessibility_XAccessibleContext_idl__
  35 #include <com/sun/star/accessibility/XAccessibleContext.idl>
  36 #endif
  37 #ifndef __com_sun_star_accessibility_XAccessibleEventBroadcaster_idl__
  38 #include <com/sun/star/accessibility/XAccessibleEventBroadcaster.idl>
  39 #endif
  40 #ifndef __com_sun_star_accessibility_XAccessibleComponent_idl__
  41 #include <com/sun/star/accessibility/XAccessibleComponent.idl>
  42 #endif
  43 #ifndef __com_sun_star_accessibility_XAccessibleExtendedComponent_idl__
  44 #include <com/sun/star/accessibility/XAccessibleExtendedComponent.idl>
  45 #endif
  46 #ifndef __com_sun_star_accessibility_XAccessibleText_idl__
  47 #include <com/sun/star/accessibility/XAccessibleText.idl>
  48 #endif
  49 #ifndef __com_sun_star_accessibility_XAccessibleAction_idl__
  50 #include <com/sun/star/accessibility/XAccessibleAction.idl>
  51 #endif
  52 #ifndef __com_sun_star_accessibility_XAccessibleValue_idl__
  53 #include <com/sun/star/accessibility/XAccessibleValue.idl>
  54 #endif
  55
  56 module com { module sun { module star { module awt {
  57
  58 /** specifies accessibility support for a button.
  59
  60     @since OOo 1.1.2
  61  */
  62 published service AccessibleButton
  63 {
  64     /** This interface gives access to the structural information of a button:
  65
  66         <ul>
  67         <li>Role: The role of a button is <const
  68             scope="com::sun::star::accessibility"
  69             >AccessibleRole::PUSH_BUTTON</const>.</li>
  70         <li>Name: The name of a button is its localized label.</li>
  71         <li>Description: The description of a button is its localized
  72             help text.</li>
  73         <li>Children: There are no children.</li>
  74         <li>Parent: The parent is the window that contains the button.</li>
  75         <li>Relations: There are no relations.</li>
  76         <li>States: The states supported by this service are
  77             <ul>
  78             <li><const scope="com::sun::star::accessibility"
  79                 >AccessibleStateType::CHECKED</const> is set
  80                 if the object is currently checked.</li>
  81             <li><const scope="com::sun::star::accessibility"
  82                 >AccessibleStateType::DEFUNC</const>
  83                 is set if the object has already been disposed
  84                 and subsequent calls to this object result in
  85                 <type scope="com::sun::star::lang">DisposedException</type>
  86                 exceptions.</li>
  87             <li><const scope="com::sun::star::accessibility"
  88                 >AccessibleStateType::ENABLED</const> is set
  89                 if the object is enabled.</li>
  90             <li><const scope="com::sun::star::accessibility"
  91                 >AccessibleStateType::FOCUSABLE</const> is always set.</li>
  92             <li><const scope="com::sun::star::accessibility"
  93                 >AccessibleStateType::FOCUSED</const> is set
  94                 if the object currently has the keyboard focus.</li>
  95             <li><const scope="com::sun::star::accessibility"
  96                 >AccessibleStateType::PRESSED</const> is set
  97                 if the object is currently pressed.</li>
  98             <li><const scope="com::sun::star::accessibility"
  99                 >AccessibleStateType::SHOWING</const> is set
 100                 if the object is displayed on the screen.</li>
 101             <li><const scope="com::sun::star::accessibility"
 102                 >AccessibleStateType::VISIBLE</const> is always set.</li>
 103             </ul>
 104             </li>
 105         </ul>
 106      */
 107     interface ::com::sun::star::accessibility::XAccessibleContext;
 108
 109     interface ::com::sun::star::accessibility::XAccessibleEventBroadcaster;
 110
 111     interface ::com::sun::star::accessibility::XAccessibleComponent;
 112
 113     interface ::com::sun::star::accessibility::XAccessibleExtendedComponent;
 114
 115     /** This interface gives read-only access to the text representation
 116         of a button.
 117      */
 118     interface ::com::sun::star::accessibility::XAccessibleText;
 119
 120     /** This interface gives access to the actions that can be executed for
 121         a button. The supported actions for a button are:
 122         <ul>
 123         <li>click</li>
 124         </ul>
 125      */
 126     interface ::com::sun::star::accessibility::XAccessibleAction;
 127
 128     /** This interface gives access to the numerical value of a button,
 129         which is related to the button's
 130         <const scope="com::sun::star::accessibility"
 131         >AccessibleStateType::PRESSED</const> state.
 132      */
 133     interface ::com::sun::star::accessibility::XAccessibleValue;
 134
 135 };
 136
 137 }; }; }; };
 138
 139 #endif