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
  20
  21
  22  module com {  module sun {  module star {  module form {
  23
  24
  25 /** provides functionality to submit data from a component.
  26
  27     <p>Usually, this is used by com::sun::star::form::component::HTMLForms.
  28
  29     <p>See the <A href="http://www.w3.org/TR/1999/REC-html401-19991224/interact/forms.html#h-17.13">HTML specification</A>
  30     to learn about submitting forms.</p>
  31  */
  32 published interface XSubmit: com::sun::star::uno::XInterface
  33 {
  34
  35     /** submits the component's data to a specified target.
  36
  37         @param aControl
  38             the control whose data is to be submitted
  39
  40         @param aMouseEvt
  41             the event which triggered the submit, if it was a mouse event
  42
  43         @see com::sun::star::awt::MouseEvent
  44      */
  45     void submit( [in] com::sun::star::awt::XControl aControl,
  46              [in] com::sun::star::awt::MouseEvent aMouseEvt );
  47
  48
  49     /** adds the specified listener to receive the "approveSubmit" event.
  50
  51         @param aListener
  52             the listener to add.
  53
  54         @see com::sun::star::form::XSubmitListener
  55      */
  56     void addSubmitListener( [in] com::sun::star::form::XSubmitListener aListener );
  57
  58
  59     /** removes the specified listener.
  60         @param aListener
  61             the listener to remove.
  62         @see com::sun::star::form::XSubmitListener
  63      */
  64     void removeSubmitListener( [in] com::sun::star::form::XSubmitListener aListener );
  65
  66 };
  67
  68
  69 }; }; }; };
  70
  71 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */