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