summaryrefslogtreecommitdiffstats
path: root/include/VBox/GuestHost/SharedClipboard.h
diff options
context:
space:
mode:
Diffstat (limited to 'include/VBox/GuestHost/SharedClipboard.h')
-rw-r--r--include/VBox/GuestHost/SharedClipboard.h82
1 files changed, 82 insertions, 0 deletions
diff --git a/include/VBox/GuestHost/SharedClipboard.h b/include/VBox/GuestHost/SharedClipboard.h
new file mode 100644
index 00000000..28d44eb3
--- /dev/null
+++ b/include/VBox/GuestHost/SharedClipboard.h
@@ -0,0 +1,82 @@
+/** @file
+ * Shared Clipboard - Common Guest and Host Code.
+ */
+
+/*
+ * Copyright (C) 2006-2019 Oracle Corporation
+ *
+ * This file is part of VirtualBox Open Source Edition (OSE), as
+ * available from http://www.virtualbox.org. This file is free software;
+ * you can redistribute it and/or modify it under the terms of the GNU
+ * General Public License (GPL) as published by the Free Software
+ * Foundation, in version 2 as it comes in the "COPYING" file of the
+ * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
+ * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
+ *
+ * The contents of this file may alternatively be used under the terms
+ * of the Common Development and Distribution License Version 1.0
+ * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
+ * VirtualBox OSE distribution, in which case the provisions of the
+ * CDDL are applicable instead of those of the GPL.
+ *
+ * You may elect to license modified versions of this file under the
+ * terms and conditions of either the GPL or the CDDL or both.
+ */
+
+#ifndef VBOX_INCLUDED_GuestHost_SharedClipboard_h
+#define VBOX_INCLUDED_GuestHost_SharedClipboard_h
+#ifndef RT_WITHOUT_PRAGMA_ONCE
+# pragma once
+#endif
+
+#include <iprt/cdefs.h>
+#include <iprt/types.h>
+
+enum
+{
+ /** The number of milliseconds before the clipboard times out. */
+#ifndef TESTCASE
+ CLIPBOARD_TIMEOUT = 5000
+#else
+ CLIPBOARD_TIMEOUT = 1
+#endif
+};
+
+/** Opaque data structure for the X11/VBox frontend/glue code. */
+struct _VBOXCLIPBOARDCONTEXT;
+typedef struct _VBOXCLIPBOARDCONTEXT VBOXCLIPBOARDCONTEXT;
+
+/** Opaque data structure for the X11/VBox backend code. */
+struct _CLIPBACKEND;
+typedef struct _CLIPBACKEND CLIPBACKEND;
+
+/** Opaque request structure for clipboard data.
+ * @todo All use of single and double underscore prefixes is banned! */
+struct _CLIPREADCBREQ;
+typedef struct _CLIPREADCBREQ CLIPREADCBREQ;
+
+/* APIs exported by the X11 backend */
+extern CLIPBACKEND *ClipConstructX11(VBOXCLIPBOARDCONTEXT *pFrontend, bool fHeadless);
+extern void ClipDestructX11(CLIPBACKEND *pBackend);
+#ifdef __cplusplus
+extern int ClipStartX11(CLIPBACKEND *pBackend, bool grab = false);
+#else
+extern int ClipStartX11(CLIPBACKEND *pBackend, bool grab);
+#endif
+extern int ClipStopX11(CLIPBACKEND *pBackend);
+extern void ClipAnnounceFormatToX11(CLIPBACKEND *pBackend,
+ uint32_t u32Formats);
+extern int ClipRequestDataFromX11(CLIPBACKEND *pBackend, uint32_t u32Format,
+ CLIPREADCBREQ *pReq);
+
+/* APIs exported by the X11/VBox frontend */
+extern int ClipRequestDataForX11(VBOXCLIPBOARDCONTEXT *pCtx,
+ uint32_t u32Format, void **ppv,
+ uint32_t *pcb);
+extern void ClipReportX11Formats(VBOXCLIPBOARDCONTEXT *pCtx,
+ uint32_t u32Formats);
+extern void ClipCompleteDataRequestFromX11(VBOXCLIPBOARDCONTEXT *pCtx, int rc,
+ CLIPREADCBREQ *pReq, void *pv,
+ uint32_t cb);
+#endif /* !VBOX_INCLUDED_GuestHost_SharedClipboard_h */
+