offapi/com/sun/star/awt/XVclWindowPeer.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: XVclWindowPeer.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_XVclWindowPeer_idl__
  31 #define __com_sun_star_awt_XVclWindowPeer_idl__
  32
  33 #ifndef __com_sun_star_awt_XWindowPeer_idl__
  34 #include <com/sun/star/awt/XWindowPeer.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_util_Color_idl__
  38 #include <com/sun/star/util/Color.idl>
  39 #endif
  40
  41 #ifndef __com_sun_star_awt_FontDescriptor_idl__
  42 #include <com/sun/star/awt/FontDescriptor.idl>
  43 #endif
  44
  45
  46 //=============================================================================
  47
  48  module com {  module sun {  module star {  module awt {
  49
  50 //=============================================================================
  51
  52 /** gives access to the VCL window implementation.
  53
  54     @deprecated
  55  */
  56 published interface XVclWindowPeer: com::sun::star::awt::XWindowPeer
  57 {
  58     //-------------------------------------------------------------------------
  59
  60     /** returns <true/> if the window peer is a child, <false/> otherwise.
  61      */
  62     boolean isChild( [in] com::sun::star::awt::XWindowPeer Peer );
  63
  64     //-------------------------------------------------------------------------
  65
  66     /** sets the design mode for use in a design editor.
  67      */
  68     [oneway] void setDesignMode( [in] boolean bOn );
  69
  70     //-------------------------------------------------------------------------
  71
  72     /** returns <true/> if the window peer is in design mode,
  73         <false/> otherwise.
  74      */
  75     boolean isDesignMode();
  76
  77     //-------------------------------------------------------------------------
  78
  79     /** enables clipping of sibling windows.
  80      */
  81     [oneway] void enableClipSiblings( [in] boolean bClip );
  82
  83     //-------------------------------------------------------------------------
  84
  85     /** sets the foreground color.
  86      */
  87     [oneway] void setForeground( [in] com::sun::star::util::Color Color );
  88
  89     //-------------------------------------------------------------------------
  90
  91     /** sets the control font.
  92      */
  93     [oneway] void setControlFont( [in] com::sun::star::awt::FontDescriptor aFont );
  94
  95     //-------------------------------------------------------------------------
  96
  97     /** returns the font, foreground and background color for the specified
  98         type.
  99      */
 100     void getStyles( [in] short nType,
 101              [out] com::sun::star::awt::FontDescriptor Font,
 102              [out] com::sun::star::util::Color ForegroundColor,
 103              [out] com::sun::star::util::Color BackgroundColor );
 104
 105     //-------------------------------------------------------------------------
 106
 107     /** sets the value of the property with the specified name.
 108      */
 109     void setProperty( [in] string PropertyName,
 110              [in] any Value );
 111
 112     //-------------------------------------------------------------------------
 113
 114     /** returns the value of the property with the specified name.
 115      */
 116     any getProperty( [in] string PropertyName );
 117
 118 };
 119
 120 //=============================================================================
 121
 122 }; }; }; };
 123
 124 #endif