SharedClipboard.h revision 2feb1c8e55e737875aba0cfd07e4bd5544621c7b
/** @file
*
* Shared Clipboard
*/
/*
* Copyright (C) 2006-2007 Sun Microsystems, Inc.
*
* 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.
*
* Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
* Clara, CA 95054 USA or visit http://www.sun.com if you need
* additional information or have any questions.
*/
#ifndef ___GUESTHOST_VBOXCLIPBOARD__H
#define ___GUESTHOST_VBOXCLIPBOARD__H
#include <iprt/cdefs.h>
#include <iprt/types.h>
enum {
/** The number of milliseconds before the clipboard times out. */
CLIPBOARD_TIMEOUT = 5000
};
/** 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;
/** A structure containing information about where to store a request
* for the X11 clipboard contents. */
struct _VBOXCLIPBOARDREQUEST
{
/** The buffer to write X11 clipboard data to (valid during a request
* for the clipboard contents) */
void *pv;
/** The size of the buffer to write X11 clipboard data to (valid during
* a request for the clipboard contents) */
unsigned cb;
/** The size of the X11 clipboard data written to the buffer (valid
* during a request for the clipboard contents) */
uint32_t *pcbActual;
/** The format VBox would like the data in */
uint32_t format;
/** Return code for the request processing code */
int rc;
/** Semaphore which is signalled when the request is completed */
RTSEMEVENT finished;
/** The clipboard context this request is associated with */
CLIPBACKEND *pCtx;
};
typedef struct _VBOXCLIPBOARDREQUEST VBOXCLIPBOARDREQUEST;
/* APIs exported by the X11 backend */
extern CLIPBACKEND *VBoxX11ClipboardConstructX11
(VBOXCLIPBOARDCONTEXT *pFrontend);
extern void VBoxX11ClipboardDestructX11(CLIPBACKEND *pBackend);
extern int VBoxX11ClipboardStartX11(CLIPBACKEND *pBackend);
extern int VBoxX11ClipboardStopX11(CLIPBACKEND *pBackend);
extern void VBoxX11ClipboardAnnounceVBoxFormat(CLIPBACKEND
*pBackend, uint32_t u32Formats);
extern int VBoxX11ClipboardReadX11Data(CLIPBACKEND *pBackend,
uint32_t u32Format,
void *pv, uint32_t cb,
uint32_t *pcbActual);
/* APIs exported by the X11/VBox frontend */
extern int VBoxX11ClipboardReadVBoxData(VBOXCLIPBOARDCONTEXT *pCtx,
uint32_t u32Format, void **ppv,
uint32_t *pcb);
extern void VBoxX11ClipboardReportX11Formats(VBOXCLIPBOARDCONTEXT *pCtx,
uint32_t u32Formats);
#endif /* ___GUESTHOST_VBOXCLIPBOARD__H */