UIConsoleEventHandler.h revision bc99944051834ab3282f351a5ba9639e46334bc7
346af0930020342df40a1ca8d13eb185ad48067evboxsync/** @file
d34409ad02ea0d28e08a6c4b089a412fdb3b4c9cvboxsync * VBox Qt GUI - UIConsoleEventHandler class declaration.
346af0930020342df40a1ca8d13eb185ad48067evboxsync */
346af0930020342df40a1ca8d13eb185ad48067evboxsync
346af0930020342df40a1ca8d13eb185ad48067evboxsync/*
1af8dbd6b690b0dc1cec3fcbaf51f95d4a9f0b2bvboxsync * Copyright (C) 2010-2014 Oracle Corporation
346af0930020342df40a1ca8d13eb185ad48067evboxsync *
346af0930020342df40a1ca8d13eb185ad48067evboxsync * This file is part of VirtualBox Open Source Edition (OSE), as
346af0930020342df40a1ca8d13eb185ad48067evboxsync * available from http://www.virtualbox.org. This file is free software;
346af0930020342df40a1ca8d13eb185ad48067evboxsync * you can redistribute it and/or modify it under the terms of the GNU
346af0930020342df40a1ca8d13eb185ad48067evboxsync * General Public License (GPL) as published by the Free Software
346af0930020342df40a1ca8d13eb185ad48067evboxsync * Foundation, in version 2 as it comes in the "COPYING" file of the
346af0930020342df40a1ca8d13eb185ad48067evboxsync * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
346af0930020342df40a1ca8d13eb185ad48067evboxsync * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
346af0930020342df40a1ca8d13eb185ad48067evboxsync */
346af0930020342df40a1ca8d13eb185ad48067evboxsync
1af8dbd6b690b0dc1cec3fcbaf51f95d4a9f0b2bvboxsync#ifndef ___UIConsoleEventHandler_h___
1af8dbd6b690b0dc1cec3fcbaf51f95d4a9f0b2bvboxsync#define ___UIConsoleEventHandler_h___
346af0930020342df40a1ca8d13eb185ad48067evboxsync
8bf8c6b1914c9e7e60b1547888400668f1774497vboxsync/* COM includes: */
8bf8c6b1914c9e7e60b1547888400668f1774497vboxsync#include "COMEnums.h"
8bf8c6b1914c9e7e60b1547888400668f1774497vboxsync#include "CEventListener.h"
1af8dbd6b690b0dc1cec3fcbaf51f95d4a9f0b2bvboxsync#include "CVirtualBoxErrorInfo.h"
8bf8c6b1914c9e7e60b1547888400668f1774497vboxsync#include "CMediumAttachment.h"
8bf8c6b1914c9e7e60b1547888400668f1774497vboxsync#include "CNetworkAdapter.h"
8bf8c6b1914c9e7e60b1547888400668f1774497vboxsync#include "CUSBDevice.h"
346af0930020342df40a1ca8d13eb185ad48067evboxsync
8bf8c6b1914c9e7e60b1547888400668f1774497vboxsync/* Forward declarations: */
346af0930020342df40a1ca8d13eb185ad48067evboxsyncclass UISession;
346af0930020342df40a1ca8d13eb185ad48067evboxsync
1af8dbd6b690b0dc1cec3fcbaf51f95d4a9f0b2bvboxsync/** Console event handler. */
346af0930020342df40a1ca8d13eb185ad48067evboxsyncclass UIConsoleEventHandler: public QObject
346af0930020342df40a1ca8d13eb185ad48067evboxsync{
346af0930020342df40a1ca8d13eb185ad48067evboxsync Q_OBJECT;
346af0930020342df40a1ca8d13eb185ad48067evboxsync
346af0930020342df40a1ca8d13eb185ad48067evboxsyncsignals:
1af8dbd6b690b0dc1cec3fcbaf51f95d4a9f0b2bvboxsync
1af8dbd6b690b0dc1cec3fcbaf51f95d4a9f0b2bvboxsync /** Notifies about mouse pointer shape change. */
346af0930020342df40a1ca8d13eb185ad48067evboxsync void sigMousePointerShapeChange(bool fVisible, bool fAlpha, QPoint hotCorner, QSize size, QVector<uint8_t> shape);
1af8dbd6b690b0dc1cec3fcbaf51f95d4a9f0b2bvboxsync /** Notifies about mouse capability change. */
1e55c91541549682278f13c784f4ecc57bd9a2b3vboxsync void sigMouseCapabilityChange(bool fSupportsAbsolute, bool fSupportsRelative, bool fSupportsMultiTouch, bool fNeedsHostCursor);
1af8dbd6b690b0dc1cec3fcbaf51f95d4a9f0b2bvboxsync /** Notifies about keyboard LEDs change. */
346af0930020342df40a1ca8d13eb185ad48067evboxsync void sigKeyboardLedsChangeEvent(bool fNumLock, bool fCapsLock, bool fScrollLock);
1af8dbd6b690b0dc1cec3fcbaf51f95d4a9f0b2bvboxsync /** Notifies about machine state change. */
346af0930020342df40a1ca8d13eb185ad48067evboxsync void sigStateChange(KMachineState state);
1af8dbd6b690b0dc1cec3fcbaf51f95d4a9f0b2bvboxsync /** Notifies about guest additions state change. */
346af0930020342df40a1ca8d13eb185ad48067evboxsync void sigAdditionsChange();
1af8dbd6b690b0dc1cec3fcbaf51f95d4a9f0b2bvboxsync /** Notifies about network adapter state change. */
346af0930020342df40a1ca8d13eb185ad48067evboxsync void sigNetworkAdapterChange(CNetworkAdapter adapter);
1af8dbd6b690b0dc1cec3fcbaf51f95d4a9f0b2bvboxsync /** Notifies about storage medium state change. */
346af0930020342df40a1ca8d13eb185ad48067evboxsync void sigMediumChange(CMediumAttachment attachment);
1af8dbd6b690b0dc1cec3fcbaf51f95d4a9f0b2bvboxsync /** Notifies about VRDE device state change. */
5d96aa0d3ade93ae2970f61342432246c9842466vboxsync void sigVRDEChange();
1af8dbd6b690b0dc1cec3fcbaf51f95d4a9f0b2bvboxsync /** Notifies about Video Capture device state change. */
4feb9880954f5fcb0c98feb110721798baccf992vboxsync void sigVideoCaptureChange();
1af8dbd6b690b0dc1cec3fcbaf51f95d4a9f0b2bvboxsync /** Notifies about USB controller state change. */
346af0930020342df40a1ca8d13eb185ad48067evboxsync void sigUSBControllerChange();
1af8dbd6b690b0dc1cec3fcbaf51f95d4a9f0b2bvboxsync /** Notifies about USB device state change. */
346af0930020342df40a1ca8d13eb185ad48067evboxsync void sigUSBDeviceStateChange(CUSBDevice device, bool fAttached, CVirtualBoxErrorInfo error);
1af8dbd6b690b0dc1cec3fcbaf51f95d4a9f0b2bvboxsync /** Notifies about shared folder state change. */
9a0c48116de3ffe1123a662b0c72fb1029a3b587vboxsync void sigSharedFolderChange();
1af8dbd6b690b0dc1cec3fcbaf51f95d4a9f0b2bvboxsync /** Notifies about CPU execution-cap change. */
1af8dbd6b690b0dc1cec3fcbaf51f95d4a9f0b2bvboxsync void sigCPUExecutionCapChange();
1af8dbd6b690b0dc1cec3fcbaf51f95d4a9f0b2bvboxsync /** Notifies about guest-screen configuration change. */
1af8dbd6b690b0dc1cec3fcbaf51f95d4a9f0b2bvboxsync void sigGuestMonitorChange(KGuestMonitorChangedEventType changeType, ulong uScreenId, QRect screenGeo);
1af8dbd6b690b0dc1cec3fcbaf51f95d4a9f0b2bvboxsync /** Notifies about Runtime error. */
346af0930020342df40a1ca8d13eb185ad48067evboxsync void sigRuntimeError(bool fFatal, QString strId, QString strMessage);
346af0930020342df40a1ca8d13eb185ad48067evboxsync#ifdef RT_OS_DARWIN
1af8dbd6b690b0dc1cec3fcbaf51f95d4a9f0b2bvboxsync /** Notifies about VM window should be shown. */
346af0930020342df40a1ca8d13eb185ad48067evboxsync void sigShowWindow();
346af0930020342df40a1ca8d13eb185ad48067evboxsync#endif /* RT_OS_DARWIN */
1af8dbd6b690b0dc1cec3fcbaf51f95d4a9f0b2bvboxsync
1af8dbd6b690b0dc1cec3fcbaf51f95d4a9f0b2bvboxsyncpublic:
1af8dbd6b690b0dc1cec3fcbaf51f95d4a9f0b2bvboxsync
bc99944051834ab3282f351a5ba9639e46334bc7vboxsync /** Static instance wrapper. */
bc99944051834ab3282f351a5ba9639e46334bc7vboxsync static UIConsoleEventHandler* instance() { return m_spInstance; }
bc99944051834ab3282f351a5ba9639e46334bc7vboxsync /** Static instance constructor. */
bc99944051834ab3282f351a5ba9639e46334bc7vboxsync static void create(UISession *pSession);
1af8dbd6b690b0dc1cec3fcbaf51f95d4a9f0b2bvboxsync /** Static instance destructor. */
1af8dbd6b690b0dc1cec3fcbaf51f95d4a9f0b2bvboxsync static void destroy();
346af0930020342df40a1ca8d13eb185ad48067evboxsync
346af0930020342df40a1ca8d13eb185ad48067evboxsyncprivate slots:
1af8dbd6b690b0dc1cec3fcbaf51f95d4a9f0b2bvboxsync
1af8dbd6b690b0dc1cec3fcbaf51f95d4a9f0b2bvboxsync /** Returns whether VM window can be shown. */
346af0930020342df40a1ca8d13eb185ad48067evboxsync void sltCanShowWindow(bool &fVeto, QString &strReason);
1af8dbd6b690b0dc1cec3fcbaf51f95d4a9f0b2bvboxsync /** Shows VM window if possible. */
25a96221cadefde67ab6689c5f1c5a6799438ad6vboxsync void sltShowWindow(LONG64 &winId);
346af0930020342df40a1ca8d13eb185ad48067evboxsync
346af0930020342df40a1ca8d13eb185ad48067evboxsyncprivate:
1af8dbd6b690b0dc1cec3fcbaf51f95d4a9f0b2bvboxsync
1af8dbd6b690b0dc1cec3fcbaf51f95d4a9f0b2bvboxsync /** Constructor: */
346af0930020342df40a1ca8d13eb185ad48067evboxsync UIConsoleEventHandler(UISession *pSession);
346af0930020342df40a1ca8d13eb185ad48067evboxsync
1af8dbd6b690b0dc1cec3fcbaf51f95d4a9f0b2bvboxsync /** Prepare routine. */
1af8dbd6b690b0dc1cec3fcbaf51f95d4a9f0b2bvboxsync void prepare();
1af8dbd6b690b0dc1cec3fcbaf51f95d4a9f0b2bvboxsync /** Cleanup routine. */
1af8dbd6b690b0dc1cec3fcbaf51f95d4a9f0b2bvboxsync void cleanup();
1af8dbd6b690b0dc1cec3fcbaf51f95d4a9f0b2bvboxsync
1af8dbd6b690b0dc1cec3fcbaf51f95d4a9f0b2bvboxsync /** Holds the static instance. */
bc99944051834ab3282f351a5ba9639e46334bc7vboxsync static UIConsoleEventHandler *m_spInstance;
1af8dbd6b690b0dc1cec3fcbaf51f95d4a9f0b2bvboxsync
1af8dbd6b690b0dc1cec3fcbaf51f95d4a9f0b2bvboxsync /** Holds the UI session reference. */
346af0930020342df40a1ca8d13eb185ad48067evboxsync UISession *m_pSession;
1af8dbd6b690b0dc1cec3fcbaf51f95d4a9f0b2bvboxsync
1af8dbd6b690b0dc1cec3fcbaf51f95d4a9f0b2bvboxsync /** Holds the main event listener instance. */
346af0930020342df40a1ca8d13eb185ad48067evboxsync CEventListener m_mainEventListener;
346af0930020342df40a1ca8d13eb185ad48067evboxsync};
346af0930020342df40a1ca8d13eb185ad48067evboxsync
346af0930020342df40a1ca8d13eb185ad48067evboxsync#define gConsoleEvents UIConsoleEventHandler::instance()
346af0930020342df40a1ca8d13eb185ad48067evboxsync
1af8dbd6b690b0dc1cec3fcbaf51f95d4a9f0b2bvboxsync#endif /* !___UIConsoleEventHandler_h___ */