offapi/com/sun/star/awt/UnoControlProgressBarModel.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: UnoControlProgressBarModel.idl,v $
  10  * $Revision: 1.9 $
  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_UnoControlProgressBarModel_idl__
  31 #define __com_sun_star_awt_UnoControlProgressBarModel_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>UnoControlProgressBar</type>.
  49  */
  50 published service UnoControlProgressBarModel
  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     /** specifies the border style of the control.
  63
  64         <pre>
  65         0: No border
  66         1: 3D border
  67         2: simple border
  68         </pre>
  69      */
  70     [property] short Border;
  71
  72     //-------------------------------------------------------------------------
  73
  74     /** specifies the color of the border, if present
  75
  76         <p>Not every border style (see <member>Border</member>) may support coloring.
  77         For instance, usually a border with 3D effect will ignore the BorderColor setting.</p>
  78
  79         @since OOo 2.0.0
  80      */
  81     [optional, property] long BorderColor;
  82
  83     //-------------------------------------------------------------------------
  84
  85     /** determines whether the control is enabled or disabled.
  86      */
  87     [property] boolean Enabled;
  88
  89     //-------------------------------------------------------------------------
  90
  91     /** specifies the fill color (RGB) of the control.
  92      */
  93     [property] com::sun::star::util::Color FillColor;
  94
  95     //-------------------------------------------------------------------------
  96
  97     /** specifies the help text of the control.
  98      */
  99     [property] string HelpText;
 100
 101     //-------------------------------------------------------------------------
 102
 103     /** specifies the help URL of the control.
 104      */
 105     [property] string HelpURL;
 106
 107     //-------------------------------------------------------------------------
 108
 109     /** specifies that the control will be printed with the document.
 110      */
 111     [property] boolean Printable;
 112
 113     //-------------------------------------------------------------------------
 114
 115     /** specifies the progress value of the control.
 116      */
 117     [property] long ProgressValue;
 118
 119     //-------------------------------------------------------------------------
 120
 121     /** specifies the maximum progress value of the control.
 122      */
 123     [property] long ProgressValueMax;
 124
 125     //-------------------------------------------------------------------------
 126
 127     /** specifies the minimum progress value of the control.
 128      */
 129     [property] long ProgressValueMin;
 130
 131 };
 132
 133 //=============================================================================
 134
 135 }; }; }; };
 136
 137 #endif