VBoxClientInternal.h revision 1a84601801d5bd045712787a3ef59313795389a1
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync/** $Id$ */
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync/** @file
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync * VBoxClient - common definitions, Darwin.
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync */
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync/*
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync * Copyright (C) 2007-2013 Oracle Corporation
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync *
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync * This file is part of VirtualBox Open Source Edition (OSE), as
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync * available from http://www.virtualbox.org. This file is free software;
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync * you can redistribute it and/or modify it under the terms of the GNU
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync * General Public License (GPL) as published by the Free Software
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync * Foundation, in version 2 as it comes in the "COPYING" file of the
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync */
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync#ifndef ___VBoxClientInternal_h
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync#define ___VBoxClientInternal_h
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync#include <VBox/VBoxGuestLib.h>
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync#include <Carbon/Carbon.h>
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync/* Service description */
deb4998ba50060c48cce222fd18a8eed053918d7vboxsynctypedef struct
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync{
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync /** The service name. */
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync const char *pszName;
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync /**
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync * Start service.
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync * @returns VBox status code.
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync */
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync DECLCALLBACKMEMBER(int, pfnStart)(void);
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync /**
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync * Stop service.
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync * @returns VBox status code.
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync */
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync DECLCALLBACKMEMBER(int, pfnStop)(void);
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync} VBOXCLIENTSERVICE;
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync/*
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync * Services
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync */
RT_C_DECLS_BEGIN
extern VBOXCLIENTSERVICE g_ClipboardService;
RT_C_DECLS_END
/*
* Functions
*/
/**
* Displays a verbose message.
*
* @param iLevel Minimum log level required to display this message.
* @param pszFormat The message text.
* @param ... Format arguments.
*/
extern void VBoxClientVerbose(int iLevel, const char *pszFormat, ...);
/**
* Walk through pasteboard items and report currently available item types.
*
* @param pPasteboard Reference to guest Pasteboard.
# @returns Available formats bit field.
*/
extern uint32_t vbclClipboardGetAvailableFormats(PasteboardRef pPasteboard);
/**
* Read host's clipboard buffer and put its content to guest clipboard.
*
* @param u32ClientId Host connection.
* @param pPasteboard Guest PasteBoard reference.
* @param fFormats List of data formats (bit field) received from host.
*
* @returns IPRT status code.
*/
extern int vbclClipboardForwardToGuest(uint32_t u32ClientId, PasteboardRef pPasteboard, uint32_t fFormats);
/**
* Read guest's clipboard buffer and forward its content to host.
*
* @param u32ClientId Host clipboard connection.
* @param pPasteboard Guest PasteBoard reference.
* @param fFormats List of data formats (bit field) received from host.
*
* @returns IPRT status code.
*/
extern int vbclClipboardForwardToHost(uint32_t u32ClientId, PasteboardRef pPasteboard, uint32_t fFormats);
#endif /* ___VBoxClientInternal_h */