offapi/com/sun/star/awt/XProgressBar.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: XProgressBar.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_XProgressBar_idl__
  31 #define __com_sun_star_awt_XProgressBar_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_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 /** gives access to the value and settings of a progress bar.
  49  */
  50 published interface XProgressBar: com::sun::star::uno::XInterface
  51 {
  52     //-------------------------------------------------------------------------
  53
  54     /** sets the foreground color (RGB) of the control.
  55      */
  56     [oneway] void setForegroundColor( [in] com::sun::star::util::Color Color );
  57
  58     //-------------------------------------------------------------------------
  59
  60     /** sets the background color (RGB) of the control.
  61      */
  62     [oneway] void setBackgroundColor( [in] com::sun::star::util::Color Color );
  63
  64     //-------------------------------------------------------------------------
  65
  66     /** sets the minimum and the maximum progress value of the progress bar.
  67
  68         <p>If the minimum value is greater than the maximum value, the method
  69         exchanges the values automatically.</p>
  70      */
  71     [oneway] void setRange( [in] long Min,
  72              [in] long Max );
  73
  74     //-------------------------------------------------------------------------
  75
  76     /** sets the progress value of the progress bar.
  77      */
  78     [oneway] void setValue( [in] long Value );
  79
  80     //-------------------------------------------------------------------------
  81
  82     /** returns the current progress value of the progress bar.
  83      */
  84     long getValue();
  85
  86 };
  87
  88 //=============================================================================
  89
  90 }; }; }; };
  91
  92 #endif