diff options
author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-07 09:06:44 +0000 |
---|---|---|
committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-07 09:06:44 +0000 |
commit | ed5640d8b587fbcfed7dd7967f3de04b37a76f26 (patch) | |
tree | 7a5f7c6c9d02226d7471cb3cc8fbbf631b415303 /offapi/com/sun/star/ui/ModuleUICommandDescription.idl | |
parent | Initial commit. (diff) | |
download | libreoffice-upstream.tar.xz libreoffice-upstream.zip |
Adding upstream version 4:7.4.7.upstream/4%7.4.7upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'offapi/com/sun/star/ui/ModuleUICommandDescription.idl')
-rw-r--r-- | offapi/com/sun/star/ui/ModuleUICommandDescription.idl | 74 |
1 files changed, 74 insertions, 0 deletions
diff --git a/offapi/com/sun/star/ui/ModuleUICommandDescription.idl b/offapi/com/sun/star/ui/ModuleUICommandDescription.idl new file mode 100644 index 000000000..d4364a329 --- /dev/null +++ b/offapi/com/sun/star/ui/ModuleUICommandDescription.idl @@ -0,0 +1,74 @@ +/* -*- 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 . + */ + +#ifndef __com_sun_star_ui_ModuleUICommandDescription_idl__ +#define __com_sun_star_ui_ModuleUICommandDescription_idl__ + +#include <com/sun/star/container/XNameAccess.idl> + + +module com { module sun { module star { module ui { + + +/** a service which provides information about the user interface commands 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 OOo 2.0 +*/ + +service ModuleUICommandDescription +{ + /** provides access to user interface commands of an installed module. + + <p> + An implementation must provide a com::sun::star::uno::Sequence which + has com::sun::star::beans::PropertyValue as entries. The following + entries a defined: + <ul> + <li><b>Label</b><br>a string which specifies the short name of the user interface command with + mnemonic and optional subsequent ... if the command needs additional user input. This string + can directly be used to set the text of a menu item.</li> + <li><b>Name</b><br>a string which specifies the short name of the user interface command without + any additional information. It can be used for the bubble help.</li> + <li><b>Popup</b><br>a boolean which specifies if the user interface command is a unique + identifier for a pop-up menu. A pop-up menu has a label, but is not bound to a command.</li> + </ul> + The key to a user interface command description is the user interface command itself which has + the following syntax ".uno:$Command". For example ".uno:Open" shows the file open dialog. + A complete list of user interface commands can be found inside the latest OpenOffice Developers Guide + or online at http://framework.openoffice.org. + </p> + + @see com::sun::star::frame::ModuleManager + */ + + interface com::sun::star::container::XNameAccess; +}; + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ |