events

type ConfigLoaded struct {
	EName
	// Failed indicates that the configuration couldn't be reloaded.
	//
	// This can happen e.g. when the config validation
	// fails.
	Failed bool `json:"failed"`
}

type EName struct {
	Name string
}

type Event interface {
	GetName() string
	GetPossibleKeys() models.PossibleKeys
}

type KeyboardLayoutSwitched struct {
	EName
	// Idx contains the index of the newly active layout.
	Idx uint8 `json:"idx"`
}

type KeyboardLayoutsChanged struct {
	EName
	// KeyboardLayouts contains the new keyboard layout configuration.
	KeyboardLayouts models.KeyboardLayouts `json:"keyboard_layouts"`
}

type OverviewOpenedOrClosed struct {
	EName
	// IsOpen contains the new state of the overview.
	IsOpen bool `json:"is_open"`
}

type ScreenshotCaptured struct {
	EName
	// Path indicates the file path where the screenshot was saved, if it was written to disk.
	//
	// If None, the screenshot was wither only copied to the clipboard, or the path couldn't be
	// converted to a String (e.g. contained invalid UTF-8 bytes).
	Path string `json:"path,omitempty"`
}

type Timestamp struct {
	// Secs is the number of whole seconds.
	Secs uint64 `json:"secs,omitempty"`
	// Nanos is the fractional part of the timestamp in nanoseconds.
	Nanos uint32 `json:"nanos,omitempty"`
}

type WindowClosed struct {
	EName
	// ID the ID of the removed window.
	ID uint64 `json:"id"`
}

type WindowFocusChanged struct {
	EName
	// ID the ID of the newly focused window, or omitted if no window is now focused.
	ID uint64 `json:"id"`
}

type WindowFocusTimestampChanged struct {
	EName
	// Id is the window ID.
	ID uint64 `json:"id"`
	// FocusTimestamp is the new focus timestamp.
	FocusTimestamp Timestamp `json:"focus_timestamp"`
}

type WindowLayoutChange struct {
	// WindowID the window id in the layout change.
	WindowID uint64
	// Layout the layout of the window.
	Layout models.WindowLayout
}

type WindowLayoutsChanged struct {
	EName
	// Pairs consisting of a window id and new layout information for the window.
	Changes []WindowLayoutChange `json:"changes"`
}

type WindowOpenedOrChanged struct {
	EName
	// Window contains the new or updated window.
	//
	// If the window is focused, all other windows are no longer focused.
	Window *models.Window `json:"window"`
}

type WindowUrgencyChanged struct {
	EName
	// ID the ID of the window.
	ID uint64 `json:"id"`
	// Urgent the new urgency state of the window.
	Urgent bool `json:"urgent"`
}

type WindowsChanged struct {
	EName
	// Windows contains the new window configuration.
	//
	// This configuration completely replaces the previous configuration. If any windows
	// are missing from here, then they were closed.
	Windows []*models.Window `json:"windows"`
}

type WorkspaceActivated struct {
	EName
	// ID the ID of the newly active workspace.
	ID uint64 `json:"id"`
	// Focused tells if this workspace also became focused.
	//
	// If true, this is now the single focused workspace. All other workspaces are no longer
	// focused, but they may remain active on their respective outputs.
	Focused bool `json:"focused"`
}

type WorkspaceActiveWindowChanged struct {
	EName
	// WorkspaceID the ID of the workspace on which the active window changed.
	WorkspaceID uint64 `json:"workspace_id"`
	// ActiveWindowID the ID of the new active window, if any.
	ActiveWindowID uint64 `json:"active_window_id"`
}

type WorkspaceUrgencyChanged struct {
	EName
	// ID the ID of the workspace.
	ID uint64 `json:"id"`
	// Urgent tells if this workspace has an urgent window.
	Urgent bool `json:"urgent"`
}

type WorkspacesChanged struct {
	EName
	// Workspaces contains the new workspace configuration.
	//
	// This configuration completely replaces the previous configuration. If any workspaces
	// are missing from here, then they were deleted.
	Workspaces []*models.Workspace `json:"workspaces"`
}