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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef __com_sun_star_form_XSubmit_idl__
  20 #define __com_sun_star_form_XSubmit_idl__
  21
  22 #include <com/sun/star/uno/XInterface.idl>
  23
  24 #include <com/sun/star/awt/XControl.idl>
  25
  26 #include <com/sun/star/awt/MouseEvent.idl>
  27
  28 #include <com/sun/star/form/XSubmitListener.idl>
  29
  30
  31
  32  module com {  module sun {  module star {  module form {
  33
  34
  35 /** provides functionality to submit data from a component.
  36
  37     <p>Usually, this is used by com::sun::star::form::component::HTMLForms.
  38
  39     <p>See the <A href="http://www.w3.org/TR/1999/REC-html401-19991224/interact/forms.html#h-17.13">HTML specification</A>
  40     to learn about submitting forms.</p>
  41  */
  42 published interface XSubmit: com::sun::star::uno::XInterface
  43 {
  44
  45     /** submits the component's data to a specified target.
  46
  47         @param aControl
  48             the control whose data is to be submitted
  49
  50         @param aMouseEvt
  51             the event which triggered the submit, if it was a mouse event
  52
  53         @see com::sun::star::awt::MouseEvent
  54      */
  55     void submit( [in] com::sun::star::awt::XControl aControl,
  56              [in] com::sun::star::awt::MouseEvent aMouseEvt );
  57
  58
  59     /** adds the specified listener to receive the "approveSubmit" event.
  60
  61         @param aListener
  62             the listener to add.
  63
  64         @see com::sun::star::form::XSubmitListener
  65      */
  66     void addSubmitListener( [in] com::sun::star::form::XSubmitListener aListener );
  67
  68
  69     /** removes the specified listener.
  70         @param aListener
  71             the listener to remove.
  72         @see com::sun::star::form::XSubmitListener
  73      */
  74     void removeSubmitListener( [in] com::sun::star::form::XSubmitListener aListener );
  75
  76 };
  77
  78
  79 }; }; }; };
  80
  81 #endif
  82
  83 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */