offapi/com/sun/star/form/control/SubmitButton.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: SubmitButton.idl,v $
  10  * $Revision: 1.4 $
  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
  31 #ifndef __com_sun_star_form_control_SubmitButton_idl__
  32 #define __com_sun_star_form_control_SubmitButton_idl__
  33
  34 #ifndef __com_sun_star_awt_UnoControlButton_idl__
  35 #include <com/sun/star/awt/UnoControlButton.idl>
  36 #endif
  37
  38 #ifndef __com_sun_star_form_submission_XSubmission_idl__
  39 #include <com/sun/star/form/submission/XSubmission.idl>
  40 #endif
  41
  42 //=============================================================================
  43
  44 module com {  module sun {  module star {  module form {  module control {
  45
  46 //=============================================================================
  47
  48 /** specifies a button control which can execute external submissions
  49
  50     <p>The model of the control has to support the <type scope="com::sun::star::form::component">SubmitButton</type>
  51     service.</p>
  52
  53     <p>The control is clickable. When clicked (by mouse or keyboard, or programmatically),
  54         the following happens:
  55     <ol><li>Any <type scope="com::sun::star::form::submission">XSubmissionVetoListener</type>s registered
  56             at the component are given the chance to veto the submission.
  57         </li>
  58         <li>The model of the control is examined for an external submission object. That is,
  59             <member scope="com::sun::star::form::submission">XSubmissionSupplier::getSubmission</member>
  60             is called at the model.<br/>
  61             If there is such a submission object, its
  62             <member scope="com::sun::star::form::submission">XSubmission::submit</member> method is invoked.
  63         </li>
  64         <li>If there is no external submission, the parent object of the model is examined
  65             for the presence of the <type scope="com::sun::star::form">XSubmit</type> interface. If it
  66             is present, it's <member scope="com::sun::star::form">XSubmit::submit</member> method is
  67             invoked.<br/>
  68             Since the parent object of a submit button can only be a <type scope="com::sun::star::form::component">Form</type>,
  69             this means that <type>SubmitButton</type>s are also able to submit <type scope="com::sun::star::form::component">HTMLForm</type>s.
  70         </li>
  71     </ol>
  72     </p>
  73 */
  74 service SubmitButton
  75 {
  76     /** allows interception (and vetoing) of submissions triggered by the control.
  77     */
  78     interface com::sun::star::form::submission::XSubmission;
  79 };
  80
  81 //=============================================================================
  82
  83 }; }; }; }; };
  84
  85 /*=============================================================================
  86
  87 =============================================================================*/
  88
  89 #endif
  90
  91