offapi/com/sun/star/awt/XMouseClickHandler.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 #ifndef __com_sun_star_awt_XMouseClickHandler_idl__
  20 #define __com_sun_star_awt_XMouseClickHandler_idl__
  21
  22 #include <com/sun/star/lang/XEventListener.idl>
  23 #include <com/sun/star/awt/MouseEvent.idl>
  24
  25
  26
  27 module com {  module sun {  module star {  module awt {
  28
  29
  30 /** makes it possible to receive events from the mouse in a certain window.
  31
  32     @since OOo 1.1.2
  33  */
  34 published interface XMouseClickHandler: ::com::sun::star::lang::XEventListener
  35 {
  36
  37     /** is invoked when a mouse button has been pressed on a window.
  38
  39         @return
  40             When `FALSE` is returned the other handlers are called and a
  41             following handling of the event by the broadcaster takes place.
  42             Otherwise, when `TRUE` is returned, no other handler will be
  43             called and the broadcaster will take no further actions
  44             regarding the event.
  45      */
  46     boolean mousePressed( [in] com::sun::star::awt::MouseEvent e );
  47
  48
  49     /** is invoked when a mouse button has been released on a window.
  50
  51         @return
  52             When `FALSE` is returned the other handlers are called and a
  53             following handling of the event by the broadcaster takes place.
  54             Otherwise, when `TRUE` is returned, no other handler will be
  55             called and the broadcaster will take no further actions
  56             regarding the event.
  57     */
  58     boolean mouseReleased( [in] com::sun::star::awt::MouseEvent e );
  59
  60 };
  61
  62
  63 }; }; }; };
  64
  65 #endif
  66
  67 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */