xref: /AOO41X/main/offapi/com/sun/star/frame/StatusbarController.idl (revision cdf0e10c4e3984b49a9502b011690b615761d4a3)

/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/
#ifndef __com_sun_star_frame_StatusbarController_idl__
#define __com_sun_star_frame_StatusbarController_idl__

#ifndef __com_sun_star_lang_XInitialization_idl__
#include <com/sun/star/lang/XInitialization.idl>
#endif

#ifndef __com_sun_star_util_XUpdatable_idl__
#include <com/sun/star/util/XUpdatable.idl>
#endif

#ifndef __com_sun_star_frame_XStatusListener_idl__
#include <com/sun/star/frame/XStatusListener.idl>
#endif

#ifndef __com_sun_star_frame_XStatusbarController_idl__
#include <com/sun/star/frame/XStatusbarController.idl>
#endif

//=============================================================================

 module com {  module sun {  module star {  module frame {

//=============================================================================
/** is an abstract service for a component which offers a more complex user
    interface to users within a status bar.

    <p>
    A generic status bar function is represented as a text field which
    provides status information to the user. A status bar controller can be
    added to a status bar and provides information or functions with a more
    sophisticated user interface.<br/>
    A typical example for a status bar controller is the zoom level chooser
    within the statusbar. It provides an option to change the zoom level of
    an application.
    <p>

    @see com::sun::star::frame::XDispatchProvider
    @see com::sun::star::frame::XStatusbarController

    @since OOo 2.0
 */

service StatusbarController
{
    //-------------------------------------------------------------------------
    /** with this interface a component can receive events if a feature has
        changed.

        <p>
        The status bar controller implementation should register itself as a
        listener when its <member scope="com::sun::star::util">XUpdatable</member>
        interface has been called.
        </p>
     */
    interface com::sun::star::frame::XStatusListener;

    /** used to initialize a component with required arguments.

        <b>A status bar controller needs at least three additional arguments
        provided as <type scope="com::sun::star::beans">PropertyValue</type>:
        <ul>
            <li><b>Frame</b><br>a
                   <type scope="com::sun::star::frame">XFrame</type> instance
                   to which the status bar controller belongs.</li>
            <li><b>CommandURL</b><br>a string which specifies the command
                   associated with the statusbar controller. The command is
                   used to identify the status bar controller
                   implementation.</li>
            <li><b>ServiceManager</b><br>a <type scope="com::sun::star::lang">
                   XMultiServiceFactory</type> instance which can be used to
                   create additional UNO services.</li>
            <li><b>Parent</b><br>a <type scope="com::sun::star::awt">Window</type>
                   instance which represents the parent window (status bar
                   window).</li>
            <li><b>Identifier</b><br>an integer value which is the unique id
                   used by the status bar implementation to identify a status
                   bar entry. This value is currently only used by internal
                   OpenOffice.org status bar controller implementations.</li>
        </ul>
    */
    interface com::sun::star::lang::XInitialization;

    /** used to notify an implementation that it needs to add its listener or
        remove and add them again.

        <p>
        A status bar controller instance is ready for use after this call has
        been made the first time. The status bar implementation guarentees that
        the controller's item window has been added to the status bar and its
        reference is held by it.
        </p>
    */
    interface com::sun::star::util::XUpdatable;

    //-------------------------------------------------------------------------
    /** used to notify changed features and requests for additional user
        interface items.

        <p>
        Mostly used by a status bar implementation to forward information to
        and request services from a status bar controller component. This
        interface must be useable after
        <member scope="com::sun::star::lang">XInitialitation::initialize</member>
        has been called.  The behavior of the interface is undefined if the
        controller component hasn't been initialized.
        </p>
     */
    interface com::sun::star::frame::XStatusbarController;
};

//=============================================================================

}; }; }; };

#endif