bd9de8189b
Thanks to psychoschlumpf for the hint. Having comments in the headers makes it easier to get the big picture when not being interested in the source. The doxygen file extracts as much as it can into HTML files. Please note that this is not official/supported documentation, but rather being nice to people who have to/want to use doxygen (I don’t). Let me paste the header of the doxygen file: You can use this file with doxygen to create a pseudo-documentation automatically from source. doxygen-comments are not used very extensively in i3, mostly for the reason that it clutters the source code and has no real use (doxygen’s output looks really ugly). So, if you want to use it, here you go. This is however not a supported document, and I recommend you have a look at the docs/ folder or at http://i3.zekjur.net/ for more, real documentation.
120 lines
3.9 KiB
C
120 lines
3.9 KiB
C
/*
|
||
* vim:ts=8:expandtab
|
||
*
|
||
* i3 - an improved dynamic tiling window manager
|
||
*
|
||
* (c) 2009 Michael Stapelberg and contributors
|
||
*
|
||
* See file LICENSE for license information.
|
||
*
|
||
*/
|
||
#ifndef _XCB_H
|
||
#define _XCB_H
|
||
|
||
#include "data.h"
|
||
|
||
#define _NET_WM_STATE_REMOVE 0
|
||
#define _NET_WM_STATE_ADD 1
|
||
#define _NET_WM_STATE_TOGGLE 2
|
||
|
||
/* This is the equivalent of XC_left_ptr. I’m not sure why xcb doesn’t have a constant for that. */
|
||
#define XCB_CURSOR_LEFT_PTR 68
|
||
#define XCB_CURSOR_SB_H_DOUBLE_ARROW 108
|
||
#define XCB_CURSOR_SB_V_DOUBLE_ARROW 116
|
||
|
||
/* from X11/keysymdef.h */
|
||
#define XCB_NUM_LOCK 0xff7f
|
||
|
||
/* The event masks are defined here because we don’t only set them once but we need to set slight
|
||
variations of them (without XCB_EVENT_MASK_ENTER_WINDOW while rendering the layout) */
|
||
/* The XCB_CW_EVENT_MASK for the child (= real window) */
|
||
#define CHILD_EVENT_MASK (XCB_EVENT_MASK_PROPERTY_CHANGE | \
|
||
XCB_EVENT_MASK_STRUCTURE_NOTIFY | \
|
||
XCB_EVENT_MASK_ENTER_WINDOW)
|
||
|
||
/* The XCB_CW_EVENT_MASK for its frame */
|
||
#define FRAME_EVENT_MASK (XCB_EVENT_MASK_BUTTON_PRESS | /* …mouse is pressed/released */ \
|
||
XCB_EVENT_MASK_BUTTON_RELEASE | \
|
||
XCB_EVENT_MASK_EXPOSURE | /* …our window needs to be redrawn */ \
|
||
XCB_EVENT_MASK_SUBSTRUCTURE_REDIRECT | /* …user moves cursor inside our window */ \
|
||
XCB_EVENT_MASK_ENTER_WINDOW) /* …the application tries to resize itself */
|
||
|
||
|
||
enum { _NET_SUPPORTED = 0,
|
||
_NET_SUPPORTING_WM_CHECK,
|
||
_NET_WM_NAME,
|
||
_NET_WM_STATE_FULLSCREEN,
|
||
_NET_WM_STATE,
|
||
_NET_WM_WINDOW_TYPE,
|
||
_NET_WM_WINDOW_TYPE_DOCK,
|
||
_NET_WM_DESKTOP,
|
||
_NET_WM_STRUT_PARTIAL,
|
||
WM_PROTOCOLS,
|
||
WM_DELETE_WINDOW,
|
||
UTF8_STRING
|
||
};
|
||
|
||
extern unsigned int xcb_numlock_mask;
|
||
|
||
/**
|
||
* Loads a font for usage, getting its height. This function is used very often, so it
|
||
* maintains a cache.
|
||
*
|
||
*/
|
||
i3Font *load_font(xcb_connection_t *conn, const char *pattern);
|
||
|
||
/**
|
||
* Returns the colorpixel to use for the given hex color (think of HTML).
|
||
*
|
||
* The hex_color has to start with #, for example #FF00FF.
|
||
*
|
||
* NOTE that get_colorpixel() does _NOT_ check the given color code for validity.
|
||
* This has to be done by the caller.
|
||
*
|
||
*/
|
||
uint32_t get_colorpixel(xcb_connection_t *conn, char *hex);
|
||
|
||
/**
|
||
* Convenience wrapper around xcb_create_window which takes care of depth, generating an ID and checking
|
||
* for errors.
|
||
*
|
||
*/
|
||
xcb_window_t create_window(xcb_connection_t *conn, Rect r, uint16_t window_class, int cursor,
|
||
uint32_t mask, uint32_t *values);
|
||
|
||
/**
|
||
* Changes a single value in the graphic context (so one doesn’t have to define an array of values)
|
||
*
|
||
*/
|
||
void xcb_change_gc_single(xcb_connection_t *conn, xcb_gcontext_t gc, uint32_t mask, uint32_t value);
|
||
|
||
/**
|
||
* Draws a line from x,y to to_x,to_y using the given color
|
||
*
|
||
*/
|
||
void xcb_draw_line(xcb_connection_t *conn, xcb_drawable_t drawable, xcb_gcontext_t gc,
|
||
uint32_t colorpixel, uint32_t x, uint32_t y, uint32_t to_x, uint32_t to_y);
|
||
|
||
/**
|
||
* Draws a rectangle from x,y with width,height using the given color
|
||
*
|
||
*/
|
||
void xcb_draw_rect(xcb_connection_t *conn, xcb_drawable_t drawable, xcb_gcontext_t gc,
|
||
uint32_t colorpixel, uint32_t x, uint32_t y, uint32_t width, uint32_t height);
|
||
|
||
/**
|
||
* Generates a configure_notify event and sends it to the given window
|
||
* Applications need this to think they’ve configured themselves correctly.
|
||
* The truth is, however, that we will manage them.
|
||
*
|
||
*/
|
||
void fake_configure_notify(xcb_connection_t *conn, Rect r, xcb_window_t window);
|
||
|
||
/**
|
||
* Finds out which modifier mask is the one for numlock, as the user may change this.
|
||
*
|
||
*/
|
||
void xcb_get_numlock_mask(xcb_connection_t *conn);
|
||
|
||
#endif
|