offapi/com/sun/star/awt/XWindow2.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: XWindow2.idl,v $
  10  * $Revision: 1.4 $
  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_XWindow2_idl__
  31 #define __com_sun_star_awt_XWindow2_idl__
  32
  33 #ifndef __com_sun_star_awt_XWindow_idl__
  34 #include <com/sun/star/awt/XWindow.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_awt_Size_idl__
  38 #include <com/sun/star/awt/Size.idl>
  39 #endif
  40
  41
  42
  43 //=============================================================================
  44
  45  module com {  module sun {  module star {  module awt {
  46
  47 //=============================================================================
  48
  49 /** specifies some extended operations for a window component.
  50
  51     <p>A window is a rectangular region on an output device with
  52     its own position, size, and internal coordinate system.
  53     A window is used for displaying data. In addition, the window
  54     receives events from the user.</p>
  55  */
  56 published interface XWindow2: com::sun::star::awt::XWindow
  57 {
  58     //-------------------------------------------------------------------------
  59
  60     /** sets the inner bounds of the window, also known as the client size
  61
  62         @param Size
  63         the inner width and height of the window.
  64
  65     */
  66     void setOutputSize( [in] com::sun::star::awt::Size aSize );
  67
  68     //-------------------------------------------------------------------------
  69
  70     /** returns the inner bounds of the window, also known as the client size.
  71      */
  72     com::sun::star::awt::Size getOutputSize();
  73
  74     //-------------------------------------------------------------------------
  75
  76     /** returns the visibility state of the window
  77      */
  78     boolean isVisible();
  79
  80     //-------------------------------------------------------------------------
  81
  82     /** returns the activation state of the window
  83      */
  84     boolean isActive();
  85
  86     //-------------------------------------------------------------------------
  87
  88     /** returns the enabled state of the window
  89      */
  90     boolean isEnabled();
  91
  92     //-------------------------------------------------------------------------
  93
  94     /** returns the focus state of the window
  95      */
  96     boolean hasFocus();
  97
  98     //-------------------------------------------------------------------------
  99 };
 100
 101 //=============================================================================
 102
 103 }; }; }; };
 104
 105 #endif