Quelle  ActionTriggerContainer.idl   Sprache: C

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


/** describes a container of user actions.

    <p>No assumption is made about any graphical representation:
    You could have a menu or a toolbox working with the same container
    describing their entries.</p>

    <p>Possible elements of the ActionTriggerContainer are
        <ul>
            <li>ActionTrigger -
                        represents a simply clickable menu entry</li>
            <li>ActionTriggerSeparator -
                        represents a separator between two entries<br/>
                 This entry type is of interest for components rendering a an
                 ActionTriggerContainer
             </li>
            <li>ActionTriggerContainer -
                represents a sub container</li>
        </ul>
    </p>
*/
published service ActionTriggerContainer
{
    /** provides access to the entries of a menu. The element type
     is com::sun::star::beans::XPropertySet.
     The property set contains attributes like CommandURL, HelpURL
     as defined in the service com::sun::star::ui::ActionTrigger
     and optional a com::sun::star::ui::ActionTriggerContainer.
     */

    interface ::com::sun::star::container::XIndexContainer;

    /** creates elements to be inserted into the container.
        <p>Usually, the XMultiServiceFactory::getSupportedServiceNames()
        gives you an ActionTrigger and
        optionally ActionTriggerContainer and
        ActionTriggerSeparator

     .</p>
     */
    interface ::com::sun::star::lang::XMultiServiceFactory;

    /** allows to enumerate the elements of the container
    */
    [optional] interface ::com::sun::star::container::XEnumerationAccess;

    /** allows foreign components to register themselves as listener for the container
        structure.
    */
    [optional] interface ::com::sun::star::container::XContainer;
};
}; }; }; };

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