1/*************************************************************************
2 *
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
6 *
7 * OpenOffice.org - a multi-platform office productivity suite
8 *
9 * This file is part of OpenOffice.org.
10 *
11 * OpenOffice.org is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License version 3
13 * only, as published by the Free Software Foundation.
14 *
15 * OpenOffice.org is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 * GNU Lesser General Public License version 3 for more details
19 * (a copy is included in the LICENSE file that accompanied this code).
20 *
21 * You should have received a copy of the GNU Lesser General Public License
22 * version 3 along with OpenOffice.org.  If not, see
23 * <http://www.openoffice.org/license.html>
24 * for a copy of the LGPLv3 License.
25 *
26 ************************************************************************/
27
28#ifndef __com_sun_star_awt_XDialogEventHandler_idl__
29#define __com_sun_star_awt_XDialogEventHandler_idl__
30
31#ifndef __com_sun_star_uno_XInterface_idl__
32#include <com/sun/star/uno/XInterface.idl>
33#endif
34#ifndef __com_sun_star_awt_XDialog_idl__
35#include <com/sun/star/awt/XDialog.idl>
36#endif
37#ifndef __com_sun_star_lang_WrappedTargetException_idl__
38#include <com/sun/star/lang/WrappedTargetException.idl>
39#endif
40
41
42//=============================================================================
43
44module com { module sun { module star { module awt {
45
46//=============================================================================
47
48/** Handles events fired by dialogs represented by a
49    <type scope="com::sun::star::awt">XDialog</type> interface.
50 */
51published interface XDialogEventHandler : ::com::sun::star::uno::XInterface {
52
53    //-------------------------------------------------------------------------
54
55    /** Handles an event generated by a dialog.
56
57        The implementation must be aware that the EventObject argument contains types
58        which it is not prepared to handle. Similarly this applies for the MethodName
59        argument. In this case the method should simply return false.
60
61        @param xDialog
62            the dialog instance that generated the event. This is the same dialog instance
63            that was returned by the <type scope="com::sun::star::awt">XDialogProvider2</type>
64            createDialogWithHandler method when passing the XDialogEventHandler instance
65            receiving the event as handler parameter.
66
67        @param EventObject
68            an object describing the event which occurred in the dialog or anything else that
69            provides additional information for the event.
70            If the event was caused by the dialog or any of the controls which it contains
71            then the any should contain an object derived from
72            <type scope="com::sun::star::lang">EventObject</type>. Typically this would be one
73            of the several com::sun::star::awt::*Event types.
74
75        @param MethodName
76            the name of the function which is to be called.
77
78        @returns
79            true if the event was handled, otherwise false.
80
81        @throws com::sun::star::lang::WrappedTargetException
82            if the implementation of the method, which is determined by the argument MethodName,
83            throws an exception. This exception is then wrapped into a
84            <type scope="com::sun::star::lang">WrappedTargetException</type>.
85
86     */
87    boolean callHandlerMethod(
88        [in] com::sun::star::awt::XDialog xDialog,
89        [in] any EventObject,
90        [in] string MethodName)
91        raises(com::sun::star::lang::WrappedTargetException);
92
93
94    /** returns a sequence of supported method names
95
96        @returns
97            all method names that will be accepted in calls to callHandlerMethod.
98     */
99    sequence<string> getSupportedMethodNames();
100};
101
102//=============================================================================
103
104}; }; }; };
105
106#endif
107