Function

AstalRiverLayoutDemandCallback

Declaration

void
(* AstalRiverLayoutDemandCallback) (
  AstalRiverLayout* self,
  AstalRiverOutput* output,
  guint view_count,
  guint usable_width,
  guint usable_height,
  gchar** layout_name,
  GList** geometries,
  gpointer user_data
)

Description

A callback function that is called when the layout manager needs to determine the layout for a given output.

Parameters

self

Type: AstalRiverLayout

An AstalRiverLayout instance.

The data is owned by the caller of the function.
output

Type: AstalRiverOutput

An AstalRiverOutput instance for which the layout is being demanded.

The data is owned by the caller of the function.
view_count

Type: guint

The number of views currently on the output.

usable_width

Type: guint

The usable width of the output for layout.

usable_height

Type: guint

The usable height of the output for layout.

layout_name

Type: gchar**

The name for the the layout provided by this callback.

The argument will be set by the function.
The caller of the function takes ownership of the returned data, and is responsible for freeing it.
The value is a NUL terminated UTF-8 string.
geometries

Type: A list of AstalRiverGeometry*

A list of AstalRiverGeometry that will be used for the layout for of the views.

The argument will be set by the function.
The caller of the function takes ownership of the returned data, and is responsible for freeing it.
user_data

Type: gpointer

User data passed to the callback.

The argument can be NULL.
The data is owned by the caller of the function.