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