//=============================================================================
 
 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.
 
    A generic status bar function is represented as a text field which has 
    provides status information to the user. A status bar controller can be 
    added to a status bar and provide information or functions with a more 
    sophisticated user interface.
    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.
 
    see com::sun::star::frame::XDispatchProvider
    see com::sun::star::frame::XStatusbarController
 
    since OOo 2.0.0
 */
 
service StatusbarController
{
    //-------------------------------------------------------------------------
    /** with this interface a component can receive events if a feature has 
        changed.
 
        The status bar controller implementation should register itself as a 
        listener when its com::sun::star::util::XUpdatable interface has 
        been called.
     */
    interface com::sun::star::frame::XStatusListener;
 
    /** used to initialize a component with required arguments.
 
        A status bar controller needs at least five additional arguments 
        provided as com::sun::star::beans::PropertyValue:
 
        Frame
        a com::sun::star::frame::XFrame instance to which the status bar 
        controller belongs.
 
        CommandURL
        a string which specifies the command associated with the 
        statusbar controller. The command is used to identify the status
        bar controller implementation.
 
        ServiceManager
        a com::sun::star::lang::XMultiServiceFactory instance which can 
        be used to create additional UNO services.
 
        Parent
        a com::sun::star::awt::XWindow instance which represents the parent
        window (status bar window).
 
        Identifier
        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.
    */
    interface com::sun::star::lang::XInitialization;
 
    /** used to notify an implementation that it needs to add its listener or 
        remove and add them again.
 
        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.
    */
    interface com::sun::star::util::XUpdatable;
 
    //-------------------------------------------------------------------------
    /** used to notify changed features and requests for additional user 
        interface items.
 
        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 
        com::sun::star::lang::XInitialitation::initialize has been called.  
        The behavior of the interface is undefined if the controller component 
        hasn't been initialized.
     */
    interface com::sun::star::frame::XStatusbarController;
 
    //-------------------------------------------------------------------------
    /** used to control the life-time of the component
 
        Used by a status bar implementation to control the life-time of
        a status bar controller. The status bar is the only instance which
        is allowed to dispose the component.
     */
    interface com::sun::star::lang::XComponent;
};
 
}; }; }; };

module com {  module sun {  module star {  module frame {
 
//=============================================================================
/** makes it possible to receive events when the state of a feature changes.
 
    <p>
    Nobody guarantee any notification. Use combination of <type>XNotifyingDispatch</type>
    and <type>XDispatchResultListener</type> for that.
    </p>
 
    @see XDispatch
    @see XNotifyingDispatch
    @see XDispatchResultListener
 */
published interface XStatusListener: com::sun::star::lang::XEventListener
{
	//-------------------------------------------------------------------------
	/** is called when the status of the feature changes.
 
        @param State
            provides information about changes of the requested feature
	 */
    [oneway] void statusChanged( [in] FeatureStateEvent State );
};
 
//=============================================================================
 
}; }; }; };

module com {  module sun {  module star {  module lang {  
 
//============================================================================= 
 
// DocMerge from xml: interface com::sun::star::lang::XInitialization
/** initializes an object directly after its creation.
 
	<p>This interface works together with factories. If you want to 
	initialize the object after creation, you should
	support this interface and you may support other interfaces 
	which offer type-safe initialization methods.  </p>
 
    <p>Instead of calling <member>XSingleComponentFactory::createInstanceWithContext</member>
    and later initialize(), you should call 
    <member>XSingleComponentFactory::createInstanceWithArgumentsAndContext</member>
    to pass the arguments to the instance. The reason is, that a component may want to
    return the same instance for the same set of parameters, and it can do so by implementing
    the factory itself.
    </p>
 
 */
published interface XInitialization: com::sun::star::uno::XInterface
{ 
	//------------------------------------------------------------------------- 
 
	// DocMerge from xml: method com::sun::star::lang::XInitialization::initialize
	/** initializes the object. 
 
		<p>It should be called directly after the object is created.
	 */
	void initialize( [in] sequence<any> aArguments ) 
			raises( com::sun::star::uno::Exception ); 
 
}; 
 
//============================================================================= 
 
}; }; }; };

module com {  module sun {  module star {  module util {
 
//=============================================================================
/** is supported by objects with data that can be updated from a data source.
 */
published interface XUpdatable: com::sun::star::uno::XInterface
{
	//-------------------------------------------------------------------------
	/** refreshes the data of the object from the connected data source.
	 */
    void update();
};
 
//=============================================================================

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 field is represented as a simple text field. A status 
    bar controller can be added to a Statusbar and provide information or 
    functions with a more sophisticated user interface.<br/>
    A typical example for status bar controller is a zoom chooser. It shows 
    the current zoom and provides general zoom levels on a popup menu 
    that can be activated by a mouse action for context menus.
    <p>
 
    @see com::sun::star::frame::XDispatchProvider
 
    @since OOo 2.0.0
 */
interface XStatusbarController : ::com::sun::star::uno::XInterface
{
    //=============================================================================
    /** is called by a status bar if the mouse position is within the controller 
        and a mouse button has been pressed. If the controller has captured the 
        mouse input this function is also called when the mouse position is not 
        within the controller.
 
        @param aMouseEvent
            current information about the mouse pointer.
 
        @return
            return <TRUE/> if the event should not be processed and <FALSE/> 
            if the event should be processed by the status bar.
    */
    boolean mouseButtonDown( [in] ::com::sun::star::awt::MouseEvent aMouseEvent );
 
    //=============================================================================
    /** is called by a status bar if the mouse position is within the controller 
        and a mouse has been moved. If the controller has captured the 
        mouse input this function is also called when the mouse position is not 
        within the controller.
 
        @param aMouseEvent
            current information about the mouse pointer.
 
        @return
            return <TRUE/> if the event should not be processed and <FALSE/> 
            if the event should be processed by the status bar.
    */
    boolean mouseMove( [in] ::com::sun::star::awt::MouseEvent aMouseEvent );
 
    //=============================================================================
    /** is called by a status bar if the mouse position is within the controller 
        and a mouse button has been released. If the controller has captured the 
        mouse input this function is also called when the mouse position is not 
        within the controller.
 
        @param aMouseEvent
            current information about the mouse pointer.
 
        @return
            return <TRUE/> if the event should not be processed and <FALSE/> 
            if the event should be processed by the status bar.
    */
    boolean mouseButtonUp( [in] ::com::sun::star::awt::MouseEvent aMouseEvent );
 
    //=============================================================================
    /** is called by a status bar if a command event is available for a controller.
 
        @param aPos
            the current mouse position in pixel.
 
        @param nCommand
            describes which command has been invoked.
 
        @param bMouseEvent
            <TRUE/> if the command is based on a mouse event, otherwise <FALSE/>.
 
        @param aData
            for future use only.
    */
    void command( [in] ::com::sun::star::awt::Point aPos,
                  [in] long nCommand,
                  [in] boolean bMouseEvent,
                  [in] any aData );
 
    //=============================================================================
    /** is called by a status bar if a command event is available for a controller.
 
        @param aPos
            the current mouse position in pixel.
 
        @param nCommand
            describes which command has been invoked.
 
        @param bMouseEvent
            <TRUE/> if the command is based on a mouse event, otherwise <FALSE/>.
 
        @param aData
            for future use only.
    */
    void paint( [in] ::com::sun::star::awt::XGraphics xGraphics,
                [in] ::com::sun::star::awt::Rectangle rOutputRectangle,
                [in] long nItemId,
                [in] long nStyle );
 
    //=============================================================================
    /** is called by a status bar if the user clicked with mouse into the 
        field of the corresponding control.
    */
    void click();
 
    //=============================================================================
    /** is called by a status bar if the user double-clicked with mouse 
        into the field of the corresponding control.
    */
    void doubleClick();
};          
 
}; }; }; };

//============================================================================= 
 
module com {  module sun {  module star {  module lang {  
 
 published interface XEventListener; 
 
//============================================================================= 
 
/** allows to exclicitly free resources and break cyclic references.
 
    Actually the real lifetime of an UNO object is controlled by 
    references kept on interfaces of this object. But there are two
    distinct meanings in keeping a reference to an interface:
    1st to own the object and 2nd to know the object.
 
    You are only allowed to keep references of interfaces
    to UNO objects if you are by definition the owner of that object or
    your reference is very temporary or you have registered an
    EventListener at that object and release the reference when
    "disposing" is called.
 */
published interface XComponent: com::sun::star::uno::XInterface
{ 
    //------------------------------------------------------------------------- 
    /** The owner of an object calls this method to explicitly free all
        resources kept by this object and thus break cyclic references.
 
        Only the owner of this object is allowed to call this method.
        The object should release all resources and references in the
        easiest possible manner ( for instance no serialization should
        take place anymore ).
 
        The object must notify all registered listeners using the method
        XEventListener::disposing. All notfied objects should release 
        there references to this object without calling 
        XComponent::removeEventListener (the disposed object will release 
        the listeners eitherway).
 
        After this method has been called, the object should behave as 
        passive as possible, thus it should ignore all calls in case it 
        can comply with its specification (for instance addEventListener()).
        Often the object can't fulfill its specification anymore, in this 
        case it must throw the DisposedException (which is derived from 
        com::sun::star::uno::RuntimeException) when it gets called.
 
        For some objects no real owner can be identified, thus it can be
        disposed from multiple reference holders. In this case
        the object should be able to cope with multiple dispose()-calls (which
        are inevitable in a multithreaded environment).
    */
    void dispose(); 
 
    //------------------------------------------------------------------------- 	 
    /** adds an event listener to the object. 
 
        The broadcaster fires the disposing method of this listener if the 
        XComponent::dispose method is called.
 
        It is suggested to allow multiple registration of the same listener,
	thus for each time a listener is added, it has to be removed.</p>
 
        If this com::sun::star::lang::XComponent is already disposed when 
        com::sun::star::lang::XComponent::addEventListener is called, the 
        call will not fail with a com::sun::star::lang::DisposedException, 
        but the caller will be notified via the 
        com::sun::star::lang::XEventListener::disposing callback.  This 
        callback can occur synchronously within the 
        com::sun::star::lang::XComponent::addEventListener call.
 
        see XComponent::removeEventListener
    */
    void addEventListener( [in] XEventListener xListener ); 
 
    //------------------------------------------------------------------------- 
    /** removes an event listener from the listener list.
 
	It is a "noop" if the specified listener is not registered.
 
        It is suggested to allow multiple registration of the same listener,
	thus for each time a listener is added, it has to be removed.
 
        If this com::sun::star::lang::XComponent is already disposed when 
        com::sun::star::lang::XComponent::removeEventListener is called, the 
        call will not fail with a com::sun::star::lang::DisposedException,
        but will rather be ignored silently.
 
        see XComponent::addEventListener
    */
    void removeEventListener( [in] XEventListener aListener ); 
}; 
 
//============================================================================= 
}; }; }; };