/* -*- 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 awt {

/** specifies accessibility support for a menu.

    @since OOo 1.1.2
 */
service AccessibleMenu
{
    /** This interface gives access to the structural information of a menu:

        <ul>
        <li>Role: The role of a menu is
            com::sun::star::accessibility::AccessibleRole::MENU.</li>
        <li>Name: The name of a menu is the localized item text.</li>
        <li>Description: The description of a menu is its localized
            help text.</li>
        <li>Children: The children of a menu are menus, menu items or
            menu separators, whose accessible context supports the services
            AccessibleMenu, AccessibleMenuItem or
            AccessibleMenuSeparator.</li>
        <li>Parent: The parent of a menu is a menu bar, a pop-up menu or
            a menu, whose accessible context supports the services
            AccessibleMenuBar, AccessiblePopupMenu
            or AccessibleMenu.</li>
        <li>Relations: There are no relations.</li>
        <li>States: The states supported by this service are
            <ul>
            <li>com::sun::star::accessibility::AccessibleStateType::ARMED
                is set if the object is highlighted.</li>
            <li>com::sun::star::accessibility::AccessibleStateType::CHECKABLE
                is set if the object is checkable, i.e. can be checked.</li>
            <li>com::sun::star::accessibility::AccessibleStateType::CHECKED
                is set if the object is currently checked.</li>
            <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::OPAQUE
                is always set.</li>
            <li>com::sun::star::accessibility::AccessibleStateType::SELECTABLE
                is always set.</li>
            <li>com::sun::star::accessibility::AccessibleStateType::SELECTED
                is set if the object is selected.</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>
            </ul>
            </li>
        </ul>
     */
    interface ::com::sun::star::accessibility::XAccessibleContext;

    interface ::com::sun::star::accessibility::XAccessibleEventBroadcaster;

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

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

    /** This interface gives read-only access to the text representation
        of a menu.
     */
    interface ::com::sun::star::accessibility::XAccessibleText;

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

    /** This interface gives access to the numerical value of a
        menu, which is related to the menu's
        com::sun::star::accessibility::AccessibleStateType::SELECTED state.
     */
    interface ::com::sun::star::accessibility::XAccessibleValue;

    /** This interface gives access to the selectable children of a
        menu.
     */
    interface ::com::sun::star::accessibility::XAccessibleSelection;

};

}; }; }; };

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