offapi/com/sun/star/form/control/SubmitButton.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 #ifndef __com_sun_star_form_control_SubmitButton_idl__
  21 #define __com_sun_star_form_control_SubmitButton_idl__
  22
  23 #include <com/sun/star/awt/UnoControlButton.idl>
  24 #include <com/sun/star/form/submission/XSubmission.idl>
  25
  26
  27 module com {  module sun {  module star {  module form {  module control {
  28
  29
  30 /** specifies a button control which can execute external submissions
  31
  32     <p>The model of the control has to support the com::sun::star::form::component::SubmitButton
  33     service.</p>
  34
  35     <p>The control is clickable. When clicked (by mouse or keyboard, or programmatically),
  36         the following happens:
  37     <ol><li>Any com::sun::star::form::submission::XSubmissionVetoListeners registered
  38             at the component are given the chance to veto the submission.
  39         </li>
  40         <li>The model of the control is examined for an external submission object. That is,
  41             com::sun::star::form::submission::XSubmissionSupplier::getSubmission()
  42             is called at the model.<br/>
  43             If there is such a submission object, its
  44             com::sun::star::form::submission::XSubmission::submit() method is invoked.
  45         </li>
  46         <li>If there is no external submission, the parent object of the model is examined
  47             for the presence of the com::sun::star::form::XSubmit interface. If it
  48             is present, it's com::sun::star::form::XSubmit::submit() method is
  49             invoked.<br/>
  50             Since the parent object of a submit button can only be a com::sun::star::form::component::Form,
  51             this means that SubmitButtons are also able to submit com::sun::star::form::component::HTMLForms.
  52         </li>
  53     </ol>
  54     </p>
  55 */
  56 service SubmitButton
  57 {
  58     /** allows interception (and vetoing) of submissions triggered by the control.
  59     */
  60     interface com::sun::star::form::submission::XSubmission;
  61 };
  62
  63
  64 }; }; }; }; };
  65
  66 #endif
  67
  68
  69 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */