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
  43             com::sun::star::accessibility::AccessibleRole::PUSH_BUTTON.</li>
  44         <li>Name: The name of a button is its localized label.</li>
  45         <li>Description: The description of a button is its localized
  46             help text.</li>
  47         <li>Children: There are no children.</li>
  48         <li>Parent: The parent is the window that contains the button.</li>
  49         <li>Relations: There are no relations.</li>
  50         <li>States: The states supported by this service are
  51             <ul>
  52             <li>com::sun::star::accessibility::AccessibleStateType::CHECKED
  53                 is set if the object is currently checked.</li>
  54             <li>com::sun::star::accessibility::AccessibleStateType::DEFUNC
  55                 is set if the object has already been disposed
  56                 and subsequent calls to this object result in
  57                 com::sun::star::lang::DisposedException
  58                 exceptions.</li>
  59             <li>com::sun::star::accessibility::AccessibleStateType::ENABLED
  60                 is set if the object is enabled.</li>
  61             <li>com::sun::star::accessibility::AccessibleStateType::FOCUSABLE
  62                 is always set.</li>
  63             <li>com::sun::star::accessibility::AccessibleStateType::FOCUSED
  64                 is set if the object currently has the keyboard focus.</li>
  65             <li>com::sun::star::accessibility::AccessibleStateType::PRESSED
  66                 is set if the object is currently pressed.</li>
  67             <li>com::sun::star::accessibility::AccessibleStateType::SHOWING
  68                 is set if the object is displayed on the screen.</li>
  69             <li>com::sun::star::accessibility::AccessibleStateType::VISIBLE
  70                 is always set.</li>
  71             </ul>
  72             </li>
  73         </ul>
  74      */
  75     interface ::com::sun::star::accessibility::XAccessibleContext;
  76
  77     interface ::com::sun::star::accessibility::XAccessibleEventBroadcaster;
  78
  79     interface ::com::sun::star::accessibility::XAccessibleComponent;
  80
  81     interface ::com::sun::star::accessibility::XAccessibleExtendedComponent;
  82
  83     /** This interface gives read-only access to the text representation
  84         of a button.
  85      */
  86     interface ::com::sun::star::accessibility::XAccessibleText;
  87
  88     /** This interface gives access to the actions that can be executed for
  89         a button. The supported actions for a button are:
  90         <ul>
  91         <li>click</li>
  92         </ul>
  93      */
  94     interface ::com::sun::star::accessibility::XAccessibleAction;
  95
  96     /** This interface gives access to the numerical value of a button,
  97         which is related to the button's
  98         com::sun::star::accessibility::AccessibleStateType::PRESSED state.
  99      */
 100     interface ::com::sun::star::accessibility::XAccessibleValue;
 101
 102 };
 103
 104 }; }; }; };
 105
 106 #endif
 107
 108 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */