xref: /aoo42x/main/offapi/com/sun/star/awt/XProgressBar.idl (revision d1766043)

/**************************************************************
 *
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 *
 *************************************************************/


#ifndef __com_sun_star_awt_XProgressBar_idl__
#define __com_sun_star_awt_XProgressBar_idl__

#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif

#ifndef __com_sun_star_util_Color_idl__
#include <com/sun/star/util/Color.idl>
#endif


//=============================================================================

 module com {  module sun {  module star {  module awt {

//=============================================================================

/** gives access to the value and settings of a progress bar.
 */
published interface XProgressBar: com::sun::star::uno::XInterface
{
	//-------------------------------------------------------------------------

	/** sets the foreground color (RGB) of the control.
     */
	[oneway] void setForegroundColor( [in] com::sun::star::util::Color Color );

	//-------------------------------------------------------------------------

    /** sets the background color (RGB) of the control.
     */
	[oneway] void setBackgroundColor( [in] com::sun::star::util::Color Color );

	//-------------------------------------------------------------------------

	/** sets the minimum and the maximum progress value of the progress bar.

		<p>If the minimum value is greater than the maximum value, the method
        exchanges the values automatically.</p>
	 */
	[oneway] void setRange( [in] long Min,
			 [in] long Max );

	//-------------------------------------------------------------------------

	/** sets the progress value of the progress bar.
     */
	[oneway] void setValue( [in] long Value );

	//-------------------------------------------------------------------------

    /** returns the current progress value of the progress bar.
     */
	long getValue();

};

//=============================================================================

}; }; }; };

#endif