offapi/com/sun/star/frame/XSubToolbarController.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 #ifndef __com_sun_star_frame_XSubToolbarController_idl__
  20 #define __com_sun_star_frame_XSubToolbarController_idl__
  21
  22 #include <com/sun/star/uno/XInterface.idl>
  23
  24
  25  module com {  module sun {  module star {  module frame {
  26
  27 /** special interface to support sub-toolbars in a controller implementation.
  28
  29     <p>
  30     This interface is normally used to implement the toolbar button/sub-
  31     toolbar function feature. It exchanges the function of the toolbar
  32     button, that opened the sub-toolbar, with the one that has been selected
  33     on the sub-toolbar.
  34     </p>
  35
  36     @see com::sun::star::frame::ToolbarController
  37
  38     @since OOo 2.0
  39  */
  40 interface XSubToolbarController : com::sun::star::uno::XInterface
  41 {
  42     /** if the controller features a sub-toolbar.
  43
  44         @return
  45             `TRUE` if the controller offers a sub toolbar, otherwise `FALSE`.
  46
  47         <p>
  48         Enables implementations to dynamically decide to support sub-toolbars
  49         or not.
  50         </p>
  51     */
  52     boolean opensSubToolbar();
  53
  54     /** provides the resource URL of the sub-toolbar this controller opens.
  55
  56         @return
  57             name of the sub-toolbar this controller offers. A empty string
  58             will be interpreted as if this controller offers no sub-toolbar.
  59     */
  60     string getSubToolbarName();
  61
  62     /** gets called to notify a controller that a sub-toolbar function has been
  63         selected.
  64
  65         @param aCommand
  66             a string which identifies the function that has been selected by
  67             a user.
  68     */
  69     void functionSelected( [in] string aCommand );
  70
  71     /** gets called to notify a controller that it should set an image which
  72         represents the current selected function.
  73
  74         <p>
  75         Only the controller instance is able to set the correct image for the
  76         current function. A toolbar implementation will ask sub-toolbar
  77         controllers to update their image whenever it has to update the images
  78         of all its buttons.
  79         </p>
  80     */
  81     void updateImage();
  82 };
  83
  84 }; }; }; };
  85
  86 #endif
  87
  88 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */