miral::Zone Class Reference

A rectangular area of the display. Not tied to a specific output. More...

#include <zone.h>

Public Member Functions
	Zone (Rectangle const &extents)
	Create a new zone with the given extents. More...
	Zone (Zone const &other)
	Makes a copy of the underlying private data. More...
Zone &	operator= (Zone const &other)
	Copies private data by value. More...
	~Zone ()
auto	operator== (Zone const &other) const -> bool
	Returns true only if all properties including IDs match. More...
auto	is_same_zone (Zone const &other) const -> bool
	Returns if true if zone IDs match, even if extents are different. More...
auto	extents () const -> Rectangle
	The area of this zone in global display coordinates. More...
void	extents (Rectangle const &extents)
	Set the extents of this zone Does not make this a different zone. More...
auto	id () const -> int
	An arbitrary number that uniquely identifies this zone, reguardless of how it is resized and moved. More...

Detailed Description

A rectangular area of the display. Not tied to a specific output.

Constructor & Destructor Documentation

Zone() [1/2]

miral::Zone::Zone

(

Rectangle const &

extents

)

Create a new zone with the given extents.

Zone() [2/2]

miral::Zone::Zone

(

Zone const &

other

)

Makes a copy of the underlying private data.

~Zone()

miral::Zone::~Zone

(

)

Member Function Documentation

extents() [1/2]

auto miral::Zone::extents

(

)

const -> Rectangle

The area of this zone in global display coordinates.

extents() [2/2]

void miral::Zone::extents

(

Rectangle const &

extents

)

Set the extents of this zone Does not make this a different zone.

id()

auto miral::Zone::id

(

)

const -> int

An arbitrary number that uniquely identifies this zone, reguardless of how it is resized and moved.

Remarks

Since MirAL 3.6

is_same_zone()

auto miral::Zone::is_same_zone

(

Zone const &

other

)

const -> bool

Returns if true if zone IDs match, even if extents are different.

operator=()

Zone & miral::Zone::operator=

(

Zone const &

other

)

Copies private data by value.

operator==()

auto miral::Zone::operator==

(

Zone const &

other

)

const -> bool

Returns true only if all properties including IDs match.

---

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

• include/miral/miral/zone.h