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 module com { module sun { module star { module awt {
  21
  22 /** specifies accessibility support for a button.
  23
  24     @since OOo 1.1.2
  25  */
  26 service AccessibleButton
  27 {
  28     /** This interface gives access to the structural information of a button:
  29
  30         <ul>
  31         <li>Role: The role of a button is
  32             com::sun::star::accessibility::AccessibleRole::PUSH_BUTTON.</li>
  33         <li>Name: The name of a button is its localized label.</li>
  34         <li>Description: The description of a button is its localized
  35             help text.</li>
  36         <li>Children: There are no children.</li>
  37         <li>Parent: The parent is the window that contains the button.</li>
  38         <li>Relations: There are no relations.</li>
  39         <li>States: The states supported by this service are
  40             <ul>
  41             <li>com::sun::star::accessibility::AccessibleStateType::CHECKABLE
  42                 is set if the object is checkable, i.e. can be checked.</li>
  43             <li>com::sun::star::accessibility::AccessibleStateType::CHECKED
  44                 is set if the object is currently checked.</li>
  45             <li>com::sun::star::accessibility::AccessibleStateType::DEFUNC
  46                 is set if the object has already been disposed
  47                 and subsequent calls to this object result in
  48                 com::sun::star::lang::DisposedException
  49                 exceptions.</li>
  50             <li>com::sun::star::accessibility::AccessibleStateType::ENABLED
  51                 is set if the object is enabled.</li>
  52             <li>com::sun::star::accessibility::AccessibleStateType::FOCUSABLE
  53                 is always set.</li>
  54             <li>com::sun::star::accessibility::AccessibleStateType::FOCUSED
  55                 is set if the object currently has the keyboard focus.</li>
  56             <li>com::sun::star::accessibility::AccessibleStateType::PRESSED
  57                 is set if the object is currently pressed.</li>
  58             <li>com::sun::star::accessibility::AccessibleStateType::SHOWING
  59                 is set if the object is displayed on the screen.</li>
  60             <li>com::sun::star::accessibility::AccessibleStateType::VISIBLE
  61                 is always set.</li>
  62             </ul>
  63             </li>
  64         </ul>
  65      */
  66     interface ::com::sun::star::accessibility::XAccessibleContext;
  67
  68     interface ::com::sun::star::accessibility::XAccessibleEventBroadcaster;
  69
  70     interface ::com::sun::star::accessibility::XAccessibleComponent;
  71
  72     interface ::com::sun::star::accessibility::XAccessibleExtendedComponent;
  73
  74     /** This interface gives read-only access to the text representation
  75         of a button.
  76      */
  77     interface ::com::sun::star::accessibility::XAccessibleText;
  78
  79     /** This interface gives access to the actions that can be executed for
  80         a button. The supported actions for a button are:
  81         <ul>
  82         <li>click</li>
  83         </ul>
  84      */
  85     interface ::com::sun::star::accessibility::XAccessibleAction;
  86
  87     /** This interface gives access to the numerical value of a button,
  88         which is related to the button's
  89         com::sun::star::accessibility::AccessibleStateType::PRESSED state.
  90      */
  91     interface ::com::sun::star::accessibility::XAccessibleValue;
  92
  93 };
  94
  95 }; }; }; };
  96
  97 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */