INTEGRATION: CWS pbrwuno (1.1.2); FILE ADDED

2005/12/21 14:17:04 fs 1.1.2.4: proper licence header
2005/10/17 08:15:36 fs 1.1.2.3: +XObjectInspectorUI::getPropertyControl
2005/10/17 07:10:24 fs 1.1.2.2: replace MeasurementUnit with css.util.MeasureUnit
2005/09/05 07:54:14 fs 1.1.2.1: #i53095# phase 3, part1: introducing XPropertyControl and relatives

1 files changed, 104 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..3574e7dd06b0
--- /dev/null
+++ b/offapi/com/sun/star/inspection/XNumericControl.idl
@@ -0,0 +1,104 @@
+/*************************************************************************
+ *
+ *  OpenOffice.org - a multi-platform office productivity suite
+ *
+ *  $RCSfile: XNumericControl.idl,v $
+ *
+ *  $Revision: 1.2 $
+ *
+ *  last change: $Author: vg $ $Date: 2006-03-14 11:06:59 $
+ *
+ *  The Contents of this file are made available subject to
+ *  the terms of GNU Lesser General Public License Version 2.1.
+ *
+ *
+ *    GNU Lesser General Public License Version 2.1
+ *    =============================================
+ *    Copyright 2005 by Sun Microsystems, Inc.
+ *    901 San Antonio Road, Palo Alto, CA 94303, USA
+ *
+ *    This library is free software; you can redistribute it and/or
+ *    modify it under the terms of the GNU Lesser General Public
+ *    License version 2.1, as published by the Free Software Foundation.
+ *
+ *    This library 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 for more details.
+ *
+ *    You should have received a copy of the GNU Lesser General Public
+ *    License along with this library; if not, write to the Free Software
+ *    Foundation, Inc., 59 Temple Place, Suite 330, Boston,
+ *    MA  02111-1307  USA
+ *
+ ************************************************************************/
+
+#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.
+*/
+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
+