i3/include/con.h
2010-11-13 22:39:59 +01:00

157 lines
3.6 KiB
C
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

#ifndef _CON_H
#define _CON_H
/**
* Create a new container (and attach it to the given parent, if not NULL).
* This function initializes the data structures and creates the appropriate
* X11 IDs using x_con_init().
*
*/
Con *con_new(Con *parent);
/**
* Sets input focus to the given container. Will be updated in X11 in the next
* run of x_push_changes().
*
*/
void con_focus(Con *con);
/**
* Returns true when this node is a leaf node (has no children)
*
*/
bool con_is_leaf(Con *con);
/**
* Returns true if this node accepts a window (if the node swallows windows,
* it might already have swallowed enough and cannot hold any more).
*
*/
bool con_accepts_window(Con *con);
/**
* Gets the output container (first container with CT_OUTPUT in hierarchy) this
* node is on.
*
*/
Con *con_get_output(Con *con);
/**
* Gets the workspace container this node is on.
*
*/
Con *con_get_workspace(Con *con);
/**
* Returns the first fullscreen node below this node.
*
*/
Con *con_get_fullscreen_con(Con *con);
/**
* Returns true if the node is floating.
*
*/
bool con_is_floating(Con *con);
/**
* Returns the container with the given client window ID or NULL if no such
* container exists.
*
*/
Con *con_by_window_id(xcb_window_t window);
/**
* Returns the container with the given frame ID or NULL if no such container
* exists.
*
*/
Con *con_by_frame_id(xcb_window_t frame);
/**
* Returns the first container which wants to swallow this window
* TODO: priority
*
*/
Con *con_for_window(i3Window *window, Match **store_match);
/**
* Returns the number of children of this container.
*
*/
int con_num_children(Con *con);
/**
* Attaches the given container to the given parent. This happens when moving
* a container or when inserting a new container at a specific place in the
* tree.
*
*/
void con_attach(Con *con, Con *parent);
/**
* Detaches the given container from its current parent
*
*/
void con_detach(Con *con);
/**
* Updates the percent attribute of the children of the given container. This
* function needs to be called when a window is added or removed from a
* container.
*
*/
void con_fix_percent(Con *con, int action);
enum { WINDOW_ADD = 0, WINDOW_REMOVE = 1 };
/**
* Toggles fullscreen mode for the given container. Fullscreen mode will not be
* entered when there already is a fullscreen container on this workspace.
*
*/
void con_toggle_fullscreen(Con *con);
/**
* Moves the given container to the currently focused container on the given
* workspace.
* TODO: is there a better place for this function?
*
*/
void con_move_to_workspace(Con *con, Con *workspace);
/**
* Returns the orientation of the given container (for stacked containers,
* vertical orientation is used regardless of the actual orientation of the
* container).
*
*/
int con_orientation(Con *con);
/**
* Returns the container which will be focused next when the given container
* is not available anymore. Called in tree_close and con_move_to_workspace
* to properly restore focus.
*
*/
Con *con_next_focused(Con *con);
/**
* Returns a "relative" Rect which contains the amount of pixels that need to
* be added to the original Rect to get the final position (obviously the
* amount of pixels for normal, 1pixel and borderless are different).
*
*/
Rect con_border_style_rect(Con *con);
/**
* Use this function to get a containers border style. This is important
* because when inside a stack, the border style is always BS_NORMAL.
* For tabbed mode, the same applies, with one exception: when the container is
* borderless and the only element in the tabbed container, the border is not
* rendered.
*
*/
int con_border_style(Con *con);
#endif