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

/**************************************************************
 *
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the 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