i3
Data Structures | Public Types | Data Fields
Config Struct Reference

Holds part of the configuration (the part which is not already in dedicated structures in include/data.h). More...

#include <config.h>

Collaboration diagram for Config:
Collaboration graph
[legend]

Data Structures

struct  config_bar
struct  config_client

Public Types

enum  { PDF_LEAVE_FULLSCREEN = 0, PDF_IGNORE = 1 }
 What should happen when a new popup is opened during fullscreen mode. More...

Data Fields

const char * terminal
i3Font font
char * ipc_socket_path
const char * restart_state_path
int default_layout
int container_stack_limit
int container_stack_limit_value
int default_orientation
 Default orientation for new containers.
bool disable_focus_follows_mouse
 By default, focus follows mouse.
bool disable_workspace_bar
 By default, a workspace bar is drawn at the bottom of the screen.
bool force_focus_wrapping
 Think of the following layout: Horizontal workspace with a tabbed con on the left of the screen and a terminal on the right of the screen.
bool force_xinerama
 By default, use the RandR API for multi-monitor setups.
char * fake_outputs
 Overwrites output detection (for testing), see src/fake_outputs.c.
bool workspace_auto_back_and_forth
 Automatic workspace back and forth switching.
border_style_t default_border
 The default border style for new windows.
border_style_t default_floating_border
 The default border style for new floating windows.
uint32_t floating_modifier
 The modifier which needs to be pressed in combination with your mouse buttons to do things with floating windows (move, resize)
int32_t floating_maximum_width
 Maximum and minimum dimensions of a floating window.
int32_t floating_maximum_height
int32_t floating_minimum_width
int32_t floating_minimum_height
struct Config::config_client client
struct Config::config_bar bar
enum Config:: { ... }  popup_during_fullscreen
 What should happen when a new popup is opened during fullscreen mode.

Detailed Description

Holds part of the configuration (the part which is not already in dedicated structures in include/data.h).

Definition at line 91 of file config.h.


Member Enumeration Documentation

anonymous enum

What should happen when a new popup is opened during fullscreen mode.

Enumerator:
PDF_LEAVE_FULLSCREEN 
PDF_IGNORE 

Definition at line 177 of file config.h.


Field Documentation

Referenced by load_configuration().

Definition at line 99 of file config.h.

Referenced by yyparse().

Definition at line 100 of file config.h.

Referenced by yyparse().

The default border style for new windows.

Definition at line 147 of file config.h.

Referenced by con_new(), load_configuration(), and yyparse().

The default border style for new floating windows.

Definition at line 150 of file config.h.

Referenced by floating_enable(), load_configuration(), and yyparse().

Definition at line 98 of file config.h.

Referenced by con_attach(), workspace_attach_to(), and yyparse().

Default orientation for new containers.

Definition at line 103 of file config.h.

Referenced by con_set_layout(), create_workspace_on_output(), load_configuration(), output_change_mode(), workspace_attach_to(), workspace_get(), and yyparse().

By default, focus follows mouse.

If the user explicitly wants to turn this off (and instead rely only on the keyboard for changing focus), we allow him to do this with this relatively special option. It is not planned to add any different focus models.

Definition at line 109 of file config.h.

Referenced by check_crossing_screen_boundary(), handle_enter_notify(), handle_motion_notify(), and yyparse().

By default, a workspace bar is drawn at the bottom of the screen.

If you want to have a more fancy bar, it is recommended to replace the whole bar by dzen2, for example using the i3-wsbar script which comes with i3. Thus, you can turn it off entirely.

Definition at line 115 of file config.h.

Referenced by yyparse().

Overwrites output detection (for testing), see src/fake_outputs.c.

Definition at line 138 of file config.h.

Referenced by main(), and yyparse().

Definition at line 158 of file config.h.

Referenced by floating_enable(), and yyparse().

Maximum and minimum dimensions of a floating window.

Definition at line 157 of file config.h.

Referenced by floating_enable(), and yyparse().

Definition at line 160 of file config.h.

Referenced by floating_enable(), and yyparse().

Definition at line 159 of file config.h.

Referenced by floating_enable(), and yyparse().

The modifier which needs to be pressed in combination with your mouse buttons to do things with floating windows (move, resize)

Definition at line 154 of file config.h.

Referenced by handle_button_press(), and yyparse().

Think of the following layout: Horizontal workspace with a tabbed con on the left of the screen and a terminal on the right of the screen.

You are in the second container in the tabbed container and focus to the right. By default, i3 will set focus to the terminal on the right. If you are in the first container in the tabbed container however, focusing to the left will wrap. This option forces i3 to always wrap, which will result in you having to use "focus parent" more often.

Definition at line 125 of file config.h.

Referenced by _tree_next(), and yyparse().

By default, use the RandR API for multi-monitor setups.

Unfortunately, the nVidia binary graphics driver doesn't support this API. Instead, it only support the less powerful Xinerama API, which can be enabled by this option.

Note: this option takes only effect on the initial startup (eg. reconfiguration is not possible). On startup, the list of screens is fetched once and never updated.

Definition at line 135 of file config.h.

Referenced by main(), and yyparse().

Definition at line 95 of file config.h.

Referenced by main(), and yyparse().

What should happen when a new popup is opened during fullscreen mode.

Referenced by manage_window(), and yyparse().

Definition at line 96 of file config.h.

Referenced by store_restart_layout(), and yyparse().

const char* Config::terminal

Definition at line 92 of file config.h.

Automatic workspace back and forth switching.

If this is set, a switch to the currently active workspace will switch to the previously focused one instead, making it possible to fast toggle between two workspaces.

Definition at line 144 of file config.h.

Referenced by cmd_workspace_name(), and yyparse().


The documentation for this struct was generated from the following file: