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/frame/XToolbarController.idl | |
parent | Initial commit. (diff) | |
download | libreoffice-upstream/4%7.4.7.tar.xz libreoffice-upstream/4%7.4.7.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/frame/XToolbarController.idl')
-rw-r--r-- | offapi/com/sun/star/frame/XToolbarController.idl | 92 |
1 files changed, 92 insertions, 0 deletions
diff --git a/offapi/com/sun/star/frame/XToolbarController.idl b/offapi/com/sun/star/frame/XToolbarController.idl new file mode 100644 index 000000000..c8f7578ab --- /dev/null +++ b/offapi/com/sun/star/frame/XToolbarController.idl @@ -0,0 +1,92 @@ +/* -*- 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_frame_XToolbarController_idl__ +#define __com_sun_star_frame_XToolbarController_idl__ + +#include <com/sun/star/awt/XWindow.idl> +#include <com/sun/star/awt/KeyModifier.idl> + + + module com { module sun { module star { module frame { + +/** is an abstract service for a component which offers a more complex user interface + to users within a toolbar. + + <p> + A generic toolbar function is represented as a button which has a state + (enabled,disabled and selected, not selected). A toolbar controller can be added to a + toolbar and provide information or functions with a more sophisticated user interface.<br/> + A typical example for toolbar controller is a font chooser on a toolbar. It provides + all available fonts in a dropdown box and shows the current chosen font. + <p> + + @see com::sun::star::frame::XDispatchProvider + + @since OOo 2.0 + */ +interface XToolbarController : com::sun::star::uno::XInterface +{ + /** provides a function to execute the command which is bound to the toolbar controller. + + @param KeyModifier + a combination of com::sun::star::awt::KeyModifier value that represent + the current state of the modifier keys. + + <p> + This function is usually called by a toolbar implementation when a user clicked on a toolbar button + or pressed enter on the keyboard when the item has the input focus. + </p> + */ + void execute( [in] short KeyModifier ); + + /** notifies a component that a single click has been made on the toolbar item. + */ + void click(); + + /** notifies a component that a double click has been made on the toolbar item. + */ + void doubleClick(); + + /** requests to create a pop-up window for additional functions. + + @return + a com::sun::star::awt::XWindow which provides additional functions + to the user. The reference must be empty if component does not want to provide a separate + window. + */ + com::sun::star::awt::XWindow createPopupWindow(); + + /** requests to create an item window which can be added to the toolbar. + + @param Parent + a com::sun::star::awt::XWindow which must be used as a parent + for the requested item window. + + @return + a com::sun::star::awt::XWindow which can be added to a toolbar. + The reference must be empty if a component does not want to provide an item window. + */ + com::sun::star::awt::XWindow createItemWindow( [in] com::sun::star::awt::XWindow Parent ); +}; + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ |