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 }
 Bar display mode (hide unless modifier is pressed or show in dock 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.
int num_outputs
 Number of outputs in the outputs array.
char ** outputs
 Outputs on which this bar should show up on.
char * tray_output
 Output on which the tray should be shown.
char * socket_path
 Path to the i3 IPC socket.
enum Barconfig:: { ... }  mode
 Bar display mode (hide unless modifier is pressed or show in dock mode)
enum Barconfig:: { ... }  position
 Bar position (bottom by default).
char * status_command
 Command that should be run to get a statusline, for example 'i3status'.
char * font
 Font specification for all text rendered on the bar.
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.
bool verbose
 Enable verbose mode? Useful for debugging purposes.
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 178 of file config.h.


Member Enumeration Documentation

anonymous enum

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

Enumerator:
M_DOCK 
M_HIDE 

Definition at line 199 of file config.h.

anonymous enum

Bar position (bottom by default).

Enumerator:
P_BOTTOM 
P_TOP 

Definition at line 202 of file config.h.


Member Function Documentation


Field Documentation

Referenced by load_configuration().

Font specification for all text rendered on the bar.

Definition at line 209 of file config.h.

Referenced by load_configuration().

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 214 of file config.h.

Referenced by IPC_HANDLER().

Automatically generated ID for this bar config.

Used by the bar process to request a specific configuration.

Definition at line 181 of file config.h.

Referenced by IPC_HANDLER(), load_configuration(), main(), and migrate_i3bar_exec().

enum { ... } Barconfig::mode

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

Referenced by IPC_HANDLER().

Number of outputs in the outputs array.

Definition at line 184 of file config.h.

Referenced by IPC_HANDLER(), and load_configuration().

Outputs on which this bar should show up on.

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

Definition at line 187 of file config.h.

Referenced by IPC_HANDLER(), and load_configuration().

enum { ... } Barconfig::position

Bar position (bottom by default).

Referenced by IPC_HANDLER().

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 196 of file config.h.

Referenced by load_configuration().

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

Will be passed to the shell.

Definition at line 206 of file config.h.

Referenced by load_configuration(), and migrate_i3bar_exec().

Output on which the tray should be shown.

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

Definition at line 191 of file config.h.

Referenced by load_configuration().

Enable verbose mode? Useful for debugging purposes.

Definition at line 217 of file config.h.

Referenced by IPC_HANDLER().


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