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
  20
  21
  22  module com {  module sun {  module star {  module awt {
  23
  24
  25 /** specifies the basic operations for a window component.
  26
  27     <p>A window is a rectangular region on an output device with
  28     its own position, size, and internal coordinate system.
  29     A window is used for displaying data. In addition, the window
  30     receives events from the user.</p>
  31  */
  32 published interface XWindow: com::sun::star::lang::XComponent
  33 {
  34
  35     /** sets the outer bounds of the window.
  36
  37         @param X
  38         the x-coordinate of the window.
  39
  40         @param Y
  41         the y-coordinate of the window.
  42
  43         @param Width
  44         the width of the window.
  45
  46         @param Height
  47         the height of the window.
  48
  49         @param Flags
  50         Flags are of type PosSize and specify, which parameters
  51         are taken into account when setting the outer bounds of the window.
  52     */
  53     void setPosSize( [in] long X,
  54              [in] long Y,
  55              [in] long Width,
  56              [in] long Height,
  57              [in] short Flags );
  58
  59
  60     /** returns the outer bounds of the window.
  61      */
  62     com::sun::star::awt::Rectangle getPosSize();
  63
  64
  65     /** shows or hides the window depending on the parameter.
  66      */
  67     void setVisible( [in] boolean Visible );
  68
  69
  70     /** enables or disables the window depending on the parameter.
  71      */
  72     void setEnable( [in] boolean Enable );
  73
  74
  75     /** sets the focus to the window.
  76      */
  77     void setFocus();
  78
  79
  80     /** adds a window listener to the object.
  81
  82         @param xListener
  83             the listener to add. If this listener also supports the XWindowListener2 interface,
  84             it will receive the additional events declared in XWindowListener2.
  85      */
  86     void addWindowListener( [in] com::sun::star::awt::XWindowListener xListener );
  87
  88
  89     /** removes the specified window listener from the listener list.
  90      */
  91     void removeWindowListener( [in] com::sun::star::awt::XWindowListener xListener );
  92
  93
  94     /** adds a focus listener to the object.
  95      */
  96     void addFocusListener( [in] com::sun::star::awt::XFocusListener xListener );
  97
  98
  99     /** removes the specified focus listener from the listener list.
 100      */
 101     void removeFocusListener( [in] com::sun::star::awt::XFocusListener xListener );
 102
 103
 104     /** adds a key listener to the object.
 105      */
 106     void addKeyListener( [in] com::sun::star::awt::XKeyListener xListener );
 107
 108
 109     /** removes the specified key listener from the listener list.
 110      */
 111     void removeKeyListener( [in] com::sun::star::awt::XKeyListener xListener );
 112
 113
 114     /** adds a mouse listener to the object.
 115      */
 116     void addMouseListener( [in] com::sun::star::awt::XMouseListener xListener );
 117
 118
 119     /** removes the specified mouse listener from the listener list.
 120      */
 121     void removeMouseListener( [in] com::sun::star::awt::XMouseListener xListener );
 122
 123
 124     /** adds a mouse motion listener to the object.
 125      */
 126     void addMouseMotionListener( [in] com::sun::star::awt::XMouseMotionListener xListener );
 127
 128
 129     /** removes the specified mouse motion listener from the listener list.
 130      */
 131     void removeMouseMotionListener( [in] com::sun::star::awt::XMouseMotionListener xListener );
 132
 133
 134     /** adds a paint listener to the object.
 135      */
 136     void addPaintListener( [in] com::sun::star::awt::XPaintListener xListener );
 137
 138
 139     /** removes the specified paint listener from the listener list.
 140      */
 141     void removePaintListener( [in] com::sun::star::awt::XPaintListener xListener );
 142
 143 };
 144
 145
 146 }; }; }; };
 147
 148 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */