offapi/com/sun/star/awt/XToolkit.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: XToolkit.idl,v $
  10  * $Revision: 1.13 $
  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_XToolkit_idl__
  31 #define __com_sun_star_awt_XToolkit_idl__
  32
  33 #ifndef __com_sun_star_uno_XInterface_idl__
  34 #include <com/sun/star/uno/XInterface.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 #ifndef __com_sun_star_awt_WindowDescriptor_idl__
  46 #include <com/sun/star/awt/WindowDescriptor.idl>
  47 #endif
  48
  49 #ifndef __com_sun_star_lang_IllegalArgumentException_idl__
  50 #include <com/sun/star/lang/IllegalArgumentException.idl>
  51 #endif
  52
  53 #ifndef __com_sun_star_awt_XDevice_idl__
  54 #include <com/sun/star/awt/XDevice.idl>
  55 #endif
  56
  57 #ifndef __com_sun_star_awt_XRegion_idl__
  58 #include <com/sun/star/awt/XRegion.idl>
  59 #endif
  60
  61
  62 //=============================================================================
  63
  64  module com {  module sun {  module star {  module awt {
  65
  66 //=============================================================================
  67
  68 /** specifies a factory interface for the window toolkit.
  69
  70     <p>This is similar to the abstract window toolkit (AWT) in Java.</p>
  71  */
  72 published interface XToolkit: com::sun::star::uno::XInterface
  73 {
  74     //-------------------------------------------------------------------------
  75
  76     /** returns the desktop window.
  77      */
  78     com::sun::star::awt::XWindowPeer getDesktopWindow();
  79
  80     //-------------------------------------------------------------------------
  81
  82     /** returns the complete work area for this toolkit.
  83      */
  84     com::sun::star::awt::Rectangle getWorkArea();
  85
  86     //-------------------------------------------------------------------------
  87
  88     /** creates a new window using the given descriptor.
  89      */
  90     com::sun::star::awt::XWindowPeer createWindow( [in] com::sun::star::awt::WindowDescriptor Descriptor )
  91             raises( com::sun::star::lang::IllegalArgumentException );
  92
  93     //-------------------------------------------------------------------------
  94
  95     /** returns a sequence of windows which are newly created using the
  96         given descriptors.
  97      */
  98     sequence<com::sun::star::awt::XWindowPeer> createWindows(
  99             [in] sequence<com::sun::star::awt::WindowDescriptor> Descriptors )
 100         raises( com::sun::star::lang::IllegalArgumentException );
 101
 102     //-------------------------------------------------------------------------
 103
 104     /** creates a virtual device that is compatible with the screen.
 105      */
 106     com::sun::star::awt::XDevice createScreenCompatibleDevice( [in] long Width,
 107              [in] long Height );
 108
 109     //-------------------------------------------------------------------------
 110
 111     /** creates a region.
 112      */
 113     com::sun::star::awt::XRegion createRegion();
 114
 115 };
 116
 117 //=============================================================================
 118
 119 }; }; }; };
 120
 121 #endif