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