ui_driver.h

Go to the documentation of this file.

 
#pragma once
 
#include <filesystem>
#include <span>
#include <string>
#include <string_view>
#include <vector>
 
#include <rex/driver.h>
#include <rex/input_keys.h>
#include <rex/memory/host.h>
#include <rex/result.h>
#include <rex/types.h>
#include <rex/platform/process.h>
#include <rex/ui/dialog.h>
#include <rex/platform/native_window.h>
#include <rex/ui/ui_event.h>
#include <rex/ui/window.h>
 
namespace rex::ui {

inline constexpr memory::Tag kUI{5};

class IUIDriver : public IDriver {
 public:
  virtual bool HasDisplay() const = 0;

  [[nodiscard]] virtual Result<void> OpenWindow(const WindowConfig& config) = 0;
 
  virtual void CloseUIWindow() = 0;
 
  virtual void SetTitle(std::string_view title) = 0;

  virtual void SetSize(u32 width, u32 height) = 0;

  virtual void SetLimits(u32 min_width, u32 min_height, ui::AspectRatio ratio) = 0;

  virtual void SetFullscreen(bool fullscreen, bool exclusive, i32 monitor, u32 mode_width,
                             u32 mode_height) = 0;
 
  virtual void RaiseWindow() = 0;

  virtual void SetCursorShape(bool visible, CursorShape shape) = 0;

  virtual void SetPointerMode(PointerMode mode) = 0;

  virtual void CaptureMouse(bool captured) = 0;

  virtual f32 GetContentScale() const = 0;

  virtual ui::WindowSize GetWindowSize() const = 0;
 
  virtual bool HasFocus() const = 0;

  virtual void SetTextInputActive(bool active) = 0;

  [[nodiscard]] virtual Result<NativeWindow> GetNativeWindow() const = 0;

  virtual bool WaitEvents(IUIEventListener& listener, u32 timeout_ms) = 0;

  virtual void WakeUp() = 0;

  [[nodiscard]] virtual Result<u32> ShowMessageBox(MessageType type, std::string_view title,
                                                   std::string_view body,
                                                   std::span<const std::string> buttons) = 0;

  [[nodiscard]] virtual Result<std::vector<std::filesystem::path>> ShowFileDialog(
      const ui::FileDialogConfig& config) = 0;
 
  virtual std::vector<ui::Monitor> GetDisplays() = 0;

  virtual std::vector<ui::HostLocale> GetPreferredLocales() = 0;

  virtual std::string GetClipboardText() = 0;

  virtual void SetClipboardText(std::string_view text) = 0;
};
 
}  // namespace rex::ui