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