offapi/com/sun/star/awt/XContainerWindowEventHandler.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_XContainerWindowEventHandler_idl__
  21 #define __com_sun_star_awt_XContainerWindowEventHandler_idl__
  22
  23 #include <com/sun/star/uno/XInterface.idl>
  24 #include <com/sun/star/awt/XWindow.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 windows represented by a
  33     com::sun::star::awt::XWindow interface.
  34  */
  35 interface XContainerWindowEventHandler : ::com::sun::star::uno::XInterface {
  36
  37
  38     /** Handles an event generated by a window.
  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 xWindow
  45             the window instance that generated the event. If used in the scope of
  46             com::sun::star::awt::XContainerWindowProvider this
  47             is the same window instance that was returned by the createContainerWindow
  48             method when passing the XContainerWindowEventHandler instance receiving the
  49             event as handler parameter.
  50
  51         @param EventObject
  52             an object describing the event which occurred in the window or anything else that
  53             provides additional information for the event.
  54             If the event was caused by the window or any of the controls which it contains
  55             then the any should contain an object derived from
  56             com::sun::star::lang::EventObject. Typically this would be one
  57             of the several com::sun::star::awt::*Event types.
  58
  59         @param MethodName
  60             the name of the function which is to be called.
  61
  62         @returns
  63             true if the event was handled, otherwise false.
  64
  65         @throws com::sun::star::lang::WrappedTargetException
  66             if the implementation of the method, which is determined by the argument MethodName,
  67             throws an exception. This exception is then wrapped into a
  68             com::sun::star::lang::WrappedTargetException.
  69
  70      */
  71     boolean callHandlerMethod(
  72         [in] com::sun::star::awt::XWindow xWindow,
  73         [in] any EventObject,
  74         [in] string MethodName)
  75         raises(com::sun::star::lang::WrappedTargetException);
  76
  77
  78     /** returns a sequence of supported method names
  79
  80         @returns
  81             all method names that will be accepted in calls to callHandlerMethod.
  82      */
  83     sequence<string> getSupportedMethodNames();
  84 };
  85
  86
  87 }; }; }; };
  88
  89 #endif
  90
  91 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */