Content for Apache OpenOffice version 3.4.
:: com :: sun :: star :: frame ::
|
| unpublished |
interface XStatusbarController |
|
|
|
- Usage Restrictions
- not published
- Description
- is an abstract service for a component which offers 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.
- 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 |
nItemId, |
| [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 nItemID
- the unique ID of the control within the status bar.
- Parameter nStyle
- reserved for future use.
|
|
click
- Description
- is called by a status bar if the user clicked with mouse into the
field of the corresponding control.
|
|
doubleClick
- Description
- is called by a status bar if the user double-clicked with mouse
into the field of the corresponding control.
|
|
Top of Page
Copyright © 2012, 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.
