offapi/com/sun/star/awt/XWindow.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef __com_sun_star_awt_XWindow_idl__
  20 #define __com_sun_star_awt_XWindow_idl__
  21
  22 #include <com/sun/star/lang/XComponent.idl>
  23
  24 #include <com/sun/star/awt/Rectangle.idl>
  25
  26 #include <com/sun/star/awt/XWindowListener.idl>
  27
  28 #include <com/sun/star/awt/XFocusListener.idl>
  29
  30 #include <com/sun/star/awt/XKeyListener.idl>
  31
  32 #include <com/sun/star/awt/XMouseListener.idl>
  33
  34 #include <com/sun/star/awt/XMouseMotionListener.idl>
  35
  36 #include <com/sun/star/awt/XPaintListener.idl>
  37
  38
  39
  40  module com {  module sun {  module star {  module awt {
  41
  42
  43 /** specifies the basic operations for a window component.
  44
  45     <p>A window is a rectangular region on an output device with
  46     its own position, size, and internal coordinate system.
  47     A window is used for displaying data. In addition, the window
  48     receives events from the user.</p>
  49  */
  50 published interface XWindow: com::sun::star::lang::XComponent
  51 {
  52
  53     /** sets the outer bounds of the window.
  54
  55         @param X
  56         the x-coordinate of the window.
  57
  58         @param Y
  59         the y-coordinate of the window.
  60
  61         @param Width
  62         the width of the window.
  63
  64         @param Height
  65         the height of the window.
  66
  67         @param Flags
  68         Flags are of type PosSize and specify, which parameters
  69         are taken into account when setting the outer bounds of the window.
  70     */
  71     void setPosSize( [in] long X,
  72              [in] long Y,
  73              [in] long Width,
  74              [in] long Height,
  75              [in] short Flags );
  76
  77
  78     /** returns the outer bounds of the window.
  79      */
  80     com::sun::star::awt::Rectangle getPosSize();
  81
  82
  83     /** shows or hides the window depending on the parameter.
  84      */
  85     void setVisible( [in] boolean Visible );
  86
  87
  88     /** enables or disables the window depending on the parameter.
  89      */
  90     void setEnable( [in] boolean Enable );
  91
  92
  93     /** sets the focus to the window.
  94      */
  95     void setFocus();
  96
  97
  98     /** adds a window listener to the object.
  99
 100         @param xListener
 101             the listener to add. If this listener also supports the XWindowListener2 interface,
 102             it will receive the additional events declared in XWindowListener2.
 103      */
 104     void addWindowListener( [in] com::sun::star::awt::XWindowListener xListener );
 105
 106
 107     /** removes the specified window listener from the listener list.
 108      */
 109     void removeWindowListener( [in] com::sun::star::awt::XWindowListener xListener );
 110
 111
 112     /** adds a focus listener to the object.
 113      */
 114     void addFocusListener( [in] com::sun::star::awt::XFocusListener xListener );
 115
 116
 117     /** removes the specified focus listener from the listener list.
 118      */
 119     void removeFocusListener( [in] com::sun::star::awt::XFocusListener xListener );
 120
 121
 122     /** adds a key listener to the object.
 123      */
 124     void addKeyListener( [in] com::sun::star::awt::XKeyListener xListener );
 125
 126
 127     /** removes the specified key listener from the listener list.
 128      */
 129     void removeKeyListener( [in] com::sun::star::awt::XKeyListener xListener );
 130
 131
 132     /** adds a mouse listener to the object.
 133      */
 134     void addMouseListener( [in] com::sun::star::awt::XMouseListener xListener );
 135
 136
 137     /** removes the specified mouse listener from the listener list.
 138      */
 139     void removeMouseListener( [in] com::sun::star::awt::XMouseListener xListener );
 140
 141
 142     /** adds a mouse motion listener to the object.
 143      */
 144     void addMouseMotionListener( [in] com::sun::star::awt::XMouseMotionListener xListener );
 145
 146
 147     /** removes the specified mouse motion listener from the listener list.
 148      */
 149     void removeMouseMotionListener( [in] com::sun::star::awt::XMouseMotionListener xListener );
 150
 151
 152     /** adds a paint listener to the object.
 153      */
 154     void addPaintListener( [in] com::sun::star::awt::XPaintListener xListener );
 155
 156
 157     /** removes the specified paint listener from the listener list.
 158      */
 159     void removePaintListener( [in] com::sun::star::awt::XPaintListener xListener );
 160
 161 };
 162
 163
 164 }; }; }; };
 165
 166 #endif
 167
 168 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */