Class

AstalRiverRiver

since: 0.1

Description 

final class AstalRiver.River : GObject.Object
  implements Gio.Initable {
  /* No available fields */
}

This class creates a connection to the river compositor.

Available since: 0.1

Ancestors

Implements

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.

since: 0.1

Functions

astal_river_river_get_default

Returns the default River object.

since: 0.1

Instance methods

astal_river_river_get_focused_output

Returns the name of the currently focused output.

since: 0.1

astal_river_river_get_focused_view

Returns the currently focused view.

since: 0.1

astal_river_river_get_mode

Returns the currently active mode.

since: 0.1

astal_river_river_get_output

Returns the output with the given name or null.

since: 0.1

astal_river_river_get_outputs

Returns a list of all outputs.

since: 0.1

astal_river_river_run_command_async

Sends a given command to the compositor and calls the callback after it was executed.

since: 0.1

Methods inherited from GObject (43)

Please see GObject for a full list of methods.

Methods inherited from GInitable (1)
g_initable_init

Initializes the object implementing the interface.

unstable since: 2.22

Properties

AstalRiver.River:focused-output

The name of the currently focused output.

since: 0.1

AstalRiver.River:focused-view

The name of the currently focused view.

since: 0.1

AstalRiver.River:mode

The currently active mode.

since: 0.1

AstalRiver.River:outputs

A list of AstalRiverOutput objects.

since: 0.1

Signals

AstalRiver.River::changed
No description available.

since: 0.1

AstalRiver.River::output-added

This signal is emitted when a new output was connected.

since: 0.1

AstalRiver.River::output-removed

This signal is emitted when a new output was disconnected.

since: 0.1

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.

unstable since: 2.0

Class structure 

struct AstalRiverRiverClass {
  GObjectClass parent_class;
  
}
No description available.
Class members
parent_class: GObjectClass
No description available.