offapi/com/sun/star/awt/XDisplayConnection.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 module com { module sun { module star { module awt {
  22
  23  published interface XEventHandler;
  24
  25
  26 /** This interface should be implemented by toolkits that want to give access
  27     to their internal message handling loop.
  28 */
  29 published interface XDisplayConnection: com::sun::star::uno::XInterface
  30 {
  31
  32     /** registers an event handler.
  33
  34         @param window
  35         the platform specific window id. If empty, the handler should be
  36         registered for all windows.
  37
  38         @param eventHandler
  39         the handler to register.
  40
  41         @param eventMask
  42         the event mask specifies the events the handler is interested in.
  43     */
  44     void addEventHandler( [in] any window, [in] XEventHandler eventHandler, [in] long eventMask );
  45
  46
  47     /** removes an eventHandler from the handler list.
  48
  49         @param window
  50         the platform specific window id the handler should be unregistered for.
  51         If empty, the handler should be unregistered completely.
  52
  53         @param eventHandler
  54         the handler to remove.
  55     */
  56     void removeEventHandler( [in] any window, [in] XEventHandler eventHandler );
  57
  58
  59     /** register an error handler for toolkit specific errors.
  60
  61         @param errorHandler
  62         the handler to register.
  63     */
  64     void addErrorHandler( [in] XEventHandler errorHandler );
  65
  66
  67     /** remover an error handler from the handler list.
  68
  69         @param errorHandler
  70         the handler to remove.
  71     */
  72     void removeErrorHandler( [in] XEventHandler errorHandler );
  73
  74
  75     /** returns an identifier.
  76
  77         @returns a unique platform dependent identifier for a display connection.
  78     */
  79     any getIdentifier();
  80
  81 };
  82
  83
  84 }; }; }; };
  85
  86 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */