1 files changed, 109 insertions, 0 deletions
diff --git a/offapi/com/sun/star/form/validation/XValidatableFormComponent.idl b/offapi/com/sun/star/form/validation/XValidatableFormComponent.idl
new file mode 100644
index 000000000..f15bfc535
--- /dev/null
+++ b/offapi/com/sun/star/form/validation/XValidatableFormComponent.idl
@@ -0,0 +1,109 @@
+/* -*- 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_form_validation_XValidatableFormComponent_idl__
+#define __com_sun_star_form_validation_XValidatableFormComponent_idl__
+
+#include <com/sun/star/form/validation/XValidatable.idl>
+#include <com/sun/star/lang/NoSupportException.idl>
+#include <com/sun/star/lang/NullPointerException.idl>
+
+
+module com {  module sun {  module star {  module form { module validation {
+
+interface XFormComponentValidityListener;
+
+
+/** is a convenience interface for accessing several aspects of a form component
+    which supports validation.
+
+    <p>A validatable form component has two aspects which other parties might
+    be interested in:
+    <ul>
+        <li>The pure validity flag: Whatever the user enters in the component, this is
+        either valid (relative to the active validator), or invalid.</li>
+        <li>The current value: Even if the validity flag does not change with the user
+        input (e.g. because the user replaces one invalid value with another invalid
+        value), observers might be interested in the current value, for example to
+        include it in a feedback message to the user.</li>
+    </ul>
+    </p>
+
+    <p>An XValidatableFormComponent allows to easily access both of these aspects.</p>
+
+    <p>Note that all of the information provided at this interface can also obtained by other means,
+    but much more inconveniently.</p>
+
+    @see XValidatable
+    @see XValidator
+*/
+interface XValidatableFormComponent : XValidatable
+{
+    /** determines whether the current value of the component passed the validity test
+        at the validator.
+
+        <p>Calling this is equal to calling XValidator::isValid() with
+        the current value (see getCurrentValue()) of the component, where
+        the validator is obtained via XValidatable::getValidator().</p>
+
+        <p>If no validator has been set (XValidatable::setValidator()), this method
+        returns true.</p>
+    */
+    boolean isValid();
+
+    /** retrieves the current value of the component.
+
+        <p>The type of the current value, as well as it's semantics, depend on the service
+        implementing this interface.</p>
+
+        <p>Again, this is a convenience method. For example, for a com::sun::star::form::component::FormattedField,
+        calling this method is equivalent to retrieving the
+        com::sun::star::awt::UnoControlFormattedFieldModel::EffectiveValue.</p>
+
+        <p>If no validator has been set (XValidatable::setValidator()), the value returned
+        here is defined by the service implementing this interface.</p>
+    */
+    any getCurrentValue();
+
+    /** registers the given listener.
+
+        <p>XFormComponentValidityListeners are called whenever <em>any</em> of the aspects
+        of the validatable form component (the validity flag, or the value) changed.</p>
+
+        @throws com::sun::star::lang::NullPointerException
+            if the given listener is `NULL`
+    */
+    void    addFormComponentValidityListener( [in] XFormComponentValidityListener Listener )
+                raises( com::sun::star::lang::NullPointerException );
+
+    /** registers the given listener.
+
+        @throws com::sun::star::lang::NullPointerException
+            if the given listener is `NULL`
+    */
+    void    removeFormComponentValidityListener( [in] XFormComponentValidityListener Listener )
+                raises( com::sun::star::lang::NullPointerException );
+};
+
+
+}; }; }; }; };
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */