offapi/com/sun/star/awt/XDialogEventHandler.idl

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