summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/form/XSubmitListener.idl
diff options
context:
space:
mode:
Diffstat (limited to 'offapi/com/sun/star/form/XSubmitListener.idl')
-rw-r--r--offapi/com/sun/star/form/XSubmitListener.idl79
1 files changed, 79 insertions, 0 deletions
diff --git a/offapi/com/sun/star/form/XSubmitListener.idl b/offapi/com/sun/star/form/XSubmitListener.idl
new file mode 100644
index 000000000000..1943c2071a2d
--- /dev/null
+++ b/offapi/com/sun/star/form/XSubmitListener.idl
@@ -0,0 +1,79 @@
+/*************************************************************************
+ *
+ * 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_form_XSubmitListener_idl__
+#define __com_sun_star_form_XSubmitListener_idl__
+
+#ifndef __com_sun_star_lang_XEventListener_idl__
+#include <com/sun/star/lang/XEventListener.idl>
+#endif
+
+#ifndef __com_sun_star_lang_EventObject_idl__
+#include <com/sun/star/lang/EventObject.idl>
+#endif
+
+
+//=============================================================================
+
+ module com { module sun { module star { module form {
+
+//=============================================================================
+
+/** receives notifications about data beeing submitted.
+
+ <p>The submission may be cancelled, so the listener has the possibility
+ of verifying the data before submission.</p>
+
+ @see XSubmit
+
+ @deprecated
+ This interface is superseded by the <type scope="com::sun::star::form::submission">XSubmissionVetoListener</type>
+ interface. New implementations should use the latter, if possible.
+ */
+published interface XSubmitListener: com::sun::star::lang::XEventListener
+{
+ //-------------------------------------------------------------------------
+
+ /** is invoked when a component is about to submit it's data.
+
+ @param aEvent
+ the event happend
+
+ @returns
+ <TRUE/> when submitting was approved, otherwise <FALSE/>.
+ */
+ boolean approveSubmit( [in] com::sun::star::lang::EventObject rEvent );
+
+};
+
+//=============================================================================
+
+}; }; }; };
+
+/*=============================================================================
+
+=============================================================================*/
+#endif