summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/form/submission/XSubmissionVetoListener.idl
blob: 64c2419a625d8bb0f202113330b4341a0c5ef3be (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
/*************************************************************************
 *
 *  OpenOffice.org - a multi-platform office productivity suite
 *
 *  $RCSfile: XSubmissionVetoListener.idl,v $
 *
 *  $Revision: 1.3 $
 *
 *  last change: $Author: rt $ $Date: 2005-09-08 00:51:10 $
 *
 *  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_submission_XSubmissionVetoListener_idl__
#define __com_sun_star_form_submission_XSubmissionVetoListener_idl__

#ifndef __com_sun_star_lang_XEventListener_idl__
#include <com/sun/star/lang/XEventListener.idl>
#endif
#ifndef __com_sun_star_util_VetoException_idl__
#include <com/sun/star/util/VetoException.idl>
#endif

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

module com {  module sun {  module star {  module form { module submission {

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

/** is implement by components which want to observe (and probably veto) the
    submission of data.

    @see XSubmission
*/
interface XSubmissionVetoListener : com::sun::star::lang::XEventListener
{
    /** is invoked when a component, at which the listener has been registered,
        is about to submit its data.

        @param event
            The submission event. The <member scope="com::sun::star::lang">EventObject::Source</member>
            member of the structure describes the component which is about to submit its data.

        @throws com::sun::star::util::VetoException
            when the submission is vetoed. <member scope="com::sun::star::uno">Exception::Message</member>
            should contain a justification for the veto then.
     */
    void    submitting( [in] com::sun::star::lang::EventObject event )
                raises ( com::sun::star::util::VetoException );

};

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

}; }; }; }; };

#endif