| 1 | /** @file
|
|---|
| 2 | *
|
|---|
| 3 | * Shared Clipboard
|
|---|
| 4 | */
|
|---|
| 5 |
|
|---|
| 6 | /*
|
|---|
| 7 | * Copyright (C) 2006-2007 Sun Microsystems, Inc.
|
|---|
| 8 | *
|
|---|
| 9 | * This file is part of VirtualBox Open Source Edition (OSE), as
|
|---|
| 10 | * available from http://www.virtualbox.org. This file is free software;
|
|---|
| 11 | * you can redistribute it and/or modify it under the terms of the GNU
|
|---|
| 12 | * General Public License (GPL) as published by the Free Software
|
|---|
| 13 | * Foundation, in version 2 as it comes in the "COPYING" file of the
|
|---|
| 14 | * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
|
|---|
| 15 | * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
|
|---|
| 16 | *
|
|---|
| 17 | * The contents of this file may alternatively be used under the terms
|
|---|
| 18 | * of the Common Development and Distribution License Version 1.0
|
|---|
| 19 | * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
|
|---|
| 20 | * VirtualBox OSE distribution, in which case the provisions of the
|
|---|
| 21 | * CDDL are applicable instead of those of the GPL.
|
|---|
| 22 | *
|
|---|
| 23 | * You may elect to license modified versions of this file under the
|
|---|
| 24 | * terms and conditions of either the GPL or the CDDL or both.
|
|---|
| 25 | *
|
|---|
| 26 | * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
|
|---|
| 27 | * Clara, CA 95054 USA or visit http://www.sun.com if you need
|
|---|
| 28 | * additional information or have any questions.
|
|---|
| 29 | */
|
|---|
| 30 |
|
|---|
| 31 | #ifndef ___GUESTHOST_VBOXCLIPBOARD__H
|
|---|
| 32 | #define ___GUESTHOST_VBOXCLIPBOARD__H
|
|---|
| 33 |
|
|---|
| 34 | #include <iprt/cdefs.h>
|
|---|
| 35 | #include <iprt/types.h>
|
|---|
| 36 |
|
|---|
| 37 | enum {
|
|---|
| 38 | /** The number of milliseconds before the clipboard times out. */
|
|---|
| 39 | CLIPBOARDTIMEOUT = 5000
|
|---|
| 40 | };
|
|---|
| 41 |
|
|---|
| 42 | /** Opaque data structure for the X11/VBox frontend/glue code. */
|
|---|
| 43 | struct _VBOXCLIPBOARDCONTEXT;
|
|---|
| 44 | typedef struct _VBOXCLIPBOARDCONTEXT VBOXCLIPBOARDCONTEXT;
|
|---|
| 45 |
|
|---|
| 46 | /** Opaque data structure for the X11/VBox backend code. */
|
|---|
| 47 | struct _VBOXCLIPBOARDCONTEXTX11;
|
|---|
| 48 | typedef struct _VBOXCLIPBOARDCONTEXTX11 VBOXCLIPBOARDCONTEXTX11;
|
|---|
| 49 |
|
|---|
| 50 | /** Does X11 or VBox currently own the clipboard? */
|
|---|
| 51 | /** @todo This is ugly, get rid of it. */
|
|---|
| 52 | enum g_eOwner { NONE = 0, X11, VB };
|
|---|
| 53 |
|
|---|
| 54 | /** A structure containing information about where to store a request
|
|---|
| 55 | * for the X11 clipboard contents. */
|
|---|
| 56 | struct _VBOXCLIPBOARDREQUEST
|
|---|
| 57 | {
|
|---|
| 58 | /** The buffer to write X11 clipboard data to (valid during a request
|
|---|
| 59 | * for the clipboard contents) */
|
|---|
| 60 | void *pv;
|
|---|
| 61 | /** The size of the buffer to write X11 clipboard data to (valid during
|
|---|
| 62 | * a request for the clipboard contents) */
|
|---|
| 63 | unsigned cb;
|
|---|
| 64 | /** The size of the X11 clipboard data written to the buffer (valid
|
|---|
| 65 | * during a request for the clipboard contents) */
|
|---|
| 66 | uint32_t *pcbActual;
|
|---|
| 67 | /** Return code for the request processing code */
|
|---|
| 68 | int rc;
|
|---|
| 69 | /** The clipboard context this request is associated with */
|
|---|
| 70 | VBOXCLIPBOARDCONTEXTX11 *pCtx;
|
|---|
| 71 | };
|
|---|
| 72 |
|
|---|
| 73 | typedef struct _VBOXCLIPBOARDREQUEST VBOXCLIPBOARDREQUEST;
|
|---|
| 74 |
|
|---|
| 75 | /* APIs exported by the X11 backend */
|
|---|
| 76 | extern VBOXCLIPBOARDCONTEXTX11 *VBoxX11ClipboardConstructX11
|
|---|
| 77 | (VBOXCLIPBOARDCONTEXT *pFrontend);
|
|---|
| 78 | extern void VBoxX11ClipboardDestructX11(VBOXCLIPBOARDCONTEXTX11 *pBackend);
|
|---|
| 79 | extern int VBoxX11ClipboardStartX11(VBOXCLIPBOARDCONTEXTX11 *pBackend,
|
|---|
| 80 | bool fOwnsClipboard);
|
|---|
| 81 | extern int VBoxX11ClipboardStopX11(VBOXCLIPBOARDCONTEXTX11 *pBackend);
|
|---|
| 82 | extern void VBoxX11ClipboardRequestSyncX11(VBOXCLIPBOARDCONTEXTX11 *pBackend);
|
|---|
| 83 | extern void VBoxX11ClipboardAnnounceVBoxFormat(VBOXCLIPBOARDCONTEXTX11
|
|---|
| 84 | *pBackend, uint32_t u32Formats);
|
|---|
| 85 | extern int VBoxX11ClipboardReadX11Data(VBOXCLIPBOARDCONTEXTX11 *pBackend,
|
|---|
| 86 | uint32_t u32Format,
|
|---|
| 87 | VBOXCLIPBOARDREQUEST *pRequest);
|
|---|
| 88 |
|
|---|
| 89 | /* APIs exported by the X11/VBox frontend */
|
|---|
| 90 | extern int VBoxX11ClipboardReadVBoxData(VBOXCLIPBOARDCONTEXT *pCtx,
|
|---|
| 91 | uint32_t u32Format, void **ppv,
|
|---|
| 92 | uint32_t *pcb);
|
|---|
| 93 | extern void VBoxX11ClipboardReportX11Formats(VBOXCLIPBOARDCONTEXT *pCtx,
|
|---|
| 94 | uint32_t u32Formats);
|
|---|
| 95 | #endif /* ___GUESTHOST_VBOXCLIPBOARD__H */
|
|---|
