/*************************************************************************
 *
 * 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_XMetricField_idl__
#define __com_sun_star_awt_XMetricField_idl__

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

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

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

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

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

    /** sets the value which is displayed in the metric field.
     */
    void setValue( [in] hyper Value, [in] short FieldUnit );

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

    /** sets the user value which is displayed in the metric field.
     */
    void setUserValue( [in] hyper Value, [in] short FieldUnit );

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

    /** returns the value which is currently displayed in the metric field.
     */
    hyper getValue( [in] short FieldUnit );

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

    /** returns the corrected value which is displayed in the metric field.
     */
    hyper getCorrectedValue( [in] short FieldUnit );

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

    /** sets the minimum value that can be entered by the user.
     */
    void setMin( [in] hyper Value, [in] short FieldUnit );

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

    /** returns the currently set minimum value that can be entered by the
        user.
     */
    hyper getMin( [in] short FieldUnit );

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

    /** sets the maximum value that can be entered by the user.
     */
    void setMax( [in] hyper Value, [in] short FieldUnit );

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

    /** returns the currently set maximum value that can be entered by the
        user.
     */
    hyper getMax( [in] short FieldUnit );

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

    /** sets the first value to be set on POS1 key.
     */
    void setFirst( [in] hyper Value, [in] short FieldUnit );

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

    /** returns the currently set first value which is set on POS1 key.
     */
    hyper getFirst( [in] short FieldUnit );

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

    /** sets the last value to be set on END key.
     */
    void setLast( [in] hyper Value, [in] short FieldUnit );

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

    /** returns the currently set last value which is set on END key.
     */
    hyper getLast( [in] short FieldUnit );

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

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

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

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

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

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

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

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

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

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

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

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

};

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

}; }; }; };

#endif
