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