diff options
Diffstat (limited to 'offapi/com/sun/star/ui/UICategoryDescription.idl')
-rw-r--r-- | offapi/com/sun/star/ui/UICategoryDescription.idl | 77 |
1 files changed, 77 insertions, 0 deletions
diff --git a/offapi/com/sun/star/ui/UICategoryDescription.idl b/offapi/com/sun/star/ui/UICategoryDescription.idl new file mode 100644 index 000000000000..9853b43fc769 --- /dev/null +++ b/offapi/com/sun/star/ui/UICategoryDescription.idl @@ -0,0 +1,77 @@ +/************************************************************************* + * + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * Copyright 2000, 2010 Oracle and/or its affiliates. + * + * OpenOffice.org - a multi-platform office productivity suite + * + * This file is part of OpenOffice.org. + * + * OpenOffice.org is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License version 3 + * only, as published by the Free Software Foundation. + * + * OpenOffice.org is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License version 3 for more details + * (a copy is included in the LICENSE file that accompanied this code). + * + * You should have received a copy of the GNU Lesser General Public License + * version 3 along with OpenOffice.org. If not, see + * <http://www.openoffice.org/license.html> + * for a copy of the LGPLv3 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 OOo 2.0.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 |