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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef __com_sun_star_awt_XDialogEventHandler_idl__
  21 #define __com_sun_star_awt_XDialogEventHandler_idl__
  22
  23 #include <com/sun/star/uno/XInterface.idl>
  24 #include <com/sun/star/awt/XDialog.idl>
  25 #include <com/sun/star/lang/WrappedTargetException.idl>
  26
  27
  28
  29 module com { module sun { module star { module awt {
  30
  31
  32 /** Handles events fired by dialogs represented by a
  33     com::sun::star::awt::XDialog interface.
  34  */
  35 interface XDialogEventHandler : ::com::sun::star::uno::XInterface {
  36
  37
  38     /** Handles an event generated by a dialog.
  39
  40         The implementation must be aware that the EventObject argument contains types
  41         which it is not prepared to handle. Similarly this applies for the MethodName
  42         argument. In this case the method should simply return false.
  43
  44         @param xDialog
  45             the dialog instance that generated the event. This is the same dialog instance
  46             that was returned by the com::sun::star::awt::XDialogProvider2
  47             createDialogWithHandler method when passing the XDialogEventHandler instance
  48             receiving the event as handler parameter.
  49
  50         @param EventObject
  51             an object describing the event which occurred in the dialog or anything else that
  52             provides additional information for the event.
  53             If the event was caused by the dialog or any of the controls which it contains
  54             then the any should contain an object derived from
  55             com::sun::star::lang::EventObject. Typically this would be one
  56             of the several com::sun::star::awt::*Event types.
  57
  58         @param MethodName
  59             the name of the function which is to be called.
  60
  61         @returns
  62             true if the event was handled, otherwise false.
  63
  64         @throws com::sun::star::lang::WrappedTargetException
  65             if the implementation of the method, which is determined by the argument MethodName,
  66             throws an exception. This exception is then wrapped into a
  67             com::sun::star::lang::WrappedTargetException.
  68
  69      */
  70     boolean callHandlerMethod(
  71         [in] com::sun::star::awt::XDialog xDialog,
  72         [in] any EventObject,
  73         [in] string MethodName)
  74         raises(com::sun::star::lang::WrappedTargetException);
  75
  76
  77     /** returns a sequence of supported method names
  78
  79         @returns
  80             all method names that will be accepted in calls to callHandlerMethod.
  81      */
  82     sequence<string> getSupportedMethodNames();
  83 };
  84
  85
  86 }; }; }; };
  87
  88 #endif
  89
  90 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */