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

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: MouseEvent.idl,v $
  10  * $Revision: 1.12 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_awt_MouseEvent_idl__
  31 #define __com_sun_star_awt_MouseEvent_idl__
  32
  33 #ifndef __com_sun_star_awt_InputEvent_idl__
  34 #include <com/sun/star/awt/InputEvent.idl>
  35 #endif
  36
  37
  38 //=============================================================================
  39
  40  module com {  module sun {  module star {  module awt {
  41
  42 //=============================================================================
  43
  44 /** specifies an event from the mouse.
  45
  46     <p>This event is also used for popup menu requests on objects.
  47     See <member>PopupTrigger</member> for details.</p>
  48
  49     @see XMouseListener
  50     @see XMouseMotionListener
  51     @see InputEvent
  52  */
  53 published struct MouseEvent: com::sun::star::awt::InputEvent
  54 {
  55     //-------------------------------------------------------------------------
  56
  57     /** contains the pressed mouse buttons.
  58
  59         <p>Zero ore more constants from the
  60         <type scope="com::sun::star::awt">MouseButton</type> group.</p>
  61      */
  62     short Buttons;
  63
  64     //-------------------------------------------------------------------------
  65
  66     /** contains the x coordinate location of the mouse.
  67      */
  68     long X;
  69
  70     //-------------------------------------------------------------------------
  71
  72     /** contains the y coordinate location of the mouse.
  73      */
  74     long Y;
  75
  76     //-------------------------------------------------------------------------
  77
  78     /** contains the number of mouse clicks associated with event.
  79      */
  80     long ClickCount;
  81
  82     //-------------------------------------------------------------------------
  83
  84     /** specifies if this event is a popup-menu trigger event.
  85
  86         <p>If this member is <TRUE/>, the event describes a request for a popup menu,
  87         also known as context menu, on an object.</p>
  88
  89         <p>In this case, <member>X</member> and <member>Y</member> describe the position
  90         where the request was issued. If those members are <code>-1</code>, then the
  91         request was issued using the keyboard, by pressing the operating-system dependent
  92         key combination for this purpose.</p>
  93
  94         @see XMouseListener::mousePressed
  95     */
  96     boolean PopupTrigger;
  97
  98 };
  99
 100 //=============================================================================
 101
 102 }; }; }; };
 103
 104 #endif