offapi/com/sun/star/awt/MouseEvent.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_MouseEvent_idl__
  29 #define __com_sun_star_awt_MouseEvent_idl__
  30
  31 #include <com/sun/star/awt/InputEvent.idl>
  32
  33
  34 //=============================================================================
  35
  36  module com {  module sun {  module star {  module awt {
  37
  38 //=============================================================================
  39
  40 /** specifies an event from the mouse.
  41
  42     <p>This event is also used for pop-up menu requests on objects.
  43     See <member>PopupTrigger</member> for details.</p>
  44
  45     @see XMouseListener
  46     @see XMouseMotionListener
  47     @see InputEvent
  48  */
  49 published struct MouseEvent: com::sun::star::awt::InputEvent
  50 {
  51     //-------------------------------------------------------------------------
  52
  53     /** contains the pressed mouse buttons.
  54
  55         <p>Zero ore more constants from the
  56         <type scope="com::sun::star::awt">MouseButton</type> group.</p>
  57      */
  58     short Buttons;
  59
  60     //-------------------------------------------------------------------------
  61
  62     /** contains the x coordinate location of the mouse.
  63      */
  64     long X;
  65
  66     //-------------------------------------------------------------------------
  67
  68     /** contains the y coordinate location of the mouse.
  69      */
  70     long Y;
  71
  72     //-------------------------------------------------------------------------
  73
  74     /** contains the number of mouse clicks associated with event.
  75      */
  76     long ClickCount;
  77
  78     //-------------------------------------------------------------------------
  79
  80     /** specifies if this event is a pop-up menu trigger event.
  81
  82         <p>If this member is <TRUE/>, the event describes a request for a pop-up menu,
  83         also known as context menu, on an object.</p>
  84
  85         <p>In this case, <member>X</member> and <member>Y</member> describe the position
  86         where the request was issued. If those members are <code>-1</code>, then the
  87         request was issued using the keyboard, by pressing the operating-system dependent
  88         key combination for this purpose.</p>
  89
  90         @see XMouseListener::mousePressed
  91     */
  92     boolean PopupTrigger;
  93
  94 };
  95
  96 //=============================================================================
  97
  98 }; }; }; };
  99
 100 #endif
 101
 102 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */