offapi/com/sun/star/awt/AccessibleButton.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*************************************************************************
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * Copyright 2000, 2010 Oracle and/or its affiliates.
   7  *
   8  * OpenOffice.org - a multi-platform office productivity suite
   9  *
  10  * This file is part of OpenOffice.org.
  11  *
  12  * OpenOffice.org is free software: you can redistribute it and/or modify
  13  * it under the terms of the GNU Lesser General Public License version 3
  14  * only, as published by the Free Software Foundation.
  15  *
  16  * OpenOffice.org is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU Lesser General Public License version 3 for more details
  20  * (a copy is included in the LICENSE file that accompanied this code).
  21  *
  22  * You should have received a copy of the GNU Lesser General Public License
  23  * version 3 along with OpenOffice.org.  If not, see
  24  * <http://www.openoffice.org/license.html>
  25  * for a copy of the LGPLv3 License.
  26  *
  27  ************************************************************************/
  28
  29 #ifndef __com_sun_star_awt_AccessibleButton_idl__
  30 #define __com_sun_star_awt_AccessibleButton_idl__
  31
  32 #include <com/sun/star/accessibility/XAccessibleContext.idl>
  33 #include <com/sun/star/accessibility/XAccessibleEventBroadcaster.idl>
  34 #include <com/sun/star/accessibility/XAccessibleComponent.idl>
  35 #include <com/sun/star/accessibility/XAccessibleExtendedComponent.idl>
  36 #include <com/sun/star/accessibility/XAccessibleText.idl>
  37 #include <com/sun/star/accessibility/XAccessibleAction.idl>
  38 #include <com/sun/star/accessibility/XAccessibleValue.idl>
  39
  40 module com { module sun { module star { module awt {
  41
  42 /** specifies accessibility support for a button.
  43
  44     @since OOo 1.1.2
  45  */
  46 published service AccessibleButton
  47 {
  48     /** This interface gives access to the structural information of a button:
  49
  50         <ul>
  51         <li>Role: The role of a button is <const
  52             scope="com::sun::star::accessibility"
  53             >AccessibleRole::PUSH_BUTTON</const>.</li>
  54         <li>Name: The name of a button is its localized label.</li>
  55         <li>Description: The description of a button is its localized
  56             help text.</li>
  57         <li>Children: There are no children.</li>
  58         <li>Parent: The parent is the window that contains the button.</li>
  59         <li>Relations: There are no relations.</li>
  60         <li>States: The states supported by this service are
  61             <ul>
  62             <li><const scope="com::sun::star::accessibility"
  63                 >AccessibleStateType::CHECKED</const> is set
  64                 if the object is currently checked.</li>
  65             <li><const scope="com::sun::star::accessibility"
  66                 >AccessibleStateType::DEFUNC</const>
  67                 is set if the object has already been disposed
  68                 and subsequent calls to this object result in
  69                 <type scope="com::sun::star::lang">DisposedException</type>
  70                 exceptions.</li>
  71             <li><const scope="com::sun::star::accessibility"
  72                 >AccessibleStateType::ENABLED</const> is set
  73                 if the object is enabled.</li>
  74             <li><const scope="com::sun::star::accessibility"
  75                 >AccessibleStateType::FOCUSABLE</const> is always set.</li>
  76             <li><const scope="com::sun::star::accessibility"
  77                 >AccessibleStateType::FOCUSED</const> is set
  78                 if the object currently has the keyboard focus.</li>
  79             <li><const scope="com::sun::star::accessibility"
  80                 >AccessibleStateType::PRESSED</const> is set
  81                 if the object is currently pressed.</li>
  82             <li><const scope="com::sun::star::accessibility"
  83                 >AccessibleStateType::SHOWING</const> is set
  84                 if the object is displayed on the screen.</li>
  85             <li><const scope="com::sun::star::accessibility"
  86                 >AccessibleStateType::VISIBLE</const> is always set.</li>
  87             </ul>
  88             </li>
  89         </ul>
  90      */
  91     interface ::com::sun::star::accessibility::XAccessibleContext;
  92
  93     interface ::com::sun::star::accessibility::XAccessibleEventBroadcaster;
  94
  95     interface ::com::sun::star::accessibility::XAccessibleComponent;
  96
  97     interface ::com::sun::star::accessibility::XAccessibleExtendedComponent;
  98
  99     /** This interface gives read-only access to the text representation
 100         of a button.
 101      */
 102     interface ::com::sun::star::accessibility::XAccessibleText;
 103
 104     /** This interface gives access to the actions that can be executed for
 105         a button. The supported actions for a button are:
 106         <ul>
 107         <li>click</li>
 108         </ul>
 109      */
 110     interface ::com::sun::star::accessibility::XAccessibleAction;
 111
 112     /** This interface gives access to the numerical value of a button,
 113         which is related to the button's
 114         <const scope="com::sun::star::accessibility"
 115         >AccessibleStateType::PRESSED</const> state.
 116      */
 117     interface ::com::sun::star::accessibility::XAccessibleValue;
 118
 119 };
 120
 121 }; }; }; };
 122
 123 #endif
 124
 125 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */