offapi/com/sun/star/awt/XProgressBar.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef __com_sun_star_awt_XProgressBar_idl__
  20 #define __com_sun_star_awt_XProgressBar_idl__
  21
  22 #include <com/sun/star/uno/XInterface.idl>
  23
  24 #include <com/sun/star/util/Color.idl>
  25
  26
  27
  28  module com {  module sun {  module star {  module awt {
  29
  30
  31 /** gives access to the value and settings of a progress bar.
  32  */
  33 published interface XProgressBar: com::sun::star::uno::XInterface
  34 {
  35
  36     /** sets the foreground color (RGB) of the control.
  37      */
  38     void setForegroundColor( [in] com::sun::star::util::Color Color );
  39
  40
  41     /** sets the background color (RGB) of the control.
  42      */
  43     void setBackgroundColor( [in] com::sun::star::util::Color Color );
  44
  45
  46     /** sets the minimum and the maximum progress value of the progress bar.
  47
  48         <p>If the minimum value is greater than the maximum value, the method
  49         exchanges the values automatically.</p>
  50      */
  51     void setRange( [in] long Min,
  52              [in] long Max );
  53
  54
  55     /** sets the progress value of the progress bar.
  56      */
  57     void setValue( [in] long Value );
  58
  59
  60     /** returns the current progress value of the progress bar.
  61      */
  62     long getValue();
  63
  64 };
  65
  66
  67 }; }; }; };
  68
  69 #endif
  70
  71 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */