Enable display configuration. The config file (miral::MirRunner::display_config_file()) is located via the XDG Base Directory Specification. Vis: ($XDG_CONFIG_HOME or $HOME/.config followed by $XDG_CONFIG_DIRS) More...

#include <display_configuration.h>

Public Member Functions
	DisplayConfiguration (MirRunner const &mir_runner)

auto	layout_option () -> ConfigurationOption
	Provide the default 'display-layout' configuration option. More...

void	select_layout (std::string const &layout)
	Select a layout from the configuration. More...

auto	list_layouts () -> std::vector< std::string >
	List all layouts found in the config file. More...

void	add_output_attribute (std::string const &key)
	Enable a custom output attribute in the .display YAML. More...

void	operator() (mir::Server &server) const

	~DisplayConfiguration ()

	DisplayConfiguration (DisplayConfiguration const &)

auto	operator= (DisplayConfiguration const &) -> DisplayConfiguration &

Detailed Description

Enable display configuration. The config file (miral::MirRunner::display_config_file()) is located via the XDG Base Directory Specification. Vis: ($XDG_CONFIG_HOME or $HOME/.config followed by $XDG_CONFIG_DIRS)

Remarks: Since MirAL 2.4

Note: From MirAL 3.8 will monitor the configuration file or, if none found, for the creation of a file in $XDG_CONFIG_HOME or $HOME/.config. Changes to this file will be reloaded. In addition, the selected layout may be overridden using a corresponding file: display_config_file() + "-layout" which will also be monitored and changes reloaded

Constructor & Destructor Documentation

◆ DisplayConfiguration() [1/2]

miral::DisplayConfiguration::DisplayConfiguration ( MirRunner const & mir_runner )

explicit

◆ ~DisplayConfiguration()

miral::DisplayConfiguration::~DisplayConfiguration ( )

◆ DisplayConfiguration() [2/2]

miral::DisplayConfiguration::DisplayConfiguration ( DisplayConfiguration const & )

Member Function Documentation

◆ add_output_attribute()

void miral::DisplayConfiguration::add_output_attribute ( std::string const & key )

Enable a custom output attribute in the .display YAML.

Remarks: Since MirAL 3.8

◆ layout_option()

auto miral::DisplayConfiguration::layout_option ( ) -> ConfigurationOption

Provide the default 'display-layout' configuration option.

◆ list_layouts()

auto miral::DisplayConfiguration::list_layouts ( ) -> std::vector< std::string >

List all layouts found in the config file.

◆ operator()()

void miral::DisplayConfiguration::operator() ( mir::Server & server ) const

◆ operator=()

auto miral::DisplayConfiguration::operator= ( DisplayConfiguration const & ) -> DisplayConfiguration &

◆ select_layout()

void miral::DisplayConfiguration::select_layout ( std::string const & layout )

Select a layout from the configuration.

The documentation for this class was generated from the following file:

include/miral/miral/display_configuration.h

Public Member Functions