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

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