/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   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 .
 */

#ifndef __com_sun_star_inspection_XNumericControl_idl__
#define __com_sun_star_inspection_XNumericControl_idl__

#include <com/sun/star/inspection/XPropertyControl.idl>
#include <com/sun/star/beans/Optional.idl>
#include <com/sun/star/lang/IllegalArgumentException.idl>

module com {  module sun {  module star {  module inspection {

/** defines the interface for an XPropertyControl which supports
    displaying and entering numerical values.

    @since OOo 2.0.3
*/
interface XNumericControl : XPropertyControl
{
    /** describes the number of decimal digits to use for the value
    */
    [attribute] short   DecimalDigits;

    /** describes the minimum value which is allowed to be entered in the control
    */
    [attribute] com::sun::star::beans::Optional<double> MinValue;

    /** describes the maximum value which is allowed to be entered in the control
    */
    [attribute] com::sun::star::beans::Optional<double> MaxValue;

    /** describes a com::sun::star::util::MeasureUnit to be applied
        for displaying values.

        <p>Only a certain set of com::sun::star::util::MeasureUnit values is
        supported. In particular, every value which denotes a fraction of another
        unit (like 100th millimeters) cannot be used as DisplayUnit.</p>

        @throws com::sun::star::lang::IllegalArgumentException
            if the caller attempts to set an unsupported com::sun::star::util::MeasureUnit
    */
    [attribute] short DisplayUnit
    {
        set raises (com::sun::star::lang::IllegalArgumentException);
    };

    /** describes a com::sun::star::util::MeasureUnit to be
        applied for transferring values.

        <p>The core measurement unit for a property value might differ from the unit which
        is used by the control to display it. For instance, your property value might require
        that your values denote 100th millimeters, but to the user, you want to present the
        value as, say, inches. In this case, a numeric control can automatically handle the
        value conversion for you, if you give it a ValueUnit different from the DisplayUnit.</p>

        @see XPropertyControl::Value
    */
    [attribute] short ValueUnit;
};


}; }; }; };

#endif

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */