AOO410/main/offapi/com/sun/star/ui/ModuleUICategoryDescription.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_ModuleUICommandDescription_idl__
#define __com_sun_star_ui_ModuleUICommandDescription_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 the user interface command
    categories of a single module.

    <p>
    Every OpenOffice.org module 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 a single OpenOffice.org module, like Writer 
    or Calc.
    </p>
    
    @since OpenOffice 2.0
*/

service ModuleUICategoryDescription
{
    /** provides access to user interface command categories of an installed 
        module.
        
        <p>
        An implementation must provide a language dependent string which
        can be used by a UI to display the category name.
        The key to a user interface command category depends on the specific
        implementation. OpenOffice.org uses a pre-defined number of 
        identifiers defined in <type scope="::com::sun:star::frame">
        CommandGroup</type>.
        </p>
        
        @see ::com::sun::star::frame::ModuleManager
        @see ::com::sun::star::frame::CommandGroup        
    */

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

}; }; }; };

#endif