AOO410/main/offapi/com/sun/star/ui/UICategoryDescription.idl

/**************************************************************
 * 
 * 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_UICategoryDescription_idl__
#define __com_sun_star_ui_UICategoryDescription_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 command 
    categories.

    <p>
    OpenOffice.org has an amount of commands that can be used by user 
    interface elements. Every command is member of a single category. 
    Categories makes it easier to handle to huge amount of commands 
    provided by OpenOffice.org. This service is normally used by UI 
    implementations which provides all commands to a user.
    </p>
    
    @since OpenOffice 2.0
*/

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

service UICategoryDescription
{
    /** provides access to user interface command categories of the installed 
        modules.

        <p>
        To access the user interface command categories 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;
};

}; }; }; }; // com.sun.star.ui

#endif