Class BasicApplicationSwitcher

Nested Relationships

Nested Types

Class Documentation

class BasicApplicationSwitcher

This class encapsulates the standard usage of the miral::ApplicationSwitcher.

It will provide the application switcher to an internal client, setup common keybinds, and automatically stop it when the server starts.

This class will provide the following keybinds by default:

This class should be provided to a miral::MirRunner::run_with.

Remark

Since MirAL 5.6

Public Functions

BasicApplicationSwitcher()

Create a new basic application switcher with the default #KeybindConfiguration.

explicit BasicApplicationSwitcher(KeybindConfiguration const &keybind_configuration)

Create a new basic application switcher with the provided keybind_configuration.

~BasicApplicationSwitcher()
void operator()(mir::Server &server) const
struct KeybindConfiguration

Describes the keyboard shortcuts for the application switcher keyboard filter.

Public Members

MirInputEventModifier primary_modifier = mir_input_event_modifier_alt

This is the modifier that must be held for any application switcher action to begin.

Defaults to mir_input_event_modifier_alt.

MirInputEventModifier reverse_modifier = mir_input_event_modifier_shift

This is the modifier that must be held alongside the primary modifier in order to reverse the direction of an action being run. For example, holding the primary modifier and hitting the application key will select the next application, while holding both the primary and reverse modifiers and hitting the application will select the previous application.

Defaults to mir_input_event_modifier_shift.

int application_key = KEY_TAB

This is the key that must be clicked in order to trigger either miral::ApplicationSwitcher::next_app or miral::ApplicationSwitcher::prev_app, depending on the modifiers that are currently being held.

Defaults to KEY_TAB.

int window_key = KEY_GRAVE

This is the key that must be clicked in order to trigger either miral::ApplicationSwitcher::next_window or miral::ApplicationSwitcher::prev_window, depending on the modifiers that are currently being held.

Defaults to KEY_GRAVE.