1 | /** @file
|
---|
2 | *
|
---|
3 | * VBox frontends: Qt GUI ("VirtualBox"):
|
---|
4 | * VBoxProblemReporter class declaration
|
---|
5 | */
|
---|
6 |
|
---|
7 | /*
|
---|
8 | * Copyright (C) 2006-2008 Sun Microsystems, Inc.
|
---|
9 | *
|
---|
10 | * This file is part of VirtualBox Open Source Edition (OSE), as
|
---|
11 | * available from http://www.virtualbox.org. This file is free software;
|
---|
12 | * you can redistribute it and/or modify it under the terms of the GNU
|
---|
13 | * General Public License (GPL) as published by the Free Software
|
---|
14 | * Foundation, in version 2 as it comes in the "COPYING" file of the
|
---|
15 | * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
|
---|
16 | * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
|
---|
17 | *
|
---|
18 | * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
|
---|
19 | * Clara, CA 95054 USA or visit http://www.sun.com if you need
|
---|
20 | * additional information or have any questions.
|
---|
21 | */
|
---|
22 |
|
---|
23 | #ifndef __VBoxProblemReporter_h__
|
---|
24 | #define __VBoxProblemReporter_h__
|
---|
25 |
|
---|
26 | #include "COMDefs.h"
|
---|
27 | #include "QIMessageBox.h"
|
---|
28 |
|
---|
29 | /* Qt icludes */
|
---|
30 | #include <QObject>
|
---|
31 |
|
---|
32 | class VBoxMedium;
|
---|
33 |
|
---|
34 | // VBoxProblemReporter class
|
---|
35 | ////////////////////////////////////////////////////////////////////////////////
|
---|
36 |
|
---|
37 | /**
|
---|
38 | * The VBoxProblemReporter class is a central place to handle all problem/error
|
---|
39 | * situations that happen during application runtime and require the user's
|
---|
40 | * attention.
|
---|
41 | *
|
---|
42 | * The role of this class is to describe the problem and/or the cause of the
|
---|
43 | * error to the user and give him the opportunity to select an action (when
|
---|
44 | * appropriate).
|
---|
45 | *
|
---|
46 | * Every problem sutiation has its own (correspondingly named) method in this
|
---|
47 | * class that takes a list of arguments necessary to describe the situation and
|
---|
48 | * to provide the appropriate actions. The method then returns the choice to the
|
---|
49 | * caller.
|
---|
50 | */
|
---|
51 | class VBoxProblemReporter : public QObject
|
---|
52 | {
|
---|
53 | Q_OBJECT;
|
---|
54 |
|
---|
55 | public:
|
---|
56 |
|
---|
57 | enum Type
|
---|
58 | {
|
---|
59 | Info = 1,
|
---|
60 | Question,
|
---|
61 | Warning,
|
---|
62 | Error,
|
---|
63 | Critical,
|
---|
64 | GuruMeditation
|
---|
65 | };
|
---|
66 |
|
---|
67 | enum
|
---|
68 | {
|
---|
69 | AutoConfirmed = 0x8000
|
---|
70 | };
|
---|
71 |
|
---|
72 | static VBoxProblemReporter &instance();
|
---|
73 |
|
---|
74 | bool isValid() const;
|
---|
75 |
|
---|
76 | // helpers
|
---|
77 |
|
---|
78 | int message (QWidget *aParent, Type aType, const QString &aMessage,
|
---|
79 | const QString &aDetails = QString::null,
|
---|
80 | const char *aAutoConfirmId = 0,
|
---|
81 | int aButton1 = 0, int aButton2 = 0, int aButton3 = 0,
|
---|
82 | const QString &aText1 = QString::null,
|
---|
83 | const QString &aText2 = QString::null,
|
---|
84 | const QString &aText3 = QString::null) const;
|
---|
85 |
|
---|
86 | int message (QWidget *aParent, Type aType, const QString &aMessage,
|
---|
87 | const char *aAutoConfirmId,
|
---|
88 | int aButton1 = 0, int aButton2 = 0, int aButton3 = 0,
|
---|
89 | const QString &aText1 = QString::null,
|
---|
90 | const QString &aText2 = QString::null,
|
---|
91 | const QString &aText3 = QString::null) const
|
---|
92 | {
|
---|
93 | return message (aParent, aType, aMessage, QString::null, aAutoConfirmId,
|
---|
94 | aButton1, aButton2, aButton3, aText1, aText2, aText3);
|
---|
95 | }
|
---|
96 |
|
---|
97 | bool messageYesNo (QWidget *aParent, Type aType, const QString &aMessage,
|
---|
98 | const QString &aDetails = QString::null,
|
---|
99 | const char *aAutoConfirmId = 0,
|
---|
100 | const QString &aYesText = QString::null,
|
---|
101 | const QString &aNoText = QString::null) const
|
---|
102 | {
|
---|
103 | return (message (aParent, aType, aMessage, aDetails, aAutoConfirmId,
|
---|
104 | QIMessageBox::Yes | QIMessageBox::Default,
|
---|
105 | QIMessageBox::No | QIMessageBox::Escape,
|
---|
106 | 0,
|
---|
107 | aYesText, aNoText, QString::null) &
|
---|
108 | QIMessageBox::ButtonMask) == QIMessageBox::Yes;
|
---|
109 | }
|
---|
110 |
|
---|
111 | bool messageYesNo (QWidget *aParent, Type aType, const QString &aMessage,
|
---|
112 | const char *aAutoConfirmId,
|
---|
113 | const QString &aYesText = QString::null,
|
---|
114 | const QString &aNoText = QString::null) const
|
---|
115 | {
|
---|
116 | return messageYesNo (aParent, aType, aMessage, QString::null,
|
---|
117 | aAutoConfirmId, aYesText, aNoText);
|
---|
118 | }
|
---|
119 |
|
---|
120 | bool messageOkCancel (QWidget *aParent, Type aType, const QString &aMessage,
|
---|
121 | const QString &aDetails = QString::null,
|
---|
122 | const char *aAutoConfirmId = 0,
|
---|
123 | const QString &aOkText = QString::null,
|
---|
124 | const QString &aCancelText = QString::null) const
|
---|
125 | {
|
---|
126 | return (message (aParent, aType, aMessage, aDetails, aAutoConfirmId,
|
---|
127 | QIMessageBox::Ok | QIMessageBox::Default,
|
---|
128 | QIMessageBox::Cancel | QIMessageBox::Escape,
|
---|
129 | 0,
|
---|
130 | aOkText, aCancelText, QString::null) &
|
---|
131 | QIMessageBox::ButtonMask) == QIMessageBox::Ok;
|
---|
132 | }
|
---|
133 |
|
---|
134 | bool messageOkCancel (QWidget *aParent, Type aType, const QString &aMessage,
|
---|
135 | const char *aAutoConfirmId,
|
---|
136 | const QString &aOkText = QString::null,
|
---|
137 | const QString &aCancelText = QString::null) const
|
---|
138 | {
|
---|
139 | return messageOkCancel (aParent, aType, aMessage, QString::null,
|
---|
140 | aAutoConfirmId, aOkText, aCancelText);
|
---|
141 | }
|
---|
142 |
|
---|
143 | bool showModalProgressDialog (CProgress &aProgress, const QString &aTitle,
|
---|
144 | QWidget *aParent, int aMinDuration = 2000);
|
---|
145 |
|
---|
146 | QWidget *mainWindowShown() const;
|
---|
147 |
|
---|
148 | /* Generic problem handlers */
|
---|
149 | bool askForOverridingFileIfExists (const QString& path, QWidget *aParent = NULL) const;
|
---|
150 | bool askForOverridingFilesIfExists (const QStringList& aPaths, QWidget *aParent /* = NULL */) const;
|
---|
151 |
|
---|
152 | /* Special problem handlers */
|
---|
153 | void showBETAWarning();
|
---|
154 |
|
---|
155 | #ifdef Q_WS_X11
|
---|
156 | void cannotFindLicenseFiles (const QString &aPath);
|
---|
157 | void cannotOpenLicenseFile (QWidget *aParent, const QString &aPath);
|
---|
158 | #endif
|
---|
159 |
|
---|
160 | void cannotOpenURL (const QString &aURL);
|
---|
161 | void cannotCopyFile (const QString &aSrc, const QString &aDst, int aVRC);
|
---|
162 |
|
---|
163 | void cannotFindLanguage (const QString &aLangID, const QString &aNlsPath);
|
---|
164 | void cannotLoadLanguage (const QString &aLangFile);
|
---|
165 |
|
---|
166 | void cannotInitCOM (HRESULT rc);
|
---|
167 | void cannotCreateVirtualBox (const CVirtualBox &vbox);
|
---|
168 |
|
---|
169 | void cannotSaveGlobalSettings (const CVirtualBox &vbox,
|
---|
170 | QWidget *parent = 0);
|
---|
171 |
|
---|
172 | void cannotLoadGlobalConfig (const CVirtualBox &vbox, const QString &error);
|
---|
173 | void cannotSaveGlobalConfig (const CVirtualBox &vbox);
|
---|
174 | void cannotSetSystemProperties (const CSystemProperties &props);
|
---|
175 | void cannotAccessUSB (const COMBaseWithEI &aObj);
|
---|
176 |
|
---|
177 | void cannotCreateMachine (const CVirtualBox &vbox,
|
---|
178 | QWidget *parent = 0);
|
---|
179 | void cannotCreateMachine (const CVirtualBox &vbox, const CMachine &machine,
|
---|
180 | QWidget *parent = 0);
|
---|
181 | void cannotApplyMachineSettings (const CMachine &machine, const COMResult &res);
|
---|
182 | void cannotSaveMachineSettings (const CMachine &machine,
|
---|
183 | QWidget *parent = 0);
|
---|
184 | void cannotLoadMachineSettings (const CMachine &machine,
|
---|
185 | bool strict = true,
|
---|
186 | QWidget *parent = 0);
|
---|
187 |
|
---|
188 | void cannotStartMachine (const CConsole &console);
|
---|
189 | void cannotStartMachine (const CProgress &progress);
|
---|
190 | void cannotPauseMachine (const CConsole &console);
|
---|
191 | void cannotResumeMachine (const CConsole &console);
|
---|
192 | void cannotACPIShutdownMachine (const CConsole &console);
|
---|
193 | void cannotSaveMachineState (const CConsole &console);
|
---|
194 | void cannotSaveMachineState (const CProgress &progress);
|
---|
195 | void cannotTakeSnapshot (const CConsole &console);
|
---|
196 | void cannotTakeSnapshot (const CProgress &progress);
|
---|
197 | void cannotStopMachine (const CConsole &console);
|
---|
198 | void cannotStopMachine (const CProgress &progress);
|
---|
199 | void cannotDeleteMachine (const CVirtualBox &vbox, const CMachine &machine);
|
---|
200 | void cannotDiscardSavedState (const CConsole &console);
|
---|
201 |
|
---|
202 | void cannotSendACPIToMachine();
|
---|
203 | bool warnAboutVirtNotEnabled();
|
---|
204 |
|
---|
205 | void cannotSetSnapshotFolder (const CMachine &aMachine, const QString &aPath);
|
---|
206 | bool askAboutSnapshotAndStateDiscarding();
|
---|
207 | void cannotDiscardSnapshot (const CConsole &aConsole,
|
---|
208 | const QString &aSnapshotName);
|
---|
209 | void cannotDiscardSnapshot (const CProgress &aProgress,
|
---|
210 | const QString &aSnapshotName);
|
---|
211 | void cannotDiscardCurrentState (const CConsole &console);
|
---|
212 | void cannotDiscardCurrentState (const CProgress &progress);
|
---|
213 | void cannotDiscardCurrentSnapshotAndState (const CConsole &console);
|
---|
214 | void cannotDiscardCurrentSnapshotAndState (const CProgress &progress);
|
---|
215 |
|
---|
216 | void cannotFindMachineByName (const CVirtualBox &vbox, const QString &name);
|
---|
217 |
|
---|
218 | void cannotEnterSeamlessMode (ULONG aWidth, ULONG aHeight,
|
---|
219 | ULONG aBpp, ULONG64 aMinVRAM);
|
---|
220 | int cannotEnterFullscreenMode (ULONG aWidth, ULONG aHeight,
|
---|
221 | ULONG aBpp, ULONG64 aMinVRAM);
|
---|
222 |
|
---|
223 | bool confirmMachineDeletion (const CMachine &machine);
|
---|
224 | bool confirmDiscardSavedState (const CMachine &machine);
|
---|
225 |
|
---|
226 | bool confirmReleaseMedium (QWidget *aParent, const VBoxMedium &aMedium,
|
---|
227 | const QString &aUsage);
|
---|
228 |
|
---|
229 | bool confirmRemoveMedium (QWidget *aParent, const VBoxMedium &aMedium);
|
---|
230 |
|
---|
231 | void sayCannotOverwriteHardDiskStorage (QWidget *aParent,
|
---|
232 | const QString &aLocation);
|
---|
233 | int confirmDeleteHardDiskStorage (QWidget *aParent,
|
---|
234 | const QString &aLocation);
|
---|
235 | void cannotDeleteHardDiskStorage (QWidget *aParent, const CHardDisk &aHD,
|
---|
236 | const CProgress &aProgress);
|
---|
237 |
|
---|
238 | int confirmDetachAddControllerSlots (QWidget *aParent) const;
|
---|
239 | int confirmChangeAddControllerSlots (QWidget *aParent) const;
|
---|
240 | int confirmRunNewHDWzdOrVDM (QWidget* aParent);
|
---|
241 |
|
---|
242 | void cannotCreateHardDiskStorage (QWidget *aParent, const CVirtualBox &aVBox,
|
---|
243 | const QString &aLocaiton,
|
---|
244 | const CHardDisk &aHD,
|
---|
245 | const CProgress &aProgress);
|
---|
246 | void cannotAttachHardDisk (QWidget *aParent, const CMachine &aMachine,
|
---|
247 | const QString &aLocation, KStorageBus aBus,
|
---|
248 | LONG aChannel, LONG aDevice);
|
---|
249 | void cannotDetachHardDisk (QWidget *aParent, const CMachine &aMachine,
|
---|
250 | const QString &aLocation, KStorageBus aBus,
|
---|
251 | LONG aChannel, LONG aDevice);
|
---|
252 |
|
---|
253 | void cannotMountMedium (QWidget *aParent, const CMachine &aMachine,
|
---|
254 | const VBoxMedium &aMedium, const COMResult &aResult);
|
---|
255 | void cannotUnmountMedium (QWidget *aParent, const CMachine &aMachine,
|
---|
256 | const VBoxMedium &aMedium, const COMResult &aResult);
|
---|
257 | void cannotOpenMedium (QWidget *aParent, const CVirtualBox &aVBox,
|
---|
258 | VBoxDefs::MediaType aType, const QString &aLocation);
|
---|
259 | void cannotCloseMedium (QWidget *aParent, const VBoxMedium &aMedium,
|
---|
260 | const COMResult &aResult);
|
---|
261 |
|
---|
262 | void cannotOpenSession (const CSession &session);
|
---|
263 | void cannotOpenSession (const CVirtualBox &vbox, const CMachine &machine,
|
---|
264 | const CProgress &progress = CProgress());
|
---|
265 |
|
---|
266 | void cannotGetMediaAccessibility (const VBoxMedium &aMedium);
|
---|
267 |
|
---|
268 | #if defined Q_WS_WIN
|
---|
269 | int confirmDeletingHostInterface (const QString &aName, QWidget *aParent = 0);
|
---|
270 | void cannotCreateHostInterface (const CHost &aHost, QWidget *aParent = 0);
|
---|
271 | void cannotCreateHostInterface (const CProgress &aProgress, QWidget *aParent = 0);
|
---|
272 | void cannotRemoveHostInterface (const CHost &aHost,
|
---|
273 | const CHostNetworkInterface &aIface,
|
---|
274 | QWidget *aParent = 0);
|
---|
275 | void cannotRemoveHostInterface (const CProgress &aProgress,
|
---|
276 | const CHostNetworkInterface &aIface,
|
---|
277 | QWidget *aParent = 0);
|
---|
278 | #endif
|
---|
279 |
|
---|
280 | void cannotAttachUSBDevice (const CConsole &console, const QString &device);
|
---|
281 | void cannotAttachUSBDevice (const CConsole &console, const QString &device,
|
---|
282 | const CVirtualBoxErrorInfo &error);
|
---|
283 | void cannotDetachUSBDevice (const CConsole &console, const QString &device);
|
---|
284 | void cannotDetachUSBDevice (const CConsole &console, const QString &device,
|
---|
285 | const CVirtualBoxErrorInfo &error);
|
---|
286 |
|
---|
287 | void cannotCreateSharedFolder (QWidget *, const CMachine &,
|
---|
288 | const QString &, const QString &);
|
---|
289 | void cannotRemoveSharedFolder (QWidget *, const CMachine &,
|
---|
290 | const QString &, const QString &);
|
---|
291 | void cannotCreateSharedFolder (QWidget *, const CConsole &,
|
---|
292 | const QString &, const QString &);
|
---|
293 | void cannotRemoveSharedFolder (QWidget *, const CConsole &,
|
---|
294 | const QString &, const QString &);
|
---|
295 |
|
---|
296 | int cannotFindGuestAdditions (const QString &aSrc1, const QString &aSrc2);
|
---|
297 | void cannotDownloadGuestAdditions (const QString &aURL,
|
---|
298 | const QString &aReason);
|
---|
299 | bool confirmDownloadAdditions (const QString &aURL, ulong aSize);
|
---|
300 | bool confirmMountAdditions (const QString &aURL, const QString &aSrc);
|
---|
301 | void warnAboutTooOldAdditions (QWidget *, const QString &, const QString &);
|
---|
302 | void warnAboutOldAdditions (QWidget *, const QString &, const QString &);
|
---|
303 | void warnAboutNewAdditions (QWidget *, const QString &, const QString &);
|
---|
304 |
|
---|
305 | void cannotConnectRegister (QWidget *aParent,
|
---|
306 | const QString &aURL,
|
---|
307 | const QString &aReason);
|
---|
308 | void showRegisterResult (QWidget *aParent,
|
---|
309 | const QString &aResult);
|
---|
310 |
|
---|
311 | void showUpdateSuccess (QWidget *aParent,
|
---|
312 | const QString &aVersion,
|
---|
313 | const QString &aLink);
|
---|
314 | void showUpdateFailure (QWidget *aParent,
|
---|
315 | const QString &aReason);
|
---|
316 | void showUpdateNotFound (QWidget *aParent);
|
---|
317 |
|
---|
318 | bool confirmInputCapture (bool *aAutoConfirmed = NULL);
|
---|
319 | void remindAboutAutoCapture();
|
---|
320 | void remindAboutMouseIntegration (bool aSupportsAbsolute);
|
---|
321 | bool remindAboutPausedVMInput();
|
---|
322 |
|
---|
323 | int warnAboutAutoConvertedSettings (const QString &aFormatVersion,
|
---|
324 | const QString &aFileList,
|
---|
325 | bool aAfterRefresh);
|
---|
326 |
|
---|
327 | bool remindAboutInaccessibleMedia();
|
---|
328 |
|
---|
329 | bool confirmGoingFullscreen (const QString &aHotKey);
|
---|
330 | bool confirmGoingSeamless (const QString &aHotKey);
|
---|
331 |
|
---|
332 | void remindAboutWrongColorDepth (ulong aRealBPP, ulong aWantedBPP);
|
---|
333 |
|
---|
334 | bool remindAboutGuruMeditation (const CConsole &aConsole,
|
---|
335 | const QString &aLogFolder);
|
---|
336 |
|
---|
337 | bool confirmVMReset (QWidget *aParent);
|
---|
338 |
|
---|
339 | bool confirmHardDisklessMachine (QWidget *aParent);
|
---|
340 |
|
---|
341 | void cannotRunInSelectorMode();
|
---|
342 |
|
---|
343 | void cannotImportAppliance (CAppliance *aAppliance, QWidget *aParent = NULL) const;
|
---|
344 | void cannotImportAppliance (const CProgress &aProgress, CAppliance *aAppliance, QWidget *aParent = NULL) const;
|
---|
345 |
|
---|
346 | void cannotExportAppliance (CAppliance *aAppliance, QWidget *aParent = NULL) const;
|
---|
347 | void cannotExportAppliance (const CMachine &aMachine, CAppliance *aAppliance, QWidget *aParent = NULL) const;
|
---|
348 | void cannotExportAppliance (const CProgress &aProgress, CAppliance *aAppliance, QWidget *aParent = NULL) const;
|
---|
349 |
|
---|
350 | void showRuntimeError (const CConsole &console, bool fatal,
|
---|
351 | const QString &errorID,
|
---|
352 | const QString &errorMsg) const;
|
---|
353 |
|
---|
354 | static QString toAccusative (VBoxDefs::MediaType aType);
|
---|
355 |
|
---|
356 | static QString formatRC (HRESULT aRC);
|
---|
357 |
|
---|
358 | static QString formatErrorInfo (const COMErrorInfo &aInfo,
|
---|
359 | HRESULT aWrapperRC = S_OK);
|
---|
360 |
|
---|
361 | static QString formatErrorInfo (const CVirtualBoxErrorInfo &aInfo)
|
---|
362 | {
|
---|
363 | return formatErrorInfo (COMErrorInfo (aInfo));
|
---|
364 | }
|
---|
365 |
|
---|
366 | static QString formatErrorInfo (const COMBaseWithEI &aWrapper)
|
---|
367 | {
|
---|
368 | Assert (aWrapper.lastRC() != S_OK);
|
---|
369 | return formatErrorInfo (aWrapper.errorInfo(), aWrapper.lastRC());
|
---|
370 | }
|
---|
371 |
|
---|
372 | static QString formatErrorInfo (const COMResult &aRC)
|
---|
373 | {
|
---|
374 | Assert (aRC.rc() != S_OK);
|
---|
375 | return formatErrorInfo (aRC.errorInfo(), aRC.rc());
|
---|
376 | }
|
---|
377 |
|
---|
378 | public slots:
|
---|
379 |
|
---|
380 | void showHelpWebDialog();
|
---|
381 | void showHelpAboutDialog();
|
---|
382 | void showHelpHelpDialog();
|
---|
383 | void resetSuppressedMessages();
|
---|
384 |
|
---|
385 | private:
|
---|
386 |
|
---|
387 | friend VBoxProblemReporter &vboxProblem();
|
---|
388 |
|
---|
389 | static QString doFormatErrorInfo (const COMErrorInfo &aInfo,
|
---|
390 | HRESULT aWrapperRC = S_OK);
|
---|
391 | };
|
---|
392 |
|
---|
393 | /**
|
---|
394 | * Shortcut to the static VBoxProblemReporter::instance() method, for
|
---|
395 | * convenience.
|
---|
396 | */
|
---|
397 | inline VBoxProblemReporter &vboxProblem() { return VBoxProblemReporter::instance(); }
|
---|
398 |
|
---|
399 | #endif // __VBoxProblemReporter_h__
|
---|