VirtualBox

source: vbox/trunk/include/VBox/HostServices/VBoxClipboardSvc.h@ 34373

Last change on this file since 34373 was 28800, checked in by vboxsync, 15 years ago

Automated rebranding to Oracle copyright/license strings via filemuncher

  • Property svn:eol-style set to native
File size: 4.0 KB
Line 
1/** @file
2 * Shared Clipboard:
3 * Common header for host service and guest clients.
4 */
5
6/*
7 * Copyright (C) 2006-2007 Oracle Corporation
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
27#ifndef ___VBox_HostService_VBoxClipboardSvc_h
28#define ___VBox_HostService_VBoxClipboardSvc_h
29
30#include <VBox/types.h>
31#include <VBox/VMMDev.h>
32#include <VBox/VBoxGuest2.h>
33#include <VBox/hgcmsvc.h>
34
35/*
36 * The mode of operations.
37 */
38#define VBOX_SHARED_CLIPBOARD_MODE_OFF 0
39#define VBOX_SHARED_CLIPBOARD_MODE_HOST_TO_GUEST 1
40#define VBOX_SHARED_CLIPBOARD_MODE_GUEST_TO_HOST 2
41#define VBOX_SHARED_CLIPBOARD_MODE_BIDIRECTIONAL 3
42
43/*
44 * Supported data formats. Bit mask.
45 */
46#define VBOX_SHARED_CLIPBOARD_FMT_UNICODETEXT 0x01
47#define VBOX_SHARED_CLIPBOARD_FMT_BITMAP 0x02
48#define VBOX_SHARED_CLIPBOARD_FMT_HTML 0x04
49
50/*
51 * The service functions which are callable by host.
52 */
53#define VBOX_SHARED_CLIPBOARD_HOST_FN_SET_MODE 1
54
55/*
56 * The service functions which are called by guest.
57 */
58/* Call host and wait blocking for an host event VBOX_SHARED_CLIPBOARD_HOST_MSG_* */
59#define VBOX_SHARED_CLIPBOARD_FN_GET_HOST_MSG 1
60/* Send list of available formats to host. */
61#define VBOX_SHARED_CLIPBOARD_FN_FORMATS 2
62/* Obtain data in specified format from host. */
63#define VBOX_SHARED_CLIPBOARD_FN_READ_DATA 3
64/* Send data in requested format to host. */
65#define VBOX_SHARED_CLIPBOARD_FN_WRITE_DATA 4
66
67/*
68 * The host messages for the guest.
69 */
70#define VBOX_SHARED_CLIPBOARD_HOST_MSG_QUIT 1
71#define VBOX_SHARED_CLIPBOARD_HOST_MSG_READ_DATA 2
72#define VBOX_SHARED_CLIPBOARD_HOST_MSG_FORMATS 3
73
74/*
75 * HGCM parameter structures.
76 */
77#pragma pack (1)
78typedef struct _VBoxClipboardGetHostMsg
79{
80 VBoxGuestHGCMCallInfo hdr;
81
82 /* VBOX_SHARED_CLIPBOARD_HOST_MSG_* */
83 HGCMFunctionParameter msg; /* OUT uint32_t */
84
85 /* VBOX_SHARED_CLIPBOARD_FMT_*, depends on the 'msg'. */
86 HGCMFunctionParameter formats; /* OUT uint32_t */
87} VBoxClipboardGetHostMsg;
88
89#define VBOX_SHARED_CLIPBOARD_CPARMS_GET_HOST_MSG 2
90
91typedef struct _VBoxClipboardFormats
92{
93 VBoxGuestHGCMCallInfo hdr;
94
95 /* VBOX_SHARED_CLIPBOARD_FMT_* */
96 HGCMFunctionParameter formats; /* OUT uint32_t */
97} VBoxClipboardFormats;
98
99#define VBOX_SHARED_CLIPBOARD_CPARMS_FORMATS 1
100
101typedef struct _VBoxClipboardReadData
102{
103 VBoxGuestHGCMCallInfo hdr;
104
105 /* Requested format. */
106 HGCMFunctionParameter format; /* IN uint32_t */
107
108 /* The data buffer. */
109 HGCMFunctionParameter ptr; /* IN linear pointer. */
110
111 /* Size of returned data, if > ptr->cb, then no data was
112 * actually transferred and the guest must repeat the call.
113 */
114 HGCMFunctionParameter size; /* OUT uint32_t */
115
116} VBoxClipboardReadData;
117
118#define VBOX_SHARED_CLIPBOARD_CPARMS_READ_DATA 3
119
120typedef struct _VBoxClipboardWriteData
121{
122 VBoxGuestHGCMCallInfo hdr;
123
124 /* Returned format as requested in the VBOX_SHARED_CLIPBOARD_HOST_MSG_READ_DATA message. */
125 HGCMFunctionParameter format; /* IN uint32_t */
126
127 /* Data. */
128 HGCMFunctionParameter ptr; /* IN linear pointer. */
129} VBoxClipboardWriteData;
130
131#define VBOX_SHARED_CLIPBOARD_CPARMS_WRITE_DATA 2
132
133#pragma pack ()
134
135#endif
Note: See TracBrowser for help on using the repository browser.

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette