mac_api_layer_interface.h

Go to the documentation of this file.

 
#pragma once
 
// local includes
#include "types.h"
 
namespace display_device {
  class MacApiLayerInterface {
  public:
    virtual ~MacApiLayerInterface() = default;
 
    [[nodiscard]] virtual bool isApiAccessAvailable() const = 0;
 
    [[nodiscard]] virtual std::string getErrorString(MacApiError error_code) const = 0;
 
    [[nodiscard]] virtual MacDisplayIdList getDisplayIds(MacQueryType type) const = 0;
 
    [[nodiscard]] virtual std::optional<MacPowerAssertionId> declareUserActivity(const std::string &reason) = 0;
 
    [[nodiscard]] virtual std::optional<MacPowerAssertionId> createDisplaySleepAssertion(const std::string &reason) = 0;
 
    [[nodiscard]] virtual bool releasePowerAssertion(MacPowerAssertionId assertion_id) = 0;
 
    [[nodiscard]] virtual std::string getDeviceId(MacDisplayId display_id) const = 0;
 
    [[nodiscard]] virtual std::optional<MacDisplayMode> getCurrentDisplayMode(MacDisplayId display_id) const = 0;
 
    [[nodiscard]] virtual MacDisplayModeList getDisplayModes(MacDisplayId display_id) const = 0;
 
    [[nodiscard]] virtual std::string getDisplayName(MacDisplayId display_id) const = 0;
 
    [[nodiscard]] virtual std::string getFriendlyName(MacDisplayId display_id) const = 0;
 
    [[nodiscard]] virtual std::vector<std::byte> getEdid(MacDisplayId display_id) const = 0;
 
    [[nodiscard]] virtual std::optional<Rational> getDisplayScale(MacDisplayId display_id) const = 0;
 
    [[nodiscard]] virtual std::optional<Point> getOriginPoint(MacDisplayId display_id) const = 0;
 
    [[nodiscard]] virtual bool isMainDisplay(MacDisplayId display_id) const = 0;
 
    [[nodiscard]] virtual bool isActive(MacDisplayId display_id) const = 0;
 
    [[nodiscard]] virtual bool isOnline(MacDisplayId display_id) const = 0;
 
    [[nodiscard]] virtual MacDisplayId getMirrorMaster(MacDisplayId display_id) const = 0;
 
    [[nodiscard]] virtual bool setDisplayMode(MacDisplayId display_id, const MacDisplayMode &mode) = 0;
 
    [[nodiscard]] virtual bool setOriginPoint(MacDisplayId display_id, const Point &origin) = 0;
 
    [[nodiscard]] virtual bool setMirror(MacDisplayId display_id, MacDisplayId master_display_id) = 0;
  };
}  // namespace display_device