blob: 816efda2f9ac2745196e4c43740577099c77f565 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
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 <type scope="com::sun::star::form::component">SubmitButton</type>
service.</p>
<p>The control is clickable. When clicked (by mouse or keyboard, or programmatically),
the following happens:
<ol><li>Any <type scope="com::sun::star::form::submission">XSubmissionVetoListener</type>s 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,
<member scope="com::sun::star::form::submission">XSubmissionSupplier::getSubmission</member>
is called at the model.<br/>
If there is such a submission object, its
<member scope="com::sun::star::form::submission">XSubmission::submit</member> method is invoked.
</li>
<li>If there is no external submission, the parent object of the model is examined
for the presence of the <type scope="com::sun::star::form">XSubmit</type> interface. If it
is present, it's <member scope="com::sun::star::form">XSubmit::submit</member> method is
invoked.<br/>
Since the parent object of a submit button can only be a <type scope="com::sun::star::form::component">Form</type>,
this means that <type>SubmitButton</type>s are also able to submit <type scope="com::sun::star::form::component">HTMLForm</type>s.
</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: */
|
