offapi/com/sun/star/awt/UnoControlContainerModel.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: UnoControlContainerModel.idl,v $
  10  * $Revision: 1.11 $
  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_UnoControlContainerModel_idl__
  31 #define __com_sun_star_awt_UnoControlContainerModel_idl__
  32
  33 #ifndef __com_sun_star_awt_UnoControlModel_idl__
  34 #include <com/sun/star/awt/UnoControlModel.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_util_Color_idl__
  38 #include <com/sun/star/util/Color.idl>
  39 #endif
  40
  41
  42 //=============================================================================
  43
  44  module com {  module sun {  module star {  module awt {
  45
  46 //=============================================================================
  47
  48 /** specifies the standard model of an <type>UnoControlContainer</type>.
  49  */
  50 published service UnoControlContainerModel
  51 {
  52     service com::sun::star::awt::UnoControlModel;
  53
  54     //-------------------------------------------------------------------------
  55
  56     /** specifies the background color (RGB) of the control.
  57      */
  58     [property] com::sun::star::util::Color BackgroundColor;
  59
  60     //-------------------------------------------------------------------------
  61
  62     /** determines whether a control is enabled or disabled.
  63      */
  64     [property] boolean Enabled;
  65
  66     //-------------------------------------------------------------------------
  67
  68     /** specifies the border style of the control.
  69
  70         <pre>
  71         0: No border
  72         1: 3D border
  73         2: simple border
  74         </pre>
  75      */
  76     [property] short Border;
  77
  78     //-------------------------------------------------------------------------
  79
  80     /** specifies the color of the border, if present
  81
  82         <p>Not every border style (see <member>Border</member>) may support coloring.
  83         For instance, usually a border with 3D effect will ignore the BorderColor setting.</p>
  84
  85         @since OOo 2.0.0
  86      */
  87     [optional, property] long BorderColor;
  88
  89     //-------------------------------------------------------------------------
  90
  91     /** specifies whether the control will be printed with the document.
  92      */
  93     [property] boolean Printable;
  94
  95     //-------------------------------------------------------------------------
  96
  97     /** specifies the text displayed in the control.
  98      */
  99     [property] string Text;
 100
 101     //-------------------------------------------------------------------------
 102
 103     /** specifies the help text of the control.
 104      */
 105     [property] string HelpText;
 106
 107     //-------------------------------------------------------------------------
 108
 109     /** specifies the help URL of the control.
 110      */
 111     [property] string HelpURL;
 112
 113 };
 114
 115 //=============================================================================
 116
 117 }; }; }; };
 118
 119 #endif