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