/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
 */


module com { module sun { module star { module accessibility {

 interface XAccessibleAction;
 interface XAccessibleText;
 interface XAccessibleValue;
 interface XAccessibleExtendedComponent;
 interface XAccessibleComponent;

}; }; }; };

module com { module sun { module star { module awt {

/** specifies accessibility support for a tool box item.

    @see com::sun::star::accessibility::AccessibleContext

    @see com::sun::star::accessibility::XAccessibleComponent
    @see com::sun::star::accessibility::XAccessibleExtendedComponent

    @see com::sun::star::accessibility::XAccessibleAction
    @see com::sun::star::accessibility::XAccessibleText
    @see com::sun::star::accessibility::XAccessibleValue

    @since OOo 1.1.2
*/
service AccessibleToolBoxItem
{
    /** This interface gives access to the structural information of a tool box item:

       <ul>
       <li>Role: The role of a tool box item is
           com::sun::star::accessibility::AccessibleRole::PUSH_BUTTON when the item is a push button, or
           com::sun::star::accessibility::AccessibleRole::TOGGLE_BUTTON when the item is a button and checkable, or
           com::sun::star::accessibility::AccessibleRole::PANEL when the item is a window, or
           com::sun::star::accessibility::AccessibleRole::FILLER when the item is a fill item, or
           com::sun::star::accessibility::AccessibleRole::SEPARATOR when the item is a separator.</li>
       <li>Name: The name of a tool box item is the name set.</li>
       <li>Description: The description of a tool box item is its localized
           help text.</li>
       <li>Children: There can exist one child.
            This can be any kind of accessible object.</li>
       <li>Parent: The parent is the tool box that contains the tool box item.</li>
       <li>Relations: There are no relations.</li>
       <li>States: The states supported by this service are
           <ul>
           <li>com::sun::star::accessibility::AccessibleStateType::DEFUNC
               is set if the object has already been disposed
               and subsequent calls to this object result in
               com::sun::star::lang::DisposedException
               exceptions.</li>
           <li>com::sun::star::accessibility::AccessibleStateType::ENABLED
               is set if the object is enabled.</li>
           <li>com::sun::star::accessibility::AccessibleStateType::FOCUSABLE
               is always set.</li>
           <li>com::sun::star::accessibility::AccessibleStateType::FOCUSED
               is set if the object currently has the keyboard focus.</li>
           <li>com::sun::star::accessibility::AccessibleStateType::SHOWING
               is set if the object is displayed on the screen.</li>
           <li>com::sun::star::accessibility::AccessibleStateType::VISIBLE
               is always set.</li>
           <li>com::sun::star::accessibility::AccessibleStateType::CHECKABLE
               is set if the tool box item is checkable, i.e. it can be checked.</li>
           <li>com::sun::star::accessibility::AccessibleStateType::CHECKED
               is set if the tool box item is checked.</li>
           </ul>
           </li>
       </ul>
    */
    service   com::sun::star::accessibility::AccessibleContext;

    interface com::sun::star::accessibility::XAccessibleComponent;
    interface com::sun::star::accessibility::XAccessibleExtendedComponent;

    /** This interface gives access to the actions that can be executed for
        a menu. The supported actions for a tool box item are:
        <ul>
        <li>click</li>
        </ul>
     */
    interface com::sun::star::accessibility::XAccessibleAction;

    /** This interface gives read-only access to the text representation
        of a tool box item.
     */
    interface com::sun::star::accessibility::XAccessibleText;
    /** This interface gives access to the numerical value of a
        tool box item, which is related to the tool box item's
        com::sun::star::accessibility::AccessibleStateType::CHECKED state.
     */
    interface com::sun::star::accessibility::XAccessibleValue;
};

}; }; }; };

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */