Typedef MirPlacementHints

• Defined in File common.h

Typedef Documentation

typedef enum MirPlacementHints MirPlacementHints

Positioning hints for aligning a window relative to a rectangle.

These hints determine how the window should be positioned in the case that the surface would fall off-screen if placed in its ideal position.

For example, mir_placement_hints_flip_x will invert the x component of aux_rect_placement_offset and replace mir_placement_gravity_northwest with mir_placement_gravity_northeast and vice versa if the window extends beyond the left or right edges of the monitor.

If mir_placement_hints_slide_x is set, the window can be shifted horizontally to fit on-screen.

If mir_placement_hints_resize_x is set, the window can be shrunken horizontally to fit.

If mir_placement_hints_antipodes is set then the rect gravity may be substituted with the opposite corner (e.g. mir_placement_gravity_northeast to mir_placement_gravity_southwest) in combination with other options.

When multiple flags are set, flipping should take precedence over sliding, which should take precedence over resizing.