i3
Data Structures | Public Types | Public Member Functions | Data Fields
Barconfig Struct Reference

Holds the status bar configuration (i3bar). More...

#include <config.h>

Collaboration diagram for Barconfig:
Collaboration graph
[legend]

Data Structures

struct  bar_colors
 

Public Types

enum  { M_DOCK = 0, M_HIDE = 1, M_INVISIBLE = 2 }
 Bar display mode (hide unless modifier is pressed or show in dock mode or always hide in invisible mode) More...
 
enum  { S_HIDE = 0, S_SHOW = 1 }
 
enum  {
  M_NONE = 0, M_CONTROL = 1, M_SHIFT = 2, M_MOD1 = 3,
  M_MOD2 = 4, M_MOD3 = 5, M_MOD4 = 6, M_MOD5 = 7
}
 Bar modifier (to show bar when in hide mode). More...
 
enum  { P_BOTTOM = 0, P_TOP = 1 }
 Bar position (bottom by default). More...
 

Public Member Functions

 TAILQ_ENTRY (Barconfig) configs
 

Data Fields

char * id
 Automatically generated ID for this bar config. More...
 
int num_outputs
 Number of outputs in the outputs array. More...
 
char ** outputs
 Outputs on which this bar should show up on. More...
 
char * tray_output
 Output on which the tray should be shown. More...
 
char * socket_path
 Path to the i3 IPC socket. More...
 
enum Barconfig:: { ... }  mode
 Bar display mode (hide unless modifier is pressed or show in dock mode or always hide in invisible mode) More...
 
enum Barconfig:: { ... }  hidden_state
 
enum Barconfig:: { ... }  modifier
 Bar modifier (to show bar when in hide mode). More...
 
enum Barconfig:: { ... }  position
 Bar position (bottom by default). More...
 
char * i3bar_command
 Command that should be run to execute i3bar, give a full path if i3bar is not in your $PATH. More...
 
char * status_command
 Command that should be run to get a statusline, for example 'i3status'. More...
 
char * font
 Font specification for all text rendered on the bar. More...
 
bool hide_workspace_buttons
 Hide workspace buttons? Configuration option is 'workspace_buttons no' but we invert the bool to get the correct default when initializing with zero. More...
 
bool strip_workspace_numbers
 Strip workspace numbers? Configuration option is 'strip_workspace_numbers yes'. More...
 
bool hide_binding_mode_indicator
 Hide mode button? Configuration option is 'binding_mode_indicator no' but we invert the bool for the same reason as hide_workspace_buttons. More...
 
bool verbose
 Enable verbose mode? Useful for debugging purposes. More...
 
struct Barconfig::bar_colors colors
 

Detailed Description

Holds the status bar configuration (i3bar).

One of these structures is created for each 'bar' block in the config.

Definition at line 223 of file config.h.

Member Enumeration Documentation

anonymous enum

Bar display mode (hide unless modifier is pressed or show in dock mode or always hide in invisible mode)

Enumerator
M_DOCK 
M_HIDE 
M_INVISIBLE 

Definition at line 244 of file config.h.

anonymous enum
Enumerator
S_HIDE 
S_SHOW 

Definition at line 247 of file config.h.

anonymous enum

Bar modifier (to show bar when in hide mode).

Enumerator
M_NONE 
M_CONTROL 
M_SHIFT 
M_MOD1 
M_MOD2 
M_MOD3 
M_MOD4 
M_MOD5 

Definition at line 250 of file config.h.

anonymous enum

Bar position (bottom by default).

Enumerator
P_BOTTOM 
P_TOP 

Definition at line 262 of file config.h.

Member Function Documentation

Barconfig::TAILQ_ENTRY ( Barconfig  )

Field Documentation

struct Barconfig::bar_colors Barconfig::colors

Referenced by CFGFUN(), and load_configuration().

char* Barconfig::font

Font specification for all text rendered on the bar.

Definition at line 274 of file config.h.

Referenced by CFGFUN(), and load_configuration().

enum { ... } Barconfig::hidden_state
bool Barconfig::hide_binding_mode_indicator

Hide mode button? Configuration option is 'binding_mode_indicator no' but we invert the bool for the same reason as hide_workspace_buttons.

Definition at line 287 of file config.h.

Referenced by CFGFUN(), and dump_bar_config().

bool Barconfig::hide_workspace_buttons

Hide workspace buttons? Configuration option is 'workspace_buttons no' but we invert the bool to get the correct default when initializing with zero.

Definition at line 279 of file config.h.

Referenced by CFGFUN(), and dump_bar_config().

char* Barconfig::i3bar_command

Command that should be run to execute i3bar, give a full path if i3bar is not in your $PATH.

By default just 'i3bar' is executed.

Definition at line 267 of file config.h.

Referenced by CFGFUN(), and load_configuration().

char* Barconfig::id

Automatically generated ID for this bar config.

Used by the bar process to request a specific configuration.

Definition at line 226 of file config.h.

Referenced by CFGFUN(), cmd_bar_hidden_state(), cmd_bar_mode(), dump_bar_config(), IPC_HANDLER(), ipc_send_barconfig_update_event(), and load_configuration().

enum { ... } Barconfig::mode

Bar display mode (hide unless modifier is pressed or show in dock mode or always hide in invisible mode)

Referenced by CFGFUN(), cmd_bar_mode(), and dump_bar_config().

enum { ... } Barconfig::modifier

Bar modifier (to show bar when in hide mode).

Referenced by CFGFUN(), and dump_bar_config().

int Barconfig::num_outputs

Number of outputs in the outputs array.

Definition at line 229 of file config.h.

Referenced by CFGFUN(), dump_bar_config(), and load_configuration().

char** Barconfig::outputs

Outputs on which this bar should show up on.

We use an array for simplicity (since we store just strings).

Definition at line 232 of file config.h.

Referenced by CFGFUN(), dump_bar_config(), and load_configuration().

enum { ... } Barconfig::position

Bar position (bottom by default).

Referenced by CFGFUN(), and dump_bar_config().

char* Barconfig::socket_path

Path to the i3 IPC socket.

This option is discouraged since programs can find out the path by looking for the I3_SOCKET_PATH property on the root window!

Definition at line 241 of file config.h.

Referenced by CFGFUN(), and load_configuration().

char* Barconfig::status_command

Command that should be run to get a statusline, for example 'i3status'.

Will be passed to the shell.

Definition at line 271 of file config.h.

Referenced by CFGFUN(), and load_configuration().

bool Barconfig::strip_workspace_numbers

Strip workspace numbers? Configuration option is 'strip_workspace_numbers yes'.

Definition at line 283 of file config.h.

Referenced by CFGFUN(), and dump_bar_config().

char* Barconfig::tray_output

Output on which the tray should be shown.

The special value of 'no' disables the tray (it’s enabled by default).

Definition at line 236 of file config.h.

Referenced by CFGFUN(), and load_configuration().

bool Barconfig::verbose

Enable verbose mode? Useful for debugging purposes.

Definition at line 290 of file config.h.

Referenced by CFGFUN(), and dump_bar_config().


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