/*************************************************************************
 *
 *  OpenOffice.org - a multi-platform office productivity suite
 *
 *  $RCSfile: SubmitButton.idl,v $
 *
 *  $Revision: 1.3 $
 *
 *  last change: $Author: rt $ $Date: 2005/09/08 00:49:41 $
 *
 *  The Contents of this file are made available subject to
 *  the terms of GNU Lesser General Public License Version 2.1.
 *
 *
 *    GNU Lesser General Public License Version 2.1
 *    =============================================
 *    Copyright 2005 by Sun Microsystems, Inc.
 *    901 San Antonio Road, Palo Alto, CA 94303, USA
 *
 *    This library is free software; you can redistribute it and/or
 *    modify it under the terms of the GNU Lesser General Public
 *    License version 2.1, as published by the Free Software Foundation.
 *
 *    This library 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 for more details.
 *
 *    You should have received a copy of the GNU Lesser General Public
 *    License along with this library; if not, write to the Free Software
 *    Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *    MA  02111-1307  USA
 *
 ************************************************************************/

#ifndef __com_sun_star_form_control_SubmitButton_idl__
#define __com_sun_star_form_control_SubmitButton_idl__

#ifndef __com_sun_star_awt_UnoControlButton_idl__
#include <com/sun/star/awt/UnoControlButton.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 form {  module control {

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

/** specifies a button control which can execute external submissions

	<p>The model of the control has to support the <type scope="com::sun::star::form::component">SubmitButton</type>
	service.</p>

    <p>The control is clickable. When clicked (by mouse or keyboard, or programmatically),
        the following happens:
    <ol><li>Any <type scope="com::sun::star::form::submission">XSubmissionVetoListener</type>s registered
            at the component are given the chance to veto the submission.
        </li>
        <li>The model of the control is examined for an external submission object. That is,
            <member scope="com::sun::star::form::submission">XSubmissionSupplier::getSubmission</member>
            is called at the model.<br/>
            If there is such a submission object, its
            <member scope="com::sun::star::form::submission">XSubmission::submit</member> method is invoked.
        </li>
        <li>If there is no external submission, the parent object of the model is examined
            for the presence of the <type scope="com::sun::star::form">XSubmit</type> interface. If it
            is present, it's <member scope="com::sun::star::form">XSubmit::submit</member> method is
            invoked.<br/>
            Since the parent object of a submit button can only be a <type scope="com::sun::star::form::component">Form</type>,
            this means that <type>SubmitButton</type>s are also able to submit <type scope="com::sun::star::form::component">HTMLForm</type>s.
        </li>
    </ol>
    </p>
*/
service SubmitButton
{
    /** allows interception (and vetoing) of submissions triggered by the control.
    */
    interface com::sun::star::form::submission::XSubmission;
};

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

}; }; }; }; };

/*=============================================================================

=============================================================================*/

#endif


