IPlatformScreen.h

Go to the documentation of this file.

/*
 * Deskflow -- mouse and keyboard sharing utility
 * SPDX-FileCopyrightText: (C) 2025 Deskflow Developers
 * SPDX-FileCopyrightText: (C) 2012 - 2016 Symless Ltd.
 * SPDX-FileCopyrightText: (C) 2002 Chris Schoeneman
 * SPDX-License-Identifier: GPL-2.0-only WITH LicenseRef-OpenSSL-Exception
 */
 
#pragma once
 
#include "deskflow/ClipboardTypes.h"
#include "deskflow/IKeyState.h"
#include "deskflow/IPrimaryScreen.h"
#include "deskflow/IScreen.h"
#include "deskflow/ISecondaryScreen.h"
#include "deskflow/OptionTypes.h"
 
class IClipboard;


class IPlatformScreen : public IScreen, public IPrimaryScreen, public ISecondaryScreen, public IKeyState
{
public:

 
  explicit IPlatformScreen(const IEventQueue *events) : IKeyState(events)
  {
    // do nothing
  }


  virtual void enable() = 0;


  virtual void disable() = 0;


  virtual void enter() = 0;


  virtual bool canLeave() = 0;


  virtual void leave() = 0;


  virtual bool setClipboard(ClipboardID id, const IClipboard *) = 0;


  virtual void checkClipboards() = 0;


  virtual void openScreensaver(bool notify) = 0;


  virtual void closeScreensaver() = 0;


  virtual void screensaver(bool activate) = 0;


  virtual void resetOptions() = 0;


  virtual void setOptions(const OptionsList &options) = 0;


  virtual void setSequenceNumber(uint32_t) = 0;


  virtual std::string getSecureInputApp() const = 0;




  virtual bool isPrimary() const = 0;

 
  // IScreen overrides
  void *getEventTarget() const override = 0;
  bool getClipboard(ClipboardID id, IClipboard *) const override = 0;
  void getShape(int32_t &x, int32_t &y, int32_t &width, int32_t &height) const override = 0;
  void getCursorPos(int32_t &x, int32_t &y) const override = 0;
 
  // IPrimaryScreen overrides
  void reconfigure(uint32_t activeSides) override = 0;
  uint32_t activeSides() override = 0;
  void warpCursor(int32_t x, int32_t y) override = 0;
  uint32_t registerHotKey(KeyID key, KeyModifierMask mask) override = 0;
  void unregisterHotKey(uint32_t id) override = 0;
  void fakeInputBegin() override = 0;
  void fakeInputEnd() override = 0;
  int32_t getJumpZoneSize() const override = 0;
  bool isAnyMouseButtonDown(uint32_t &buttonID) const override = 0;
  void getCursorCenter(int32_t &x, int32_t &y) const override = 0;
 
  // ISecondaryScreen overrides
  void fakeMouseButton(ButtonID id, bool press) override = 0;
  void fakeMouseMove(int32_t x, int32_t y) override = 0;
  void fakeMouseRelativeMove(int32_t dx, int32_t dy) const override = 0;
  void fakeMouseWheel(int32_t xDelta, int32_t yDelta) const override = 0;
 
  // IKeyState overrides
  void updateKeyMap() override = 0;
  void updateKeyState() override = 0;
  void setHalfDuplexMask(KeyModifierMask) override = 0;
  void fakeKeyDown(KeyID id, KeyModifierMask mask, KeyButton button, const std::string &lang) override = 0;
  bool
  fakeKeyRepeat(KeyID id, KeyModifierMask mask, int32_t count, KeyButton button, const std::string &lang) override = 0;
  bool fakeKeyUp(KeyButton button) override = 0;
  void fakeAllKeysUp() override = 0;
  bool fakeCtrlAltDel() override = 0;
  bool fakeMediaKey(KeyID id) override;
  bool isKeyDown(KeyButton) const override = 0;
  KeyModifierMask getActiveModifiers() const override = 0;
  KeyModifierMask pollActiveModifiers() const override = 0;
  int32_t pollActiveGroup() const override = 0;
  void pollPressedKeys(KeyButtonSet &pressedKeys) const override = 0;
 
protected:

  virtual void handleSystemEvent(const Event &event) = 0;
};