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

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XSubToolbarController.idl,v $
  10  * $Revision: 1.5 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_frame_XSubToolbarController_idl__
  31 #define __com_sun_star_frame_XSubToolbarController_idl__
  32
  33 #ifndef __com_sun_star_uno_XInterface_idl__
  34 #include <com/sun/star/uno/XInterface.idl>
  35 #endif
  36
  37 //=============================================================================
  38
  39  module com {  module sun {  module star {  module frame {
  40
  41 //=============================================================================
  42 /** special interface to support sub-toolbars in a controller implementation.
  43
  44     <p>
  45     This interface is normally used to implement the toolbar button/sub-
  46     toolbar function feature. It exchanges the function of the toolbar
  47     button, that opened the sub-toolbar, with the one that has been selected
  48     on the sub-toolbar.
  49     </p>
  50
  51     @see com::sun::star::frame::ToolbarController
  52
  53     @since OOo 2.0.0
  54  */
  55 interface XSubToolbarController : com::sun::star::uno::XInterface
  56 {
  57     //=============================================================================
  58     /** if the controller features a sub-toolbar.
  59
  60         @return
  61             <TRUE/> if the controller offers a sub toolbar, otherwise <FALSE/>.
  62
  63         <p>
  64         Enables implementations to dynamically decide to support sub-toolbars
  65         or not.
  66         </p>
  67     */
  68     boolean opensSubToolbar();
  69
  70     //=============================================================================
  71     /** provides the resource URL of the sub-toolbar this controller opens.
  72
  73         @return
  74             name of the sub-toolbar this controller offers. A empty string
  75             will be interpreted as if this controller offers no sub-toolbar.
  76     */
  77     string getSubToolbarName();
  78
  79     //=============================================================================
  80     /** gets called to notify a controller that a sub-toolbar function has been
  81         selected.
  82
  83         @param aCommand
  84             a string which identifies the function that has been selected by
  85             a user.
  86     */
  87     void functionSelected( [in] string aCommand );
  88
  89     //=============================================================================
  90     /** gets called to notify a controller that it should set an image which
  91         represents the current selected function.
  92
  93         <p>
  94         Only the controller instance is able to set the correct image for the
  95         current function. A toolbar implementation will ask sub-toolbar
  96         controllers to update their image whenever it has to update the images
  97         of all its buttons.
  98         </p>
  99     */
 100     void updateImage();
 101 };
 102
 103 }; }; }; };
 104
 105 #endif