Screen.h

Go to the documentation of this file.

/*
 * Deskflow -- mouse and keyboard sharing utility
 * 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/IScreen.h"
#include "deskflow/KeyTypes.h"
#include "deskflow/MouseTypes.h"
#include "deskflow/OptionTypes.h"
 
#include <string>
 
class IClipboard;
class IPlatformScreen;
class IEventQueue;
 
namespace deskflow {


class Screen : public IScreen
{
public:
  Screen(IPlatformScreen *platformScreen, IEventQueue *events);
  Screen(Screen const &) = delete;
  Screen(Screen &&) = delete;
  ~Screen() override;
 
  Screen &operator&(Screen const &) = delete;
  Screen &operator&(Screen &&) = delete;




  void enable();


  void disable();


  void enter(KeyModifierMask toggleMask);


  bool leave();


  void reconfigure(uint32_t activeSides);


  void warpCursor(int32_t x, int32_t y);


  void setClipboard(ClipboardID, const IClipboard *);


  void grabClipboard(ClipboardID);


  void screensaver(bool activate) const;


  void keyDown(KeyID id, KeyModifierMask, KeyButton, const std::string &);


  void keyRepeat(KeyID id, KeyModifierMask, int32_t count, KeyButton, const std::string &lang);


  void keyUp(KeyID id, KeyModifierMask, KeyButton);


  void mouseDown(ButtonID id);


  void mouseUp(ButtonID id);


  void mouseMove(int32_t xAbs, int32_t yAbs);


  void mouseRelativeMove(int32_t xRel, int32_t yRel) const;


  void mouseWheel(int32_t xDelta, int32_t yDelta) const;


  void resetOptions();


  void setOptions(const OptionsList &options);


  void setSequenceNumber(uint32_t);


  uint32_t registerHotKey(KeyID key, KeyModifierMask mask);


  void unregisterHotKey(uint32_t id);


  void fakeInputBegin();


  void fakeInputEnd();


  std::string getSecureInputApp() const;




  bool isOnScreen() const;


  bool isLockedToScreen() const;


  int32_t getJumpZoneSize() const;


  void getCursorCenter(int32_t &x, int32_t &y) const;


  KeyModifierMask getActiveModifiers() const;


  KeyModifierMask pollActiveModifiers() const;

 
  // IScreen overrides
  void *getEventTarget() const override;
  bool getClipboard(ClipboardID id, IClipboard *) const override;
  void getShape(int32_t &x, int32_t &y, int32_t &width, int32_t &height) const override;
  void getCursorPos(int32_t &x, int32_t &y) const override;
 
  IPlatformScreen *getPlatformScreen()
  {
    return m_screen;
  }
 
protected:
  void enablePrimary();
  void enableSecondary();
  void disablePrimary();
  void disableSecondary();
 
  void enterPrimary() const;
  void enterSecondary(KeyModifierMask toggleMask) const;
  void leavePrimary();
  void leaveSecondary();
 
private:
  // our platform dependent screen
  IPlatformScreen *m_screen = nullptr;
 
  // true if screen is being used as a primary screen, false otherwise
  bool m_isPrimary = false;
 
  // true if screen is enabled
  bool m_enabled = false;
 
  // true if the cursor is on this screen
  bool m_entered = false;
 
  // note toggle keys that toggles on up/down (false) or on
  // transition (true)
  KeyModifierMask m_halfDuplex;
 
  // true if we're faking input on a primary screen
  bool m_fakeInput = false;
 
  IEventQueue *m_events = nullptr;
};
 
} // namespace deskflow