offapi/com/sun/star/frame/XToolbarController.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20
  21  module com {  module sun {  module star {  module frame {
  22
  23 /** is an abstract service for a component which offers a more complex user interface
  24     to users within a toolbar.
  25
  26     <p>
  27     A generic toolbar function is represented as a button which has a state
  28     (enabled,disabled and selected, not selected). A toolbar controller can be added to a
  29     toolbar and provide information or functions with a more sophisticated user interface.<br/>
  30     A typical example for toolbar controller is a font chooser on a toolbar. It provides
  31     all available fonts in a dropdown box and shows the current chosen font.
  32     <p>
  33
  34     @see com::sun::star::frame::XDispatchProvider
  35
  36     @since OOo 2.0
  37  */
  38 interface XToolbarController : com::sun::star::uno::XInterface
  39 {
  40     /** provides a function to execute the command which is bound to the toolbar controller.
  41
  42         @param KeyModifier
  43             a combination of com::sun::star::awt::KeyModifier value that represent
  44             the current state of the modifier keys.
  45
  46         <p>
  47         This function is usually called by a toolbar implementation when a user clicked on a toolbar button
  48         or pressed enter on the keyboard when the item has the input focus.
  49         </p>
  50     */
  51     void execute( [in] short KeyModifier );
  52
  53     /** notifies a component that a single click has been made on the toolbar item.
  54     */
  55     void click();
  56
  57     /** notifies a component that a double click has been made on the toolbar item.
  58     */
  59     void doubleClick();
  60
  61     /** requests to create a pop-up window for additional functions.
  62
  63         @return
  64             a com::sun::star::awt::XWindow which provides additional functions
  65             to the user. The reference must be empty if component does not want to provide a separate
  66             window.
  67     */
  68     com::sun::star::awt::XWindow createPopupWindow();
  69
  70     /** requests to create an item window which can be added to the toolbar.
  71
  72         @param Parent
  73             a com::sun::star::awt::XWindow which must be used as a parent
  74             for the requested item window.
  75
  76         @return
  77             a com::sun::star::awt::XWindow which can be added to a toolbar.
  78             The reference must be empty if a component does not want to provide an item window.
  79     */
  80     com::sun::star::awt::XWindow createItemWindow( [in] com::sun::star::awt::XWindow Parent );
  81 };
  82
  83 }; }; }; };
  84
  85 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */