xref: /aoo41x/main/offapi/com/sun/star/form/XSubmit.idl (revision cdf0e10c)
1*cdf0e10cSrcweir/*************************************************************************
2*cdf0e10cSrcweir *
3*cdf0e10cSrcweir * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4*cdf0e10cSrcweir *
5*cdf0e10cSrcweir * Copyright 2000, 2010 Oracle and/or its affiliates.
6*cdf0e10cSrcweir *
7*cdf0e10cSrcweir * OpenOffice.org - a multi-platform office productivity suite
8*cdf0e10cSrcweir *
9*cdf0e10cSrcweir * This file is part of OpenOffice.org.
10*cdf0e10cSrcweir *
11*cdf0e10cSrcweir * OpenOffice.org is free software: you can redistribute it and/or modify
12*cdf0e10cSrcweir * it under the terms of the GNU Lesser General Public License version 3
13*cdf0e10cSrcweir * only, as published by the Free Software Foundation.
14*cdf0e10cSrcweir *
15*cdf0e10cSrcweir * OpenOffice.org is distributed in the hope that it will be useful,
16*cdf0e10cSrcweir * but WITHOUT ANY WARRANTY; without even the implied warranty of
17*cdf0e10cSrcweir * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18*cdf0e10cSrcweir * GNU Lesser General Public License version 3 for more details
19*cdf0e10cSrcweir * (a copy is included in the LICENSE file that accompanied this code).
20*cdf0e10cSrcweir *
21*cdf0e10cSrcweir * You should have received a copy of the GNU Lesser General Public License
22*cdf0e10cSrcweir * version 3 along with OpenOffice.org.  If not, see
23*cdf0e10cSrcweir * <http://www.openoffice.org/license.html>
24*cdf0e10cSrcweir * for a copy of the LGPLv3 License.
25*cdf0e10cSrcweir *
26*cdf0e10cSrcweir ************************************************************************/
27*cdf0e10cSrcweir#ifndef __com_sun_star_form_XSubmit_idl__
28*cdf0e10cSrcweir#define __com_sun_star_form_XSubmit_idl__
29*cdf0e10cSrcweir
30*cdf0e10cSrcweir#ifndef __com_sun_star_uno_XInterface_idl__
31*cdf0e10cSrcweir#include <com/sun/star/uno/XInterface.idl>
32*cdf0e10cSrcweir#endif
33*cdf0e10cSrcweir
34*cdf0e10cSrcweir#ifndef __com_sun_star_awt_XControl_idl__
35*cdf0e10cSrcweir#include <com/sun/star/awt/XControl.idl>
36*cdf0e10cSrcweir#endif
37*cdf0e10cSrcweir
38*cdf0e10cSrcweir#ifndef __com_sun_star_awt_MouseEvent_idl__
39*cdf0e10cSrcweir#include <com/sun/star/awt/MouseEvent.idl>
40*cdf0e10cSrcweir#endif
41*cdf0e10cSrcweir
42*cdf0e10cSrcweir#ifndef __com_sun_star_form_XSubmitListener_idl__
43*cdf0e10cSrcweir#include <com/sun/star/form/XSubmitListener.idl>
44*cdf0e10cSrcweir#endif
45*cdf0e10cSrcweir
46*cdf0e10cSrcweir
47*cdf0e10cSrcweir//=============================================================================
48*cdf0e10cSrcweir
49*cdf0e10cSrcweir module com {  module sun {  module star {  module form {
50*cdf0e10cSrcweir
51*cdf0e10cSrcweir//=============================================================================
52*cdf0e10cSrcweir
53*cdf0e10cSrcweir/** provides functionality to submit data from a component.
54*cdf0e10cSrcweir
55*cdf0e10cSrcweir	<p>Usually, this is used by <type scope="com::sun::star::form::component">HTMLForm</type>s.
56*cdf0e10cSrcweir
57*cdf0e10cSrcweir	<p>See the <A href="http://www.w3.org/TR/1999/REC-html401-19991224/interact/forms.html#h-17.13">HTML specification</A>
58*cdf0e10cSrcweir	to learn about submitting forms.</p>
59*cdf0e10cSrcweir */
60*cdf0e10cSrcweirpublished interface XSubmit: com::sun::star::uno::XInterface
61*cdf0e10cSrcweir{
62*cdf0e10cSrcweir	//-------------------------------------------------------------------------
63*cdf0e10cSrcweir
64*cdf0e10cSrcweir	/** submits the component's data to a specified target.
65*cdf0e10cSrcweir
66*cdf0e10cSrcweir		@param aControl
67*cdf0e10cSrcweir			the control which's data is to be be submitted
68*cdf0e10cSrcweir
69*cdf0e10cSrcweir		@param aMouseEvt
70*cdf0e10cSrcweir			the event which triggered the submit, if it was a mouse event
71*cdf0e10cSrcweir
72*cdf0e10cSrcweir		@see com::sun::star::awt::MouseEvent
73*cdf0e10cSrcweir	 */
74*cdf0e10cSrcweir	[oneway] void submit( [in] com::sun::star::awt::XControl aControl,
75*cdf0e10cSrcweir			 [in] com::sun::star::awt::MouseEvent aMouseEvt );
76*cdf0e10cSrcweir
77*cdf0e10cSrcweir	//-------------------------------------------------------------------------
78*cdf0e10cSrcweir
79*cdf0e10cSrcweir	/** adds the specified listener to receive the "approveSubmit" event.
80*cdf0e10cSrcweir
81*cdf0e10cSrcweir		@param aListener
82*cdf0e10cSrcweir			the listener to add.
83*cdf0e10cSrcweir
84*cdf0e10cSrcweir		@see com::sun::star::form::XSubmitListener
85*cdf0e10cSrcweir	 */
86*cdf0e10cSrcweir	[oneway] void addSubmitListener( [in] com::sun::star::form::XSubmitListener aListener );
87*cdf0e10cSrcweir
88*cdf0e10cSrcweir	//-------------------------------------------------------------------------
89*cdf0e10cSrcweir
90*cdf0e10cSrcweir	/** removes the specified listener.
91*cdf0e10cSrcweir		@param aListener
92*cdf0e10cSrcweir			the listener to remove.
93*cdf0e10cSrcweir		@see com::sun::star::form::XSubmitListener
94*cdf0e10cSrcweir	 */
95*cdf0e10cSrcweir	[oneway] void removeSubmitListener( [in] com::sun::star::form::XSubmitListener aListener );
96*cdf0e10cSrcweir
97*cdf0e10cSrcweir};
98*cdf0e10cSrcweir
99*cdf0e10cSrcweir//=============================================================================
100*cdf0e10cSrcweir
101*cdf0e10cSrcweir}; }; }; };
102*cdf0e10cSrcweir
103*cdf0e10cSrcweir/*=============================================================================
104*cdf0e10cSrcweir
105*cdf0e10cSrcweir=============================================================================*/
106*cdf0e10cSrcweir#endif
107