offapi/com/sun/star/awt/XMouseClickHandler.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*************************************************************************
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * Copyright 2000, 2010 Oracle and/or its affiliates.
   7  *
   8  * OpenOffice.org - a multi-platform office productivity suite
   9  *
  10  * This file is part of OpenOffice.org.
  11  *
  12  * OpenOffice.org is free software: you can redistribute it and/or modify
  13  * it under the terms of the GNU Lesser General Public License version 3
  14  * only, as published by the Free Software Foundation.
  15  *
  16  * OpenOffice.org is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU Lesser General Public License version 3 for more details
  20  * (a copy is included in the LICENSE file that accompanied this code).
  21  *
  22  * You should have received a copy of the GNU Lesser General Public License
  23  * version 3 along with OpenOffice.org.  If not, see
  24  * <http://www.openoffice.org/license.html>
  25  * for a copy of the LGPLv3 License.
  26  *
  27  ************************************************************************/
  28 #ifndef __com_sun_star_awt_XMouseClickHandler_idl__
  29 #define __com_sun_star_awt_XMouseClickHandler_idl__
  30
  31 #include <com/sun/star/lang/XEventListener.idl>
  32 #include <com/sun/star/awt/MouseEvent.idl>
  33
  34
  35 //=============================================================================
  36
  37 module com {  module sun {  module star {  module awt {
  38
  39 //=============================================================================
  40
  41 /** makes it possible to receive events from the mouse in a certain window.
  42
  43     @since OOo 1.1.2
  44  */
  45 published interface XMouseClickHandler: ::com::sun::star::lang::XEventListener
  46 {
  47     //-------------------------------------------------------------------------
  48
  49     /** is invoked when a mouse button has been pressed 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 mousePressed( [in] com::sun::star::awt::MouseEvent e );
  59
  60     //-------------------------------------------------------------------------
  61
  62     /** is invoked when a mouse button has been released on a window.
  63
  64         @return
  65             When <FALSE/> is returned the other handlers are called and a
  66             following handling of the event by the broadcaster takes place.
  67             Otherwise, when <TRUE/> is returned, no other handler will be
  68             called and the broadcaster will take no further actions
  69             regarding the event.
  70     */
  71     boolean mouseReleased( [in] com::sun::star::awt::MouseEvent e );
  72
  73 };
  74
  75 //=============================================================================
  76
  77 }; }; }; };
  78
  79 #endif
  80
  81 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */