offapi/com/sun/star/frame/StatusbarController.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: StatusbarController.idl,v $
  10  * $Revision: 1.6 $
  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_StatusbarController_idl__
  31 #define __com_sun_star_frame_StatusbarController_idl__
  32
  33 #ifndef __com_sun_star_lang_XInitialization_idl__
  34 #include <com/sun/star/lang/XInitialization.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_util_XUpdatable_idl__
  38 #include <com/sun/star/util/XUpdatable.idl>
  39 #endif
  40
  41 #ifndef __com_sun_star_frame_XStatusListener_idl__
  42 #include <com/sun/star/frame/XStatusListener.idl>
  43 #endif
  44
  45 #ifndef __com_sun_star_frame_XStatusbarController_idl__
  46 #include <com/sun/star/frame/XStatusbarController.idl>
  47 #endif
  48
  49 //=============================================================================
  50
  51  module com {  module sun {  module star {  module frame {
  52
  53 //=============================================================================
  54 /** is an abstract service for a component which offers a more complex user
  55     interface to users within a status bar.
  56
  57     <p>
  58     A generic status bar function is represented as a text field which
  59     provides status information to the user. A status bar controller can be
  60     added to a status bar and provides information or functions with a more
  61     sophisticated user interface.<br/>
  62     A typical example for a status bar controller is the zoom level chooser
  63     within the statusbar. It provides an option to change the zoom level of
  64     an application.
  65     <p>
  66
  67     @see com::sun::star::frame::XDispatchProvider
  68     @see com::sun::star::frame::XStatusbarController
  69
  70     @since OOo 2.0.0
  71  */
  72
  73 service StatusbarController
  74 {
  75     //-------------------------------------------------------------------------
  76     /** with this interface a component can receive events if a feature has
  77         changed.
  78
  79         <p>
  80         The status bar controller implementation should register itself as a
  81         listener when its <member scope="com::sun::star::util">XUpdatable</member>
  82         interface has been called.
  83         </p>
  84      */
  85     interface com::sun::star::frame::XStatusListener;
  86
  87     /** used to initialize a component with required arguments.
  88
  89         <b>A status bar controller needs at least three additional arguments
  90         provided as <type scope="com::sun::star::beans">PropertyValue</type>:
  91         <ul>
  92             <li><b>Frame</b><br>a
  93                    <type scope="com::sun::star::frame">XFrame</type> instance
  94                    to which the status bar controller belongs.</li>
  95             <li><b>CommandURL</b><br>a string which specifies the command
  96                    associated with the statusbar controller. The command is
  97                    used to identify the status bar controller
  98                    implementation.</li>
  99             <li><b>ServiceManager</b><br>a <type scope="com::sun::star::lang">
 100                    XMultiServiceFactory</type> instance which can be used to
 101                    create additional UNO services.</li>
 102             <li><b>Parent</b><br>a <type scope="com::sun::star::awt">Window</type>
 103                    instance which represents the parent window (status bar
 104                    window).</li>
 105             <li><b>Identifier</b><br>an integer value which is the unique id
 106                    used by the status bar implementation to identify a status
 107                    bar entry. This value is currently only used by internal
 108                    OpenOffice.org status bar controller implementations.</li>
 109         </ul>
 110     */
 111     interface com::sun::star::lang::XInitialization;
 112
 113     /** used to notify an implementation that it needs to add its listener or
 114         remove and add them again.
 115
 116         <p>
 117         A status bar controller instance is ready for use after this call has
 118         been made the first time. The status bar implementation guarentees that
 119         the controller's item window has been added to the status bar and its
 120         reference is held by it.
 121         </p>
 122     */
 123     interface com::sun::star::util::XUpdatable;
 124
 125     //-------------------------------------------------------------------------
 126     /** used to notify changed features and requests for additional user
 127         interface items.
 128
 129         <p>
 130         Mostly used by a status bar implementation to forward information to
 131         and request services from a status bar controller component. This
 132         interface must be useable after
 133         <member scope="com::sun::star::lang">XInitialitation::initialize</member>
 134         has been called.  The behavior of the interface is undefined if the
 135         controller component hasn't been initialized.
 136         </p>
 137      */
 138     interface com::sun::star::frame::XStatusbarController;
 139 };
 140
 141 //=============================================================================
 142
 143 }; }; }; };
 144
 145 #endif