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
  21
  22 module com { module sun { module star { module awt {
  23
  24
  25 /** Handles events fired by windows represented by a
  26     com::sun::star::awt::XWindow interface.
  27  */
  28 interface XContainerWindowEventHandler : ::com::sun::star::uno::XInterface {
  29
  30
  31     /** Handles an event generated by a window.
  32
  33         The implementation must be aware that the EventObject argument contains types
  34         which it is not prepared to handle. Similarly this applies for the MethodName
  35         argument. In this case the method should simply return false.
  36
  37         @param xWindow
  38             the window instance that generated the event. If used in the scope of
  39             com::sun::star::awt::XContainerWindowProvider this
  40             is the same window instance that was returned by the createContainerWindow
  41             method when passing the XContainerWindowEventHandler instance receiving the
  42             event as handler parameter.
  43
  44         @param EventObject
  45             an object describing the event which occurred in the window or anything else that
  46             provides additional information for the event.
  47             If the event was caused by the window or any of the controls which it contains
  48             then the any should contain an object derived from
  49             com::sun::star::lang::EventObject. Typically this would be one
  50             of the several com::sun::star::awt::*Event types.
  51
  52         @param MethodName
  53             the name of the function which is to be called.
  54
  55         @returns
  56             true if the event was handled, otherwise false.
  57
  58         @throws com::sun::star::lang::WrappedTargetException
  59             if the implementation of the method, which is determined by the argument MethodName,
  60             throws an exception. This exception is then wrapped into a
  61             com::sun::star::lang::WrappedTargetException.
  62
  63      */
  64     boolean callHandlerMethod(
  65         [in] com::sun::star::awt::XWindow xWindow,
  66         [in] any EventObject,
  67         [in] string MethodName)
  68         raises(com::sun::star::lang::WrappedTargetException);
  69
  70
  71     /** returns a sequence of supported method names
  72
  73         @returns
  74             all method names that will be accepted in calls to callHandlerMethod.
  75      */
  76     sequence<string> getSupportedMethodNames();
  77 };
  78
  79
  80 }; }; }; };
  81
  82 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */