:: com :: sun :: star :: frame ::
|
unpublished |
interface XStatusbarController |
|
|
- Base Interfaces
XStatusbarController
┣ ::com::sun::star::lang::XComponent
┣ ::com::sun::star::lang::XInitialization
┣ XStatusListener
┃ ┗ ::com::sun::star::lang::XEventListener
┗ ::com::sun::star::util::XUpdatable
::com::sun::star::lang::XComponent |
- Description
- 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.
|
::com::sun::star::lang::XInitialization |
- Description
- used to initialize a component with required arguments.
A status bar controller is initialized with five additional
arguments provided as a sequence of
::com::sun::star::beans::PropertyValue:
- Frame
a 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.
- StatusbarItem
a ::com::sun::star::ui::XStatusbarItem
instance which represents the status bar item asociated with
this controller.
- ParentWindow
a com::sun::star::awt::Window
instance which represents the parent window (status bar window).
- ModuleName
a string which specifies the name of the
office module attached to the frame to which this controller
belongs; the value is taken from
XModuleManager::identify().
|
XStatusListener |
- Description
- 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 XUpdatable
interface has been called.
|
::com::sun::star::util::XUpdatable |
- Description
- 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.
|
|
- Usage Restrictions
- not published
- Description
- interface to be implemented by a component offering a more complex user
interface to users within a status bar.
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.
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.
- Since
- OOo 2.0
- See also
- XDispatchProvider
|
Methods' Summary |
mouseButtonDown |
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.
|
mouseMove |
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.
|
mouseButtonUp |
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.
|
command |
is called by a status bar if a command event is available for a controller.
|
paint |
is called by a status bar if the controller has to update the visual
representation.
|
click |
is called by a status bar if the user clicked with mouse into the
field of the corresponding control.
|
doubleClick |
is called by a status bar if the user double-clicked with mouse
into the field of the corresponding control.
|
Methods' Details |
mouseButtonDown
boolean |
mouseButtonDown( |
[in] ::com::sun::star::awt::MouseEvent |
aMouseEvent ); |
- Description
- 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.
- Parameter aMouseEvent
- current information about the mouse pointer.
- Returns
- return true if the event should not be processed and false
if the event should be processed by the status bar.
|
|
mouseMove
boolean |
mouseMove( |
[in] ::com::sun::star::awt::MouseEvent |
aMouseEvent ); |
- Description
- 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.
- Parameter aMouseEvent
- current information about the mouse pointer.
- Returns
- return true if the event should not be processed and false
if the event should be processed by the status bar.
|
|
mouseButtonUp
boolean |
mouseButtonUp( |
[in] ::com::sun::star::awt::MouseEvent |
aMouseEvent ); |
- Description
- 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.
- Parameter aMouseEvent
- current information about the mouse pointer.
- Returns
- return true if the event should not be processed and false
if the event should be processed by the status bar.
|
|
command
void |
command( |
[in] ::com::sun::star::awt::Point |
aPos, |
| [in] long |
nCommand, |
| [in] boolean |
bMouseEvent, |
| [in] any |
aData ); |
- Description
- is called by a status bar if a command event is available for a controller.
- Parameter aPos
- the current mouse position in pixel.
- Parameter nCommand
- describes which command has been invoked.
See ::com::sun::star::awt::Command for
possible values.
- Parameter bMouseEvent
- true if the command is based on a mouse event, otherwise false.
- Parameter aData
- for future use only.
|
|
paint
void |
paint( |
[in] ::com::sun::star::awt::XGraphics |
xGraphics, |
| [in] ::com::sun::star::awt::Rectangle |
rOutputRectangle, |
| [in] long |
nStyle ); |
- Description
- is called by a status bar if the controller has to update the visual
representation.
- Parameter xGraphics
- a reference to a ::com::sun::star::awt::XGraphics
which has to be used to update the visual representation.
- Parameter nCommand
- a ::com::sun::star::awt::Rectangle which
determine the output rectangle for all drawing operations
- Parameter nStyle
- reserved for future use.
|
|
click
void |
click( |
[in] ::com::sun::star::awt::Point |
aPos ); |
- Description
- is called by a status bar if the user clicked with mouse into the
field of the corresponding control.
- Parameter aPos
- the current mouse position in pixel.
|
|
doubleClick
void |
doubleClick( |
[in] ::com::sun::star::awt::Point |
aPos ); |
- Description
- is called by a status bar if the user double-clicked with mouse
into the field of the corresponding control.
- Parameter aPos
- the current mouse position in pixel.
|
|
Top of Page
Copyright © 2013, The Apache Software Foundation, Licensed under the Apache License, Version 2.0. Apache, the Apache feather logo, Apache OpenOffice and OpenOffice.org are trademarks of The Apache Software Foundation. Other names may be trademarks of their respective owners.