IClipboard.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 <cstdint>
#include <string>


class IClipboard
{
public:
  virtual ~IClipboard() = default;

  using Time = uint32_t;


  enum class Format
  {
    Text,        
    HTML,        
    Bitmap,      
    TotalFormats 
  };




  virtual bool empty() = 0;


  virtual void add(Format, const std::string &data) = 0;




  virtual bool open(Time time) const = 0;


  virtual void close() const = 0;


  virtual Time getTime() const = 0;


  virtual bool has(Format) const = 0;


  virtual std::string get(Format) const = 0;


  static std::string marshall(const IClipboard *clipboard);


  static void unmarshall(IClipboard *clipboard, const std::string_view &data, Time time);


  static bool copy(IClipboard *dst, const IClipboard *src);


  static bool copy(IClipboard *dst, const IClipboard *src, Time);

 
private:
  static uint32_t readUInt32(const char *);
  static void writeUInt32(std::string *, uint32_t);
};