star/frame/XStatusbarController.idl

9  * with the License.  You may obtain a copy of the License at
36 /** interface to be implemented by a component offering a more complex user
37     interface to users within a status bar.
40     A generic status bar field is represented as a simple text field. A status
41     bar controller can be added to a Statusbar and provide information or
42     functions with a more sophisticated user interface.<br/>
43     A typical example for status bar controller is a zoom chooser. It shows
44     the current zoom and provides general zoom levels on a popup menu
45     that can be activated by a mouse action for context menus.
56         Used by a status bar implementation to control the life-time of
57         a status bar controller. The status bar is the only instance which
62     /** used to initialize a component with required arguments.
65         arguments provided as a sequence of
69             <li><b>Frame</b><br/>a <type scope="com::sun::star::frame">XFrame</type>
72             <li><b>CommandURL</b><br/>a string which specifies the command
77             <li><b>StatusbarItem</b><br/>a <type scope="com::sun::star::ui">XStatusbarItem</type>
81             <li><b>ParentWindow</b><br/>a <type scope="com::sun::star::awt">Window</type>
84             <li><b>ModuleName</b><br/>a string which specifies the name of the
93     /** with this interface a component can receive events if a feature has
96         <p>The status bar controller implementation should register itself as a
114     /** is called by a status bar if the mouse position is within the controller
115         and a mouse button has been pressed. If the controller has captured the
128     /** is called by a status bar if the mouse position is within the controller
129         and a mouse has been moved. If the controller has captured the
142     /** is called by a status bar if the mouse position is within the controller
143         and a mouse button has been released. If the controller has captured the
156     /** is called by a status bar if a command event is available for a controller.
167             <TRUE/> if the command is based on a mouse event, otherwise <FALSE/>.
177     /** is called by a status bar if the controller has to update the visual
181             a reference to a <type scope="com::sun::star::awt">XGraphics</type>
185             a <type scope="com::sun::star::awt">Rectangle</type> which
195     /** is called by a status bar if the user clicked with mouse into the
203     /** is called by a status bar if the user double-clicked with mouse