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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /**
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef __com_sun_star_awt_AccessibleButton_idl__
  21 #define __com_sun_star_awt_AccessibleButton_idl__
  22
  23 #include <com/sun/star/accessibility/XAccessibleContext.idl>
  24 #include <com/sun/star/accessibility/XAccessibleEventBroadcaster.idl>
  25 #include <com/sun/star/accessibility/XAccessibleComponent.idl>
  26 #include <com/sun/star/accessibility/XAccessibleExtendedComponent.idl>
  27 #include <com/sun/star/accessibility/XAccessibleText.idl>
  28 #include <com/sun/star/accessibility/XAccessibleAction.idl>
  29 #include <com/sun/star/accessibility/XAccessibleValue.idl>
  30
  31 module com { module sun { module star { module awt {
  32
  33 /** specifies accessibility support for a button.
  34
  35     @since OOo 1.1.2
  36  */
  37 service AccessibleButton
  38 {
  39     /** This interface gives access to the structural information of a button:
  40
  41         <ul>
  42         <li>Role: The role of a button is <const
  43             scope="com::sun::star::accessibility"
  44             >AccessibleRole::PUSH_BUTTON</const>.</li>
  45         <li>Name: The name of a button is its localized label.</li>
  46         <li>Description: The description of a button is its localized
  47             help text.</li>
  48         <li>Children: There are no children.</li>
  49         <li>Parent: The parent is the window that contains the button.</li>
  50         <li>Relations: There are no relations.</li>
  51         <li>States: The states supported by this service are
  52             <ul>
  53             <li><const scope="com::sun::star::accessibility"
  54                 >AccessibleStateType::CHECKED</const> is set
  55                 if the object is currently checked.</li>
  56             <li><const scope="com::sun::star::accessibility"
  57                 >AccessibleStateType::DEFUNC</const>
  58                 is set if the object has already been disposed
  59                 and subsequent calls to this object result in
  60                 <type scope="com::sun::star::lang">DisposedException</type>
  61                 exceptions.</li>
  62             <li><const scope="com::sun::star::accessibility"
  63                 >AccessibleStateType::ENABLED</const> is set
  64                 if the object is enabled.</li>
  65             <li><const scope="com::sun::star::accessibility"
  66                 >AccessibleStateType::FOCUSABLE</const> is always set.</li>
  67             <li><const scope="com::sun::star::accessibility"
  68                 >AccessibleStateType::FOCUSED</const> is set
  69                 if the object currently has the keyboard focus.</li>
  70             <li><const scope="com::sun::star::accessibility"
  71                 >AccessibleStateType::PRESSED</const> is set
  72                 if the object is currently pressed.</li>
  73             <li><const scope="com::sun::star::accessibility"
  74                 >AccessibleStateType::SHOWING</const> is set
  75                 if the object is displayed on the screen.</li>
  76             <li><const scope="com::sun::star::accessibility"
  77                 >AccessibleStateType::VISIBLE</const> is always set.</li>
  78             </ul>
  79             </li>
  80         </ul>
  81      */
  82     interface ::com::sun::star::accessibility::XAccessibleContext;
  83
  84     interface ::com::sun::star::accessibility::XAccessibleEventBroadcaster;
  85
  86     interface ::com::sun::star::accessibility::XAccessibleComponent;
  87
  88     interface ::com::sun::star::accessibility::XAccessibleExtendedComponent;
  89
  90     /** This interface gives read-only access to the text representation
  91         of a button.
  92      */
  93     interface ::com::sun::star::accessibility::XAccessibleText;
  94
  95     /** This interface gives access to the actions that can be executed for
  96         a button. The supported actions for a button are:
  97         <ul>
  98         <li>click</li>
  99         </ul>
 100      */
 101     interface ::com::sun::star::accessibility::XAccessibleAction;
 102
 103     /** This interface gives access to the numerical value of a button,
 104         which is related to the button's
 105         <const scope="com::sun::star::accessibility"
 106         >AccessibleStateType::PRESSED</const> state.
 107      */
 108     interface ::com::sun::star::accessibility::XAccessibleValue;
 109
 110 };
 111
 112 }; }; }; };
 113
 114 #endif
 115
 116 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */