Top Description Inners Fields Methods
com.sun.jna.platform.unix

public Interface X11

extends Library
Imports
com.sun.jna.Callback, .FromNativeContext, .Library, .Native, .NativeLong, .Pointer, .PointerType, .Structure, .Structure.FieldOrder, .Union, com.sun.jna.ptr.ByReference, .IntByReference, .NativeLongByReference, .PointerByReference

Definition (incomplete) of the X library.

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
public static class
public static class
public static class
public static class
public static class
public static class
public static class
public static class
public static class
public static class
public static class
public static class
public static class
public static class
public static class
public static class
public static class
public static class
public static class
public static class
public static class
public static class
public static class
public static class
public static class
public static class
public static class
public static class
public static class
public static class
public static interface
public static class
X11.XEvent

DEFINITIONS OF SPECIFIC EVENTS

public static interface
X11.Xevie

Definition of the Xevie library.

public static class
public static interface
X11.Xext

Definition (incomplete) of the Xext library.

public static class
public static class
public static class
public static class
public static class
X11.XGenericEvent

This event is the standard event for all newer extensions.

public static class
public static class
public static class
public static class
public static class
public static class
public static class
public static class
public static class
public static class
public static class
public static class
public static class
public static class
public static class
X11.XModifierKeymapRef

The modifiermap member of the XModifierKeymap structure contains 8 sets of max_keypermod KeyCodes, one for each modifier in the order Shift, Lock, Control, Mod1, Mod2, Mod3, Mod4, and Mod5.

public static class
public static class
public static class
public static class
public static class
public static class
public static interface
X11.Xrender

Definition (incomplete) of the Xrender library.

public static class
public static class
public static class
public static class
public static class
public static class
public static class
public static interface
X11.XTest

Definition of the XTest library.

public static class
public static class
public static class
public static class
public static class
public static class

Field Summary

Modifier and TypeField and Description
public static final int
public static final int
public static final int
AllocNone

COLOR MAP STUFF

public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
AutoRepeatModeOff

KEYBOARD/POINTER STUFF

public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
CursorShape

CURSOR STUFF

public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
DontPreferBlanking

SCREEN SAVER STUFF

public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
GXclear

GRAPHICS DEFINITIONS

public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
HostInsert

HOSTS AND CONNECTIONS

public static final int
public static final int
public static final int
public static final int
InputOutput

WINDOW DEFINITIONS

public static final X11
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
NoEventMask

EVENT DEFINITIONS

public static final int
public static final int
public static final int
None

RESERVED RESOURCE AND CONSTANT DEFINITIONS

public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
Success

ERROR CODES

public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final X11.Atom
public static final X11.Atom
public static final X11.Atom
public static final X11.Atom
public static final X11.Atom
public static final X11.Atom
public static final X11.Atom
public static final X11.Atom
public static final X11.Atom
public static final X11.Atom
public static final X11.Atom
public static final X11.Atom
public static final X11.Atom
public static final X11.Atom
public static final X11.Atom
public static final X11.Atom
public static final X11.Atom
public static final X11.Atom
public static final X11.Atom
public static final X11.Atom
public static final X11.Atom
public static final X11.Atom
public static final X11.Atom
public static final X11.Atom
public static final X11.Atom
public static final X11.Atom
public static final X11.Atom
public static final X11.Atom
public static final X11.Atom
public static final X11.Atom
public static final X11.Atom
public static final X11.Atom
public static final X11.Atom
public static final X11.Atom
public static final X11.Atom
public static final X11.Atom
public static final X11.Atom
public static final X11.Atom
public static final X11.Atom
public static final X11.Atom
public static final X11.Atom
public static final X11.Atom
public static final X11.Atom
public static final X11.Atom
public static final X11.Atom
public static final X11.Atom
public static final X11.Atom
public static final X11.Atom
public static final X11.Atom
public static final X11.Atom
public static final X11.Atom
public static final X11.Atom
public static final X11.Atom
public static final X11.Atom
public static final X11.Atom
public static final X11.Atom
public static final X11.Atom
public static final X11.Atom
public static final X11.Atom
public static final X11.Atom
public static final X11.Atom
public static final X11.Atom
public static final X11.Atom
public static final X11.Atom
public static final X11.Atom
public static final X11.Atom
public static final X11.Atom
public static final X11.Atom
public static final X11.Atom
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
XYBitmap

IMAGING

public static final int
public static final int
public static final int
public static final int
public static final int
Inherited from com.sun.jna.Library:
OPTION_ALLOW_OBJECTSOPTION_CALLING_CONVENTIONOPTION_CLASSLOADEROPTION_FUNCTION_MAPPEROPTION_INVOCATION_MAPPEROPTION_OPEN_FLAGSOPTION_STRING_ENCODINGOPTION_STRUCTURE_ALIGNMENTOPTION_SYMBOL_PROVIDEROPTION_TYPE_MAPPER

Method Summary

Modifier and TypeMethod and Description
public X11.Screen
public int
XAllocNamedColor(X11.Display display, int colormap, String color_name, Pointer screen_def_return, Pointer exact_def_return)

public X11.XSizeHints
public int

Returns:

status
XAutoRepeatOff
(X11.Display
display
display
)

Turns off auto-repeat for the keyboard on the specified display.

public int

Returns:

status
XAutoRepeatOn
(X11.Display
display
display
)

Turns on auto-repeat for the keyboard on the specified display.

public int

Returns:

status
XBell
(X11.Display
display
display
,
int
value to set
percent
)

Rings the bell on the keyboard on the specified display, if possible.

public int

Returns:

status
XChangeKeyboardControl
(X11.Display
display
display
,
NativeLong
disjunction of KBKeyClickPercent, KBBellPercent, KBBellPitch, KBBellDuration, KBLed, KBLedMode, KBKey, KBAutoRepeatMode
value_mask
,
X11.XKeyboardControlRef
control ref values
values
)

Changes the keyboard control state.

public int

Returns:

status
XChangeKeyboardMapping
(X11.Display
target Display
display
,
int
first keycode
first_keycode
,
int
number of syms per keycode
keysyms_per_keycode
,
X11.KeySym[]
array of KeySym
keysyms
,
int
number of keycodes to be changed
num_codes
)

Defines the symbols for the specified number of KeyCodes starting with first_keycode.

public int
XChangeProperty(X11.Display display, X11.Window w, X11.Atom property, X11.Atom type, int format, int mode, Pointer data, int nelements)

public int
public boolean
XCheckMaskEvent(X11.Display display, NativeLong event_mask, X11.XEvent event_return)

public boolean
XCheckTypedEvent(X11.Display display, int event_type, X11.XEvent event_return)

public boolean
XCheckTypedWindowEvent(X11.Display display, X11.Window w, int event_type, X11.XEvent event_return)

public boolean
XCheckWindowEvent(X11.Display display, X11.Window w, NativeLong event_mask, X11.XEvent event_return)

public int
XClearArea(X11.Display display, X11.Window window, int x, int y, int w, int h, int exposures)

public int
XClearWindow(X11.Display display, X11.Window window)

public int
public int
XCopyArea(X11.Display dpy, X11.Drawable src, X11.Drawable dst, X11.GC gc, int src_x, int src_y, int w, int h, int dst_x, int dst_y)

public X11.Pixmap
XCreateBitmapFromData(X11.Display display, X11.Window window, Pointer data, int width, int height)

public X11.Colormap
XCreateColormap(X11.Display display, X11.Window w, X11.Visual visual, int alloc)

public X11.GC
XCreateGC(X11.Display display, X11.Drawable drawable, NativeLong mask, X11.XGCValues values)

public X11.XImage
XCreateImage(X11.Display dpy, X11.Visual visual, int depth, int format, int offset, Pointer data, int width, int height, int bitmap_pad, int bytes_per_line)

public X11.Pixmap
XCreatePixmap(X11.Display display, X11.Drawable drawable, int width, int height, int depth)

public X11.Window
XCreateSimpleWindow(X11.Display display, X11.Window parent, int x, int y, int width, int height, int border_width, int border, int background)

public X11.Colormap
XDefaultColormap(X11.Display display, int screen)

public X11.Window
public int
public X11.Visual
XDefaultVisual(X11.Display display, int screen)

public X11.XModifierKeymapRef

Returns:

modifier specification struct
XDeleteModifiermapEntry
(X11.XModifierKeymapRef
modifier map
modmap
,
byte
keycode entry
keycode_entry
,
int
modifier
modifier
)

Deletes the specified KeyCode from the set that controls the specified modifier and returns a pointer to the resulting XModifierKeymap structure.

public int
XDeleteProperty(X11.Display display, X11.Window w, X11.Atom property)

public int
public int
XDestroyWindow(X11.Display display, X11.Window window)

public int
XDisplayHeight(X11.Display display, int screen)

public int

Returns:

status
XDisplayKeycodes
(X11.Display
target Display
display
,
IntByReference
smallest keycode
min_keycodes_return
,
IntByReference
largest keycode
max_keycodes_return
)

Returns the min-keycodes and max-keycodes supported by the specified display.

public int
XDisplayWidth(X11.Display display, int screen)

public int
XDrawPoint(X11.Display display, X11.Drawable drawable, X11.GC gc, int x, int y)

public int
XDrawPoints(X11.Display display, X11.Drawable drawable, X11.GC gc, X11.XPoint[] points, int npoints, int mode)

public int

Returns:

status
XEventsQueued
(X11.Display
target Display
display
,
int
QueuedAlready, QueuedAfterFlush, or QueuedAfterReading
mode
)

If mode is QueuedAlready, XEventsQueued returns the number of events already in the event queue (and never performs a system call).

public int

Returns:

Integer. Nonzero = success, zero = no name has been set.
XFetchName
(X11.Display
Specifies the connection to the X server.
display
,
X11.Window
Specifies the window.
window
,
PointerByReference
Returns the window name, which is a null-terminated string.
window_name_return
)

The XFetchName() function returns the name of the specified window.

public int
XFillArc(X11.Display display, X11.Drawable drawable, X11.GC gc, int x, int y, int width, int height, int angle1, int angle2)

public int
XFillPolygon(X11.Display dpy, X11.Drawable drawable, X11.GC gc, X11.XPoint[] points, int npoints, int shape, int mode)

public int
XFillRectangle(X11.Display display, X11.Drawable drawable, X11.GC gc, int x, int y, int width, int height)

public int
XFillRectangles(X11.Display display, X11.Drawable drawable, X11.GC gc, X11.XRectangle[] rectangles, int nrectangles)

public int

Returns:

status
XFlush
(X11.Display
target Display
display
)

Flushes the output buffer.

public int
XFree(Pointer data)

public void
public int
XFreeGC(X11.Display display, X11.GC gc)

public int

Returns:

status
XFreeModifiermap
(X11.XModifierKeymapRef
modifier map to be freed
modmap
)

Frees the specified XModifierKeymap structure.

public int
XFreePixmap(X11.Display display, X11.Pixmap pixmap)

public String
XGetAtomName(X11.Display display, X11.Atom atom)

public int
XGetErrorText(X11.Display display, int code, byte[] buffer, int len)

public boolean
public int
public int

Returns:

status
XGetKeyboardControl
(X11.Display
display
display
,
X11.XKeyboardStateRef
keyboard state structure
values_return
)

Returns the current control values for the keyboard to the XKeyboardState structure.

public X11.KeySym

Returns:

KeySym for the requested code
XGetKeyboardMapping
(X11.Display
target Display
display
,
byte
first keycode to be changed or returned
first_keycode
,
int
how many
keycode_count
,
IntByReference
number of syms per keycode
keysyms_per_keycode_return
)

Returns the symbols for the specified number of KeyCodes starting with first_keycode.

public X11.XModifierKeymapRef

Returns:

modifier specification
XGetModifierMapping
(X11.Display
target Display
display
)

The XGetModifierMapping function returns a pointer to a newly created XModifierKeymap structure that contains the keys being used as modifiers.

public X11.XVisualInfo

Returns:

returned array
XGetVisualInfo
(X11.Display
target Display
display
,
NativeLong
mask of data to retrieve
vinfo_mask
,
X11.XVisualInfo
template struct to use as basis for returned data
vinfo_template
,
IntByReference
number size of returned array
nitems_return
)

Returns an array of XVisualInfo which must be freed by XFree.

public int
public int
XGetWindowProperty(X11.Display display, X11.Window w, X11.Atom property, NativeLong long_offset, NativeLong long_length, boolean delete, X11.Atom reg_type, X11.AtomByReference actual_type_return, IntByReference actual_format_return, NativeLongByReference nitems_return, NativeLongByReference bytes_after_return, PointerByReference prop_return)

public X11.XWMHints

Returns:

XWMHints structure for the requested window
XGetWMHints
(X11.Display
target Display
display
,
X11.Window
target Window
window
)

Returns an XWMHints which must be freed by XFree.

public int
XGetWMName(X11.Display display, X11.Window window, X11.XTextProperty text_property_return)

public int
XGetWMProtocols(X11.Display display, X11.Window w, PointerByReference protocols_return, IntByReference count_return)

public int

Returns:

nothing
XGrabKey
(X11.Display
Specifies the connection to the X server.
display
,
int
Specifies the KeyCode or AnyKey.
keyCode
,
int
Specifies the set of keymasks or AnyModifier. The mask is the bitwise inclusive OR of the valid keymask bits.
modifiers
,
X11.Window
Specifies the grab window.
grab_window
,
int
Specifies a Boolean value that indicates whether the keyboard events are to be reported as usual.
ownerEvents
,
int
Specifies further processing of pointer events. You can pass GrabModeSync or GrabModeAsync.
pointerMode
,
int
Specifies further processing of keyboard events. You can pass GrabModeSync or GrabModeAsync.
keyBoardMode
)

Establishes a passive grab on the keyboard

public int

Returns:

nothing
XGrabKeyboard
(X11.Display
Specifies the connection to the X server.
display
,
X11.Window
Specifies the grab window.
grab_window
,
int
Specifies a Boolean value that indicates whether the keyboard events are to be reported as usual.
owner_events
,
int
Specifies further processing of pointer events. You can pass GrabModeSync or GrabModeAsync.
pointer_mode
,
int
Specifies further processing of keyboard events. You can pass GrabModeSync or GrabModeAsync.
keyboard_mode
,
NativeLong
Specifies the time. You can pass either a timestamp or CurrentTime.
time
)

Actively grabs control of the keyboard and generates FocusIn and FocusOut events

public X11.XModifierKeymapRef

Returns:

modifier specification struct
XInsertModifiermapEntry
(X11.XModifierKeymapRef
modifier map
modmap
,
byte
keycode entry
keycode_entry
,
int
modifier
modifier
)

Adds the specified KeyCode to the set that controls the specified modifier and returns the resulting XModifierKeymap structure (expanded as needed).

public X11.Atom
XInternAtom(X11.Display display, String name, boolean only_if_exists)

public X11.KeySym
XKeycodeToKeysym(X11.Display display, byte keycode, int index)

public byte
public String
public int
XMapRaised(X11.Display display, X11.Window window)

public int
XMapSubwindows(X11.Display display, X11.Window window)

public int
XMapWindow(X11.Display display, X11.Window window)

public int
XMaskEvent(X11.Display display, NativeLong event_mask, X11.XEvent event_return)

public X11.XModifierKeymapRef

Returns:

modifier specification struct
XNewModifiermap
(int
number of keys to include in the mapping
max_keys_per_mod
)

Returns a pointer to XModifierKeymap structure for later use.

public int
XNextEvent(X11.Display display, X11.XEvent event_return)

