Struct ApplicationInfo

• Defined in File application_info.h

Struct Documentation

struct ApplicationInfo

Provides information about a miral::Application and its associated list of miral::Window objects.

An instance of this class may be obtained from miral::WindowManagerTools::info_for.

See also

miral::Application - the class for which this class provides information

See also

miral::WindowManagerTools::info_for - the method to obtain an instance of this class

Public Functions

ApplicationInfo()

Constructs a new application info without a backing miral::Application.

explicit ApplicationInfo(Application const &app)

Constructs a new application info backed by app.

Parameters:

app – The backing application.

~ApplicationInfo()

ApplicationInfo(ApplicationInfo const &that)

auto operator=(ApplicationInfo const &that) -> miral::ApplicationInfo&

auto name() const -> std::string

Return the name of the application.

Returns:

The name of the application.

auto application() const -> Application

Return the backing miral::Application for this info.

Returns:

The backing application.

auto windows() const -> std::vector<Window>&

Return the list of miral::Window instances that are associated with this miral::Application.

Returns:

The list of windows associated with the application.

auto userdata() const -> std::shared_ptr<void>

Return the user data set for this application.

Compositor authors may set this payload with miral::ApplicationInfo::userdata(std::shared_ptr<void>).

Returns:

The user data set by the compositor author, and nullptr if none was set.

void userdata(std::shared_ptr<void> userdata)

Set the arbitrary user data payload for this application.

This can be used by the compositor author to store information specific to their use case.

This payload can be retrieved later via miral::ApplicationInfo::userdata().

Parameters:

userdata – An arbitrary payload.