con.h

Go to the documentation of this file.

/*
 * vim:ts=4:sw=4:expandtab
 *
 * i3 - an improved dynamic tiling window manager
 * © 2009 Michael Stapelberg and contributors (see also: LICENSE)
 *
 * con.c: Functions which deal with containers directly (creating containers,
 *        searching containers, getting specific properties from containers,
 *        …).
 *
 */
#pragma once

#include <config.h>

Con *con_new_skeleton(Con *parent, i3Window *window);

/* A wrapper for con_new_skeleton, to retain the old con_new behaviour
 *
 */
Con *con_new(Con *parent, i3Window *window);

void con_free(Con *con);

void con_focus(Con *con);

void con_close(Con *con, kill_window_t kill_window);

bool con_is_leaf(Con *con);

bool con_has_managed_window(Con *con);

bool con_is_split(Con *con);

bool con_is_hidden(Con *con);

bool con_is_sticky(Con *con);

bool con_has_children(Con *con);

bool con_accepts_window(Con *con);

Con *con_get_output(Con *con);

Con *con_get_workspace(Con *con);

Con *con_parent_with_orientation(Con *con, orientation_t orientation);

Con *con_get_fullscreen_con(Con *con, fullscreen_mode_t fullscreen_mode);

bool con_is_internal(Con *con);

bool con_is_floating(Con *con);

bool con_is_docked(Con *con);

Con *con_inside_floating(Con *con);

bool con_inside_focused(Con *con);

bool con_has_parent(Con *con, Con *parent);

Con *con_by_window_id(xcb_window_t window);

Con *con_by_con_id(long target);

bool con_exists(Con *con);

Con *con_by_frame_id(xcb_window_t frame);

Con *con_by_mark(const char *mark);

bool con_has_mark(Con *con, const char *mark);

void con_mark_toggle(Con *con, const char *mark, mark_mode_t mode);

void con_mark(Con *con, const char *mark, mark_mode_t mode);

/*
 * Removes marks from containers.
 * If con is NULL, all containers are considered.
 * If name is NULL, this removes all existing marks.
 * Otherwise, it will only remove the given mark (if it is present).
 *
 */
void con_unmark(Con *con, const char *name);

Con *con_for_window(Con *con, i3Window *window, Match **store_match);

int con_num_children(Con *con);

int con_num_visible_children(Con *con);

int con_num_windows(Con *con);

void con_attach(Con *con, Con *parent, bool ignore_focus);

void con_detach(Con *con);

void con_fix_percent(Con *con);

void con_toggle_fullscreen(Con *con, int fullscreen_mode);

void con_enable_fullscreen(Con *con, fullscreen_mode_t fullscreen_mode);

void con_disable_fullscreen(Con *con);

void con_move_to_workspace(Con *con, Con *workspace, bool fix_coordinates,
                           bool dont_warp, bool ignore_focus);

void con_move_to_output(Con *con, Output *output);

bool con_move_to_mark(Con *con, const char *mark);

orientation_t con_orientation(Con *con);

Con *con_next_focused(Con *con);

Con *con_get_next(Con *con, char way, orientation_t orientation);

Con *con_descend_focused(Con *con);

Con *con_descend_tiling_focused(Con *con);

/*
 * Returns the leftmost, rightmost, etc. container in sub-tree. For example, if
 * direction is D_LEFT, then we return the rightmost container and if direction
 * is D_RIGHT, we return the leftmost container.  This is because if we are
 * moving D_LEFT, and thus want the rightmost container.
 */
Con *con_descend_direction(Con *con, direction_t direction);

Rect con_border_style_rect(Con *con);

adjacent_t con_adjacent_borders(Con *con);

int con_border_style(Con *con);

void con_set_border_style(Con *con, int border_style, int border_width);

void con_set_layout(Con *con, layout_t layout);

void con_toggle_layout(Con *con, const char *toggle_mode);

Rect con_minimum_size(Con *con);

bool con_fullscreen_permits_focusing(Con *con);

bool con_has_urgent_child(Con *con);

void con_update_parents_urgency(Con *con);

void con_set_urgency(Con *con, bool urgent);

char *con_get_tree_representation(Con *con);

void con_force_split_parents_redraw(Con *con);

i3String *con_parse_title_format(Con *con);

bool con_swap(Con *first, Con *second);