offapi/com/sun/star/xforms/XSubmission.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: XSubmission.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_xsd_XSubmission_idl__
  32 #define __com_sun_star_xsd_XSubmission_idl__
  33
  34 #ifndef __com_sun_star_uno_XInterface_idl__
  35 #include <com/sun/star/uno/XInterface.idl>
  36 #endif
  37 #ifndef __com_sun_star_beans_XPropertySet_idl__
  38 #include <com/sun/star/beans/XPropertySet.idl>
  39 #endif
  40 #ifndef __com_sun_star_container_XNamed_idl__
  41 #include <com/sun/star/container/XNamed.idl>
  42 #endif
  43 #ifndef __com_sun_star_form_submission_XSubmission_idl__
  44 #include <com/sun/star/form/submission/XSubmission.idl>
  45 #endif
  46
  47 //=============================================================================
  48 module com {  module sun {  module star {  module xforms {
  49
  50 //-----------------------------------------------------------------------------
  51 /** specifies a submission object, associated with an <type>XModel</type>
  52 */
  53 interface XSubmission
  54 {
  55     /** allows access to the submission's properties
  56     */
  57     interface com::sun::star::beans::XPropertySet;
  58
  59     /** allows access to the name of the submission
  60
  61         <p>Note that the name of the submission always equals it's the value of its ID
  62         property./p>
  63     */
  64     interface com::sun::star::container::XNamed;
  65
  66     /** allows the submission to be associated with certain form controls
  67
  68         <p>Calling the <member scope="com::sun::star::form::submission">XSubmission::submit</member>
  69         yields exactly the same result as calling <member>XModel::submit</member> of the model which
  70         the submission belongs to, passing the ID of the submission.</p>
  71     */
  72     interface com::sun::star::form::submission::XSubmission;
  73 };
  74
  75 //=============================================================================
  76
  77 }; }; }; };
  78
  79 #endif