offapi/com/sun/star/frame/XStatusbarController.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XStatusbarController.idl,v $
  10  * $Revision: 1.6 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_frame_XStatusbarController_idl__
  31 #define __com_sun_star_frame_XStatusbarController_idl__
  32
  33 #ifndef __com_sun_star_awt_Point_idl__
  34 #include <com/sun/star/awt/Point.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_awt_MouseEvent_idl__
  38 #include <com/sun/star/awt/MouseEvent.idl>
  39 #endif
  40
  41 #ifndef __com_sun_star_awt_Rectangle_idl__
  42 #include <com/sun/star/awt/Rectangle.idl>
  43 #endif
  44
  45 #ifndef __com_sun_star_awt_XGraphics_idl__
  46 #include <com/sun/star/awt/XGraphics.idl>
  47 #endif
  48
  49 //=============================================================================
  50
  51 module com {  module sun {  module star {  module frame {
  52
  53 //=============================================================================
  54 /** is an abstract service for a component which offers a more complex user interface
  55     to users within a status bar.
  56
  57     <p>
  58     A generic status bar field is represented as a simple text field. A status
  59     bar controller can be added to a Statusbar and provide information or
  60     functions with a more sophisticated user interface.<br/>
  61     A typical example for status bar controller is a zoom chooser. It shows
  62     the current zoom and provides general zoom levels on a popup menu
  63     that can be activated by a mouse action for context menus.
  64     <p>
  65
  66     @see com::sun::star::frame::XDispatchProvider
  67
  68     @since OOo 2.0.0
  69  */
  70 interface XStatusbarController : ::com::sun::star::uno::XInterface
  71 {
  72     //=============================================================================
  73     /** is called by a status bar if the mouse position is within the controller
  74         and a mouse button has been pressed. If the controller has captured the
  75         mouse input this function is also called when the mouse position is not
  76         within the controller.
  77
  78         @param aMouseEvent
  79             current information about the mouse pointer.
  80
  81         @return
  82             return <TRUE/> if the event should not be processed and <FALSE/>
  83             if the event should be processed by the status bar.
  84     */
  85     boolean mouseButtonDown( [in] ::com::sun::star::awt::MouseEvent aMouseEvent );
  86
  87     //=============================================================================
  88     /** is called by a status bar if the mouse position is within the controller
  89         and a mouse has been moved. If the controller has captured the
  90         mouse input this function is also called when the mouse position is not
  91         within the controller.
  92
  93         @param aMouseEvent
  94             current information about the mouse pointer.
  95
  96         @return
  97             return <TRUE/> if the event should not be processed and <FALSE/>
  98             if the event should be processed by the status bar.
  99     */
 100     boolean mouseMove( [in] ::com::sun::star::awt::MouseEvent aMouseEvent );
 101
 102     //=============================================================================
 103     /** is called by a status bar if the mouse position is within the controller
 104         and a mouse button has been released. If the controller has captured the
 105         mouse input this function is also called when the mouse position is not
 106         within the controller.
 107
 108         @param aMouseEvent
 109             current information about the mouse pointer.
 110
 111         @return
 112             return <TRUE/> if the event should not be processed and <FALSE/>
 113             if the event should be processed by the status bar.
 114     */
 115     boolean mouseButtonUp( [in] ::com::sun::star::awt::MouseEvent aMouseEvent );
 116
 117     //=============================================================================
 118     /** is called by a status bar if a command event is available for a controller.
 119
 120         @param aPos
 121             the current mouse position in pixel.
 122
 123         @param nCommand
 124             describes which command has been invoked.
 125
 126         @param bMouseEvent
 127             <TRUE/> if the command is based on a mouse event, otherwise <FALSE/>.
 128
 129         @param aData
 130             for future use only.
 131     */
 132     void command( [in] ::com::sun::star::awt::Point aPos,
 133                   [in] long nCommand,
 134                   [in] boolean bMouseEvent,
 135                   [in] any aData );
 136
 137     //=============================================================================
 138     /** is called by a status bar if the controller has to update the visual
 139         representation.
 140
 141         @param xGraphics
 142             a reference to a <type scope="com::sun::star::awt">XGraphics</type>
 143             which has to be used to update the visual representation.
 144
 145         @param nCommand
 146             a <type scope="com::sun::star::awt">Rectangle</type> which
 147             determine the output rectangle for all drawing operations
 148
 149         @param nItemID
 150             the unique ID of the control within the status bar.
 151
 152         @param nStyle
 153             reserved for future use.
 154     */
 155     void paint( [in] ::com::sun::star::awt::XGraphics xGraphics,
 156                 [in] ::com::sun::star::awt::Rectangle rOutputRectangle,
 157                 [in] long nItemId,
 158                 [in] long nStyle );
 159
 160     //=============================================================================
 161     /** is called by a status bar if the user clicked with mouse into the
 162         field of the corresponding control.
 163     */
 164     void click();
 165
 166     //=============================================================================
 167     /** is called by a status bar if the user double-clicked with mouse
 168         into the field of the corresponding control.
 169     */
 170     void doubleClick();
 171 };
 172
 173 }; }; }; };
 174
 175 #endif