diff options
Diffstat (limited to 'offapi/com/sun/star/inspection/XNumericControl.idl')
-rw-r--r-- | offapi/com/sun/star/inspection/XNumericControl.idl | 98 |
1 files changed, 98 insertions, 0 deletions
diff --git a/offapi/com/sun/star/inspection/XNumericControl.idl b/offapi/com/sun/star/inspection/XNumericControl.idl new file mode 100644 index 000000000000..13e4631a3959 --- /dev/null +++ b/offapi/com/sun/star/inspection/XNumericControl.idl @@ -0,0 +1,98 @@ +/************************************************************************* + * + * 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_inspection_XNumericControl_idl__ +#define __com_sun_star_inspection_XNumericControl_idl__ + +#ifndef __com_sun_star_inspection_XPropertyControl_idl__ +#include <com/sun/star/inspection/XPropertyControl.idl> +#endif +#ifndef __com_sun_star_beans_Optional_idl__ +#include <com/sun/star/beans/Optional.idl> +#endif +#ifndef __com_sun_star_lang_IllegalArgumentException_idl__ +#include <com/sun/star/lang/IllegalArgumentException.idl> +#endif + +//============================================================================= +module com { module sun { module star { module inspection { + +//----------------------------------------------------------------------------- +/** defines the interface for an <type>XPropertyControl</type> 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 <type scope="com::sun::star::util">MeasureUnit</type> to be applied + for displaying values. + + <p>Only a certain set of <type scope="com::sun::star::util">MeasureUnit</type> values is + supported. In particular, every value which denotes a fraction of another + unit (like 100th millimiters) cannot be used as DisplayUnit.</p> + + @throws com::sun::star::lang::IllegalArgumentException + if the caller attempts to set an unsupported <type scope="com::sun::star::util">MeasureUnit</type> + */ + [attribute] short DisplayUnit + { + set raises (com::sun::star::lang::IllegalArgumentException); + }; + + /** describes a <type scope="com::sun::star::util">MeasureUnit</type> to be + applied for transfering 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 + |