offapi/com/sun/star/awt/AccessibleToolBox.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 XAccessibleExtendedComponent;
  24  interface XAccessibleComponent;
  25
  26 }; }; }; };
  27
  28 module com { module sun { module star { module awt {
  29
  30
  31
  32 /** specifies accessibility support for a tool box.
  33
  34     @see com::sun::star::accessibility::AccessibleContext
  35     @see com::sun::star::accessibility::XAccessibleComponent
  36     @see com::sun::star::accessibility::XAccessibleExtendedComponent
  37
  38     @since OOo 1.1.2
  39 */
  40 service AccessibleToolBox
  41 {
  42     /** This interface gives access to the structural information of a tool box:
  43
  44        <ul>
  45        <li>Role: The role of a tool box is
  46        com::sun::star::accessibility::AccessibleRole::TOOL_BAR.</li>
  47        <li>Name: The name of a tool box is its localized label.</li>
  48        <li>Description: The description of a tool box is its localized
  49            help text.</li>
  50        <li>Children: There exists children of type com::sun::star::awt::AccessibleToolBoxItem.
  51        </li>
  52        <li>Parent: The parent is the window that contains the tool box.</li>
  53        <li>Relations: There are no relations.</li>
  54        <li>States: The states supported by this service are
  55            <ul>
  56            <li>com::sun::star::accessibility::AccessibleStateType::DEFUNC
  57                is set if the object has already been disposed
  58                and subsequent calls to this object result in
  59                com::sun::star::lang::DisposedException
  60                exceptions.</li>
  61            <li>com::sun::star::accessibility::AccessibleStateType::ENABLED
  62                is set if the object is enabled.</li>
  63            <li>com::sun::star::accessibility::AccessibleStateType::FOCUSABLE
  64                is always set.</li>
  65            <li>com::sun::star::accessibility::AccessibleStateType::FOCUSED
  66                is set if the object currently has the keyboard focus.</li>
  67            <li>com::sun::star::accessibility::AccessibleStateType::ACTIVE
  68                is set if a child has currently the focus.</li>
  69            <li>com::sun::star::accessibility::AccessibleStateType::RESIZABLE
  70                is set if the object can be resized.</li>
  71            <li>com::sun::star::accessibility::AccessibleStateType::SHOWING
  72                is set if the object is displayed on the screen.</li>
  73            <li>com::sun::star::accessibility::AccessibleStateType::VISIBLE
  74                is always set.</li>
  75            <li>com::sun::star::accessibility::AccessibleStateType::VERTICAL
  76                is set if the tool box is vertical.</li>
  77            <li>com::sun::star::accessibility::AccessibleStateType::HORIZONTAL
  78                is set if the tool box is horizontal.</li>
  79            </ul>
  80            </li>
  81        </ul>
  82     */
  83     service   com::sun::star::accessibility::AccessibleContext;
  84
  85     interface com::sun::star::accessibility::XAccessibleComponent;
  86     interface com::sun::star::accessibility::XAccessibleExtendedComponent;
  87
  88 };
  89
  90 }; }; }; };
  91
  92 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */