xref: /trunk/main/offapi/com/sun/star/ui/UICommandDescription.idl (revision f431c806)

/**************************************************************
 *
 * 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
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 *
 *************************************************************/



#ifndef __com_sun_star_ui_UICommandDescription_idl__
#define __com_sun_star_ui_UICommandDescription_idl__

#ifndef __com_sun_star_container_XNameAccess_idl__
#include <com/sun/star/container/XNameAccess.idl>
#endif

//=============================================================================

module com { module sun { module star { module ui {

//=============================================================================

/** a service which provides information about user interface commands of modules.

    <p>
    OpenOffice.org has an amount of commands that can be used by user interface
    elements. This service provides access to the user interface commands that
    are part of OpenOffice.org modules, like Writer or Calc.
    </p>

    @since OpenOffice 2.0
*/

service UICommandDescription
{
    /** provides access to user interface commands of the installed modules.

        <p>
        To access the user interface command description of a module, a unique module specifier
        must be provided to <member scope="com::sun::star::container">XNameAccess::getByName()</member> function.
        The module specifier can be retrieved from the <type scope="com::sun::star::frame">ModuleManager</type>
        service. The interface provides references to <type scope="com::sun:star::ui">ModuleUICommandDescription</type>.
        </p>

        @see com::sun::star::frame::ModuleManager
    */

    interface com::sun::star::container::XNameAccess;
};

}; }; }; };

#endif