[jvcard.git] / src / com / googlecode / lanterna / terminal / MouseCaptureMode.java

package com.googlecode.lanterna.terminal;

/**
 * Constant describing different modes for capturing mouse input. By default, no mouse capturing is enabled (unless
 * previously enabled before starting the Lanterna application. These are the different modes of input capturing
 * supported. Please note that terminal emulators vary widely in how these are implemented!
 * Created by martin on 26/07/15.
 */
public enum MouseCaptureMode {
    /**
     * Mouse clicks are captured on the down-motion but not the up-motion. This corresponds to the X10 xterm protocol.
     * KDE's Konsole (tested with 15.04) does not implement this extension, but xfce4-terminal, gnome-terminal and
     * xterm does.
     */
    CLICK,
    /**
     * Mouse clicks are captured both on down and up, this is the normal mode for capturing mouse input. KDE's konsole
     * interprets this as CLICK_RELEASE_DRAG.
     */
    CLICK_RELEASE,
    /**
     * Mouse clicks are captured both on down and up and if the mouse if moved while holding down one of the button, a
     * drag event is generated.
     */
    CLICK_RELEASE_DRAG,
    /**
     * Mouse clicks are captured both on down and up and also all mouse movements, no matter if any button is held down
     * or not.
     */
    CLICK_RELEASE_DRAG_MOVE,
    ;
}
Commit	Line	Data
a3b510ab NR	1	package com.googlecode.lanterna.terminal;
	2
	3	/**
	4	* Constant describing different modes for capturing mouse input. By default, no mouse capturing is enabled (unless
	5	* previously enabled before starting the Lanterna application. These are the different modes of input capturing
	6	* supported. Please note that terminal emulators vary widely in how these are implemented!
	7	* Created by martin on 26/07/15.
	8	*/
	9	public enum MouseCaptureMode {
	10	/**
	11	* Mouse clicks are captured on the down-motion but not the up-motion. This corresponds to the X10 xterm protocol.
	12	* KDE's Konsole (tested with 15.04) does not implement this extension, but xfce4-terminal, gnome-terminal and
	13	* xterm does.
	14	*/
	15	CLICK,
	16	/**
	17	* Mouse clicks are captured both on down and up, this is the normal mode for capturing mouse input. KDE's konsole
	18	* interprets this as CLICK_RELEASE_DRAG.
	19	*/
	20	CLICK_RELEASE,
	21	/**
	22	* Mouse clicks are captured both on down and up and if the mouse if moved while holding down one of the button, a
	23	* drag event is generated.
	24	*/
	25	CLICK_RELEASE_DRAG,
	26	/**
	27	* Mouse clicks are captured both on down and up and also all mouse movements, no matter if any button is held down
	28	* or not.
	29	*/
	30	CLICK_RELEASE_DRAG_MOVE,
	31	;
	32	}