offapi/com/sun/star/form/XSubmit.idl

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