VirtualBox

source: vbox/trunk/include/VBox/HostServices/VBoxClipboardExt.h@ 103224

Last change on this file since 103224 was 100655, checked in by vboxsync, 17 months ago

Shared Clipboard/VRDE: Integrated the logic of ShClSvcIsBackendActive() in ShClSvcReportFormats(), so that the specific backends don't need to be in charge for that anymore. Renamed VBOX_CLIPBOARD_EXT_FN_FORMAT_ANNOUNCE -> VBOX_CLIPBOARD_EXT_FN_FORMAT_REPORT_TO_HOST to emphasize its usage. Added VBOX_CLIPBOARD_EXT_FN_FORMAT_REPORT_TO_GUEST; see comment for details.

The whole concept of VRDE being a (one and only) service extension nowadays isn't optimal anymore and needs to be replaced with a more generic mechanism, which is out of this scope for this task. So just adapt this as needed and keep the current way.

bugref:9437

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 3.8 KB
Line 
1/** @file
2 * Shared Clipboard - Common header for the service extension.
3 */
4
5/*
6 * Copyright (C) 2006-2023 Oracle and/or its affiliates.
7 *
8 * This file is part of VirtualBox base platform packages, as
9 * available from https://www.virtualbox.org.
10 *
11 * This program is free software; you can redistribute it and/or
12 * modify it under the terms of the GNU General Public License
13 * as published by the Free Software Foundation, in version 3 of the
14 * License.
15 *
16 * This program is distributed in the hope that it will be useful, but
17 * WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
19 * General Public License for more details.
20 *
21 * You should have received a copy of the GNU General Public License
22 * along with this program; if not, see <https://www.gnu.org/licenses>.
23 *
24 * The contents of this file may alternatively be used under the terms
25 * of the Common Development and Distribution License Version 1.0
26 * (CDDL), a copy of it is provided in the "COPYING.CDDL" file included
27 * in the VirtualBox distribution, in which case the provisions of the
28 * CDDL are applicable instead of those of the GPL.
29 *
30 * You may elect to license modified versions of this file under the
31 * terms and conditions of either the GPL or the CDDL or both.
32 *
33 * SPDX-License-Identifier: GPL-3.0-only OR CDDL-1.0
34 */
35
36#ifndef VBOX_INCLUDED_HostServices_VBoxClipboardExt_h
37#define VBOX_INCLUDED_HostServices_VBoxClipboardExt_h
38#ifndef RT_WITHOUT_PRAGMA_ONCE
39# pragma once
40#endif
41
42#include <VBox/types.h>
43#include <VBox/GuestHost/SharedClipboard.h>
44#ifdef VBOX_WITH_SHARED_CLIPBOARD_TRANSFERS
45# include <VBox/GuestHost/SharedClipboard-transfers.h>
46#endif
47
48/** Sets (or unsets) a clipboard extension callback. */
49#define VBOX_CLIPBOARD_EXT_FN_SET_CALLBACK (0)
50/** The guest reports clipboard formats to the extension. */
51#define VBOX_CLIPBOARD_EXT_FN_FORMAT_REPORT_TO_HOST (1)
52/** The clipboard service wants to report formats to the guest. */
53#define VBOX_CLIPBOARD_EXT_FN_FORMAT_REPORT_TO_GUEST (2)
54/** The clipboard service requests clipboard data from the extension. */
55#define VBOX_CLIPBOARD_EXT_FN_DATA_READ (3)
56/** The clipboard service writes clipboard data to the extension. */
57#define VBOX_CLIPBOARD_EXT_FN_DATA_WRITE (4)
58/** The clipboard service announces an error to the extension. */
59#define VBOX_CLIPBOARD_EXT_FN_ERROR (5)
60
61typedef DECLCALLBACKTYPE(int, FNSHCLEXTCALLBACK,(uint32_t u32Function, uint32_t u32Format, void *pvData, uint32_t cbData));
62typedef FNSHCLEXTCALLBACK *PFNSHCLEXTCALLBACK;
63
64/**
65 * Structure for holding Shared Clipboard service extension parameters.
66 */
67typedef struct _SHCLEXTPARMS
68{
69 union
70 {
71 /** Reports clipboard formats. */
72 struct
73 {
74 SHCLFORMATS uFormats;
75 } ReportFormats;
76 /** Reads / writes clipboard data. */
77 struct
78 {
79 SHCLFORMAT uFormat;
80 void *pvData;
81 uint32_t cbData;
82 } ReadWriteData;
83 /** Sets a read / write callback. */
84 struct
85 {
86 PFNSHCLEXTCALLBACK
87 pfnCallback;
88 } SetCallback;
89 /** Reports a clipboard error. */
90 struct
91 {
92 /** Clipboard ID. Optional and can be NULL. */
93 char *pszId;
94 /** User friendly error message. */
95 char *pszMsg;
96 /** IPRT-style error code. */
97 int rc;
98 } Error;
99 } u;
100} SHCLEXTPARMS;
101/** Pointer to Shared Clipboard service extension parameters. */
102typedef SHCLEXTPARMS *PSHCLEXTPARMS;
103
104#endif /* !VBOX_INCLUDED_HostServices_VBoxClipboardExt_h */
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