+ Gets a list of currently configured binding modes. +
+So, a typical message could look like this:
+ Reply to the GET_BINDING_MODES message. +
+The reply consists of a single serialized map. At the moment, the only -property is success (bool), but this will be expanded in future versions.
The reply consists of a list of serialized maps for each command that was +parsed. Each has the property success (bool) and may also include a +human-readable error message in the property error (string).
Example:
{ "success": true }
+[{ "success": true }]
The logical number of the workspace. Corresponds to the command - to switch to this workspace. + to switch to this workspace. For named workspaces, this will be -1.
+ Whether this output is currently the primary output. +
+- The current workspace which is visible on this output. null if the - output is not active. + The name of the current workspace that is visible on this output. null if + the output is not active.
+ Type of this container. Can be one of "root", "output", "con", + "floating_con", "workspace" or "dockarea". +
+- Can be either "normal", "none" or "1pixel", dependending on the + Can be either "normal", "none" or "pixel", depending on the containerâs border style.
+ The coordinates of the window decoration inside its container. These + coordinates are relative to the container and do not include the actual + client window. +
+The reply consists of a single array of strings for each container that has a -mark. The order of that array is undefined. If more than one container has the -same mark, it will be represented multiple times in the reply (the array -contents are not unique).
If no window has a mark the response will be the empty array [].
+ Display the mode indicator or not? Defaults to true. +
++ Text color to be used for the separator. +
+- Text color/background color for a workspace button when the workspace + Background color of the bar on the currently focused monitor output. +
++ Text color to be used for the statusline on the currently focused + monitor output. +
++ Text color to be used for the separator on the currently focused + monitor output. +
++ Text/background/border color for a workspace button when the workspace has focus.
- Text color/background color for a workspace button when the workspace + Text/background/border color for a workspace button when the workspace is active (visible) on some output, but the focus is on another one. You can only tell this apart from the focused workspace when you are using multiple monitors.
- Text color/background color for a workspace button when the workspace + Text/background/border color for a workspace button when the workspace does not have focus and is not active (visible) on any output. This will be the case for most workspaces.
- Text color/background color for workspaces which contain at least one + Text/background/border color for workspaces which contain at least one window with the urgency hint set.
+ Text/background/border color for the binding mode indicator. +
+Example of configured bars:
+ The current config path. +
+Example:
{
"human_readable" : "4.2-169-gf80b877 (2012-08-05, branch \"next\")",
+ "loaded_config_file_name" : "/home/hwangcc23/.i3/config",
"minor" : 2,
"patch" : 0,
"major" : 4
}
The reply consists of an array of all currently configured binding modes.
Example:
["default", "resize"]+
type: SUBSCRIBE -payload: [ "workspace", "focus" ]+payload: [ "workspace", "output" ]
+ Sent when a client’s window is successfully reparented (that is when i3 + has finished fitting it into a container), when a window received input + focus or when certain properties of the window have changed. +
++ Sent when the hidden_state or mode field in the barconfig of any bar + instance was updated and when the config is reloaded. +
++ Sent when a configured command binding is triggered with the keyboard or + mouse +
++ Sent when the ipc shuts down because of a restart or exit by user command +
+Example:
This event consists of a single serialized map containing a property change (string) which indicates the type of the change ("focus", "init", -"empty", "urgent").
Moreover, when the change is "focus", an old (object) and a current -(object) properties will be present with the previous and current -workspace respectively. When the first switch occurs (when i3 focuses -the workspace visible at the beginning) there is no previous -workspace, and the old property will be set to null. Also note -that if the previous is empty it will get destroyed when switching, -but will still be present in the "old" property.
When the change is "focus", an old (object) property will be present with the +previous workspace. When the first switch occurs (when i3 focuses the +workspace visible at the beginning) there is no previous workspace, and the +old property will be set to null. Also note that if the previous is empty +it will get destroyed when switching, but will still be present in the "old" +property.
Example:
This event consists of a single serialized map containing a property change (string) which holds the name of current mode in use. The name is the same as specified in config when creating a mode. The default -mode is simply named default.
Example:
{
+ "change": "default",
+ "pango_markup": true
+}
+This event consists of a single serialized map containing a property +change (string) which indicates the type of the change
+new â the window has become managed by i3 +
++close â the window has closed +
++focus â the window has received input focus +
++title â the window’s title has changed +
++fullscreen_mode â the window has entered or exited fullscreen mode +
++move â the window has changed its position in the tree +
++floating â the window has transitioned to or from floating +
++urgent â the window has become urgent or lost its urgent status +
++mark â a mark has been added to or removed from the window +
+Additionally a container (object) field will be present, which consists +of the window’s parent container. Be aware that for the "new" event, the +container will hold the initial name of the newly reparented window (e.g. +if you run urxvt with a shell that changes the title, you will still at +this point get the window title as "urxvt").
Example:
{
+ "change": "new",
+ "container": {
+ "id": 35569536,
+ "type": "con",
+ ...
+ }
+}
+This event consists of a single serialized map reporting on options from the +barconfig of the specified bar_id that were updated in i3. This event is the +same as a GET_BAR_CONFIG reply for the bar with the given id.
This event consists of a single serialized map reporting on the details of a +binding that ran a command because of user input. The change (string) field +indicates what sort of binding event was triggered (right now it will always be +"run" but may be expanded in the future).
The binding (object) field contains details about the binding that was run:
+ The i3 command that is configured to run for this binding. +
++ The group and modifier keys that were configured with this binding. +
++ If the binding was configured with bindcode, this will be the key code + that was given for the binding. If the binding is a mouse binding, it will be + the number of the mouse button that was pressed. Otherwise it will be 0. +
++ If this is a keyboard binding that was configured with bindsym, this + field will contain the given symbol. Otherwise it will be null. +
++ This will be "keyboard" or "mouse" depending on whether or not this was + a keyboard or a mouse binding. +
+Example:
{ "change": "default" }
+{
+ "change": "run",
+ "binding": {
+ "command": "nop",
+ "event_state_mask": [
+ "shift",
+ "ctrl"
+ ],
+ "input_code": 0,
+ "symbol": "t",
+ "input_type": "keyboard"
+ }
+}
+This event is triggered when the connection to the ipc is about to shutdown +because of a user action such as a restart or exit command. The change +(string) field indicates why the ipc is shutting down. It can be either +"restart" or "exit".
Example:
{
+ "change": "restart"
+}
+i3 includes a headerfile i3/ipc.h which provides you all constants. +
+- i3 includes a headerfile i3/ipc.h which provides you all constants. - However, there is no library yet. +https://github.com/acrisci/i3ipc-glib
+-https://github.com/whitelynx/i3ipc +https://github.com/acrisci/i3ipc-python
-https://github.com/ziberna/i3-py (includes higher-level features) +https://github.com/whitelynx/i3ipc (not maintained) +
++https://github.com/ziberna/i3-py (not maintained) +
++https://github.com/badboy/i3-ipc (not maintained) +
+