zone.h

Go to the documentation of this file.

/*
 * Copyright © Canonical Ltd.
 *
 * This program is free software: you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 or 3 as
 * published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
 
#ifndef MIRAL_ZONE_H
#define MIRAL_ZONE_H
 
#include <mir_toolkit/common.h>
 
#include <mir/geometry/rectangle.h>
#include <mir/int_wrapper.h>
 
#include <memory>
 
namespace miral
{
using namespace mir::geometry;
 
/// A rectangular area of the display.
/// Not tied to a specific output.
class Zone
{
public:
 
    Zone(Rectangle const& extents); ///< Create a new zone with the given extents
    Zone(Zone const& other); ///< Makes a copy of the underlying private data
    Zone& operator=(Zone const& other); ///< Copies private data by value
    ~Zone();
 
    /// Returns true only if all properties including IDs match
    auto operator==(Zone const& other) const -> bool;
 
    /// Returns if true if zone IDs match, even if extents are different
    auto is_same_zone(Zone const& other) const -> bool;
 
    /// The area of this zone in global display coordinates
    auto extents() const -> Rectangle;
 
    /// Set the extents of this zone
    /// Does not make this a different zone
    void extents(Rectangle const& extents);
 
    /// An arbitrary number that uniquely identifies this zone, reguardless of how it is resized and moved
    /// \remark Since MirAL 3.6
    auto id() const -> int;
 
private:
    class Self;
    std::unique_ptr<Self> self;
};
}
 
#endif // MIRAL_ZONE_H