IPC interface (interprocess communication)
<michael@i3wm.org>
-October 2012 +October 2014
3.2. COMMAND reply
-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.
- 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". +
++ The coordinates of the window decoration inside its container. These + coordinates are relative to the container and do not include the actual + client window. +
+3.7. MARKS reply
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/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 @@ -1060,7 +1134,7 @@ you can register to an event.
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). + 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
4.3. workspace event
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.