Class

AstalRiverRiver

Description 

class AstalRiver.River : GObject.Object
{
  /* No available fields */
}

This class creates a connection to the river compositor.

Ancestors

Constructors

astal_river_river_new

Creates a new River object. It is recommended to use the astal_river_get_default() method instead of this method.

Functions

astal_river_river_get_default

Returns the singleton River instance.

Instance methods

astal_river_river_find_output_by_wl_output

Looks up an output based on its underlying wl_output object.

astal_river_river_find_output_by_astal_wl_output

Looks up an output based on its underlying AstalWlOutput object.

astal_river_river_find_output_by_name

Looks up an output based on its underlying name.

astal_river_river_find_output_by_id

Looks up an output based on its underlying wayland id.

astal_river_river_run_command

Executes a given command, similar to riverctl.

astal_river_river_run_command_async

Executes a given command, similar to riverctl.

astal_river_river_run_command_finish
No description available.

astal_river_river_new_layout

Creates a new Layout object with a given namespace.

astal_river_river_get_outputs
No description available.

astal_river_river_get_focused_output
No description available.

astal_river_river_get_focused_output_name
No description available.

astal_river_river_get_focused_view
No description available.

astal_river_river_get_mode
No description available.

Methods inherited from GObject (43)

Please see GObject for a full list of methods.

Properties

AstalRiver.River:outputs

A List of all known Outputs.

AstalRiver.River:focused-output

The currently focused Output object.

AstalRiver.River:focused-output-name

The currently focused Output name.

AstalRiver.River:focused-view

The currently focused view title.

AstalRiver.River:mode

The currently active mode.

Signals

AstalRiver.River::output-added

Signals a new Output was added, emitted after the Output was added to the lists.

AstalRiver.River::output-removed

Signals an Output was removed, emitted after the Output was removed from the lists.

Signals inherited from GObject (1)
GObject::notify

The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.

Class structure 

struct AstalRiverRiverClass {
  /* no available fields */
}

No description available.