offapi/com/sun/star/awt/AccessibleRadioButton.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_AccessibleRadioButton_idl__
  30 #define __com_sun_star_awt_AccessibleRadioButton_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 radio button.
  43
  44     @since OOo 1.1.2
  45  */
  46 published service AccessibleRadioButton
  47 {
  48     /** This interface gives access to the structural information of a
  49         radio button:
  50
  51         <ul>
  52         <li>Role: The role of a radio button is <const
  53             scope="com::sun::star::accessibility"
  54             >AccessibleRole::RADIO_BUTTON</const>.</li>
  55         <li>Name: The name of a radio button is its localized label.</li>
  56         <li>Description: The description of a radio button is its localized
  57             help text.</li>
  58         <li>Children: There are no children.</li>
  59         <li>Parent: The parent is the window that contains the radio button.</li>
  60         <li>Relations: The relations supported by this service are
  61             <ul>
  62             <li><const scope="com::sun::star::accessibility"
  63                 >AccessibleRelationType::MEMBER_OF</const> is set
  64                 if the object is a member of a group of one or more
  65                 target objects.</li>
  66             </ul>
  67             </li>
  68         <li>States: The states supported by this service are
  69             <ul>
  70             <li><const scope="com::sun::star::accessibility"
  71                 >AccessibleStateType::CHECKED</const> is set
  72                 if the object is currently checked.</li>
  73             <li><const scope="com::sun::star::accessibility"
  74                 >AccessibleStateType::DEFUNC</const>
  75                 is set if the object has already been disposed
  76                 and subsequent calls to this object result in
  77                 <type scope="com::sun::star::lang">DisposedException</type>
  78                 exceptions.</li>
  79             <li><const scope="com::sun::star::accessibility"
  80                 >AccessibleStateType::ENABLED</const> is set
  81                 if the object is enabled.</li>
  82             <li><const scope="com::sun::star::accessibility"
  83                 >AccessibleStateType::FOCUSABLE</const> is always set.</li>
  84             <li><const scope="com::sun::star::accessibility"
  85                 >AccessibleStateType::FOCUSED</const> is set
  86                 if the object currently has the keyboard focus.</li>
  87             <li><const scope="com::sun::star::accessibility"
  88                 >AccessibleStateType::SHOWING</const> is set
  89                 if the object is displayed on the screen.</li>
  90             <li><const scope="com::sun::star::accessibility"
  91                 >AccessibleStateType::VISIBLE</const> is always set.</li>
  92             </ul>
  93             </li>
  94         </ul>
  95      */
  96     interface ::com::sun::star::accessibility::XAccessibleContext;
  97
  98     interface ::com::sun::star::accessibility::XAccessibleEventBroadcaster;
  99
 100     interface ::com::sun::star::accessibility::XAccessibleComponent;
 101
 102     interface ::com::sun::star::accessibility::XAccessibleExtendedComponent;
 103
 104     /** This interface gives read-only access to the text representation
 105         of a radio button.
 106      */
 107     interface ::com::sun::star::accessibility::XAccessibleText;
 108
 109     /** This interface gives access to the actions that can be executed for
 110         a radio button. The supported actions for a radio button are:
 111         <ul>
 112         <li>click</li>
 113         </ul>
 114      */
 115     interface ::com::sun::star::accessibility::XAccessibleAction;
 116
 117     /** This interface gives access to the numerical value of a
 118         radio button, which is related to the radio button's
 119         <const scope="com::sun::star::accessibility"
 120         >AccessibleStateType::CHECKED</const> state.
 121      */
 122     interface ::com::sun::star::accessibility::XAccessibleValue;
 123
 124 };
 125
 126 }; }; }; };
 127
 128 #endif
 129
 130 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */