xref: /aoo41x/main/offapi/com/sun/star/form/XSubmit.idl (revision d1766043)
1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23#ifndef __com_sun_star_form_XSubmit_idl__
24#define __com_sun_star_form_XSubmit_idl__
25
26#ifndef __com_sun_star_uno_XInterface_idl__
27#include <com/sun/star/uno/XInterface.idl>
28#endif
29
30#ifndef __com_sun_star_awt_XControl_idl__
31#include <com/sun/star/awt/XControl.idl>
32#endif
33
34#ifndef __com_sun_star_awt_MouseEvent_idl__
35#include <com/sun/star/awt/MouseEvent.idl>
36#endif
37
38#ifndef __com_sun_star_form_XSubmitListener_idl__
39#include <com/sun/star/form/XSubmitListener.idl>
40#endif
41
42
43//=============================================================================
44
45 module com {  module sun {  module star {  module form {
46
47//=============================================================================
48
49/** provides functionality to submit data from a component.
50
51	<p>Usually, this is used by <type scope="com::sun::star::form::component">HTMLForm</type>s.
52
53	<p>See the <A href="http://www.w3.org/TR/1999/REC-html401-19991224/interact/forms.html#h-17.13">HTML specification</A>
54	to learn about submitting forms.</p>
55 */
56published interface XSubmit: com::sun::star::uno::XInterface
57{
58	//-------------------------------------------------------------------------
59
60	/** submits the component's data to a specified target.
61
62		@param aControl
63			the control which's data is to be be submitted
64
65		@param aMouseEvt
66			the event which triggered the submit, if it was a mouse event
67
68		@see com::sun::star::awt::MouseEvent
69	 */
70	[oneway] void submit( [in] com::sun::star::awt::XControl aControl,
71			 [in] com::sun::star::awt::MouseEvent aMouseEvt );
72
73	//-------------------------------------------------------------------------
74
75	/** adds the specified listener to receive the "approveSubmit" event.
76
77		@param aListener
78			the listener to add.
79
80		@see com::sun::star::form::XSubmitListener
81	 */
82	[oneway] void addSubmitListener( [in] com::sun::star::form::XSubmitListener aListener );
83
84	//-------------------------------------------------------------------------
85
86	/** removes the specified listener.
87		@param aListener
88			the listener to remove.
89		@see com::sun::star::form::XSubmitListener
90	 */
91	[oneway] void removeSubmitListener( [in] com::sun::star::form::XSubmitListener aListener );
92
93};
94
95//=============================================================================
96
97}; }; }; };
98
99/*=============================================================================
100
101=============================================================================*/
102#endif
103