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

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27 #ifndef __com_sun_star_frame_StatusbarController_idl__
  28 #define __com_sun_star_frame_StatusbarController_idl__
  29
  30 #ifndef __com_sun_star_lang_XInitialization_idl__
  31 #include <com/sun/star/lang/XInitialization.idl>
  32 #endif
  33
  34 #ifndef __com_sun_star_util_XUpdatable_idl__
  35 #include <com/sun/star/util/XUpdatable.idl>
  36 #endif
  37
  38 #ifndef __com_sun_star_frame_XStatusListener_idl__
  39 #include <com/sun/star/frame/XStatusListener.idl>
  40 #endif
  41
  42 #ifndef __com_sun_star_frame_XStatusbarController_idl__
  43 #include <com/sun/star/frame/XStatusbarController.idl>
  44 #endif
  45
  46 //=============================================================================
  47
  48  module com {  module sun {  module star {  module frame {
  49
  50 //=============================================================================
  51 /** is an abstract service for a component which offers a more complex user
  52     interface to users within a status bar.
  53
  54     <p>
  55     A generic status bar function is represented as a text field which
  56     provides status information to the user. A status bar controller can be
  57     added to a status bar and provides information or functions with a more
  58     sophisticated user interface.<br/>
  59     A typical example for a status bar controller is the zoom level chooser
  60     within the statusbar. It provides an option to change the zoom level of
  61     an application.
  62     <p>
  63
  64     @see com::sun::star::frame::XDispatchProvider
  65     @see com::sun::star::frame::XStatusbarController
  66
  67     @since OOo 2.0.0
  68  */
  69
  70 service StatusbarController
  71 {
  72     //-------------------------------------------------------------------------
  73     /** with this interface a component can receive events if a feature has
  74         changed.
  75
  76         <p>
  77         The status bar controller implementation should register itself as a
  78         listener when its <member scope="com::sun::star::util">XUpdatable</member>
  79         interface has been called.
  80         </p>
  81      */
  82     interface com::sun::star::frame::XStatusListener;
  83
  84     /** used to initialize a component with required arguments.
  85
  86         <b>A status bar controller needs at least three additional arguments
  87         provided as <type scope="com::sun::star::beans">PropertyValue</type>:
  88         <ul>
  89             <li><b>Frame</b><br>a
  90                    <type scope="com::sun::star::frame">XFrame</type> instance
  91                    to which the status bar controller belongs.</li>
  92             <li><b>CommandURL</b><br>a string which specifies the command
  93                    associated with the statusbar controller. The command is
  94                    used to identify the status bar controller
  95                    implementation.</li>
  96             <li><b>ServiceManager</b><br>a <type scope="com::sun::star::lang">
  97                    XMultiServiceFactory</type> instance which can be used to
  98                    create additional UNO services.</li>
  99             <li><b>Parent</b><br>a <type scope="com::sun::star::awt">Window</type>
 100                    instance which represents the parent window (status bar
 101                    window).</li>
 102             <li><b>Identifier</b><br>an integer value which is the unique id
 103                    used by the status bar implementation to identify a status
 104                    bar entry. This value is currently only used by internal
 105                    OpenOffice.org status bar controller implementations.</li>
 106         </ul>
 107     */
 108     interface com::sun::star::lang::XInitialization;
 109
 110     /** used to notify an implementation that it needs to add its listener or
 111         remove and add them again.
 112
 113         <p>
 114         A status bar controller instance is ready for use after this call has
 115         been made the first time. The status bar implementation guarentees that
 116         the controller's item window has been added to the status bar and its
 117         reference is held by it.
 118         </p>
 119     */
 120     interface com::sun::star::util::XUpdatable;
 121
 122     //-------------------------------------------------------------------------
 123     /** used to notify changed features and requests for additional user
 124         interface items.
 125
 126         <p>
 127         Mostly used by a status bar implementation to forward information to
 128         and request services from a status bar controller component. This
 129         interface must be useable after
 130         <member scope="com::sun::star::lang">XInitialitation::initialize</member>
 131         has been called.  The behavior of the interface is undefined if the
 132         controller component hasn't been initialized.
 133         </p>
 134      */
 135     interface com::sun::star::frame::XStatusbarController;
 136 };
 137
 138 //=============================================================================
 139
 140 }; }; }; };
 141
 142 #endif