org.freedesktop.gstreamer.event

Class NavigationEvent

java.lang.Object

org.freedesktop.gstreamer.glib.NativeObject

org.freedesktop.gstreamer.glib.RefCountedObject

org.freedesktop.gstreamer.MiniObject

org.freedesktop.gstreamer.event.Event

org.freedesktop.gstreamer.event.NavigationEvent

All Implemented Interfaces:

AutoCloseable

public class NavigationEvent
extends Event

Navigation events are usually used for communicating user requests, such as mouse or keyboard movements, to upstream elements.

Nested Class Summary

Nested classes/interfaces inherited from class org.freedesktop.gstreamer.event.Event

Event.Types

Nested classes/interfaces inherited from class org.freedesktop.gstreamer.MiniObject

MiniObject.Handle

Nested classes/interfaces inherited from class org.freedesktop.gstreamer.glib.NativeObject

NativeObject.Initializer, NativeObject.TypeProvider, NativeObject.TypeRegistration<T extends NativeObject>

Field Summary

Fields inherited from class org.freedesktop.gstreamer.event.Event

GTYPE_NAME

Constructor Summary

Constructors

Constructor and Description
NavigationEvent(Structure structure) Creates a new navigation event from the given description.

Method Summary

Modifier and Type	Method and Description
static NavigationEvent	createKeyEvent(String event, String key) Creates a new key navigation event.
static NavigationEvent	createKeyPressEvent(String key) Creates a new key press navigation event.
static NavigationEvent	createKeyReleaseEvent(String key) Creates a new key release navigation event.
static NavigationEvent	createMouseButtonPressEvent(double x, double y, int button) Creates a mouse button press navigation event.
static NavigationEvent	createMouseButtonReleaseEvent(double x, double y, int button) Creates a mouse button release navigation event.
static NavigationEvent	createMouseEvent(String event, double x, double y, int button) Creates a mouse navigation event.
static NavigationEvent	createMouseMoveEvent(double x, double y, int button) Creates a mouse move navigation event.
String	toString() Gets a human-readable string representation of this navigation event.

Methods inherited from class org.freedesktop.gstreamer.event.Event

getStructure

Methods inherited from class org.freedesktop.gstreamer.MiniObject

copy, getRefCount, isWritable, makeWritable

Methods inherited from class org.freedesktop.gstreamer.glib.NativeObject

close, disown, dispose, equals, getPointer, getRawPointer, hashCode, invalidate

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

NavigationEvent

public NavigationEvent(Structure structure)

Creates a new navigation event from the given description.

Unless you really need a custom navigation event, use one of the static convenience methods for creating navigation events.

Parameters:

structure - the description of the navigation event.

Method Detail

toString

public String toString()

Gets a human-readable string representation of this navigation event.

Overrides:

toString in class NativeObject

Returns:

a string

createMouseEvent

public static NavigationEvent createMouseEvent(String event,
                                               double x,
                                               double y,
                                               int button)

Creates a mouse navigation event.

Parameters:

event - the type of mouse event.

x - the X location of the mouse cursor

y - the Y location of the mouse cursor

button - the button(s) currently pressed

Returns:

a new navigation event

createMouseMoveEvent

public static NavigationEvent createMouseMoveEvent(double x,
                                                   double y,
                                                   int button)

Creates a mouse move navigation event.

Parameters:

x - the X location of the mouse cursor

y - the Y location of the mouse cursor

button - the button(s) currently pressed

Returns:

a new navigation event

createMouseButtonPressEvent

public static NavigationEvent createMouseButtonPressEvent(double x,
                                                          double y,
                                                          int button)

Creates a mouse button press navigation event.

Parameters:

x - the X location of the mouse cursor

y - the Y location of the mouse cursor

button - the button(s) currently pressed

Returns:

a new navigation event

createMouseButtonReleaseEvent

public static NavigationEvent createMouseButtonReleaseEvent(double x,
                                                            double y,
                                                            int button)

Creates a mouse button release navigation event.

Parameters:

x - the X location of the mouse cursor

y - the Y location of the mouse cursor

button - the button(s) currently pressed

Returns:

a new navigation event

createKeyEvent

public static NavigationEvent createKeyEvent(String event,
                                             String key)

Creates a new key navigation event.

Parameters:

event - the type of key event.

key - the ascii key code for the key.

Returns:

a new navigation event

createKeyPressEvent

public static NavigationEvent createKeyPressEvent(String key)

Creates a new key press navigation event.

Parameters:

key - the ascii key code for the key.

Returns:

a new navigation event

createKeyReleaseEvent

public static NavigationEvent createKeyReleaseEvent(String key)

Creates a new key release navigation event.

Parameters:

key - the ascii key code for the key.

Returns:

a new navigation event