VBoxGlobal.h revision aa58cad62dff6a585f0a674bdf7041436d13f52c
/** @file
*
* VBox frontends: Qt GUI ("VirtualBox"):
* VBoxGlobal class declaration
*/
/*
* Copyright (C) 2006-2007 Sun Microsystems, Inc.
*
* This file is part of VirtualBox Open Source Edition (OSE), as
* available from http://www.virtualbox.org. This file is free software;
* General Public License (GPL) as published by the Free Software
* Foundation, in version 2 as it comes in the "COPYING" file of the
* VirtualBox OSE distribution. VirtualBox OSE is distributed in the
* hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
*
* Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
* Clara, CA 95054 USA or visit http://www.sun.com if you need
* additional information or have any questions.
*/
#ifndef __VBoxGlobal_h__
#define __VBoxGlobal_h__
#include "COMDefs.h"
#include "VBoxGlobalSettings.h"
/* Qt includes */
#include <QApplication>
#include <QLayout>
#include <QHash>
#include <QPixmap>
#include <QMenu>
#include <QStyle>
#include <QProcess>
// Auxiliary types
////////////////////////////////////////////////////////////////////////////////
/** Simple media descriptor type. */
struct VBoxMedia
{
};
// VirtualBox callback events
////////////////////////////////////////////////////////////////////////////////
{
{}
const KMachineState state;
};
{
{}
};
{
{}
const bool registered;
};
{
{}
const KSessionState state;
};
{
{}
const QUuid snapshotId;
};
{
VBoxCanShowRegDlgEvent (bool aCanShow)
{}
const bool mCanShow;
};
{
VBoxCanShowUpdDlgEvent (bool aCanShow)
{}
const bool mCanShow;
};
{
{}
};
{
int aTimeout = 5000
/* wait for data maximum 5 seconds */)
{
/* Why is it really needed is because of Qt4.3 bug with QProcess.
* This bug is about QProcess sometimes (~70%) do not receive
* notification about process was finished, so this makes
* 'bool QProcess::waitForFinished (int)' block the GUI thread and
* never dismissed with 'true' result even if process was really
* started&finished. So we just waiting for some information
* on process output and destroy the process with force. Due to
* QProcess::~QProcess() has the same 'waitForFinished (int)' blocker
* we have to change process state to QProcess::NotRunning. */
if (firstShotReady)
return result;
}
};
// VBoxGlobal class
////////////////////////////////////////////////////////////////////////////////
{
static VBoxGlobal &instance();
/* main window handle storage */
const char *vmRenderModeStr() const { return vm_render_mode_str; }
#ifdef VBOX_WITH_DEBUGGER_GUI
bool isDebuggerEnabled() const { return mDbgEnabled; }
bool isDebuggerAutoShowEnabled() const { return mDbgAutoShow; }
#endif
QStringList vmGuestOSTypeDescriptions() const;
{
}
{
}
{
return machineStates.value (s);
}
{
return sessionStates.value (s);
}
/**
* Returns a string representation of the given KStorageBus enum value.
* Complementary to #toStorageBusType (const QString &) const.
*/
{
return storageBuses [aBus];
}
/**
* Returns a KStorageBus enum value corresponding to the given string
* representation. Complementary to #toString (KStorageBus) const.
*/
{
}
{
}
{
return diskStorageTypes.value (t);
}
{
return vrdpAuthTypes.value (t);
}
{
return portModeTypes.value (t);
}
{
return usbFilterActionTypes.value (t);
}
{
return clipboardTypes.value (t);
}
{
}
{
return ideControllerTypes.value (t);
}
{
}
{
}
{
}
{
}
/**
* Similar to toString (KHardDiskType), but returns 'Differencing'
* for normal hard disks that have a parent hard disk.
*/
{
{
}
}
{
return deviceTypes.value (t);
}
{
}
QStringList deviceTypeStrings() const;
{
return audioDriverTypes.value (t);
}
{
}
{
return audioControllerTypes.value (t);
}
{
}
{
return networkAdapterTypes.value (t);
}
{
}
{
return networkAttachmentTypes.value (t);
}
{
}
{
}
QStringList COMPortNames() const;
QStringList LPTPortNames() const;
{
}
/* details generators */
bool aDoRefresh = true);
bool aDoRefresh = true);
/* VirtualBox helpers */
bool showVirtualBoxLicense();
#endif
void checkForAutoConvertedSettings();
/** Shortcut to openSession (aId, true). */
void startEnumeratingMedia();
/**
* Returns a list of all currently registered media. This list is used
* to globally track the accessiblity state of all media on a dedicated
* thread. This the list is initially empty (before the first enumeration
* process is started using #startEnumeratingMedia()).
*/
/** Returns true if the media enumeration is in progress. */
void updateMedia (const VBoxMedia &);
/* various helpers */
QString languageName() const;
QString languageCountry() const;
QString languageNameEnglish() const;
QString languageCountryEnglish() const;
QString languageTranslators() const;
void retranslateUi();
/** @internal made public for internal purposes */
void cleanup();
/* public static stuff */
static void adoptLabelPixmap (QLabel *);
static QString languageId();
const char *aSmallDisabled = NULL,
const char *aSmallActive = NULL);
bool aCanResize = true);
bool aCanResize = true);
static QChar decimalSep();
static QString sizeRegexp();
static QString systemLanguageId();
bool resolveSymlinks = TRUE);
bool resolveSymLinks = true);
const char *aClassName = NULL,
bool aRecursive = false);
/* Qt 4.2.0 support function */
{
#if QT_VERSION < 0x040300
/* Deprecated since > 4.2 */
#else
/* New since > 4.2 */
#endif
}
/**
* Emitted at the beginning of the enumeration process started
* by #startEnumeratingMedia().
*/
void mediaEnumStarted();
/**
* Emitted when a new media item from the list has updated
* its accessibility state.
*/
/**
* Emitted at the end of the enumeration process started
* by #startEnumeratingMedia(). The @a aList argument is passed for
* convenience, it is exactly the same as returned by #currentMediaList().
*/
/** Emitted when a new media is added using #addMedia(). */
void mediaAdded (const VBoxMedia &);
/** Emitted when the media is updated using #updateMedia(). */
void mediaUpdated (const VBoxMedia &);
/** Emitted when the media is removed using #removeMedia(). */
/* signals emitted when the VirtualBox callback is called by the server
* (not that currently these signals are emitted only when the application
* is the in the VM selector mode) */
void machineStateChanged (const VBoxMachineStateChangeEvent &e);
void machineDataChanged (const VBoxMachineDataChangeEvent &e);
void machineRegistered (const VBoxMachineRegisteredEvent &e);
void sessionStateChanged (const VBoxSessionStateChangeEvent &e);
void snapshotChanged (const VBoxSnapshotEvent &e);
void canShowRegDlg (bool aCanShow);
void canShowUpdDlg (bool aCanShow);
void showRegistrationDialog (bool aForce = true);
void showUpdateDialog (bool aForce = true);
VBoxGlobal();
~VBoxGlobal();
void init();
bool mValid;
#ifdef VBOX_WITH_REGISTRATION
#endif
const char * vm_render_mode_str;
#ifdef VBOX_WITH_DEBUGGER_GUI
/** Whether the debugger should be accessible or not.
* Use --dbg, the env.var. VBOX_GUI_DBG_ENABLED, --debug or the env.var.
* VBOX_GUI_DBG_AUTO_SHOW to enable. */
bool mDbgEnabled;
/** Whether to show the debugger automatically with the console.
* Use --debug or the env.var. VBOX_GUI_DBG_AUTO_SHOW to enable. */
bool mDbgAutoShow;
/** VBoxDbg module handle. */
#endif
#if defined (Q_WS_WIN32)
#endif
};
// Helper classes
////////////////////////////////////////////////////////////////////////////////
/**
* Generic asyncronous event.
*
* This abstract class is intended to provide a conveinent way to execute
* code on the main GUI thread asynchronously to the calling party. This is
* done by putting necessary actions to the #handle() function in a subclass
* and then posting an instance of the subclass using #post(). The instance
* must be allocated on the heap using the <tt>new</tt> operation and will be
* automatically deleted after processing. Note that if you don't call #post()
* on the created instance, you have to delete it yourself.
*/
{
/**
* Worker function. Gets executed on the GUI thread when the posted event
* is processed by the main event loop.
*/
/**
* Posts this event to the main event loop.
* The caller loses ownership of this object after this method returns
* and must not delete the object.
*/
void post()
{
}
};
/**
* USB Popup Menu class.
* This class provides the list of USB devices attached to the host.
*/
{
VBoxUSBMenu (QWidget *);
void setConsole (const CConsole &);
void processAboutToShow();
};
/**
*/
{
void setToolTip (const QString &);
void processAboutToShow();
bool mInverted;
};
#endif /* __VBoxGlobal_h__ */