offapi/com/sun/star/awt/AccessibleToolBox.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: AccessibleToolBox.idl,v $
  10  * $Revision: 1.10 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef __com_sun_star_accessibility_AccessibleToolBox_idl__
  32 #define __com_sun_star_accessibility_AccessibleToolBox_idl__
  33
  34 #ifndef __com_sun_star_accessibility_AccessibleContext_idl__
  35 #include <com/sun/star/accessibility/AccessibleContext.idl>
  36 #endif
  37
  38
  39 module com { module sun { module star { module accessibility {
  40
  41  published interface XAccessibleExtendedComponent;
  42  published interface XAccessibleComponent;
  43
  44 }; }; }; };
  45
  46 module com { module sun { module star { module awt {
  47
  48
  49
  50 /** specifies accessibility support for a tool box.
  51
  52     @see com::sun::star::accessibility::AccessibleContext
  53     @see com::sun::star::accessibility::XAccessibleComponent
  54     @see com::sun::star::accessibility::XAccessibleExtendedComponent
  55
  56     @since OOo 1.1.2
  57 */
  58 published service AccessibleToolBox
  59 {
  60     /** This interface gives access to the structural information of a tool box:
  61
  62        <ul>
  63        <li>Role: The role of a tool box is <const
  64            scope="com::sun::star::accessibility"
  65            >AccessibleRole::TOOL_BAR</const>.</li>
  66        <li>Name: The name of a tool box is its localized label.</li>
  67        <li>Description: The description of a tool box is its localized
  68            help text.</li>
  69        <li>Children: There exists children of type <type scope="com::sun::star::awt">AccessibleToolBoxItem</type>.
  70        </li>
  71        <li>Parent: The parent is the window that contains the tool box.</li>
  72        <li>Relations: There are no relations.</li>
  73        <li>States: The states supported by this service are
  74            <ul>
  75            <li><const scope="com::sun::star::accessibility"
  76                >AccessibleStateType::DEFUNC</const>
  77                is set if the object has already been disposed
  78                and subsequent calls to this object result in
  79                <type scope="com::sun::star::lang">DisposedException</type>
  80                exceptions.</li>
  81            <li><const scope="com::sun::star::accessibility"
  82                >AccessibleStateType::ENABLED</const> is set
  83                if the object is enabled.</li>
  84            <li><const scope="com::sun::star::accessibility"
  85                >AccessibleStateType::FOCUSABLE</const> is always set.</li>
  86            <li><const scope="com::sun::star::accessibility"
  87                >AccessibleStateType::FOCUSED</const> is set
  88                if the object currently has the keyboard focus.</li>
  89            <li><const scope="com::sun::star::accessibility"
  90                >AccessibleStateType::ACTIVE</const> is set
  91                if a child has currently the focus.</li>
  92            <li><const scope="com::sun::star::accessibility"
  93                >AccessibleStateType::RESIZABLE</const> is set
  94                if the object can be resized.</li>
  95            <li><const scope="com::sun::star::accessibility"
  96                >AccessibleStateType::SHOWING</const> is set
  97                if the object is displayed on the screen.</li>
  98            <li><const scope="com::sun::star::accessibility"
  99                >AccessibleStateType::VISIBLE</const> is always set.</li>
 100            <li><const scope="com::sun::star::accessibility"
 101                >AccessibleStateType::VERTICAL</const> is set
 102                if the tool box is vertical.</li>
 103            <li><const scope="com::sun::star::accessibility"
 104                >AccessibleStateType::HORIZONTAL</const> is set
 105                if the tool box is horizontal.</li>
 106            </ul>
 107            </li>
 108        </ul>
 109     */
 110     service   com::sun::star::accessibility::AccessibleContext;
 111
 112     interface com::sun::star::accessibility::XAccessibleComponent;
 113     interface com::sun::star::accessibility::XAccessibleExtendedComponent;
 114
 115 };
 116
 117 }; }; }; };
 118
 119 #endif