summaryrefslogtreecommitdiffstats
path: root/offapi/com/sun/star/form/control/SubmitButton.idl
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-07 09:06:44 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-07 09:06:44 +0000
commited5640d8b587fbcfed7dd7967f3de04b37a76f26 (patch)
tree7a5f7c6c9d02226d7471cb3cc8fbbf631b415303 /offapi/com/sun/star/form/control/SubmitButton.idl
parentInitial commit. (diff)
downloadlibreoffice-upstream.tar.xz
libreoffice-upstream.zip
Adding upstream version 4:7.4.7.upstream/4%7.4.7upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'offapi/com/sun/star/form/control/SubmitButton.idl')
-rw-r--r--offapi/com/sun/star/form/control/SubmitButton.idl69
1 files changed, 69 insertions, 0 deletions
diff --git a/offapi/com/sun/star/form/control/SubmitButton.idl b/offapi/com/sun/star/form/control/SubmitButton.idl
new file mode 100644
index 000000000..d84716627
--- /dev/null
+++ b/offapi/com/sun/star/form/control/SubmitButton.idl
@@ -0,0 +1,69 @@
+/* -*- 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_control_SubmitButton_idl__
+#define __com_sun_star_form_control_SubmitButton_idl__
+
+#include <com/sun/star/awt/UnoControlButton.idl>
+#include <com/sun/star/form/submission/XSubmission.idl>
+
+
+module com { module sun { module star { module form { module control {
+
+
+/** specifies a button control which can execute external submissions
+
+ <p>The model of the control has to support the com::sun::star::form::component::SubmitButton
+ service.</p>
+
+ <p>The control is clickable. When clicked (by mouse or keyboard, or programmatically),
+ the following happens:
+ <ol><li>Any com::sun::star::form::submission::XSubmissionVetoListeners registered
+ at the component are given the chance to veto the submission.
+ </li>
+ <li>The model of the control is examined for an external submission object. That is,
+ com::sun::star::form::submission::XSubmissionSupplier::getSubmission()
+ is called at the model.<br/>
+ If there is such a submission object, its
+ com::sun::star::form::submission::XSubmission::submit() method is invoked.
+ </li>
+ <li>If there is no external submission, the parent object of the model is examined
+ for the presence of the com::sun::star::form::XSubmit interface. If it
+ is present, it's com::sun::star::form::XSubmit::submit() method is
+ invoked.<br/>
+ Since the parent object of a submit button can only be a com::sun::star::form::component::Form,
+ this means that SubmitButtons are also able to submit com::sun::star::form::component::HTMLForms.
+ </li>
+ </ol>
+ </p>
+*/
+service SubmitButton
+{
+ /** allows interception (and vetoing) of submissions triggered by the control.
+ */
+ interface com::sun::star::form::submission::XSubmission;
+};
+
+
+}; }; }; }; };
+
+#endif
+
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */