Options
All
  • Public
  • Public/Protected
  • All
Menu

Index

Modules

Enumerations

Classes

Interfaces

Type aliases

Type aliases

ARC

ARC: { angle1: number; angle2: number; height: number; width: number; x: number; y: number }

Type declaration

  • angle1: number
  • angle2: number
  • height: number
  • width: number
  • x: number
  • y: number

ATOM

ATOM: number

AccessError

AccessError: { badValue: number; majorOpcode: number; minorOpcode: number }

Type declaration

  • badValue: number
  • majorOpcode: number
  • minorOpcode: number

AllocColorCellsCookie

AllocColorCellsCookie: Promise<AllocColorCellsReply>

AllocColorCellsReply

AllocColorCellsReply: { masks: Uint32Array; masksLen: number; pixels: Uint32Array; pixelsLen: number }

Type declaration

  • masks: Uint32Array
  • masksLen: number
  • pixels: Uint32Array
  • pixelsLen: number

AllocColorCookie

AllocColorCookie: Promise<AllocColorReply>

AllocColorPlanesCookie

AllocColorPlanesCookie: Promise<AllocColorPlanesReply>

AllocColorPlanesReply

AllocColorPlanesReply: { blueMask: number; greenMask: number; pixels: Uint32Array; pixelsLen: number; redMask: number }

Type declaration

  • blueMask: number
  • greenMask: number
  • pixels: Uint32Array
  • pixelsLen: number
  • redMask: number

AllocColorReply

AllocColorReply: { blue: number; green: number; pixel: number; red: number }

Type declaration

  • blue: number
  • green: number
  • pixel: number
  • red: number

AllocError

AllocError: { badValue: number; majorOpcode: number; minorOpcode: number }

Type declaration

  • badValue: number
  • majorOpcode: number
  • minorOpcode: number

AllocNamedColorCookie

AllocNamedColorCookie: Promise<AllocNamedColorReply>

AllocNamedColorReply

AllocNamedColorReply: { exactBlue: number; exactGreen: number; exactRed: number; pixel: number; visualBlue: number; visualGreen: number; visualRed: number }

Type declaration

  • exactBlue: number
  • exactGreen: number
  • exactRed: number
  • pixel: number
  • visualBlue: number
  • visualGreen: number
  • visualRed: number

AtomError

AtomError: { badValue: number; majorOpcode: number; minorOpcode: number }

Type declaration

  • badValue: number
  • majorOpcode: number
  • minorOpcode: number

BOOL32

BOOL32: number

BUTTON

BUTTON: number

ButtonPressEvent

ButtonPressEvent: { child: WINDOW; detail: BUTTON; event: WINDOW; eventX: number; eventY: number; root: WINDOW; rootX: number; rootY: number; sameScreen: number; state: number; time: TIMESTAMP }

a mouse button was pressed/released

See:

XConnection.grabButton

XConnection.grabPointer

Type declaration

  • child: WINDOW
  • detail: BUTTON

    The keycode (a number representing a physical key on the keyboard) of the key which was pressed.

  • event: WINDOW
  • eventX: number

    If same_screen is true, this is the X coordinate relative to the event window's origin. Otherwise, event_x will be set to zero.

  • eventY: number

    If same_screen is true, this is the Y coordinate relative to the event window's origin. Otherwise, event_y will be set to zero.

  • root: WINDOW

    The root window of child.

  • rootX: number

    The X coordinate of the pointer relative to the root window at the time of the event.

  • rootY: number

    The Y coordinate of the pointer relative to the root window at the time of the event.

  • sameScreen: number

    Whether the event window is on the same screen as the root window.

  • state: number

    The logical state of the pointer buttons and modifier keys just prior to the event.

  • time: TIMESTAMP

    Time when the event was generated (in milliseconds).

ButtonReleaseEvent

ButtonReleaseEvent: { child: WINDOW; detail: BUTTON; event: WINDOW; eventX: number; eventY: number; root: WINDOW; rootX: number; rootY: number; sameScreen: number; state: number; time: TIMESTAMP }

a mouse button was pressed/released

See:

XConnection.grabButton

XConnection.grabPointer

Type declaration

  • child: WINDOW
  • detail: BUTTON

    The keycode (a number representing a physical key on the keyboard) of the key which was pressed.

  • event: WINDOW
  • eventX: number

    If same_screen is true, this is the X coordinate relative to the event window's origin. Otherwise, event_x will be set to zero.

  • eventY: number

    If same_screen is true, this is the Y coordinate relative to the event window's origin. Otherwise, event_y will be set to zero.

  • root: WINDOW

    The root window of child.

  • rootX: number

    The X coordinate of the pointer relative to the root window at the time of the event.

  • rootY: number

    The Y coordinate of the pointer relative to the root window at the time of the event.

  • sameScreen: number

    Whether the event window is on the same screen as the root window.

  • state: number

    The logical state of the pointer buttons and modifier keys just prior to the event.

  • time: TIMESTAMP

    Time when the event was generated (in milliseconds).

CHAR2B

CHAR2B: { byte1: number; byte2: number }

Type declaration

  • byte1: number
  • byte2: number

CHARINFO

CHARINFO: { ascent: number; attributes: number; characterWidth: number; descent: number; leftSideBearing: number; rightSideBearing: number }

Type declaration

  • ascent: number
  • attributes: number
  • characterWidth: number
  • descent: number
  • leftSideBearing: number
  • rightSideBearing: number

COLORITEM

COLORITEM: { blue: number; flags: number; green: number; pixel: number; red: number }

Type declaration

  • blue: number
  • flags: number
  • green: number
  • pixel: number
  • red: number

COLORMAP

COLORMAP: number

CURSOR

CURSOR: number

CirculateNotifyEvent

CirculateNotifyEvent: { event: WINDOW; place: Place; window: WINDOW }

NOT YET DOCUMENTED

See:

XConnection.circulateWindow

Type declaration

  • event: WINDOW

    Either the restacked window or its parent, depending on whether StructureNotify or SubstructureNotify was selected.

  • place: Place
  • window: WINDOW

    The restacked window.

CirculateRequestEvent

CirculateRequestEvent: { event: WINDOW; place: Place; window: WINDOW }

NOT YET DOCUMENTED

See:

XConnection.circulateWindow

Type declaration

  • event: WINDOW

    Either the restacked window or its parent, depending on whether StructureNotify or SubstructureNotify was selected.

  • place: Place
  • window: WINDOW

    The restacked window.

ClientMessageData

ClientMessageData: { data16: Uint16Array; data32: Uint32Array; data8: Uint8Array }

Type declaration

  • data16: Uint16Array
  • data32: Uint32Array
  • data8: Uint8Array

ClientMessageEvent

ClientMessageEvent: { _type: ATOM; data: ClientMessageData; format: number; window: WINDOW }

NOT YET DOCUMENTED

This event represents a ClientMessage, sent by another X11 client. An example is a client sending the _NET_WM_STATE ClientMessage to the root window to indicate the fullscreen window state, effectively requesting that the window manager puts it into fullscreen mode.

See:

XConnection.sendEvent

Type declaration

  • _type: ATOM

    An atom which indicates how the data should be interpreted by the receiving client.

  • data: ClientMessageData

    The data itself (20 bytes max).

  • format: number

    Specifies how to interpret data. Can be either 8, 16 or 32.

  • window: WINDOW

ColormapError

ColormapError: { badValue: number; majorOpcode: number; minorOpcode: number }

Type declaration

  • badValue: number
  • majorOpcode: number
  • minorOpcode: number

ColormapNotifyEvent

ColormapNotifyEvent: { _new: number; colormap: COLORMAP; state: ColormapState; window: WINDOW }

the colormap for some window changed

See:

XConnection.freeColormap

Type declaration

  • _new: number
  • colormap: COLORMAP

    The colormap which is changed, installed or uninstalled. This is XCB_NONE when the colormap is changed by a call to FreeColormap.

  • state: ColormapState
  • window: WINDOW

    The window whose associated colormap is changed, installed or uninstalled.

ConfigureNotifyEvent

ConfigureNotifyEvent: { aboveSibling: WINDOW; borderWidth: number; event: WINDOW; height: number; overrideRedirect: number; width: number; window: WINDOW; x: number; y: number }

NOT YET DOCUMENTED

See:

XConnection.freeColormap

Type declaration

  • aboveSibling: WINDOW

    If XCB_NONE, the window is on the bottom of the stack with respect to sibling windows. However, if set to a sibling window, the window is placed on top of this sibling window.

  • borderWidth: number

    The border width of window.

  • event: WINDOW

    The reconfigured window or its parent, depending on whether StructureNotify or SubstructureNotify was selected.

  • height: number

    The inside height of window, not including the border.

  • overrideRedirect: number

    Window managers should ignore this window if override_redirect is 1.

  • width: number

    The inside width of window, not including the border.

  • window: WINDOW

    The window whose size, position, border, and/or stacking order was changed.

  • x: number

    The X coordinate of the upper-left outside corner of window, relative to the parent window's origin.

  • y: number

    The Y coordinate of the upper-left outside corner of window, relative to the parent window's origin.

ConfigureRequestEvent

ConfigureRequestEvent: { borderWidth: number; height: number; parent: WINDOW; sibling: WINDOW; stackMode: StackMode; valueMask: number; width: number; window: WINDOW; x: number; y: number }

Type declaration

  • borderWidth: number
  • height: number
  • parent: WINDOW
  • sibling: WINDOW
  • stackMode: StackMode
  • valueMask: number
  • width: number
  • window: WINDOW
  • x: number
  • y: number

CreateNotifyEvent

CreateNotifyEvent: { borderWidth: number; height: number; overrideRedirect: number; parent: WINDOW; width: number; window: WINDOW; x: number; y: number }

Type declaration

  • borderWidth: number
  • height: number
  • overrideRedirect: number
  • parent: WINDOW
  • width: number
  • window: WINDOW
  • x: number
  • y: number

CursorError

CursorError: { badValue: number; majorOpcode: number; minorOpcode: number }

Type declaration

  • badValue: number
  • majorOpcode: number
  • minorOpcode: number

DEPTH

DEPTH: { depth: number; visuals: VISUALTYPE[]; visualsLen: number }

Type declaration

  • depth: number
  • visuals: VISUALTYPE[]
  • visualsLen: number

DRAWABLE

DRAWABLE: number

DestroyNotifyEvent

DestroyNotifyEvent: { event: WINDOW; window: WINDOW }

a window is destroyed

See:

XConnection.destroyWindow

Type declaration

  • event: WINDOW

    The reconfigured window or its parent, depending on whether StructureNotify or SubstructureNotify was selected.

  • window: WINDOW

    The window that is destroyed.

DrawableError

DrawableError: { badValue: number; majorOpcode: number; minorOpcode: number }

Type declaration

  • badValue: number
  • majorOpcode: number
  • minorOpcode: number

EnterNotifyEvent

EnterNotifyEvent: { child: WINDOW; detail: NotifyDetail; event: WINDOW; eventX: number; eventY: number; mode: NotifyMode; root: WINDOW; rootX: number; rootY: number; sameScreenFocus: number; state: number; time: TIMESTAMP }

the pointer is in a different window

Type declaration

  • child: WINDOW

    If the event window has subwindows and the final pointer position is in one of them, then child is set to that subwindow, XCB_WINDOW_NONE otherwise.

  • detail: NotifyDetail
  • event: WINDOW

    The window on which the event was generated.

  • eventX: number

    If event is on the same screen as root, this is the pointer X coordinate relative to the event window's origin.

  • eventY: number

    If event is on the same screen as root, this is the pointer Y coordinate relative to the event window's origin.

  • mode: NotifyMode
  • root: WINDOW

    The root window for the final cursor position.

  • rootX: number

    The pointer X coordinate relative to root's origin at the time of the event.

  • rootY: number

    The pointer Y coordinate relative to root's origin at the time of the event.

  • sameScreenFocus: number
  • state: number
  • time: TIMESTAMP

ExposeEvent

ExposeEvent: { count: number; height: number; width: number; window: WINDOW; x: number; y: number }

NOT YET DOCUMENTED

Type declaration

  • count: number

    The amount of Expose events following this one. Simple applications that do not want to optimize redisplay by distinguishing between subareas of its window can just ignore all Expose events with nonzero counts and perform full redisplays on events with zero counts.

  • height: number

    The height of the exposed rectangle.

  • width: number

    The width of the exposed rectangle.

  • window: WINDOW

    The exposed (damaged) window.

  • x: number

    The X coordinate of the left-upper corner of the exposed rectangle, relative to the window's origin.

  • y: number

    The Y coordinate of the left-upper corner of the exposed rectangle, relative to the window's origin.

FONT

FONT: number

FONTABLE

FONTABLE: number

FONTPROP

FONTPROP: { name: ATOM; value: number }

Type declaration

  • name: ATOM
  • value: number

FORMAT

FORMAT: { bitsPerPixel: number; depth: number; scanlinePad: number }

Type declaration

  • bitsPerPixel: number
  • depth: number
  • scanlinePad: number

FocusInEvent

FocusInEvent: { detail: NotifyDetail; event: WINDOW; mode: NotifyMode }

NOT YET DOCUMENTED

Type declaration

  • detail: NotifyDetail
  • event: WINDOW

    The window on which the focus event was generated. This is the window used by the X server to report the event.

  • mode: NotifyMode

FocusOutEvent

FocusOutEvent: { detail: NotifyDetail; event: WINDOW; mode: NotifyMode }

NOT YET DOCUMENTED

Type declaration

  • detail: NotifyDetail
  • event: WINDOW

    The window on which the focus event was generated. This is the window used by the X server to report the event.

  • mode: NotifyMode

FontError

FontError: { badValue: number; majorOpcode: number; minorOpcode: number }

Type declaration

  • badValue: number
  • majorOpcode: number
  • minorOpcode: number

GCONTEXT

GCONTEXT: number

GContextError

GContextError: { badValue: number; majorOpcode: number; minorOpcode: number }

Type declaration

  • badValue: number
  • majorOpcode: number
  • minorOpcode: number

GeGenericEvent

GeGenericEvent: {}

generic event (with length)

Type declaration

GetAtomNameCookie

GetAtomNameCookie: Promise<GetAtomNameReply>

GetAtomNameReply

GetAtomNameReply: { name: Int8Array; nameLen: number }

Type declaration

  • name: Int8Array
  • nameLen: number

GetFontPathCookie

GetFontPathCookie: Promise<GetFontPathReply>

GetFontPathReply

GetFontPathReply: { path: STR[]; pathLen: number }

Type declaration

  • path: STR[]
  • pathLen: number

GetGeometryCookie

GetGeometryCookie: Promise<GetGeometryReply>

GetGeometryReply

GetGeometryReply: { borderWidth: number; depth: number; height: number; root: WINDOW; width: number; x: number; y: number }

Type declaration

  • borderWidth: number

    The border width (in pixels).

  • depth: number

    The depth of the drawable (bits per pixel for the object).

  • height: number

    The height of drawable.

  • root: WINDOW

    Root window of the screen containing drawable.

  • width: number

    The width of drawable.

  • x: number

    The X coordinate of drawable. If drawable is a window, the coordinate specifies the upper-left outer corner relative to its parent's origin. If drawable is a pixmap, the X coordinate is always 0.

  • y: number

    The Y coordinate of drawable. If drawable is a window, the coordinate specifies the upper-left outer corner relative to its parent's origin. If drawable is a pixmap, the Y coordinate is always 0.

GetImageCookie

GetImageCookie: Promise<GetImageReply>

GetImageReply

GetImageReply: { data: Uint8Array; depth: number; visual: VISUALID }

Type declaration

  • data: Uint8Array
  • depth: number
  • visual: VISUALID

GetInputFocusCookie

GetInputFocusCookie: Promise<GetInputFocusReply>

GetInputFocusReply

GetInputFocusReply: { focus: WINDOW; revertTo: InputFocus }

Type declaration

GetKeyboardControlCookie

GetKeyboardControlCookie: Promise<GetKeyboardControlReply>

GetKeyboardControlReply

GetKeyboardControlReply: { autoRepeats: Uint8Array; bellDuration: number; bellPercent: number; bellPitch: number; globalAutoRepeat: AutoRepeatMode; keyClickPercent: number; ledMask: number }

Type declaration

  • autoRepeats: Uint8Array
  • bellDuration: number
  • bellPercent: number
  • bellPitch: number
  • globalAutoRepeat: AutoRepeatMode
  • keyClickPercent: number
  • ledMask: number

GetKeyboardMappingCookie

GetKeyboardMappingCookie: Promise<GetKeyboardMappingReply>

GetKeyboardMappingReply

GetKeyboardMappingReply: { keysyms: Uint32Array; keysymsPerKeycode: number }

Type declaration

  • keysyms: Uint32Array
  • keysymsPerKeycode: number

GetModifierMappingCookie

GetModifierMappingCookie: Promise<GetModifierMappingReply>

GetModifierMappingReply

GetModifierMappingReply: { keycodes: Uint8Array; keycodesPerModifier: number }

Type declaration

  • keycodes: Uint8Array
  • keycodesPerModifier: number

GetMotionEventsCookie

GetMotionEventsCookie: Promise<GetMotionEventsReply>

GetMotionEventsReply

GetMotionEventsReply: { events: TIMECOORD[]; eventsLen: number }

Type declaration

GetPointerControlCookie

GetPointerControlCookie: Promise<GetPointerControlReply>

GetPointerControlReply

GetPointerControlReply: { accelerationDenominator: number; accelerationNumerator: number; threshold: number }

Type declaration

  • accelerationDenominator: number
  • accelerationNumerator: number
  • threshold: number

GetPointerMappingCookie

GetPointerMappingCookie: Promise<GetPointerMappingReply>

GetPointerMappingReply

GetPointerMappingReply: { map: Uint8Array; mapLen: number }

Type declaration

  • map: Uint8Array
  • mapLen: number

GetPropertyCookie

GetPropertyCookie: Promise<GetPropertyReply>

GetPropertyReply

GetPropertyReply: { _type: ATOM; bytesAfter: number; format: number; value: Uint8Array; valueLen: number }

Type declaration

  • _type: ATOM

    The actual type of the property (an atom).

  • bytesAfter: number

    The number of bytes remaining to be read in the property if a partial read was performed.

  • format: number

    Specifies whether the data should be viewed as a list of 8-bit, 16-bit, or 32-bit quantities. Possible values are 8, 16, and 32. This information allows the X server to correctly perform byte-swap operations as necessary.

  • value: Uint8Array
  • valueLen: number

    The length of value. You should use the corresponding accessor instead of this field.

GetScreenSaverCookie

GetScreenSaverCookie: Promise<GetScreenSaverReply>

GetScreenSaverReply

GetScreenSaverReply: { allowExposures: Exposures; interval: number; preferBlanking: Blanking; timeout: number }

Type declaration

  • allowExposures: Exposures
  • interval: number
  • preferBlanking: Blanking
  • timeout: number

GetSelectionOwnerCookie

GetSelectionOwnerCookie: Promise<GetSelectionOwnerReply>

GetSelectionOwnerReply

GetSelectionOwnerReply: { owner: WINDOW }

Type declaration

  • owner: WINDOW

    The current selection owner window.

GetWindowAttributesCookie

GetWindowAttributesCookie: Promise<GetWindowAttributesReply>

GetWindowAttributesReply

GetWindowAttributesReply: { _class: WindowClass; allEventMasks: number; backingPixel: number; backingPlanes: number; backingStore: BackingStore; bitGravity: Gravity; colormap: COLORMAP; doNotPropagateMask: number; mapIsInstalled: number; mapState: MapState; overrideRedirect: number; saveUnder: number; visual: VISUALID; winGravity: Gravity; yourEventMask: number }

Type declaration

  • _class: WindowClass
  • allEventMasks: number

    Set of events all people have interest in.

  • backingPixel: number

    Value to be used when restoring planes.

  • backingPlanes: number

    Planes to be preserved if possible.

  • backingStore: BackingStore
  • bitGravity: Gravity
  • colormap: COLORMAP

    Color map to be associated with window.

  • doNotPropagateMask: number

    Set of events that should not propagate.

  • mapIsInstalled: number
  • mapState: MapState
  • overrideRedirect: number

    Window managers should ignore this window if override_redirect is 1.

  • saveUnder: number

    Boolean, should bits under be saved?

  • visual: VISUALID

    The associated visual structure of window.

  • winGravity: Gravity
  • yourEventMask: number

    My event mask.

GrabKeyboardCookie

GrabKeyboardCookie: Promise<GrabKeyboardReply>

GrabKeyboardReply

GrabKeyboardReply: { status: GrabStatus }

Type declaration

GrabPointerCookie

GrabPointerCookie: Promise<GrabPointerReply>

GrabPointerReply

GrabPointerReply: { status: GrabStatus }

Type declaration

GraphicsExposureEvent

GraphicsExposureEvent: { count: number; drawable: DRAWABLE; height: number; majorOpcode: number; minorOpcode: number; width: number; x: number; y: number }

Type declaration

  • count: number
  • drawable: DRAWABLE
  • height: number
  • majorOpcode: number
  • minorOpcode: number
  • width: number
  • x: number
  • y: number

GravityNotifyEvent

GravityNotifyEvent: { event: WINDOW; window: WINDOW; x: number; y: number }

Type declaration

HOST

HOST: { address: Uint8Array; addressLen: number; family: Family }

Type declaration

  • address: Uint8Array
  • addressLen: number
  • family: Family

IDChoiceError

IDChoiceError: { badValue: number; majorOpcode: number; minorOpcode: number }

Type declaration

  • badValue: number
  • majorOpcode: number
  • minorOpcode: number

ImplementationError

ImplementationError: { badValue: number; majorOpcode: number; minorOpcode: number }

Type declaration

  • badValue: number
  • majorOpcode: number
  • minorOpcode: number

InternAtomCookie

InternAtomCookie: Promise<InternAtomReply>

InternAtomReply

InternAtomReply: { atom: ATOM }

Type declaration

KEYCODE

KEYCODE: number

KEYCODE32

KEYCODE32: number

KEYSYM

KEYSYM: number

KeyPressEvent

KeyPressEvent: { child: WINDOW; detail: KEYCODE; event: WINDOW; eventX: number; eventY: number; root: WINDOW; rootX: number; rootY: number; sameScreen: number; state: number; time: TIMESTAMP }

a key was pressed/released

See:

XConnection.grabKey

XConnection.grabKeyboard

Type declaration

  • child: WINDOW
  • detail: KEYCODE

    The keycode (a number representing a physical key on the keyboard) of the key which was pressed.

  • event: WINDOW
  • eventX: number

    If same_screen is true, this is the X coordinate relative to the event window's origin. Otherwise, event_x will be set to zero.

  • eventY: number

    If same_screen is true, this is the Y coordinate relative to the event window's origin. Otherwise, event_y will be set to zero.

  • root: WINDOW

    The root window of child.

  • rootX: number

    The X coordinate of the pointer relative to the root window at the time of the event.

  • rootY: number

    The Y coordinate of the pointer relative to the root window at the time of the event.

  • sameScreen: number

    Whether the event window is on the same screen as the root window.

  • state: number

    The logical state of the pointer buttons and modifier keys just prior to the event.

  • time: TIMESTAMP

    Time when the event was generated (in milliseconds).

KeyReleaseEvent

KeyReleaseEvent: { child: WINDOW; detail: KEYCODE; event: WINDOW; eventX: number; eventY: number; root: WINDOW; rootX: number; rootY: number; sameScreen: number; state: number; time: TIMESTAMP }

a key was pressed/released

See:

XConnection.grabKey

XConnection.grabKeyboard

Type declaration

  • child: WINDOW
  • detail: KEYCODE

    The keycode (a number representing a physical key on the keyboard) of the key which was pressed.

  • event: WINDOW
  • eventX: number

    If same_screen is true, this is the X coordinate relative to the event window's origin. Otherwise, event_x will be set to zero.

  • eventY: number

    If same_screen is true, this is the Y coordinate relative to the event window's origin. Otherwise, event_y will be set to zero.

  • root: WINDOW

    The root window of child.

  • rootX: number

    The X coordinate of the pointer relative to the root window at the time of the event.

  • rootY: number

    The Y coordinate of the pointer relative to the root window at the time of the event.

  • sameScreen: number

    Whether the event window is on the same screen as the root window.

  • state: number

    The logical state of the pointer buttons and modifier keys just prior to the event.

  • time: TIMESTAMP

    Time when the event was generated (in milliseconds).

KeymapNotifyEvent

KeymapNotifyEvent: { keys: Uint8Array }

Type declaration

  • keys: Uint8Array

LeaveNotifyEvent

LeaveNotifyEvent: { child: WINDOW; detail: NotifyDetail; event: WINDOW; eventX: number; eventY: number; mode: NotifyMode; root: WINDOW; rootX: number; rootY: number; sameScreenFocus: number; state: number; time: TIMESTAMP }

the pointer is in a different window

Type declaration

  • child: WINDOW

    If the event window has subwindows and the final pointer position is in one of them, then child is set to that subwindow, XCB_WINDOW_NONE otherwise.

  • detail: NotifyDetail
  • event: WINDOW

    The window on which the event was generated.

  • eventX: number

    If event is on the same screen as root, this is the pointer X coordinate relative to the event window's origin.

  • eventY: number

    If event is on the same screen as root, this is the pointer Y coordinate relative to the event window's origin.

  • mode: NotifyMode
  • root: WINDOW

    The root window for the final cursor position.

  • rootX: number

    The pointer X coordinate relative to root's origin at the time of the event.

  • rootY: number

    The pointer Y coordinate relative to root's origin at the time of the event.

  • sameScreenFocus: number
  • state: number
  • time: TIMESTAMP

LengthError

LengthError: { badValue: number; majorOpcode: number; minorOpcode: number }

Type declaration

  • badValue: number
  • majorOpcode: number
  • minorOpcode: number

ListExtensionsCookie

ListExtensionsCookie: Promise<ListExtensionsReply>

ListExtensionsReply

ListExtensionsReply: { names: STR[]; namesLen: number }

Type declaration

  • names: STR[]
  • namesLen: number

ListFontsCookie

ListFontsCookie: Promise<ListFontsReply>

ListFontsReply

ListFontsReply: { names: STR[]; namesLen: number }

Type declaration

  • names: STR[]
  • namesLen: number

    The number of font names.

ListFontsWithInfoCookie

ListFontsWithInfoCookie: Promise<ListFontsWithInfoReply>

ListFontsWithInfoReply

ListFontsWithInfoReply: { allCharsExist: number; defaultChar: number; drawDirection: FontDraw; fontAscent: number; fontDescent: number; maxBounds: CHARINFO; maxByte1: number; maxCharOrByte2: number; minBounds: CHARINFO; minByte1: number; minCharOrByte2: number; name: Int8Array; nameLen: number; properties: FONTPROP[]; propertiesLen: number; repliesHint: number }

Type declaration

  • allCharsExist: number

    flag if all characters have nonzero size

  • defaultChar: number

    char to print for undefined character

  • drawDirection: FontDraw
  • fontAscent: number

    baseline to top edge of raster

  • fontDescent: number

    baseline to bottom edge of raster

  • maxBounds: CHARINFO

    maximum bounds over all existing char

  • maxByte1: number
  • maxCharOrByte2: number

    last character

  • minBounds: CHARINFO

    minimum bounds over all existing char

  • minByte1: number
  • minCharOrByte2: number

    first character

  • name: Int8Array
  • nameLen: number

    The number of matched font names.

  • properties: FONTPROP[]
  • propertiesLen: number

    how many properties there are

  • repliesHint: number

    An indication of how many more fonts will be returned. This is only a hint and may be larger or smaller than the number of fonts actually returned. A zero value does not guarantee that no more fonts will be returned.

ListHostsCookie

ListHostsCookie: Promise<ListHostsReply>

ListHostsReply

ListHostsReply: { hosts: HOST[]; hostsLen: number; mode: AccessControl }

Type declaration

ListInstalledColormapsCookie

ListInstalledColormapsCookie: Promise<ListInstalledColormapsReply>

ListInstalledColormapsReply

ListInstalledColormapsReply: { cmaps: Uint32Array; cmapsLen: number }

Type declaration

  • cmaps: Uint32Array
  • cmapsLen: number

ListPropertiesCookie

ListPropertiesCookie: Promise<ListPropertiesReply>

ListPropertiesReply

ListPropertiesReply: { atoms: Uint32Array; atomsLen: number }

Type declaration

  • atoms: Uint32Array
  • atomsLen: number

LookupColorCookie

LookupColorCookie: Promise<LookupColorReply>

LookupColorReply

LookupColorReply: { exactBlue: number; exactGreen: number; exactRed: number; visualBlue: number; visualGreen: number; visualRed: number }

Type declaration

  • exactBlue: number
  • exactGreen: number
  • exactRed: number
  • visualBlue: number
  • visualGreen: number
  • visualRed: number

MapNotifyEvent

MapNotifyEvent: { event: WINDOW; overrideRedirect: number; window: WINDOW }

a window was mapped

See:

XConnection.mapWindow

Type declaration

  • event: WINDOW

    The window which was mapped or its parent, depending on whether StructureNotify or SubstructureNotify was selected.

  • overrideRedirect: number

    Window managers should ignore this window if override_redirect is 1.

  • window: WINDOW

    The window that was mapped.

MapRequestEvent

MapRequestEvent: { parent: WINDOW; window: WINDOW }

window wants to be mapped

See:

XConnection.mapWindow

Type declaration

  • parent: WINDOW

    The parent of window.

  • window: WINDOW

    The window to be mapped.

MappingNotifyEvent

MappingNotifyEvent: { count: number; firstKeycode: KEYCODE; request: Mapping }

keyboard mapping changed

Type declaration

  • count: number

    The number of keycodes altered.

  • firstKeycode: KEYCODE

    The first number in the range of the altered mapping.

  • request: Mapping

MatchError

MatchError: { badValue: number; majorOpcode: number; minorOpcode: number }

Type declaration

  • badValue: number
  • majorOpcode: number
  • minorOpcode: number

MotionNotifyEvent

MotionNotifyEvent: { child: WINDOW; detail: Motion; event: WINDOW; eventX: number; eventY: number; root: WINDOW; rootX: number; rootY: number; sameScreen: number; state: number; time: TIMESTAMP }

Type declaration

  • child: WINDOW
  • detail: Motion

    The keycode (a number representing a physical key on the keyboard) of the key which was pressed.

  • event: WINDOW
  • eventX: number

    If same_screen is true, this is the X coordinate relative to the event window's origin. Otherwise, event_x will be set to zero.

  • eventY: number

    If same_screen is true, this is the Y coordinate relative to the event window's origin. Otherwise, event_y will be set to zero.

  • root: WINDOW

    The root window of child.

  • rootX: number

    The X coordinate of the pointer relative to the root window at the time of the event.

  • rootY: number

    The Y coordinate of the pointer relative to the root window at the time of the event.

  • sameScreen: number

    Whether the event window is on the same screen as the root window.

  • state: number

    The logical state of the pointer buttons and modifier keys just prior to the event.

  • time: TIMESTAMP

    Time when the event was generated (in milliseconds).

NameError

NameError: { badValue: number; majorOpcode: number; minorOpcode: number }

Type declaration

  • badValue: number
  • majorOpcode: number
  • minorOpcode: number

NoExposureEvent

NoExposureEvent: { drawable: DRAWABLE; majorOpcode: number; minorOpcode: number }

Type declaration

  • drawable: DRAWABLE
  • majorOpcode: number
  • minorOpcode: number

PIXMAP

PIXMAP: number

POINT

POINT: { x: number; y: number }

Type declaration

  • x: number
  • y: number

PixmapError

PixmapError: { badValue: number; majorOpcode: number; minorOpcode: number }

Type declaration

  • badValue: number
  • majorOpcode: number
  • minorOpcode: number

PropertyNotifyEvent

PropertyNotifyEvent: { atom: ATOM; state: Property; time: TIMESTAMP; window: WINDOW }

a window property changed

See:

XConnection.changeProperty

Type declaration

  • atom: ATOM

    The property's atom, to indicate which property was changed.

  • state: Property
  • time: TIMESTAMP

    A timestamp of the server time when the property was changed.

  • window: WINDOW

    The window whose associated property was changed.

QueryBestSizeCookie

QueryBestSizeCookie: Promise<QueryBestSizeReply>

QueryBestSizeReply

QueryBestSizeReply: { height: number; width: number }

Type declaration

  • height: number
  • width: number

QueryColorsCookie

QueryColorsCookie: Promise<QueryColorsReply>

QueryColorsReply

QueryColorsReply: { colors: RGB[]; colorsLen: number }

Type declaration

  • colors: RGB[]
  • colorsLen: number

QueryExtensionCookie

QueryExtensionCookie: Promise<QueryExtensionReply>

QueryExtensionReply

QueryExtensionReply: { firstError: number; firstEvent: number; majorOpcode: number; present: number }

Type declaration

  • firstError: number

    The first error code, if any.

  • firstEvent: number

    The first event code, if any.

  • majorOpcode: number

    The major opcode for requests.

  • present: number

    Whether the extension is present on this X11 server.

QueryFontCookie

QueryFontCookie: Promise<QueryFontReply>

QueryFontReply

QueryFontReply: { allCharsExist: number; charInfos: CHARINFO[]; charInfosLen: number; defaultChar: number; drawDirection: FontDraw; fontAscent: number; fontDescent: number; maxBounds: CHARINFO; maxByte1: number; maxCharOrByte2: number; minBounds: CHARINFO; minByte1: number; minCharOrByte2: number; properties: FONTPROP[]; propertiesLen: number }

Type declaration

  • allCharsExist: number

    flag if all characters have nonzero size

  • charInfos: CHARINFO[]
  • charInfosLen: number
  • defaultChar: number

    char to print for undefined character

  • drawDirection: FontDraw
  • fontAscent: number

    baseline to top edge of raster

  • fontDescent: number

    baseline to bottom edge of raster

  • maxBounds: CHARINFO

    maximum bounds over all existing char

  • maxByte1: number
  • maxCharOrByte2: number

    last character

  • minBounds: CHARINFO

    minimum bounds over all existing char

  • minByte1: number
  • minCharOrByte2: number

    first character

  • properties: FONTPROP[]
  • propertiesLen: number

    how many properties there are

QueryKeymapCookie

QueryKeymapCookie: Promise<QueryKeymapReply>

QueryKeymapReply

QueryKeymapReply: { keys: Uint8Array }

Type declaration

  • keys: Uint8Array

QueryPointerCookie

QueryPointerCookie: Promise<QueryPointerReply>

QueryPointerReply

QueryPointerReply: { child: WINDOW; mask: number; root: WINDOW; rootX: number; rootY: number; sameScreen: number; winX: number; winY: number }

Type declaration

  • child: WINDOW

    The child window containing the pointer, if any, if same_screen is true. If same_screen is false, XCB_NONE is returned.

  • mask: number

    The current logical state of the modifier keys and the buttons. Note that the logical state of a device (as seen by means of the protocol) may lag the physical state if device event processing is frozen.

  • root: WINDOW

    The root window the pointer is logically on.

  • rootX: number

    The pointer X position, relative to root.

  • rootY: number

    The pointer Y position, relative to root.

  • sameScreen: number

    If same_screen is False, then the pointer is not on the same screen as the argument window, child is None, and win_x and win_y are zero. If same_screen is True, then win_x and win_y are the pointer coordinates relative to the argument window's origin, and child is the child containing the pointer, if any.

  • winX: number

    The pointer X coordinate, relative to child, if same_screen is true. Zero otherwise.

  • winY: number

    The pointer Y coordinate, relative to child, if same_screen is true. Zero otherwise.

QueryTextExtentsCookie

QueryTextExtentsCookie: Promise<QueryTextExtentsReply>

QueryTextExtentsReply

QueryTextExtentsReply: { drawDirection: FontDraw; fontAscent: number; fontDescent: number; overallAscent: number; overallDescent: number; overallLeft: number; overallRight: number; overallWidth: number }

Type declaration

  • drawDirection: FontDraw
  • fontAscent: number
  • fontDescent: number
  • overallAscent: number
  • overallDescent: number
  • overallLeft: number
  • overallRight: number
  • overallWidth: number

QueryTreeCookie

QueryTreeCookie: Promise<QueryTreeReply>

QueryTreeReply

QueryTreeReply: { children: Uint32Array; childrenLen: number; parent: WINDOW; root: WINDOW }

Type declaration

  • children: Uint32Array
  • childrenLen: number

    The number of child windows.

  • parent: WINDOW

    The parent window of window.

  • root: WINDOW

    The root window of window.

RECTANGLE

RECTANGLE: { height: number; width: number; x: number; y: number }

Type declaration

  • height: number
  • width: number
  • x: number
  • y: number

RGB

RGB: { blue: number; green: number; red: number }

Type declaration

  • blue: number
  • green: number
  • red: number

ReparentNotifyEvent

ReparentNotifyEvent: { event: WINDOW; overrideRedirect: number; parent: WINDOW; window: WINDOW; x: number; y: number }

Type declaration

  • event: WINDOW
  • overrideRedirect: number
  • parent: WINDOW
  • window: WINDOW
  • x: number
  • y: number

RequestError

RequestError: { badValue: number; majorOpcode: number; minorOpcode: number }

Type declaration

  • badValue: number
  • majorOpcode: number
  • minorOpcode: number

ResizeRequestEvent

ResizeRequestEvent: { height: number; width: number; window: WINDOW }

Type declaration

  • height: number
  • width: number
  • window: WINDOW

SCREEN

SCREEN: { allowedDepths: DEPTH[]; allowedDepthsLen: number; backingStores: BackingStore; blackPixel: number; currentInputMasks: number; defaultColormap: COLORMAP; heightInMillimeters: number; heightInPixels: number; maxInstalledMaps: number; minInstalledMaps: number; root: WINDOW; rootDepth: number; rootVisual: VISUALID; saveUnders: number; whitePixel: number; widthInMillimeters: number; widthInPixels: number }

Type declaration

  • allowedDepths: DEPTH[]
  • allowedDepthsLen: number
  • backingStores: BackingStore
  • blackPixel: number
  • currentInputMasks: number
  • defaultColormap: COLORMAP
  • heightInMillimeters: number
  • heightInPixels: number
  • maxInstalledMaps: number
  • minInstalledMaps: number
  • root: WINDOW
  • rootDepth: number
  • rootVisual: VISUALID
  • saveUnders: number
  • whitePixel: number
  • widthInMillimeters: number
  • widthInPixels: number

SEGMENT

SEGMENT: { x1: number; x2: number; y1: number; y2: number }

Type declaration

  • x1: number
  • x2: number
  • y1: number
  • y2: number

STR

STR: { name: Int8Array; nameLen: number }

Type declaration

  • name: Int8Array
  • nameLen: number

SelectionClearEvent

SelectionClearEvent: { owner: WINDOW; selection: ATOM; time: TIMESTAMP }

Type declaration

SelectionNotifyEvent

SelectionNotifyEvent: { property: ATOM; requestor: WINDOW; selection: ATOM; target: ATOM; time: TIMESTAMP }

Type declaration

SelectionRequestEvent

SelectionRequestEvent: { owner: WINDOW; property: ATOM; requestor: WINDOW; selection: ATOM; target: ATOM; time: TIMESTAMP }

Type declaration

SetModifierMappingCookie

SetModifierMappingCookie: Promise<SetModifierMappingReply>

SetModifierMappingReply

SetModifierMappingReply: { status: MappingStatus }

Type declaration

SetPointerMappingCookie

SetPointerMappingCookie: Promise<SetPointerMappingReply>

SetPointerMappingReply

SetPointerMappingReply: { status: MappingStatus }

Type declaration

Setup

Setup: { bitmapFormatBitOrder: ImageOrder; bitmapFormatScanlinePad: number; bitmapFormatScanlineUnit: number; imageByteOrder: ImageOrder; length: number; maxKeycode: KEYCODE; maximumRequestLength: number; minKeycode: KEYCODE; motionBufferSize: number; pixmapFormats: FORMAT[]; pixmapFormatsLen: number; protocolMajorVersion: number; protocolMinorVersion: number; releaseNumber: number; resourceIdBase: number; resourceIdMask: number; roots: SCREEN[]; rootsLen: number; status: number; vendor: Int8Array; vendorLen: number }

Type declaration

  • bitmapFormatBitOrder: ImageOrder
  • bitmapFormatScanlinePad: number
  • bitmapFormatScanlineUnit: number
  • imageByteOrder: ImageOrder
  • length: number
  • maxKeycode: KEYCODE
  • maximumRequestLength: number
  • minKeycode: KEYCODE
  • motionBufferSize: number
  • pixmapFormats: FORMAT[]
  • pixmapFormatsLen: number
  • protocolMajorVersion: number
  • protocolMinorVersion: number
  • releaseNumber: number
  • resourceIdBase: number
  • resourceIdMask: number
  • roots: SCREEN[]
  • rootsLen: number
  • status: number
  • vendor: Int8Array
  • vendorLen: number

SetupAuthenticate

SetupAuthenticate: { length: number; reason: Int8Array; status: number }

Type declaration

  • length: number
  • reason: Int8Array
  • status: number

SetupFailed

SetupFailed: { length: number; protocolMajorVersion: number; protocolMinorVersion: number; reason: Int8Array; reasonLen: number; status: number }

Type declaration

  • length: number
  • protocolMajorVersion: number
  • protocolMinorVersion: number
  • reason: Int8Array
  • reasonLen: number
  • status: number

SetupRequest

SetupRequest: { authorizationProtocolData: Int8Array; authorizationProtocolDataLen: number; authorizationProtocolName: Int8Array; authorizationProtocolNameLen: number; byteOrder: number; protocolMajorVersion: number; protocolMinorVersion: number }

Type declaration

  • authorizationProtocolData: Int8Array
  • authorizationProtocolDataLen: number
  • authorizationProtocolName: Int8Array
  • authorizationProtocolNameLen: number
  • byteOrder: number
  • protocolMajorVersion: number
  • protocolMinorVersion: number

TIMECOORD

TIMECOORD: { time: TIMESTAMP; x: number; y: number }

Type declaration

TIMESTAMP

TIMESTAMP: number

TranslateCoordinatesCookie

TranslateCoordinatesCookie: Promise<TranslateCoordinatesReply>

TranslateCoordinatesReply

TranslateCoordinatesReply: { child: WINDOW; dstX: number; dstY: number; sameScreen: number }

Type declaration

  • child: WINDOW
  • dstX: number
  • dstY: number
  • sameScreen: number

UnmapNotifyEvent

UnmapNotifyEvent: { event: WINDOW; fromConfigure: number; window: WINDOW }

a window is unmapped

See:

XConnection.unmapWindow

Type declaration

  • event: WINDOW

    The reconfigured window or its parent, depending on whether StructureNotify or SubstructureNotify was selected.

  • fromConfigure: number

    Set to 1 if the event was generated as a result of a resizing of the window's parent when window had a win_gravity of UnmapGravity.

  • window: WINDOW

    The window that was unmapped.

VISUALID

VISUALID: number

VISUALTYPE

VISUALTYPE: { _class: VisualClass; bitsPerRgbValue: number; blueMask: number; colormapEntries: number; greenMask: number; redMask: number; visualId: VISUALID }

Type declaration

  • _class: VisualClass
  • bitsPerRgbValue: number
  • blueMask: number
  • colormapEntries: number
  • greenMask: number
  • redMask: number
  • visualId: VISUALID

ValueError

ValueError: { badValue: number; majorOpcode: number; minorOpcode: number }

Type declaration

  • badValue: number
  • majorOpcode: number
  • minorOpcode: number

VisibilityNotifyEvent

VisibilityNotifyEvent: { state: Visibility; window: WINDOW }

Type declaration

WINDOW

WINDOW: number

WindowError

WindowError: { badValue: number; majorOpcode: number; minorOpcode: number }

Type declaration

  • badValue: number
  • majorOpcode: number
  • minorOpcode: number

Legend

  • Function
  • Type alias
  • Enumeration
  • Interface
  • Class

Generated using TypeDoc