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

/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 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