summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/awt/XDialogEventHandler.idl
diff options
context:
space:
mode:
Diffstat (limited to 'offapi/com/sun/star/awt/XDialogEventHandler.idl')
-rw-r--r--offapi/com/sun/star/awt/XDialogEventHandler.idl106
1 files changed, 106 insertions, 0 deletions
diff --git a/offapi/com/sun/star/awt/XDialogEventHandler.idl b/offapi/com/sun/star/awt/XDialogEventHandler.idl
new file mode 100644
index 000000000000..206d71bb5dee
--- /dev/null
+++ b/offapi/com/sun/star/awt/XDialogEventHandler.idl
@@ -0,0 +1,106 @@
+/*************************************************************************
+ *
+ * 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_awt_XDialogEventHandler_idl__
+#define __com_sun_star_awt_XDialogEventHandler_idl__
+
+#ifndef __com_sun_star_uno_XInterface_idl__
+#include <com/sun/star/uno/XInterface.idl>
+#endif
+#ifndef __com_sun_star_awt_XDialog_idl__
+#include <com/sun/star/awt/XDialog.idl>
+#endif
+#ifndef __com_sun_star_lang_WrappedTargetException_idl__
+#include <com/sun/star/lang/WrappedTargetException.idl>
+#endif
+
+
+//=============================================================================
+
+module com { module sun { module star { module awt {
+
+//=============================================================================
+
+/** Handles events fired by dialogs represented by a
+ <type scope="com::sun::star::awt">XDialog</type> interface.
+ */
+interface XDialogEventHandler : ::com::sun::star::uno::XInterface {
+
+ //-------------------------------------------------------------------------
+
+ /** Handles an event generated by a dialog.
+
+ The implementation must be aware that the EventObject argument contains types
+ which it is not prepared to handle. Similarly this applies for the MethodName
+ argument. In this case the method should simply return false.
+
+ @param xDialog
+ the dialog instance that generated the event. This is the same dialog instance
+ that was returned by the <type scope="com::sun::star::awt">XDialogProvider2</type>
+ createDialogWithHandler method when passing the XDialogEventHandler instance
+ receiving the event as handler parameter.
+
+ @param EventObject
+ an object describing the event which occurred in the dialog or anything else that
+ provides additional information for the event.
+ If the event was caused by the dialog or any of the controls which it contains
+ then the any should contain an object derived from
+ <type scope="com::sun::star::lang">EventObject</type>. Typically this would be one
+ of the several com::sun::star::awt::*Event types.
+
+ @param MethodName
+ the name of the function which is to be called.
+
+ @returns
+ true if the event was handled, otherwise false.
+
+ @throws com::sun::star::lang::WrappedTargetException
+ if the implementation of the method, which is determined by the argument MethodName,
+ throws an exception. This exception is then wrapped into a
+ <type scope="com::sun::star::lang">WrappedTargetException</type>.
+
+ */
+ boolean callHandlerMethod(
+ [in] com::sun::star::awt::XDialog xDialog,
+ [in] any EventObject,
+ [in] string MethodName)
+ raises(com::sun::star::lang::WrappedTargetException);
+
+
+ /** returns a sequence of supported method names
+
+ @returns
+ all method names that will be accepted in calls to callHandlerMethod.
+ */
+ sequence<string> getSupportedMethodNames();
+};
+
+//=============================================================================
+
+}; }; }; };
+
+#endif