/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org 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 version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/
#ifndef __com_sun_star_awt_XMouseListener_idl__
#define __com_sun_star_awt_XMouseListener_idl__

#ifndef __com_sun_star_lang_XEventListener_idl__
#include <com/sun/star/lang/XEventListener.idl>
#endif

#ifndef __com_sun_star_awt_MouseEvent_idl__
#include <com/sun/star/awt/MouseEvent.idl>
#endif


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

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

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

/** makes it possible to receive events from the mouse in a certain window.
 */
published interface XMouseListener: com::sun::star::lang::XEventListener
{
    //-------------------------------------------------------------------------

    /** is invoked when a mouse button has been pressed on a window.

        <p>Since mouse presses are usually also used to indicate requests for popup menus
        (also known as context menus) on objects, you might receive two events
        for a single mouse press: For example, if, on your operating system,
        pressing the right mouse button indicates the request for a context menu,
        then you will receive one call to <member>mousePressed</member> indicating
        the mouse click, and another one indicating the context menu request. For
        the latter, the <member>MouseEvent::PopupTrigger</member> member of the
        event will be set to <TRUE/>.</p>
    */
    [oneway] void mousePressed( [in] com::sun::star::awt::MouseEvent e );

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

    /** is invoked when a mouse button has been released on a window.
     */
    [oneway] void mouseReleased( [in] com::sun::star::awt::MouseEvent e );

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

    /** is invoked when the mouse enters a window.
     */
    [oneway] void mouseEntered( [in] com::sun::star::awt::MouseEvent e );

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

    /** is invoked when the mouse exits a window.
     */
    [oneway] void mouseExited( [in] com::sun::star::awt::MouseEvent e );

};

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

}; }; }; };

#endif
