offapi/com/sun/star/awt/WindowDescriptor.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: WindowDescriptor.idl,v $
  10  * $Revision: 1.12 $
  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_WindowDescriptor_idl__
  31 #define __com_sun_star_awt_WindowDescriptor_idl__
  32
  33 #ifndef __com_sun_star_awt_WindowClass_idl__
  34 #include <com/sun/star/awt/WindowClass.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_awt_XWindowPeer_idl__
  38 #include <com/sun/star/awt/XWindowPeer.idl>
  39 #endif
  40
  41 #ifndef __com_sun_star_awt_Rectangle_idl__
  42 #include <com/sun/star/awt/Rectangle.idl>
  43 #endif
  44
  45
  46 //=============================================================================
  47
  48  module com {  module sun {  module star {  module awt {
  49
  50 //=============================================================================
  51
  52 /** describes a window.
  53  */
  54 published struct WindowDescriptor
  55 {
  56     //-------------------------------------------------------------------------
  57
  58     /** specifies the type of window.
  59      */
  60     com::sun::star::awt::WindowClass Type;
  61
  62     //-------------------------------------------------------------------------
  63
  64     /** specifies the name of the component service.
  65
  66         <p>A zero length name means that the vcl creates a blank top,
  67         a container, or a simple window.
  68         The following service names are defined:<br/>
  69         <ul>
  70             <li>buttondialog</li>
  71             <li>cancelbutton</li>
  72             <li>checkbox</li>
  73             <li>combobox</li>
  74             <li>control</li>
  75             <li>currencybox</li>
  76             <li>currencyfield</li>
  77             <li>datebox</li>
  78             <li>datefield</li>
  79             <li>dialog</li>
  80             <li>dockingarea</li>
  81             <li>dockingwindow</li>
  82             <li>edit</li>
  83             <li>errorbox</li>
  84             <li>fixedbitmap</li>
  85             <li>fixedimage</li>
  86             <li>fixedline</li>
  87             <li>fixedtext</li>
  88             <li>floatingwindow</li>
  89             <li>framewindow</li>
  90             <li>groupbox</li>
  91             <li>helpbutton</li>
  92             <li>imagebutton</li>
  93             <li>imageradiobutton</li>
  94             <li>infobox</li>
  95             <li>listbox</li>
  96             <li>longcurrencybox</li>
  97             <li>longcurrencyfield</li>
  98             <li>menubutton</li>
  99             <li>messbox</li>
 100             <li>metricbox</li>
 101             <li>metricfield</li>
 102             <li>modaldialog</li>
 103             <li>modelessdialog</li>
 104             <li>morebutton</li>
 105             <li>multilistbox</li>
 106             <li>numericbox</li>
 107             <li>numericfield</li>
 108             <li>okbutton</li>
 109             <li>patternbox</li>
 110             <li>patternfield</li>
 111             <li>pushbutton</li>
 112             <li>querybox</li>
 113             <li>radiobutton</li>
 114             <li>scrollbar</li>
 115             <li>scrollbarbox</li>
 116             <li>simpleanimation</li>
 117             <li>spinbutton</li>
 118             <li>spinfield</li>
 119             <li>throbber</li>
 120             <li>splitter</li>
 121             <li>splitwindow</li>
 122             <li>statusbar</li>
 123             <li>systemchildwindow</li>
 124             <li>tabcontrol</li>
 125             <li>tabdialog</li>
 126             <li>tabpage</li>
 127             <li>timebox</li>
 128             <li>timefield</li>
 129             <li>toolbox</li>
 130             <li>tristatebox</li>
 131             <li>warningbox</li>
 132             <li>window</li>
 133             <li>workwindow</li>
 134         </ul>
 135         </p>
 136      */
 137     string WindowServiceName;
 138
 139     //-------------------------------------------------------------------------
 140
 141     /** specifies the parent of the component.
 142
 143         <p>If <code>Parent == 0 && ParentIndex == -1</code>,
 144         then the window is on the desktop.</p>
 145      */
 146     com::sun::star::awt::XWindowPeer Parent;
 147
 148     //-------------------------------------------------------------------------
 149
 150     /** specifies the index of the parent window, if available.
 151
 152         <p>If <code>Parent == 0</code> and this struct is a member of an array,
 153         then this is the offset from the beginning of the array to the parent.
 154         A value of -1 means desktop.</p>
 155      */
 156     short ParentIndex;
 157
 158     //-------------------------------------------------------------------------
 159
 160     /** specifies the position and size of the window.
 161
 162         <p>This member is ignored if the window attribute is
 163         <const scope="com::sun::star::awt">WindowAttribute::FULLSIZE</const>.</p>
 164      */
 165     com::sun::star::awt::Rectangle Bounds;
 166
 167     //-------------------------------------------------------------------------
 168
 169     /** specifies the window attributes.
 170
 171         <p>Use one value out of the constant group
 172         <type scope="com::sun::star::awt">WindowAttribute</type>.</p>
 173      */
 174     long WindowAttributes;
 175
 176 };
 177
 178 //=============================================================================
 179
 180 }; }; }; };
 181
 182 #endif