/*************************************************************************
 *
 *  OpenOffice.org - a multi-platform office productivity suite
 *
 *  $RCSfile: MouseEvent.idl,v $
 *
 *  $Revision: 1.11 $
 *
 *  last change: $Author: rt $ $Date: 2005-09-07 21:10:58 $
 *
 *  The Contents of this file are made available subject to
 *  the terms of GNU Lesser General Public License Version 2.1.
 *
 *
 *    GNU Lesser General Public License Version 2.1
 *    =============================================
 *    Copyright 2005 by Sun Microsystems, Inc.
 *    901 San Antonio Road, Palo Alto, CA 94303, USA
 *
 *    This library is free software; you can redistribute it and/or
 *    modify it under the terms of the GNU Lesser General Public
 *    License version 2.1, as published by the Free Software Foundation.
 *
 *    This library is distributed in the hope that it will be useful,
 *    but WITHOUT ANY WARRANTY; without even the implied warranty of
 *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *    Lesser General Public License for more details.
 *
 *    You should have received a copy of the GNU Lesser General Public
 *    License along with this library; if not, write to the Free Software
 *    Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *    MA  02111-1307  USA
 *
 ************************************************************************/
#ifndef __com_sun_star_awt_MouseEvent_idl__
#define __com_sun_star_awt_MouseEvent_idl__

#ifndef __com_sun_star_awt_InputEvent_idl__
#include <com/sun/star/awt/InputEvent.idl>
#endif


//=============================================================================

 module com {  module sun {  module star {  module awt {

//=============================================================================

/** specifies an event from the mouse.

    <p>This event is also used for popup menu requests on objects.
    See <member>PopupTrigger</member> for details.</p>

    @see XMouseListener
    @see XMouseMotionListener
    @see InputEvent
 */
published struct MouseEvent: com::sun::star::awt::InputEvent
{
    //-------------------------------------------------------------------------

    /** contains the pressed mouse buttons.

        <p>Zero ore more constants from the
        <type scope="com::sun::star::awt">MouseButton</type> group.</p>
     */
    short Buttons;

    //-------------------------------------------------------------------------

    /** contains the x coordinate location of the mouse.
     */
    long X;

    //-------------------------------------------------------------------------

    /** contains the y coordinate location of the mouse.
     */
    long Y;

    //-------------------------------------------------------------------------

    /** contains the number of mouse clicks associated with event.
     */
    long ClickCount;

    //-------------------------------------------------------------------------

    /** specifies if this event is a popup-menu trigger event.

        <p>If this member is <TRUE/>, the event describes a request for a popup menu,
        also known as context menu, on an object.</p>

        <p>In this case, <member>X</member> and <member>Y</member> describe the position
        where the request was issued. If those members are <code>-1</code>, then the
        request was issued using the keyboard, by pressing the operating-system dependent
        key combination for this purpose.</p>

        @see XMouseListener::mousePressed
    */
    boolean PopupTrigger;

};

//=============================================================================

}; }; }; };

#endif
