xref: /trunk/main/offapi/com/sun/star/xforms/XSubmission.idl (revision cdf0e10c)

/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/

#ifndef __com_sun_star_xsd_XSubmission_idl__
#define __com_sun_star_xsd_XSubmission_idl__

#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif
#ifndef __com_sun_star_beans_XPropertySet_idl__
#include <com/sun/star/beans/XPropertySet.idl>
#endif
#ifndef __com_sun_star_container_XNamed_idl__
#include <com/sun/star/container/XNamed.idl>
#endif
#ifndef __com_sun_star_form_submission_XSubmission_idl__
#include <com/sun/star/form/submission/XSubmission.idl>
#endif

//=============================================================================
module com {  module sun {  module star {  module xforms {

//-----------------------------------------------------------------------------
/** specifies a submission object, associated with an <type>XModel</type>
*/
interface XSubmission
{
    /** allows access to the submission's properties
    */
    interface com::sun::star::beans::XPropertySet;

    /** allows access to the name of the submission

        <p>Note that the name of the submission always equals it's the value of its ID
        property./p>
    */
    interface com::sun::star::container::XNamed;

    /** allows the submission to be associated with certain form controls

        <p>Calling the <member scope="com::sun::star::form::submission">XSubmission::submit</member>
        yields exactly the same result as calling <member>XModel::submit</member> of the model which
        the submission belongs to, passing the ID of the submission.</p>
    */
    interface com::sun::star::form::submission::XSubmission;
};

//=============================================================================

}; }; }; };

#endif