| 1 | /* $Id: wayland-helper.h 100246 2023-06-22 10:55:10Z vboxsync $ */
|
|---|
| 2 | /** @file
|
|---|
| 3 | * Guest Additions - Definitions for Wayland Desktop Environments helpers.
|
|---|
| 4 | */
|
|---|
| 5 |
|
|---|
| 6 | /*
|
|---|
| 7 | * Copyright (C) 2006-2023 Oracle and/or its affiliates.
|
|---|
| 8 | *
|
|---|
| 9 | * This file is part of VirtualBox base platform packages, as
|
|---|
| 10 | * available from https://www.alldomusa.eu.org.
|
|---|
| 11 | *
|
|---|
| 12 | * This program is free software; you can redistribute it and/or
|
|---|
| 13 | * modify it under the terms of the GNU General Public License
|
|---|
| 14 | * as published by the Free Software Foundation, in version 3 of the
|
|---|
| 15 | * License.
|
|---|
| 16 | *
|
|---|
| 17 | * This program is distributed in the hope that it will be useful, but
|
|---|
| 18 | * WITHOUT ANY WARRANTY; without even the implied warranty of
|
|---|
| 19 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|---|
| 20 | * General Public License for more details.
|
|---|
| 21 | *
|
|---|
| 22 | * You should have received a copy of the GNU General Public License
|
|---|
| 23 | * along with this program; if not, see <https://www.gnu.org/licenses>.
|
|---|
| 24 | *
|
|---|
| 25 | * SPDX-License-Identifier: GPL-3.0-only
|
|---|
| 26 | */
|
|---|
| 27 |
|
|---|
| 28 | #ifndef GA_INCLUDED_SRC_x11_VBoxClient_wayland_helper_h
|
|---|
| 29 | #define GA_INCLUDED_SRC_x11_VBoxClient_wayland_helper_h
|
|---|
| 30 | #ifndef RT_WITHOUT_PRAGMA_ONCE
|
|---|
| 31 | # pragma once
|
|---|
| 32 | #endif
|
|---|
| 33 |
|
|---|
| 34 | #include <iprt/cdefs.h>
|
|---|
| 35 | #include <iprt/err.h>
|
|---|
| 36 |
|
|---|
| 37 |
|
|---|
| 38 | /** Helper capabilities list. */
|
|---|
| 39 | typedef enum
|
|---|
| 40 | {
|
|---|
| 41 | /** Indicates that helper does not support any functionality (initializer). */
|
|---|
| 42 | VBOX_WAYLAND_HELPER_CAP_NONE = 0,
|
|---|
| 43 | /** Indicates that helper supported shared clipboard functionality. */
|
|---|
| 44 | VBOX_WAYLAND_HELPER_CAP_CLIPBOARD,
|
|---|
| 45 | /** Indicates that helper supported drag-and-drop functionality. */
|
|---|
| 46 | VBOX_WAYLAND_HELPER_CAP_DND
|
|---|
| 47 | } vbox_wayland_helper_cap_t;
|
|---|
| 48 |
|
|---|
| 49 | /**
|
|---|
| 50 | * Wayland Desktop Environment helper definition structure.
|
|---|
| 51 | */
|
|---|
| 52 | typedef struct
|
|---|
| 53 | {
|
|---|
| 54 | /** A short helper name. 16 chars maximum (RTTHREAD_NAME_LEN). */
|
|---|
| 55 | const char *pszName;
|
|---|
| 56 |
|
|---|
| 57 | /**
|
|---|
| 58 | * Probing callback.
|
|---|
| 59 | *
|
|---|
| 60 | * Called in attempt to detect if user is currently running Desktop Environment
|
|---|
| 61 | * which is compatible with the helper.
|
|---|
| 62 | *
|
|---|
| 63 | * @returns Helpercapabilities bitmask as described by vbox_wayland_helper_cap_t.
|
|---|
| 64 | */
|
|---|
| 65 | DECLCALLBACKMEMBER(int, pfnProbe, (void));
|
|---|
| 66 |
|
|---|
| 67 | /**
|
|---|
| 68 | * Initialization callback.
|
|---|
| 69 | *
|
|---|
| 70 | * @returns IPRT status code.
|
|---|
| 71 | */
|
|---|
| 72 | DECLCALLBACKMEMBER(int, pfnInit, (void));
|
|---|
| 73 |
|
|---|
| 74 | /**
|
|---|
| 75 | * Termination callback.
|
|---|
| 76 | *
|
|---|
| 77 | * @returns IPRT status code.
|
|---|
| 78 | */
|
|---|
| 79 | DECLCALLBACKMEMBER(int, pfnTerm, (void));
|
|---|
| 80 |
|
|---|
| 81 | } VBCLWAYLANDHELPER;
|
|---|
| 82 |
|
|---|
| 83 | /** Wayland helper which uses GTK library. */
|
|---|
| 84 | extern const VBCLWAYLANDHELPER g_WaylandHelperGtk;
|
|---|
| 85 | /** Wayland helper which uses Data Control Protocol. */
|
|---|
| 86 | extern const VBCLWAYLANDHELPER g_WaylandHelperDcp;
|
|---|
| 87 |
|
|---|
| 88 | #endif /* !GA_INCLUDED_SRC_x11_VBoxClient_wayland_helper_h */
|
|---|
