offapi/com/sun/star/awt/XWindow.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: XWindow.idl,v $
  10  * $Revision: 1.9 $
  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_awt_XWindow_idl__
  31 #define __com_sun_star_awt_XWindow_idl__
  32
  33 #ifndef __com_sun_star_lang_XComponent_idl__
  34 #include <com/sun/star/lang/XComponent.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_awt_Rectangle_idl__
  38 #include <com/sun/star/awt/Rectangle.idl>
  39 #endif
  40
  41 #ifndef __com_sun_star_awt_XWindowListener_idl__
  42 #include <com/sun/star/awt/XWindowListener.idl>
  43 #endif
  44
  45 #ifndef __com_sun_star_awt_XFocusListener_idl__
  46 #include <com/sun/star/awt/XFocusListener.idl>
  47 #endif
  48
  49 #ifndef __com_sun_star_awt_XKeyListener_idl__
  50 #include <com/sun/star/awt/XKeyListener.idl>
  51 #endif
  52
  53 #ifndef __com_sun_star_awt_XMouseListener_idl__
  54 #include <com/sun/star/awt/XMouseListener.idl>
  55 #endif
  56
  57 #ifndef __com_sun_star_awt_XMouseMotionListener_idl__
  58 #include <com/sun/star/awt/XMouseMotionListener.idl>
  59 #endif
  60
  61 #ifndef __com_sun_star_awt_XPaintListener_idl__
  62 #include <com/sun/star/awt/XPaintListener.idl>
  63 #endif
  64
  65
  66 //=============================================================================
  67
  68  module com {  module sun {  module star {  module awt {
  69
  70 //=============================================================================
  71
  72 /** specifies the basic operations for a window component.
  73
  74     <p>A window is a rectangular region on an output device with
  75     its own position, size, and internal coordinate system.
  76     A window is used for displaying data. In addition, the window
  77     receives events from the user.</p>
  78  */
  79 published interface XWindow: com::sun::star::lang::XComponent
  80 {
  81     //-------------------------------------------------------------------------
  82
  83     /** sets the outer bounds of the window.
  84
  85         @param X
  86         the x-coordinate of the window.
  87
  88         @param Y
  89         the y-coordinate of the window.
  90
  91         @param Width
  92         the width of the window.
  93
  94         @param Height
  95         the height of the window.
  96
  97         @param Flags
  98         Flags are of type <type>PosSize</type> and specify, which parameters
  99         are taken into account when setting the outer bounds of the window.
 100     */
 101     [oneway] void setPosSize( [in] long X,
 102              [in] long Y,
 103              [in] long Width,
 104              [in] long Height,
 105              [in] short Flags );
 106
 107     //-------------------------------------------------------------------------
 108
 109     /** returns the outer bounds of the window.
 110      */
 111     com::sun::star::awt::Rectangle getPosSize();
 112
 113     //-------------------------------------------------------------------------
 114
 115     /** shows or hides the window depending on the parameter.
 116      */
 117     [oneway] void setVisible( [in] boolean Visible );
 118
 119     //-------------------------------------------------------------------------
 120
 121     /** enables or disables the window depending on the parameter.
 122      */
 123     [oneway] void setEnable( [in] boolean Enable );
 124
 125     //-------------------------------------------------------------------------
 126
 127     /** sets the focus to the window.
 128      */
 129     [oneway] void setFocus();
 130
 131     //-------------------------------------------------------------------------
 132
 133     /** adds a window listener to the object.
 134
 135         @param xListener
 136             the listener to add. If this listener also supports the <type>XWindowListener2</type> interface,
 137             it will receive the additional events declared in XWindowListener2.
 138      */
 139     [oneway] void addWindowListener( [in] com::sun::star::awt::XWindowListener xListener );
 140
 141     //-------------------------------------------------------------------------
 142
 143     /** removes the specified window listener from the listener list.
 144      */
 145     [oneway] void removeWindowListener( [in] com::sun::star::awt::XWindowListener xListener );
 146
 147     //-------------------------------------------------------------------------
 148
 149     /** adds a focus listener to the object.
 150      */
 151     [oneway] void addFocusListener( [in] com::sun::star::awt::XFocusListener xListener );
 152
 153     //-------------------------------------------------------------------------
 154
 155     /** removes the specified focus listener from the listener list.
 156      */
 157     [oneway] void removeFocusListener( [in] com::sun::star::awt::XFocusListener xListener );
 158
 159     //-------------------------------------------------------------------------
 160
 161     /** adds a key listener to the object.
 162      */
 163     [oneway] void addKeyListener( [in] com::sun::star::awt::XKeyListener xListener );
 164
 165     //-------------------------------------------------------------------------
 166
 167     /** removes the specified key listener from the listener list.
 168      */
 169     [oneway] void removeKeyListener( [in] com::sun::star::awt::XKeyListener xListener );
 170
 171     //-------------------------------------------------------------------------
 172
 173     /** adds a mouse listener to the object.
 174      */
 175     [oneway] void addMouseListener( [in] com::sun::star::awt::XMouseListener xListener );
 176
 177     //-------------------------------------------------------------------------
 178
 179     /** removes the specified mouse listener from the listener list.
 180      */
 181     [oneway] void removeMouseListener( [in] com::sun::star::awt::XMouseListener xListener );
 182
 183     //-------------------------------------------------------------------------
 184
 185     /** adds a mouse motion listener to the object.
 186      */
 187     [oneway] void addMouseMotionListener( [in] com::sun::star::awt::XMouseMotionListener xListener );
 188
 189     //-------------------------------------------------------------------------
 190
 191     /** removes the specified mouse motion listener from the listener list.
 192      */
 193     [oneway] void removeMouseMotionListener( [in] com::sun::star::awt::XMouseMotionListener xListener );
 194
 195     //-------------------------------------------------------------------------
 196
 197     /** adds a paint listener to the object.
 198      */
 199     [oneway] void addPaintListener( [in] com::sun::star::awt::XPaintListener xListener );
 200
 201     //-------------------------------------------------------------------------
 202
 203     /** removes the specified paint listener from the listener list.
 204      */
 205     [oneway] void removePaintListener( [in] com::sun::star::awt::XPaintListener xListener );
 206
 207 };
 208
 209 //=============================================================================
 210
 211 }; }; }; };
 212
 213 #endif