offapi/com/sun/star/form/component/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 #ifndef __com_sun_star_form_component_SubmitButton_idl__
  31 #define __com_sun_star_form_component_SubmitButton_idl__
  32
  33 #ifndef __com_sun_star_form_FormControlModel_idl__
  34 #include <com/sun/star/form/FormControlModel.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_awt_UnoControlButtonModel_idl__
  38 #include <com/sun/star/awt/UnoControlButtonModel.idl>
  39 #endif
  40
  41 #ifndef __com_sun_star_form_submission_XSubmissionSupplier_idl__
  42 #include <com/sun/star/form/submission/XSubmissionSupplier.idl>
  43 #endif
  44
  45 //=============================================================================
  46
  47 module com {  module sun {  module star {  module form {  module component {
  48
  49 //=============================================================================
  50
  51 /** specifies the control model for a button, part of a form component hierarchy,
  52     which can be bound to external submissions.
  53
  54     @see CommandButton
  55  */
  56 service SubmitButton
  57 {
  58     service com::sun::star::form::FormControlModel;
  59
  60     /** allows binding external submissions to the control model
  61
  62         <p>Note that the control model itself will not make any use of the submission.
  63         Instead, submissions are triggered by a control (not a control <em>model</em>).
  64         Thus, the <type scope="com::sun::star::form::control">SubmitButton</type>
  65         control associated with a <type>SubmitButton</type> model is responsible for
  66         using the submission supplied at this model.</p>
  67     */
  68     interface com::sun::star::form::submission::XSubmissionSupplier;
  69 };
  70
  71 //=============================================================================
  72
  73 }; }; }; }; };
  74
  75 #endif