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