add missing function documentation

This commit is contained in:
Michael Stapelberg 2011-02-14 23:17:30 +01:00
parent 26a416e016
commit 834f4d7bc2
4 changed files with 28 additions and 1 deletions

View File

@ -42,7 +42,11 @@ Con *con_get_output(Con *con);
*/
Con *con_get_workspace(Con *con);
/**
* Searches parenst of the given 'con' until it reaches one with the specified
* 'orientation'. Aborts when it comes across a floating_con.
*
*/
Con *con_parent_with_orientation(Con *con, orientation_t orientation);
/**

View File

@ -99,6 +99,12 @@ void workspace_map_clients(xcb_connection_t *conn, Workspace *ws);
*/
void workspace_update_urgent_flag(Con *ws);
/**
* 'Forces' workspace orientation by moving all cons into a new split-con with
* the same orientation as the workspace and then changing the workspace
* orientation.
*
*/
void ws_force_orientation(Con *ws, orientation_t orientation);
#endif

View File

@ -230,6 +230,11 @@ Con *con_get_workspace(Con *con) {
return result;
}
/*
* Searches parenst of the given 'con' until it reaches one with the specified
* 'orientation'. Aborts when it comes across a floating_con.
*
*/
Con *con_parent_with_orientation(Con *con, orientation_t orientation) {
DLOG("Searching for parent of Con %p with orientation %d\n", con, orientation);
Con *parent = con->parent;
@ -759,6 +764,12 @@ void con_set_layout(Con *con, int layout) {
con->layout = layout;
}
/*
* Callback which will be called when removing a child from the given con.
* Kills the container if it is empty and replaces it with the child if there
* is exactly one child.
*
*/
static void con_on_remove_child(Con *con) {
DLOG("on_remove_child\n");

View File

@ -488,6 +488,12 @@ void workspace_update_urgent_flag(Con *ws) {
ipc_send_event("workspace", I3_IPC_EVENT_WORKSPACE, "{\"change\":\"urgent\"}");
}
/*
* 'Forces' workspace orientation by moving all cons into a new split-con with
* the same orientation as the workspace and then changing the workspace
* orientation.
*
*/
void ws_force_orientation(Con *ws, orientation_t orientation) {
/* 1: create a new split container */
Con *split = con_new(NULL);