include/winpr/clipboard.h

 
#ifndef WINPR_CLIPBOARD_H
#define WINPR_CLIPBOARD_H
 
#include <winpr/winpr.h>
#include <winpr/wtypes.h>
 
typedef struct s_wClipboard wClipboard;
 
typedef void* (*CLIPBOARD_SYNTHESIZE_FN)(wClipboard* clipboard, UINT32 formatId, const void* data,
                                         UINT32* pSize);
 
typedef struct
{
  UINT32 streamId;
  UINT32 listIndex;
} wClipboardFileSizeRequest;
 
typedef struct
{
  UINT32 streamId;
  UINT32 listIndex;
  UINT32 nPositionLow;
  UINT32 nPositionHigh;
  UINT32 cbRequested;
} wClipboardFileRangeRequest;
 
typedef struct s_wClipboardDelegate wClipboardDelegate;
 
struct s_wClipboardDelegate
{
  wClipboard* clipboard;
  void* custom;
  char* basePath;
 
  WINPR_ATTR_NODISCARD UINT (*ClientRequestFileSize)(wClipboardDelegate*,
                                                     const wClipboardFileSizeRequest*);
  WINPR_ATTR_NODISCARD UINT (*ClipboardFileSizeSuccess)(wClipboardDelegate*,
                                                        const wClipboardFileSizeRequest*,
                                                        UINT64 fileSize);
  WINPR_ATTR_NODISCARD UINT (*ClipboardFileSizeFailure)(wClipboardDelegate*,
                                                        const wClipboardFileSizeRequest*,
                                                        UINT errorCode);
 
  WINPR_ATTR_NODISCARD UINT (*ClientRequestFileRange)(wClipboardDelegate*,
                                                      const wClipboardFileRangeRequest*);
  WINPR_ATTR_NODISCARD UINT (*ClipboardFileRangeSuccess)(wClipboardDelegate*,
                                                         const wClipboardFileRangeRequest*,
                                                         const BYTE* data, UINT32 size);
  WINPR_ATTR_NODISCARD UINT (*ClipboardFileRangeFailure)(wClipboardDelegate*,
                                                         const wClipboardFileRangeRequest*,
                                                         UINT errorCode);
 
  WINPR_ATTR_NODISCARD BOOL (*IsFileNameComponentValid)(LPCWSTR lpFileName);
};
 
#ifdef __cplusplus
extern "C"
{
#endif
 
  WINPR_API void ClipboardLock(wClipboard* clipboard);
  WINPR_API void ClipboardUnlock(wClipboard* clipboard);
 
  WINPR_API BOOL ClipboardEmpty(wClipboard* clipboard);
 
  WINPR_ATTR_NODISCARD
  WINPR_API UINT32 ClipboardCountFormats(wClipboard* clipboard);
 
  WINPR_ATTR_NODISCARD
  WINPR_API UINT32 ClipboardGetFormatIds(wClipboard* clipboard, UINT32** ppFormatIds);
 
  WINPR_ATTR_NODISCARD
  WINPR_API UINT32 ClipboardCountRegisteredFormats(wClipboard* clipboard);
 
  WINPR_ATTR_NODISCARD
  WINPR_API UINT32 ClipboardGetRegisteredFormatIds(wClipboard* clipboard, UINT32** ppFormatIds);
 
  WINPR_ATTR_NODISCARD
  WINPR_API UINT32 ClipboardRegisterFormat(wClipboard* clipboard, const char* name);
 
  WINPR_ATTR_NODISCARD
  WINPR_API BOOL ClipboardRegisterSynthesizer(wClipboard* clipboard, UINT32 formatId,
                                              UINT32 syntheticId,
                                              CLIPBOARD_SYNTHESIZE_FN pfnSynthesize);
 
  WINPR_ATTR_NODISCARD
  WINPR_API UINT32 ClipboardGetFormatId(wClipboard* clipboard, const char* name);
 
  WINPR_ATTR_NODISCARD
  WINPR_API const char* ClipboardGetFormatName(wClipboard* clipboard, UINT32 formatId);
 
  WINPR_ATTR_NODISCARD
  WINPR_API void* ClipboardGetData(wClipboard* clipboard, UINT32 formatId, UINT32* pSize);
 
  WINPR_ATTR_NODISCARD
  WINPR_API BOOL ClipboardSetData(wClipboard* clipboard, UINT32 formatId, const void* data,
                                  UINT32 size);
 
  WINPR_ATTR_NODISCARD
  WINPR_API UINT64 ClipboardGetOwner(wClipboard* clipboard);
  WINPR_API void ClipboardSetOwner(wClipboard* clipboard, UINT64 ownerId);
 
  WINPR_ATTR_NODISCARD
  WINPR_API wClipboardDelegate* ClipboardGetDelegate(wClipboard* clipboard);
 
  WINPR_API void ClipboardDestroy(wClipboard* clipboard);
 
  WINPR_ATTR_MALLOC(ClipboardDestroy, 1)
  WINPR_API wClipboard* ClipboardCreate(void);
 
  WINPR_ATTR_NODISCARD
  WINPR_API const char* ClipboardGetFormatIdString(UINT32 formatId);
 
#ifdef __cplusplus
}
#endif
 
#endif /* WINPR_CLIPBOARD_H */