public X11.Display
public int
XPeekEvent(X11.Display display, X11.XEvent event_return)

public int

Returns:

status
XPending
(X11.Display
target Display
display
)

Returns the number of events that have been received from the X server but have not been removed from the event queue.

public int
XPutImage(X11.Display dpy, X11.Drawable d, X11.GC gc, X11.XImage image, int src_x, int src_y, int dest_x, int dest_y, int width, int height)

public boolean

Returns:

if present
XQueryExtension
(X11.Display
Specifies the connection to the X server.
display
,
String
Specifies the extension name.
name
,
IntByReference
Returns the major opcode.
major_opcode_return
,
IntByReference
Returns the first event code, if any.
first_event_return
,
IntByReference
Returns the first error code, if any.
first_error_return
)

The XQueryExtension function determines if the named extension is present.

public int

Returns:

status
XQueryKeymap
(X11.Display
display
display
,
byte[]
keymap
keys_return
)

Returns a bit vector for the logical state of the keyboard, where each bit set to 1 indicates that the corresponding key is currently pressed down.

public boolean
XQueryPointer(X11.Display display, X11.Window window, X11.WindowByReference root_return, X11.WindowByReference child_return, IntByReference root_x_return, IntByReference root_y_return, IntByReference win_x_return, IntByReference win_y_return, IntByReference mask_return)

public int
public X11.Window
XRootWindow(X11.Display display, int screen)

public int
XSelectInput(X11.Display display, X11.Window window, NativeLong eventMask)

public int
XSendEvent(X11.Display display, X11.Window w, int propagate, NativeLong event_mask, X11.XEvent event_send)

public int
XSetBackground(X11.Display display, X11.GC gc, NativeLong color)

public X11.XErrorHandler

Returns:

The previous error handler
XSetErrorHandler
(X11.XErrorHandler
Specifies the program's supplied error handler
handler
)

Installs an error handler

public int
XSetFillRule(X11.Display display, X11.GC gc, int fill_rule)

public int
XSetForeground(X11.Display display, X11.GC gc, NativeLong color)

public int

Returns:

status
XSetModifierMapping
(X11.Display
target Display
display
,
X11.XModifierKeymapRef
modifier specification
modmap
)

Specifies the KeyCodes of the keys (if any) that are to be used as modifiers.

public void
XSetWMProperties(X11.Display display, X11.Window window, String window_name, String icon_name, String[] argv, int argc, X11.XSizeHints normal_hints, Pointer wm_hints, Pointer class_hints)

public int
XSetWMProtocols(X11.Display display, X11.Window window, X11.Atom[] atom, int count)

public X11.KeySym
public int

Returns:

status
XSync
(X11.Display
target Display
display
,
boolean
whether to discard events
discard
)

Flushes the output buffer and then waits until all requests have been received and processed by the X server.

public boolean
XTranslateCoordinates(X11.Display display, X11.Window src_w, X11.Window dest_w, int src_x, int src_y, IntByReference dest_x_return, IntByReference dest_y_return, X11.WindowByReference child_return)

public int

Returns:

nothing
XUngrabKey
(X11.Display
Specifies the connection to the X server.
display
,
int
Specifies the KeyCode or AnyKey.
keyCode
,
int
Specifies the set of keymasks or AnyModifier. The mask is the bitwise inclusive OR of the valid keymask bits
modifiers
,
X11.Window
Specifies the grab window.
grab_window
)

The XUngrabKey() function releases the key combination on the specified window if it was grabbed by this client.

public int

Returns:

nothing
XUngrabKeyboard
(X11.Display
Specifies the connection to the X server.
display
,
NativeLong
Specifies the time. You can pass either a timestamp or CurrentTime.
time
)

Releases the keyboard and any queued events if this client has it actively grabbed from either XGrabKeyboard() or XGrabKey().

public int
XUnmapWindow(X11.Display display, X11.Window window)

public int
XWindowEvent(X11.Display display, X11.Window w, NativeLong event_mask, X11.XEvent event_return)