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