xref: /trunk/main/offapi/com/sun/star/awt/XCurrencyField.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_XCurrencyField_idl__
#define __com_sun_star_awt_XCurrencyField_idl__

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


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

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

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

/** gives access to the value and formatting of a currency field.
 */
published interface XCurrencyField: com::sun::star::uno::XInterface
{
	//-------------------------------------------------------------------------

	/** sets the value which is displayed in the currency field.
	 */
	[oneway] void setValue( [in] double Value );

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

	/** returns the value which is currently displayed in the currency field.
	 */
	double getValue();

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

	/** sets the minimum value that can be entered by the user.
	 */
	[oneway] void setMin( [in] double Value );

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

	/** returns the currently set minimum value that can be entered by the
        user.
	 */
	double getMin();

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

	/** sets the maximum value that can be entered by the user.
	 */
	[oneway] void setMax( [in] double Value );

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

	/** returns the currently set maximum value that can be entered by the
        user.
	 */
	double getMax();

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

	/** sets the first value to be set on POS1 key.
	 */
	[oneway] void setFirst( [in] double Value );

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

	/** returns the currently set first value which is set on POS1 key.
	 */
	double getFirst();

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

	/** sets the last value to be set on END key.
	 */
	[oneway] void setLast( [in] double Value );

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

	/** returns the currently set last value which is set on END key.
	 */
	double getLast();

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

	/** sets the increment value for the spin button.
	 */
	[oneway] void setSpinSize( [in] double Value );

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

	/** returns the currently set increment value for the spin button.
	 */
	double getSpinSize();

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

	/** sets the number of decimals.
	 */
	[oneway] void setDecimalDigits( [in] short nDigits );

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

	/** returns the currently set number of decimals.
	 */
	short getDecimalDigits();

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

	/** determines if the format is checked during user input.
	 */
	[oneway] void setStrictFormat( [in] boolean bStrict );

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

	/** returns whether the format is currently checked during user input.
	 */
	boolean isStrictFormat();

};

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

}; }; }; };

#endif