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