/*
 * Copyright 2003 Sun Microsystems, Inc.  All Rights Reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.  Sun designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Sun in the LICENSE file that accompanied this code.
 *
 * This code 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 General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
 * CA 95054 USA or visit www.sun.com if you need additional information or
 * have any questions.
 */

package sun.awt.X11;

interface XDragSourceProtocolListener {
    /**
     * Called when a reply from the current drop target is received.
     *
     * @param action is the drop action selected by the drop target
     */
    void handleDragReply(int action);

    /**
     * Called when a reply from the current drop target is received.
     *
     * @param action the drop action selected by the drop target
     * @param x the x coordinate of the pointer location in screen coordinates
     *        for the reply
     * @param y the x coordinate of the pointer location in screen coordinates
     *        for the reply
     */
    void handleDragReply(int action, int x, int y);

    /**
     * Called when a reply from the current drop target is received.
     *
     * @param action the drop action selected by the drop target
     * @param x the x coordinate of the pointer location in screen coordinates
     *        for the reply
     * @param y the x coordinate of the pointer location in screen coordinates
     *        for the reply
     * @param modifiers the keyboard modifiers state for the reply
     */
    void handleDragReply(int action, int x, int y, int modifiers);

    /**
     * Called when the current drop target signals that the drag-and-drop
     * operation is finished.
     */
    void handleDragFinished();

    /**
     * Called when the current drop target signals that the drag-and-drop
     * operation is finished.
     *
     * @param success true if the drop target successfully performed the drop
     *                action
     */
    void handleDragFinished(boolean success);

    /**
     * Called when the current drop target signals that the drag-and-drop
     * operation is finished.
     *
     * @param action the drop action performed by the drop target
     * @param success true if the drop target successfully performed the drop
     *                action
     */
    void handleDragFinished(boolean success, int action);

    /**
     * Called when the current drop target signals that the drag-and-drop
     * operation is finished.
     *
     * @param action the drop action performed by the drop target
     * @param success true if the drop target successfully performed the drop
     *                action
     * @param x the x coordinate of the pointer location in screen coordinates
     *          for the signal
     * @param y the x coordinate of the pointer location in screen coordinates
     *          for the signal
     */
    void handleDragFinished(boolean success, int action, int x, int y);

    /**
     * Terminates the current drag-and-drop operation (if any) and performs
     * the necessary cleanup.
     * @param time the time stamp of the event that triggered drag termination
     *             or XlibWrapper.CurrentTime
     */
    void cleanup(long time);
}