X11Wrapper Class Reference

#include <X11Wrapper.hpp>

Inheritance diagram for X11Wrapper:

Collaboration diagram for X11Wrapper:

Public Member Functions
	X11Wrapper ()=default
	~X11Wrapper ()=default
Display *	openDisplay () override
Display *	openDisplay (const char *displayName) override
void	closeDisplay (Display *display) override
int	defaultScreen (Display *display) override
Window	rootWindow (Display *display, int screen) override
Atom	internAtom (Display *display, const char *atomName, bool onlyIfExists) override
int	displayWidth (Display *display, int screen) override
int	displayHeight (Display *display, int screen) override
int	grabServer (Display *display) override
int	ungrabServer (Display *display) override
int	flush (Display *display) override
XErrorHandler	setErrorHandler (XErrorHandler handler) override
int	selectInput (Display *display, Window window, long eventMask) override
int	sync (Display *display, bool discard) override
int	queryTree (Display *display, Window window, Window *rootReturn, Window *parentReturn, Window **childrenReturn, unsigned int *nChildrenReturn) override
int	freeX (void *data) override
int	nextEvent (Display *display, XEvent *eventReturn) override
int	sendEvent (Display *display, Window window, bool propagate, long eventMask, XEvent *event_send) override
int	changeProperty (Display *display, Window window, Atom property, Atom type, int format, int mode, const unsigned char *data, int nelements) override
int	getProperty (Display *display, Window window, Atom property, long longOffset, long longLength, bool delete_, Atom reqType, Atom *actualTypeReturn, int *actualFormatReturn, unsigned long *nitemsReturn, unsigned long *bytesAfterReturn, unsigned char **propReturn) override
int	setInputFocus (Display *display, Window focus, int revertTo, Time time) override
int	getErrorText (Display *display, int code, char *buffer_return, int length) override
int	mapWindow (Display *display, Window window) override
int	unmapWindow (Display *display, Window window) override
int	configureWindow (Display *display, Window window, unsigned valueMask, XWindowChanges *changes) override
int	setInputFocus (Display *display, Window focus, int revertTo) override
int	raiseWindow (Display *display, Window window) override
int	lowerWindow (Display *display, Window window) override
int	setWindowBorder (Display *display, Window window, unsigned long border) override
int	getWindowProperty (Display *display, Window window, Atom property, long long_offset, long long_length, bool delete_, Atom req_type, Atom *actual_type_return, int *actual_format_return, unsigned long *nitems_return, unsigned long *bytes_after_return, unsigned char **prop_return) override
int	destroyWindow (Display *display, Window window) override
int	getWindowAttributes (Display *display, Window window, XWindowAttributes *window_attributes_return) override
int	addToSaveSet (Display *display, Window window) override
int	removeFromSaveSet (Display *display, Window window) override
int	reparentWindow (Display *display, Window window, Window parent, int x, int y) override
int	grabButton (Display *display, unsigned int button, unsigned int modifiers, Window grabWindow, bool ownerEvents, unsigned int eventMask, int pointerMode, int keyboardMode, Window confineTo, Cursor cursor) override
int	ungrabButton (Display *display, unsigned int button, unsigned int modifiers, Window grab_window) override
int	grabKey (Display *display, int keycode, unsigned int modifiers, Window grabWindow, bool ownerEvents, int pointerMode, int keyboardMode) override
int	ungrabKey (Display *display, int keycode, unsigned int modifiers, Window grabWindow) override
int	moveWindow (Display *display, Window window, int x, int y) override
int	resizeWindow (Display *display, Window window, unsigned int width, unsigned int height) override
int	keysymToKeycode (Display *display, int keysym) override
KeySym	stringToKeysym (const char *string) override
Window	createWindow (Display *display, Window parent, int x, int y, unsigned int width, unsigned int height, unsigned int border_width, int depth, unsigned int _class, Visual *visual, unsigned long valuemask, XSetWindowAttributes *attributes) override
int	clearWindow (Display *display, Window window) override
int	drawString (Display *display, Window window, GC gc, int x, int y, const char *string, int length) override
Window	createSimpleWindow (Display *display, Window parent, int x, int y, unsigned int width, unsigned int height, unsigned int border_width, unsigned long border, unsigned long background) override

Constructor & Destructor Documentation

X11Wrapper()

X11Wrapper::X11Wrapper ( )

default

~X11Wrapper()

X11Wrapper::~X11Wrapper ( )

default

Member Function Documentation

addToSaveSet()

int X11Wrapper::addToSaveSet ( Display *  display, Window  window  )

overridevirtual

Implements BaseX11Wrapper.

                                                            {
    return XAddToSaveSet(display, window);
}

changeProperty()

int X11Wrapper::changeProperty ( Display *  display, Window  window, Atom  property, Atom  type, int  format, int  mode, const unsigned char *  data, int  nelements  )

overridevirtual

Implements BaseX11Wrapper.

                                              {
    int r = XChangeProperty(display,
                            window,
                            property,
                            type,
                            format,
                            mode,
                            data,
                            nelements);
    if (r != 0) {
        throw X11Exception("Failed to change property");
    }
    return r;
}

clearWindow()

int X11Wrapper::clearWindow ( Display *  display, Window  window  )

overridevirtual

Implements BaseX11Wrapper.

                                                           {
    int r = XClearWindow(display, window);
    if (r != 0) {
        throw X11Exception("Failed to clear window");
    }
    return r;
}

closeDisplay()

void X11Wrapper::closeDisplay ( Display *  display )

overridevirtual

Implements BaseX11Wrapper.

                                              {
    int r = XCloseDisplay(display);
    if (r == 0) {
        throw X11Exception("Failed to close display");
    }
}

configureWindow()

int X11Wrapper::configureWindow ( Display *  display, Window  window, unsigned  valueMask, XWindowChanges *  changes  )

overridevirtual

Implements BaseX11Wrapper.

                                                         {
    return XConfigureWindow(display, window, valueMask, changes);
}

createSimpleWindow()

Window X11Wrapper::createSimpleWindow ( Display *  display, Window  parent, int  x, int  y, unsigned int  width, unsigned int  height, unsigned int  border_width, unsigned long  border, unsigned long  background  )

overridevirtual

Implements BaseX11Wrapper.

                                                                {
    Window r = XCreateSimpleWindow(display,
                                   parent,
                                   x, y,
                                   width, height,
                                   border_width,
                                   border,
                                   background);
    if (r == 0) {
        throw X11Exception("Failed to create simple window");
    }
    return r;
}

createWindow()

Window X11Wrapper::createWindow ( Display *  display, Window  parent, int  x, int  y, unsigned int  width, unsigned int  height, unsigned int  border_width, int  depth, unsigned int  _class, Visual *  visual, unsigned long  valuemask, XSetWindowAttributes *  attributes  )

overridevirtual

Implements BaseX11Wrapper.

                                                                  {
    Window r = XCreateWindow(display,
                             parent,
                             x, y,
                             width, height,
                             border_width,
                             depth,
                             _class,
                             visual,
                             valuemask,
                             attributes);
    if (r == 0) {
        throw X11Exception("Failed to create window");
    }
    return r;
}

defaultScreen()

int X11Wrapper::defaultScreen ( Display *  display )

overridevirtual

Implements BaseX11Wrapper.

                                              {
    return DefaultScreen(display);
}

destroyWindow()

int X11Wrapper::destroyWindow ( Display *  display, Window  window  )

overridevirtual

Implements BaseX11Wrapper.

                                                             {
    return XDestroyWindow(display, window);
}

displayHeight()

int X11Wrapper::displayHeight ( Display *  display, int  screen  )

overridevirtual

Implements BaseX11Wrapper.

                                                          {
    return DisplayHeight(display, screen);
}

displayWidth()

int X11Wrapper::displayWidth ( Display *  display, int  screen  )

overridevirtual

Implements BaseX11Wrapper.

                                                         {
    return DisplayWidth(display, screen);
}

drawString()

int X11Wrapper::drawString ( Display *  display, Window  window, GC  gc, int  x, int  y, const char *  string, int  length  )

overridevirtual

Implements BaseX11Wrapper.

                                       {
    int r = XDrawString(display, window, gc, x, y, string, length);
    if (r != 0) {
        throw X11Exception("Failed to draw string");
    }
    return r;
}

flush()

int X11Wrapper::flush ( Display *  display )

overridevirtual

Implements BaseX11Wrapper.

                                      {
    return XFlush(display);
}

freeX()

int X11Wrapper::freeX ( void *  data )

overridevirtual

Implements BaseX11Wrapper.

                                {
    return XFree(data);
}

getErrorText()

int X11Wrapper::getErrorText ( Display *  display, int  code, char *  buffer_return, int  length  )

overridevirtual

Implements BaseX11Wrapper.

                                         {
    return XGetErrorText(display, code, buffer_return, length);
}

getProperty()

int X11Wrapper::getProperty ( Display *  display, Window  window, Atom  property, long  longOffset, long  longLength, bool  delete_, Atom  reqType, Atom *  actualTypeReturn, int *  actualFormatReturn, unsigned long *  nitemsReturn, unsigned long *  bytesAfterReturn, unsigned char **  propReturn  )

overridevirtual

Implements BaseX11Wrapper.

                                                    {
    int r = XGetWindowProperty(display,
                               window,
                               property,
                               longOffset,
                               longLength,
                               delete_,
                               reqType,
                               actualTypeReturn,
                               actualFormatReturn,
                               nitemsReturn,
                               bytesAfterReturn,
                               propReturn);
    if (r != 0) {
        throw X11Exception("Failed to get property");
    }
    return r;
}

getWindowAttributes()

int X11Wrapper::getWindowAttributes ( Display *  display, Window  window, XWindowAttributes *  window_attributes_return  )

overridevirtual

Implements BaseX11Wrapper.

                                                                                 {
    int r = XGetWindowAttributes(display, window, window_attributes_return);
    if (r == 0) {
        throw X11Exception("Failed to get window attributes");
    }
    return r;
}

getWindowProperty()

int X11Wrapper::getWindowProperty ( Display *  display, Window  window, Atom  property, long  long_offset, long  long_length, bool  delete_, Atom  req_type, Atom *  actual_type_return, int *  actual_format_return, unsigned long *  nitems_return, unsigned long *  bytes_after_return, unsigned char **  prop_return  )

overridevirtual

Implements BaseX11Wrapper.

                                                               {
    return XGetWindowProperty(display,
                               window,
                               property,
                               long_offset,
                               long_length,
                               delete_,
                               req_type,
                               actual_type_return,
                               actual_format_return,
                               nitems_return,
                               bytes_after_return,
                               prop_return);
}

grabButton()

int X11Wrapper::grabButton ( Display *  display, unsigned int  button, unsigned int  modifiers, Window  grabWindow, bool  ownerEvents, unsigned int  eventMask, int  pointerMode, int  keyboardMode, Window  confineTo, Cursor  cursor  )

overridevirtual

Implements BaseX11Wrapper.

                                          {
    return XGrabButton(display,
                        button,
                        modifiers,
                        grabWindow,
                        ownerEvents,
                        eventMask,
                        pointerMode,
                        keyboardMode,
                        confineTo,
                        cursor);
}

grabKey()

int X11Wrapper::grabKey ( Display *  display, int  keycode, unsigned int  modifiers, Window  grabWindow, bool  ownerEvents, int  pointerMode, int  keyboardMode  )

overridevirtual

Implements BaseX11Wrapper.

                                          {
    int r = XGrabKey(display,
                     keycode,
                     modifiers,
                     grabWindow,
                     ownerEvents,
                     pointerMode,
                     keyboardMode);
    if (r != 0) {
        throw X11Exception("Failed to grab key");
    }
    return r;
}

grabServer()

int X11Wrapper::grabServer ( Display *  display )

overridevirtual

Implements BaseX11Wrapper.

                                           {
    return XGrabServer(display);
}

internAtom()

Atom X11Wrapper::internAtom ( Display *  display, const char *  atomName, bool  onlyIfExists  )

overridevirtual

Implements BaseX11Wrapper.

                                                                                     {
    Atom r =  XInternAtom(display, atomName, onlyIfExists);
    if (r == None) {
        throw X11Exception("Failed to intern atom");
    }
    return r;
}

keysymToKeycode()

int X11Wrapper::keysymToKeycode ( Display *  display, int  keysym  )

overridevirtual

Implements BaseX11Wrapper.

                                                            {
    int r = XKeysymToKeycode(display, keysym);
    if (r == 0) {
        throw X11Exception("Failed to get keycode from keysym");
    }
    return r;
}

lowerWindow()

int X11Wrapper::lowerWindow ( Display *  display, Window  window  )

overridevirtual

Implements BaseX11Wrapper.

                                                           {
    int r = XLowerWindow(display, window);
    if (r != 0) {
        throw X11Exception("Failed to lower window");
    }
    return r;
}

mapWindow()

int X11Wrapper::mapWindow ( Display *  display, Window  window  )

overridevirtual

Implements BaseX11Wrapper.

                                                         {
    return XMapWindow(display, window);
}

moveWindow()

int X11Wrapper::moveWindow ( Display *  display, Window  window, int  x, int  y  )

overridevirtual

Implements BaseX11Wrapper.

                                                                        {
    return XMoveWindow(display, window, x, y);
}

nextEvent()

int X11Wrapper::nextEvent ( Display *  display, XEvent *  eventReturn  )

overridevirtual

Implements BaseX11Wrapper.

                                                               {
    int r = XNextEvent(display, eventReturn);
    if (r != 0) {
        throw X11Exception("Failed to get next event");
    }
    return r;
}

openDisplay() [1/2]

Display * X11Wrapper::openDisplay ( )

overridevirtual

Implements BaseX11Wrapper.

                                 {
    Display * r = XOpenDisplay(nullptr);
    if (r == nullptr) {
        throw X11Exception("Failed to open display");
    }
    return r;
}

openDisplay() [2/2]

Display * X11Wrapper::openDisplay ( const char *  displayName )

overridevirtual

Implements BaseX11Wrapper.

                                                        {
    Display * r = XOpenDisplay(displayName);
    if (r == nullptr) {
        throw X11Exception("Failed to open display");
    }
    return r;
}

queryTree()

int X11Wrapper::queryTree ( Display *  display, Window  window, Window *  rootReturn, Window *  parentReturn, Window **  childrenReturn, unsigned int *  nChildrenReturn  )

overridevirtual

Implements BaseX11Wrapper.

                                                     {
    int r = XQueryTree(display,
                       window,
                       rootReturn,
                       parentReturn,
                       childrenReturn,
                       nChildrenReturn);
    if (r == 0) {
        throw X11Exception("Failed to query tree");
    }
    return r;
}

raiseWindow()

int X11Wrapper::raiseWindow ( Display *  display, Window  window  )

overridevirtual

Implements BaseX11Wrapper.

                                                           {
    return XRaiseWindow(display, window);
}

removeFromSaveSet()

int X11Wrapper::removeFromSaveSet ( Display *  display, Window  window  )

overridevirtual

Implements BaseX11Wrapper.

                                                                 {
    int r = XRemoveFromSaveSet(display, window);
    if (r != 0) {
        throw X11Exception("Failed to remove from save set");
    }
    return r;
}

reparentWindow()

int X11Wrapper::reparentWindow ( Display *  display, Window  window, Window  parent, int  x, int  y  )

overridevirtual

Implements BaseX11Wrapper.

                                                                                           {
    return XReparentWindow(display, window, parent, x, y);
}

resizeWindow()

int X11Wrapper::resizeWindow ( Display *  display, Window  window, unsigned int  width, unsigned int  height  )

overridevirtual

Implements BaseX11Wrapper.

                                                  {
    return XResizeWindow(display, window, width, height);
}

rootWindow()

Window X11Wrapper::rootWindow ( Display *  display, int  screen  )

overridevirtual

Implements BaseX11Wrapper.

                                                          {
    return RootWindow(display, screen);
}

selectInput()

int X11Wrapper::selectInput ( Display *  display, Window  window, long  eventMask  )

overridevirtual

Implements BaseX11Wrapper.

                                                                           {
    int r = XSelectInput(display, window, eventMask);
    if (r == 0) {
        throw X11Exception("Failed to select input");
    }
    return r;
}

sendEvent()

int X11Wrapper::sendEvent ( Display *  display, Window  window, bool  propagate, long  eventMask, XEvent *  event_send  )

overridevirtual

Implements BaseX11Wrapper.

                                                                                                             {
    int r = XSendEvent(display, window, propagate, eventMask, event_send);
    if (r == 0) {
        throw X11Exception("Failed to send event");
    }
    return r;
}

setErrorHandler()

XErrorHandler X11Wrapper::setErrorHandler ( XErrorHandler  handler )

overridevirtual

Implements BaseX11Wrapper.

                                                               {
    return XSetErrorHandler(handler);
}

setInputFocus() [1/2]

int X11Wrapper::setInputFocus ( Display *  display, Window  focus, int  revertTo  )

overridevirtual

Implements BaseX11Wrapper.

                                                                          {
    int r = XSetInputFocus(display, focus, revertTo, CurrentTime);
    if (r != 0) {
        throw X11Exception("Failed to set input focus");
    }
    return r;
}

setInputFocus() [2/2]

int X11Wrapper::setInputFocus ( Display *  display, Window  focus, int  revertTo, Time  time  )

overridevirtual

Implements BaseX11Wrapper.

                                         {
    return XSetInputFocus(display, focus, revertTo, time);
}

setWindowBorder()

int X11Wrapper::setWindowBorder ( Display *  display, Window  window, unsigned long  border  )

overridevirtual

Implements BaseX11Wrapper.

                                                                                     {
    return XSetWindowBorder(display, window, border);
}

stringToKeysym()

KeySym X11Wrapper::stringToKeysym ( const char *  string )

overridevirtual

Implements BaseX11Wrapper.

                                                    {
    KeySym r = XStringToKeysym(string);
    if (r == NoSymbol) {
        throw X11Exception("Failed to get keysym from string");
    }
    return r;
}

sync()

int X11Wrapper::sync ( Display *  display, bool  discard  )

overridevirtual

Implements BaseX11Wrapper.

                                                   {
    return XSync(display, discard);
}

ungrabButton()

int X11Wrapper::ungrabButton ( Display *  display, unsigned int  button, unsigned int  modifiers, Window  grab_window  )

overridevirtual

Implements BaseX11Wrapper.

                                                 {
    int r = XUngrabButton(display, button, modifiers, grab_window);
    if (r != 0) {
        throw X11Exception("Failed to ungrab button");
    }
    return r;
}

ungrabKey()

int X11Wrapper::ungrabKey ( Display *  display, int  keycode, unsigned int  modifiers, Window  grabWindow  )

overridevirtual

Implements BaseX11Wrapper.

                                             {
    int r = XUngrabKey(display, keycode, modifiers, grabWindow);
    if (r != 0) {
        throw X11Exception("Failed to ungrab key");
    }
    return r;
}

ungrabServer()

int X11Wrapper::ungrabServer ( Display *  display )

overridevirtual

Implements BaseX11Wrapper.

                                             {
    return XUngrabServer(display);
}

unmapWindow()

int X11Wrapper::unmapWindow ( Display *  display, Window  window  )

overridevirtual

Implements BaseX11Wrapper.

                                                           {
    return XUnmapWindow(display, window);
}

---

The documentation for this class was generated from the following files:

• inc/X11wrapper/X11Wrapper.hpp
• src/X11wrapper/X11Wrapper.cpp