Mir API¶
Page Hierarchy¶
Class Hierarchy¶
File Hierarchy¶
Full API¶
Namespaces¶
Classes and Structs¶
- Struct WindowInfo
- Struct Documentation
miral::WindowInfo
min_width()
min_height()
max_width()
max_height()
width_inc()
height_inc()
min_aspect()
max_aspect()
application_id()
needs_titlebar()
AspectRatio
WindowInfo()
WindowInfo()
~WindowInfo()
WindowInfo()
operator=()
can_be_active()
can_morph_to()
must_have_parent()
must_not_have_parent()
is_visible()
constrain_resize()
window()
name()
type()
state()
restore_rect()
parent()
children()
has_output_id()
output_id()
preferred_orientation()
confine_pointer()
shell_chrome()
userdata()
userdata()
swap()
depth_layer()
attached_edges()
exclusive_rect()
ignore_exclusion_zones()
clip_area()
clip_area()
focus_mode()
visible_on_lock_screen()
- Struct Documentation
- Class ApplicationAuthorizer
- Class Documentation
miral::ApplicationAuthorizer
ApplicationAuthorizer()
~ApplicationAuthorizer()
ApplicationAuthorizer()
operator=()
connection_is_allowed()
configure_display_is_allowed()
set_base_display_configuration_is_allowed()
screencast_is_allowed()
prompt_session_is_allowed()
configure_input_is_allowed()
set_base_input_configuration_is_allowed()
- Class Documentation
- Class ConfigurationOption
- Class Documentation
miral::ConfigurationOption
ConfigurationOption()
ConfigurationOption()
ConfigurationOption()
ConfigurationOption()
ConfigurationOption()
ConfigurationOption()
ConfigurationOption()
ConfigurationOption()
ConfigurationOption()
ConfigurationOption()
ConfigurationOption()
operator()()
~ConfigurationOption()
ConfigurationOption()
operator=()
pre_init
- Class Documentation
- Class InputConfiguration
- Nested Relationships
- Class Documentation
miral::InputConfiguration
InputConfiguration()
~InputConfiguration()
operator()()
mouse()
mouse()
touchpad()
touchpad()
keyboard()
keyboard()
miral::InputConfiguration::Keyboard
miral::InputConfiguration::Mouse
miral::InputConfiguration::Touchpad
Touchpad()
~Touchpad()
Touchpad()
operator=()
disable_while_typing()
disable_with_external_mouse()
acceleration()
acceleration_bias()
vscroll_speed()
hscroll_speed()
click_mode()
scroll_mode()
tap_to_click()
disable_while_typing()
disable_with_external_mouse()
acceleration()
acceleration_bias()
vscroll_speed()
hscroll_speed()
click_mode()
scroll_mode()
tap_to_click()
- Class InputConfiguration::Touchpad
- Nested Relationships
- Class Documentation
miral::InputConfiguration::Touchpad
Touchpad()
~Touchpad()
Touchpad()
operator=()
disable_while_typing()
disable_with_external_mouse()
acceleration()
acceleration_bias()
vscroll_speed()
hscroll_speed()
click_mode()
scroll_mode()
tap_to_click()
disable_while_typing()
disable_with_external_mouse()
acceleration()
acceleration_bias()
vscroll_speed()
hscroll_speed()
click_mode()
scroll_mode()
tap_to_click()
- Class MinimalWindowManager
- Inheritance Relationships
- Class Documentation
miral::MinimalWindowManager
MinimalWindowManager()
MinimalWindowManager()
MinimalWindowManager()
MinimalWindowManager()
~MinimalWindowManager()
place_new_window()
handle_window_ready()
handle_modify_window()
handle_raise_window()
confirm_placement_on_display()
handle_keyboard_event()
handle_touch_event()
handle_pointer_event()
handle_request_move()
handle_request_resize()
confirm_inherited_move()
advise_focus_gained()
advise_focus_lost()
advise_new_app()
advise_delete_app()
advise_new_window()
advise_delete_window()
begin_pointer_move()
begin_pointer_resize()
begin_touch_move()
begin_touch_resize()
tools
- Class Output
- Nested Relationships
- Class Documentation
miral::Output
- Class WaylandExtensions
- Nested Relationships
- Class Documentation
miral::WaylandExtensions
zwlr_layer_shell_v1
zxdg_output_manager_v1
zwlr_foreign_toplevel_manager_v1
zwp_virtual_keyboard_manager_v1
zwp_input_method_v1
zwp_input_panel_v1
zwp_input_method_manager_v2
zwlr_screencopy_manager_v1
zwlr_virtual_pointer_manager_v1
ext_session_lock_manager_v1
add_extension()
add_extension_disabled_by_default()
enable()
disable()
conditionally_enable()
recommended()
supported()
Filter
EnableCallback
WaylandExtensions()
operator()()
~WaylandExtensions()
WaylandExtensions()
operator=()
all_supported()
miral::WaylandExtensions::Builder
miral::WaylandExtensions::Context
miral::WaylandExtensions::EnableInfo
- Class WindowManagementPolicy
- Inheritance Relationships
- Class Documentation
miral::WindowManagementPolicy
handle_window_ready()
handle_modify_window()
handle_raise_window()
confirm_placement_on_display()
handle_keyboard_event()
handle_touch_event()
handle_pointer_event()
advise_new_app()
advise_delete_app()
advise_new_window()
advise_focus_lost()
advise_focus_gained()
advise_state_change()
advise_move_to()
advise_resize()
advise_delete_window()
advise_raise()
advise_adding_to_workspace()
advise_removing_from_workspace()
handle_request_move()
handle_request_resize()
advise_output_create()
advise_output_update()
advise_output_delete()
advise_application_zone_create()
advise_application_zone_update()
advise_application_zone_delete()
advise_begin()
advise_end()
place_new_window()
confirm_inherited_move()
~WindowManagementPolicy()
WindowManagementPolicy()
WindowManagementPolicy()
operator=()
- Class WindowManagerTools
- Class Documentation
miral::WindowManagerTools
count_applications()
for_each_application()
find_application()
info_for()
info_for()
info_for()
info_for_window_id()
id_for_window()
ask_client_to_close()
active_window()
select_active_window()
drag_active_window()
drag_window()
focus_next_application()
focus_prev_application()
focus_next_within_application()
focus_prev_within_application()
window_to_select_application()
can_select_window()
window_at()
active_output()
active_application_zone()
raise_tree()
swap_tree_order()
send_tree_to_back()
modify_window()
modify_window()
place_and_size_for_state()
create_workspace()
add_tree_to_workspace()
remove_tree_from_workspace()
move_workspace_content_to_workspace()
for_each_workspace_containing()
for_each_window_in_workspace()
WindowManagerTools()
WindowManagerTools()
operator=()
~WindowManagerTools()
invoke_under_lock()
move_cursor_to()
- Class Documentation
- Class WindowSpecification
- Nested Relationships
- Class Documentation
miral::WindowSpecification
min_width()
min_height()
max_width()
max_height()
width_inc()
height_inc()
min_aspect()
max_aspect()
depth_layer()
depth_layer()
attached_edges()
attached_edges()
exclusive_rect()
exclusive_rect()
ignore_exclusion_zones()
ignore_exclusion_zones()
application_id()
application_id()
server_side_decorated()
server_side_decorated()
focus_mode()
focus_mode()
visible_on_lock_screen()
visible_on_lock_screen()
InputReceptionMode
WindowSpecification()
WindowSpecification()
operator=()
WindowSpecification()
~WindowSpecification()
top_left()
size()
name()
output_id()
type()
state()
preferred_orientation()
aux_rect()
placement_hints()
window_placement_gravity()
aux_rect_placement_gravity()
aux_rect_placement_offset()
min_width()
min_height()
max_width()
max_height()
width_inc()
height_inc()
min_aspect()
max_aspect()
parent()
input_shape()
input_mode()
shell_chrome()
confine_pointer()
userdata()
top_left()
size()
name()
output_id()
type()
state()
preferred_orientation()
aux_rect()
placement_hints()
window_placement_gravity()
aux_rect_placement_gravity()
aux_rect_placement_offset()
parent()
input_shape()
input_mode()
shell_chrome()
confine_pointer()
userdata()
miral::WindowSpecification::AspectRatio
- Class SurfaceObserver
- Class Documentation
miroil::SurfaceObserver
SurfaceObserver()
SurfaceObserver()
operator=()
~SurfaceObserver()
attrib_changed()
window_resized_to()
content_resized_to()
moved_to()
hidden_set_to()
frame_posted()
alpha_set_to()
orientation_set_to()
transformation_set_to()
cursor_image_set_to()
client_surface_close_requested()
keymap_changed()
renamed()
cursor_image_removed()
placed_relative()
input_consumed()
start_drag_and_drop()
depth_layer_set_to()
application_id_set_to()
- Class Documentation
- Class TilingWindowManagerPolicy
- Nested Relationships
- Inheritance Relationships
- Class Documentation
TilingWindowManagerPolicy
TilingWindowManagerPolicy()
place_new_window()
handle_window_ready()
handle_modify_window()
handle_keyboard_event()
handle_touch_event()
handle_pointer_event()
handle_raise_window()
advise_end()
advise_new_window()
advise_focus_gained()
advise_new_app()
advise_delete_app()
handle_request_move()
handle_request_resize()
confirm_inherited_move()
confirm_placement_on_display()
Enums¶
- Enum MirEventType
- Enum Documentation
MirEventType
mir_event_type_key
mir_event_type_motion
mir_event_type_window
mir_event_type_resize
mir_event_type_prompt_session_state_change
mir_event_type_orientation
mir_event_type_close_window
mir_event_type_input
mir_event_type_input_configuration
mir_event_type_window_output
mir_event_type_input_device_state
mir_event_type_window_placement
- Enum Documentation
- Enum MirInputEventModifier
- Enum Documentation
MirInputEventModifier
mir_input_event_modifier_none
mir_input_event_modifier_alt
mir_input_event_modifier_alt_left
mir_input_event_modifier_alt_right
mir_input_event_modifier_shift
mir_input_event_modifier_shift_left
mir_input_event_modifier_shift_right
mir_input_event_modifier_sym
mir_input_event_modifier_function
mir_input_event_modifier_ctrl
mir_input_event_modifier_ctrl_left
mir_input_event_modifier_ctrl_right
mir_input_event_modifier_meta
mir_input_event_modifier_meta_left
mir_input_event_modifier_meta_right
mir_input_event_modifier_caps_lock
mir_input_event_modifier_num_lock
mir_input_event_modifier_scroll_lock
- Enum Documentation
- Enum MirOutputType
- Enum Documentation
MirOutputType
mir_output_type_unknown
mir_output_type_vga
mir_output_type_dvii
mir_output_type_dvid
mir_output_type_dvia
mir_output_type_composite
mir_output_type_svideo
mir_output_type_lvds
mir_output_type_component
mir_output_type_ninepindin
mir_output_type_displayport
mir_output_type_hdmia
mir_output_type_hdmib
mir_output_type_tv
mir_output_type_edp
mir_output_type_virtual
mir_output_type_dsi
mir_output_type_dpi
- Enum Documentation