offapi/com/sun/star/xforms/XSubmission.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27
  28 #ifndef __com_sun_star_xsd_XSubmission_idl__
  29 #define __com_sun_star_xsd_XSubmission_idl__
  30
  31 #ifndef __com_sun_star_uno_XInterface_idl__
  32 #include <com/sun/star/uno/XInterface.idl>
  33 #endif
  34 #ifndef __com_sun_star_beans_XPropertySet_idl__
  35 #include <com/sun/star/beans/XPropertySet.idl>
  36 #endif
  37 #ifndef __com_sun_star_container_XNamed_idl__
  38 #include <com/sun/star/container/XNamed.idl>
  39 #endif
  40 #ifndef __com_sun_star_form_submission_XSubmission_idl__
  41 #include <com/sun/star/form/submission/XSubmission.idl>
  42 #endif
  43
  44 //=============================================================================
  45 module com {  module sun {  module star {  module xforms {
  46
  47 //-----------------------------------------------------------------------------
  48 /** specifies a submission object, associated with an <type>XModel</type>
  49 */
  50 interface XSubmission
  51 {
  52     /** allows access to the submission's properties
  53     */
  54     interface com::sun::star::beans::XPropertySet;
  55
  56     /** allows access to the name of the submission
  57
  58         <p>Note that the name of the submission always equals it's the value of its ID
  59         property./p>
  60     */
  61     interface com::sun::star::container::XNamed;
  62
  63     /** allows the submission to be associated with certain form controls
  64
  65         <p>Calling the <member scope="com::sun::star::form::submission">XSubmission::submit</member>
  66         yields exactly the same result as calling <member>XModel::submit</member> of the model which
  67         the submission belongs to, passing the ID of the submission.</p>
  68     */
  69     interface com::sun::star::form::submission::XSubmission;
  70 };
  71
  72 //=============================================================================
  73
  74 }; }; }; };
  75
  76 #endif