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.
56 lines
1.3 KiB
C
56 lines
1.3 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.
|
|
*
|
|
*/
|
|
#include "data.h"
|
|
|
|
#ifndef _XINERAMA_H
|
|
#define _XINERAMA_H
|
|
|
|
TAILQ_HEAD(screens_head, Screen);
|
|
extern struct screens_head *virtual_screens;
|
|
|
|
/**
|
|
* We have just established a connection to the X server and need the initial Xinerama
|
|
* information to setup workspaces for each screen.
|
|
*
|
|
*/
|
|
void initialize_xinerama(xcb_connection_t *conn);
|
|
|
|
/**
|
|
* This is called when the rootwindow receives a configure_notify event and therefore the
|
|
* number/position of the Xinerama screens could have changed.
|
|
*
|
|
*/
|
|
void xinerama_requery_screens(xcb_connection_t *conn);
|
|
|
|
/**
|
|
* Looks in virtual_screens for the i3Screen whose start coordinates are x, y
|
|
*
|
|
*/
|
|
i3Screen *get_screen_at(int x, int y, struct screens_head *screenlist);
|
|
|
|
/**
|
|
* Looks in virtual_screens for the i3Screen which contains coordinates x, y
|
|
*
|
|
*/
|
|
i3Screen *get_screen_containing(int x, int y);
|
|
|
|
/**
|
|
* Gets the screen which is the last one in the given direction, for example the screen
|
|
* on the most bottom when direction == D_DOWN, the screen most right when direction == D_RIGHT
|
|
* and so on.
|
|
*
|
|
* This function always returns a screen.
|
|
*
|
|
*/
|
|
i3Screen *get_screen_most(direction_t direction);
|
|
|
|
#endif
|