VBoxVMLogViewer.ui.h@ 3927

Last change on this file since 3927 was 3926, checked in by vboxsync, 18 years ago

2124: VirtualBox LogViewer search mechanism:

Positioning mechanism changed so that it will scroll the view to the beginning of the string as close as possible.
Add F1 as hot-key to Help.
Alt-H & Alt-C hot-keys removed from Help & Close buttons accordingly.

Property svn:eol-style set to native
Property svn:keywords set to Date Revision Author Id

File size: 22.6 KB

Line
1	/**
2	*
3	* VBox frontends: Qt GUI ("VirtualBox"):
4	* "Virtual Log Viewer" dialog UI include (Qt Designer)
5	*/
6
7	/*
8	* Copyright (C) 2006 innotek GmbH
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 as published by the Free Software Foundation,
14	* in version 2 as it comes in the "COPYING" file of the VirtualBox OSE
15	* distribution. VirtualBox OSE is distributed in the hope that it will
16	* be useful, but WITHOUT ANY WARRANTY of any kind.
17	*
18	* If you received this file as part of a commercial VirtualBox
19	* distribution, then only the terms of your commercial VirtualBox
20	* license agreement apply instead of the previous paragraph.
21	*/
22
23	/****************************************************************************
24	** ui.h extension file, included from the uic-generated form implementation.
25	**
26	** If you wish to add, delete or rename functions or slots use
27	** Qt Designer which will update this file, preserving your code. Create an
28	** init() function in place of a constructor, and a destroy() function in
29	** place of a destructor.
30	*****************************************************************************/
31
32
33	class VBoxLogSearchPanel : public QWidget
34	{
35	Q_OBJECT
36
37	public:
38
39	VBoxLogSearchPanel (QWidget *aParent,
40	VBoxVMLogViewer *aViewer,
41	const char *aName)
42	: QWidget (aParent, aName)
43	, mViewer (aViewer)
44	, mButtonClose (0)
45	, mSearchName (0), mSearchString (0)
46	, mButtonPrev (0), mButtonNext (0)
47	, mCaseSensitive (0)
48	, mWarningSpacer (0), mWarningIcon (0), mWarningString (0)
49	{
50	mButtonClose = new QToolButton (this);
51	mButtonClose->setAutoRaise (true);
52	mButtonClose->setFocusPolicy (QWidget::TabFocus);
53	mButtonClose->setAccel (QKeySequence (Qt::Key_Escape));
54	connect (mButtonClose, SIGNAL (clicked()), this, SLOT (hide()));
55	mButtonClose->setIconSet (VBoxGlobal::iconSet ("delete_16px.png",
56	"delete_dis_16px.png"));
57
58	mSearchName = new QLabel (this);
59	mSearchString = new QLineEdit (this);
60	mSearchString->setSizePolicy (QSizePolicy::Preferred,
61	QSizePolicy::Fixed);
62	connect (mSearchString, SIGNAL (textChanged (const QString &)),
63	this, SLOT (findCurrent (const QString &)));
64
65	mButtonNext = new QToolButton (this);
66	mButtonNext->setEnabled (false);
67	mButtonNext->setAutoRaise (true);
68	mButtonNext->setFocusPolicy (QWidget::TabFocus);
69	mButtonNext->setUsesTextLabel (true);
70	mButtonNext->setTextPosition (QToolButton::BesideIcon);
71	connect (mButtonNext, SIGNAL (clicked()), this, SLOT (findNext()));
72	mButtonNext->setIconSet (VBoxGlobal::iconSet ("list_movedown_16px.png",
73	"list_movedown_disabled_16px.png"));
74
75	mButtonPrev = new QToolButton (this);
76	mButtonPrev->setEnabled (false);
77	mButtonPrev->setAutoRaise (true);
78	mButtonPrev->setFocusPolicy (QWidget::TabFocus);
79	mButtonPrev->setUsesTextLabel (true);
80	mButtonPrev->setTextPosition (QToolButton::BesideIcon);
81	connect (mButtonPrev, SIGNAL (clicked()), this, SLOT (findBack()));
82	mButtonPrev->setIconSet (VBoxGlobal::iconSet ("list_moveup_16px.png",
83	"list_moveup_disabled_16px.png"));
84
85	mCaseSensitive = new QCheckBox (this);
86
87	mWarningSpacer = new QSpacerItem (0, 0, QSizePolicy::Fixed,
88	QSizePolicy::Minimum);
89	mWarningIcon = new QLabel (this);
90	mWarningIcon->hide();
91	QImage img = QMessageBox::standardIcon (QMessageBox::Warning).
92	convertToImage();
93	if (!img.isNull())
94	{
95	img = img.smoothScale (16, 16);
96	QPixmap pixmap;
97	pixmap.convertFromImage (img);
98	mWarningIcon->setPixmap (pixmap);
99	}
100	mWarningString = new QLabel (this);
101	mWarningString->hide();
102
103	QSpacerItem *spacer = new QSpacerItem (0, 0, QSizePolicy::Expanding,
104	QSizePolicy::Minimum);
105
106	QHBoxLayout *mainLayout = new QHBoxLayout (this, 5, 5);
107	mainLayout->addWidget (mButtonClose);
108	mainLayout->addWidget (mSearchName);
109	mainLayout->addWidget (mSearchString);
110	mainLayout->addWidget (mButtonNext);
111	mainLayout->addWidget (mButtonPrev);
112	mainLayout->addWidget (mCaseSensitive);
113	mainLayout->addItem (mWarningSpacer);
114	mainLayout->addWidget (mWarningIcon);
115	mainLayout->addWidget (mWarningString);
116	mainLayout->addItem (spacer);
117
118	setFocusProxy (mCaseSensitive);
119	qApp->installEventFilter (this);
120
121	languageChange();
122	}
123
124	void languageChange()
125	{
126	QToolTip::add (mButtonClose, tr ("Close the search panel"));
127	mSearchName->setText (tr ("Find "));
128	QToolTip::add (mSearchString, tr ("Enter a search string here"));
129	mButtonPrev->setTextLabel (tr ("&Previous"));
130	mButtonPrev->setAccel (QKeySequence (tr ("Alt+P")));
131	QToolTip::add (mButtonPrev,
132	tr ("Search for the previous occurrence of the string"));
133	mButtonNext->setTextLabel (tr ("&Next"));
134	mButtonNext->setAccel (QKeySequence (tr ("Alt+N")));
135	QToolTip::add (mButtonNext,
136	tr ("Search for the next occurrence of the string"));
137	mCaseSensitive->setText (tr ("C&ase Sensitive"));
138	QToolTip::add (mCaseSensitive,
139	tr ("Perform case sensitive search (when checked)"));
140	mWarningString->setText (tr ("String not found"));
141	}
142
143	private slots:
144
145	void findNext()
146	{
147	search (true);
148	}
149
150	void findBack()
151	{
152	search (false);
153	}
154
155	void findCurrent (const QString &aSearchString)
156	{
157	mButtonNext->setEnabled (aSearchString.length());
158	mButtonPrev->setEnabled (aSearchString.length());
159	toggleWarning (!aSearchString.length());
160	if (aSearchString.length())
161	search (true, true);
162	else
163	mViewer->currentLogPage()->removeSelection();
164	}
165
166	private:
167
168	void search (bool aForward, bool aStartCurrent = false)
169	{
170	QTextBrowser *browser = mViewer->currentLogPage();
171	if (!browser) return;
172
173	int startPrg = 0, endPrg = 0;
174	int startInd = 0, endInd = 0;
175	if (browser->hasSelectedText())
176	browser->getSelection (&startPrg, &startInd, &endPrg, &endInd);
177
178	bool found = false;
179	int increment = aForward ? 1 : -1;
180	int border = aForward ? browser->paragraphs() : -1;
181	int startFrom = aStartCurrent ? startInd : startInd + increment;
182	int paragraph = startFrom < 0 ? startPrg + increment : startPrg;
183	for (; paragraph != border; paragraph += increment)
184	{
185	QString text = browser->text (paragraph);
186	int res = aForward ?
187	text.find (mSearchString->text(), startFrom,
188	mCaseSensitive->isChecked()) :
189	text.findRev (mSearchString->text(), startFrom,
190	mCaseSensitive->isChecked());
191	if (res != -1)
192	{
193	found = true;
194	browser->setSelection (paragraph, res, paragraph,
195	res + mSearchString->text().length());
196	/* ensures the selected word visible */
197	int curPrg = 0, curInd = 0;
198	browser->getCursorPosition (&curPrg, &curInd);
199	QRect rect = browser->paragraphRect (curPrg);
200	QString string = browser->text (curPrg);
201	string.truncate (curInd);
202	int x = rect.x() + browser->fontMetrics().width (string);
203	int y = rect.y() + browser->pointSize() / 2;
204	browser->setContentsPos (0, browser->contentsY());
205	browser->ensureVisible (x, y, 40, 40);
206	break;
207	}
208	startFrom = aForward ? 0 : -1;
209	}
210
211	toggleWarning (found);
212	if (!found)
213	browser->setSelection (startPrg, startInd, endPrg, endInd);
214	}
215
216	bool eventFilter (QObject aObject, QEvent aEvent)
217	{
218	switch (aEvent->type())
219	{
220	case QEvent::KeyPress:
221	{
222	QKeyEvent e = static_cast<QKeyEvent> (aEvent);
223
224	/* processing the return keypress for the mSearchString
225	* widget as the search next string action */
226	if (aObject == mSearchString &&
227	(e->state() == 0 \|\| e->state() & Keypad) &&
228	(e->key() == Key_Enter \|\| e->key() == Key_Return))
229	{
230	findNext();
231	return true;
232	}
233	/* processing other search next/previous shortcuts */
234	else if (e->key() == Key_F3)
235	{
236	if (e->state() == 0)
237	findNext();
238	else if (e->state() == ShiftButton)
239	findBack();
240	return true;
241	}
242	/* processing ctrl-f key combination as the shortcut to
243	* move to the search field */
244	else if (e->state() == ControlButton && e->key() == Key_F)
245	{
246	if (mViewer->currentLogPage())
247	{
248	if (isHidden()) show();
249	mSearchString->setFocus();
250	return true;
251	}
252	}
253	/* processing the alpha-numeric keys as the shortcuts to the
254	* search panel displaying and search activation */
255	else if (e->state() == 0 &&
256	e->key() >= Qt::Key_Exclam &&
257	e->key() <= Qt::Key_AsciiTilde)
258	{
259	if (mViewer->currentLogPage())
260	{
261	if (isHidden()) show();
262	mSearchString->setFocus();
263	mSearchString->insert (e->text());
264	return true;
265	}
266	}
267
268	break;
269	}
270	default:
271	break;
272	}
273	return false;
274	}
275
276	void showEvent (QShowEvent *aEvent)
277	{
278	QWidget::showEvent (aEvent);
279	mSearchString->setFocus();
280	mSearchString->selectAll();
281	}
282
283	void hideEvent (QHideEvent *aEvent)
284	{
285	if (focusData()->focusWidget()->parent() == this)
286	focusNextPrevChild (true);
287	QWidget::hideEvent (aEvent);
288	}
289
290	void toggleWarning (bool aHide)
291	{
292	mWarningSpacer->changeSize (aHide ? 0 : 16, 0, QSizePolicy::Fixed,
293	QSizePolicy::Minimum);
294	mWarningIcon->setHidden (aHide);
295	mWarningString->setHidden (aHide);
296	}
297
298	VBoxVMLogViewer *mViewer;
299	QToolButton *mButtonClose;
300	QLabel *mSearchName;
301	QLineEdit *mSearchString;
302	QToolButton *mButtonPrev;
303	QToolButton *mButtonNext;
304	QCheckBox *mCaseSensitive;
305	QSpacerItem *mWarningSpacer;
306	QLabel *mWarningIcon;
307	QLabel *mWarningString;
308	};
309
310
311	VBoxVMLogViewer::LogViewersMap VBoxVMLogViewer::mSelfArray = LogViewersMap();
312
313	void VBoxVMLogViewer::createLogViewer (CMachine &aMachine)
314	{
315	if (mSelfArray.find (aMachine.GetName()) == mSelfArray.end())
316	{
317	/* creating new log viewer if there is no one existing */
318	mSelfArray [aMachine.GetName()] = new VBoxVMLogViewer (0,
319	"VBoxVMLogViewer", WType_TopLevel \| WDestructiveClose);
320	/* read new machine data for this log viewer */
321	mSelfArray [aMachine.GetName()]->setup (aMachine);
322	}
323
324	VBoxVMLogViewer *viewer = mSelfArray [aMachine.GetName()];
325	viewer->show();
326	viewer->setWindowState (viewer->windowState() & ~WindowMinimized);
327	viewer->setActiveWindow();
328	}
329
330
331	void VBoxVMLogViewer::init()
332	{
333	/* prepare dialog to first run */
334	mFirstRun = true;
335
336	/* dialog initially is not polished */
337	mIsPolished = false;
338
339	/* search the default button */
340	mDefaultButton = searchDefaultButton();
341	qApp->installEventFilter (this);
342
343	/* setup a dialog icon */
344	setIcon (QPixmap::fromMimeSource ("show_logs_16px.png"));
345
346	/* statusbar initially disabled */
347	statusBar()->setHidden (true);
348
349	/* setup size grip */
350	mSizeGrip = new QSizeGrip (centralWidget(), "mSizeGrip");
351	mSizeGrip->resize (mSizeGrip->sizeHint());
352	mSizeGrip->stackUnder (mCloseButton);
353
354	/* logs list creation */
355	mLogList = new QTabWidget (mLogsFrame, "mLogList");
356	QVBoxLayout *logsFrameLayout = new QVBoxLayout (mLogsFrame);
357	logsFrameLayout->addWidget (mLogList);
358
359	/* search panel creation */
360	mSearchPanel = new VBoxLogSearchPanel (mLogsFrame, this,
361	"VBoxLogSearchPanel");
362	logsFrameLayout->addWidget (mSearchPanel);
363	mSearchPanel->hide();
364
365	/* fix the tab order to ensure the dialog keys are always the last */
366	setTabOrder (mSearchPanel->focusProxy(), mHelpButton);
367	setTabOrder (mHelpButton, mFindButton);
368	setTabOrder (mFindButton, mSaveButton);
369	setTabOrder (mSaveButton, mRefreshButton);
370	setTabOrder (mRefreshButton, mCloseButton);
371	setTabOrder (mCloseButton, mLogList);
372
373	/* make the [Save] button focused by default */
374	mSaveButton->setFocus();
375
376	/* applying language settings */
377	languageChangeImp();
378	}
379
380
381	void VBoxVMLogViewer::destroy()
382	{
383	mSelfArray.erase (mMachine.GetName());
384	}
385
386
387	void VBoxVMLogViewer::setup (CMachine &aMachine)
388	{
389	/* saving related machine */
390	mMachine = aMachine;
391
392	/* reading log files */
393	refresh();
394
395	/* loading language constants */
396	languageChangeImp();
397	}
398
399
400	const CMachine& VBoxVMLogViewer::machine()
401	{
402	return mMachine;
403	}
404
405
406	void VBoxVMLogViewer::languageChangeImp()
407	{
408	/* setup a dialog caption */
409	if (!mMachine.isNull())
410	setCaption (tr ("%1 - VirtualBox Log Viewer").arg (mMachine.GetName()));
411	/* translate a search panel */
412	if (mSearchPanel)
413	mSearchPanel->languageChange();
414	}
415
416
417	QPushButton* VBoxVMLogViewer::searchDefaultButton()
418	{
419	/* this mechanism is used for searching the default dialog button
420	* and similar the same mechanism in Qt::QDialog inner source */
421	QPushButton *button = 0;
422	QObjectList *list = queryList ("QPushButton");
423	QObjectListIt it (*list);
424	while ((button = (QPushButton*)it.current()) && !button->isDefault())
425	++ it;
426	return button;
427	}
428
429
430	bool VBoxVMLogViewer::eventFilter (QObject aObject, QEvent aEvent)
431	{
432	switch (aEvent->type())
433	{
434	/* auto-default button focus-in processor used to move the "default"
435	* button property into the currently focused button */
436	case QEvent::FocusIn:
437	{
438	if (aObject->inherits ("QPushButton") &&
439	aObject->parent() == centralWidget())
440	{
441	((QPushButton*)aObject)->setDefault (aObject != mDefaultButton);
442	if (mDefaultButton)
443	mDefaultButton->setDefault (aObject == mDefaultButton);
444	}
445	break;
446	}
447	/* auto-default button focus-out processor used to remove the "default"
448	* button property from the previously focused button */
449	case QEvent::FocusOut:
450	{
451	if (aObject->inherits ("QPushButton") &&
452	aObject->parent() == centralWidget())
453	{
454	if (mDefaultButton)
455	mDefaultButton->setDefault (aObject != mDefaultButton);
456	((QPushButton*)aObject)->setDefault (aObject == mDefaultButton);
457	}
458	break;
459	}
460	default:
461	break;
462	}
463	return QMainWindow::eventFilter (aObject, aEvent);
464	}
465
466
467	bool VBoxVMLogViewer::event (QEvent *aEvent)
468	{
469	bool result = QMainWindow::event (aEvent);
470	switch (aEvent->type())
471	{
472	case QEvent::LanguageChange:
473	{
474	languageChangeImp();
475	break;
476	}
477	default:
478	break;
479	}
480	return result;
481	}
482
483
484	void VBoxVMLogViewer::keyPressEvent (QKeyEvent *aEvent)
485	{
486	if (aEvent->state() == 0 \|\|
487	(aEvent->state() & Keypad && aEvent->key() == Key_Enter))
488	{
489	switch (aEvent->key())
490	{
491	/* processing the return keypress for the auto-default button */
492	case Key_Enter:
493	case Key_Return:
494	{
495	QPushButton *currentDefault = searchDefaultButton();
496	if (currentDefault)
497	currentDefault->animateClick();
498	break;
499	}
500	/* processing the escape keypress as the close dialog action */
501	case Key_Escape:
502	{
503	mCloseButton->animateClick();
504	break;
505	}
506	}
507	}
508	else
509	aEvent->ignore();
510	}
511
512
513	void VBoxVMLogViewer::showEvent (QShowEvent *aEvent)
514	{
515	QMainWindow::showEvent (aEvent);
516
517	/* one may think that QWidget::polish() is the right place to do things
518	* below, but apparently, by the time when QWidget::polish() is called,
519	* the widget style & layout are not fully done, at least the minimum
520	* size hint is not properly calculated. Since this is sometimes necessary,
521	* we provide our own "polish" implementation. */
522
523	if (mIsPolished)
524	return;
525
526	mIsPolished = true;
527
528	VBoxGlobal::centerWidget (this, parentWidget());
529	}
530
531
532	void VBoxVMLogViewer::resizeEvent (QResizeEvent*)
533	{
534	/* adjust the size-grip location for the current resize event */
535	mSizeGrip->move (centralWidget()->rect().bottomRight() -
536	QPoint (mSizeGrip->rect().width() - 1,
537	mSizeGrip->rect().height() - 1));
538	}
539
540
541	void VBoxVMLogViewer::refresh()
542	{
543	/* clearing old data if any */
544	mLogFilesList.clear();
545	mLogList->setEnabled (true);
546	while (mLogList->count())
547	{
548	QWidget *logPage = mLogList->page (0);
549	mLogList->removePage (logPage);
550	delete logPage;
551	}
552
553	bool isAnyLogPresent = false;
554
555	/* entering log files folder */
556	QString logFilesPath = mMachine.GetLogFolder();
557	QDir logFilesDir (logFilesPath);
558	if (logFilesDir.exists())
559	{
560	/* reading log files folder */
561	logFilesDir.setNameFilter (".log .log.*");
562	QStringList logList = logFilesDir.entryList (QDir::Files);
563	if (!logList.empty()) isAnyLogPresent = true;
564	for (QStringList::Iterator it = logList.begin(); it != logList.end(); ++it)
565	loadLogFile (logFilesDir.filePath (*it));
566	}
567
568	/* create an empty log page if there are no logs at all */
569	if (!isAnyLogPresent)
570	{
571	QTextBrowser *dummyLog = createLogPage ("VBox.log");
572	dummyLog->setTextFormat (Qt::RichText);
573	dummyLog->setWordWrap (QTextEdit::WidgetWidth);
574	dummyLog->setText (tr ("<p>No log files found. Press the <b>Refresh</b> "
575	"button to rescan the log folder <nobr><b>%1</b></nobr>.</p>")
576	.arg (logFilesPath));
577	/* we don't want it to remain white */
578	dummyLog->setPaper (backgroundBrush());
579	}
580
581	/* restore previous tab-widget margin which was reseted when
582	* the tab widget's children was removed */
583	mLogList->setMargin (10);
584
585	/* show the first tab widget's page after the refresh */
586	mLogList->showPage (mLogList->page(0));
587
588	/* enable/disable save button & tab widget according log presence */
589	mFindButton->setEnabled (isAnyLogPresent);
590	mSaveButton->setEnabled (isAnyLogPresent);
591	mLogList->setEnabled (isAnyLogPresent);
592
593	if (mFirstRun)
594	{
595	/* resize the whole log-viewer to fit 80 symbols in text-browser for
596	* the first time started */
597	QTextBrowser firstPage = static_cast <QTextBrowser > (mLogList->page(0));
598	int fullWidth = firstPage->fontMetrics().width (QChar ('x')) * 80 +
599	firstPage->verticalScrollBar()->width() +
600	firstPage->frameWidth() * 2 +
601	5 + 4 /* left text margin + QTabWidget frame width */ +
602	mLogList->margin() * 2 +
603	centralWidget()->layout()->margin() * 2;
604	resize (fullWidth, height());
605	mFirstRun = false;
606	}
607	}
608
609
610	void VBoxVMLogViewer::loadLogFile (const QString &aFileName)
611	{
612	/* prepare log file */
613	QFile logFile (aFileName);
614	if (!logFile.exists() \|\| !logFile.open (IO_ReadOnly))
615	return;
616
617	/* read log file and write it into the log page */
618	QTextBrowser *logViewer = createLogPage (QFileInfo (aFileName).fileName());
619	logViewer->setText (logFile.readAll());
620
621	mLogFilesList << aFileName;
622	}
623
624
625	QTextBrowser* VBoxVMLogViewer::createLogPage (const QString &aName)
626	{
627	QTextBrowser *logViewer = new QTextBrowser();
628	logViewer->setTextFormat (Qt::PlainText);
629	QFont font = logViewer->currentFont();
630	font.setFamily ("Courier New,courier");
631	logViewer->setFont (font);
632	logViewer->setWordWrap (QTextEdit::NoWrap);
633	logViewer->setVScrollBarMode (QScrollView::AlwaysOn);
634	mLogList->addTab (logViewer, aName);
635	return logViewer;
636	}
637
638
639	QTextBrowser* VBoxVMLogViewer::currentLogPage()
640	{
641	return mLogList->isEnabled() ?
642	static_cast<QTextBrowser*> (mLogList->currentPage()) : 0;
643	}
644
645
646	void VBoxVMLogViewer::save()
647	{
648	/* prepare "save as" dialog */
649	QFileInfo fileInfo (mLogFilesList [mLogList->currentPageIndex()]);
650	QDateTime dtInfo = fileInfo.lastModified();
651	QString dtString = dtInfo.toString ("yyyy-MM-dd-hh-mm-ss");
652	QString defaultFileName = QString ("%1-%2.log")
653	.arg (mMachine.GetName()).arg (dtString);
654	QString defaultFullName = QDir::convertSeparators (QDir::home().absPath() +
655	"/" + defaultFileName);
656
657	QString newFileName = QFileDialog::getSaveFileName (defaultFullName,
658	QString::null, this, "SaveLogAsDialog", tr ("Save VirtualBox Log As"));
659
660	/* save new log into the file */
661	if (!newFileName.isEmpty())
662	{
663	/* reread log data */
664	QFile oldFile (mLogFilesList [mLogList->currentPageIndex()]);
665	QFile newFile (newFileName);
666	if (!oldFile.open (IO_ReadOnly) \|\| !newFile.open (IO_WriteOnly))
667	return;
668
669	/* save log data into the new file */
670	newFile.writeBlock (oldFile.readAll());
671	}
672	}
673
674	void VBoxVMLogViewer::search()
675	{
676	mSearchPanel->isHidden() ? mSearchPanel->show() : mSearchPanel->hide();
677	}
678
679	#include "VBoxVMLogViewer.ui.moc"
680

Note: See TracBrowser for help on using the repository browser.

source: vbox/trunk/src/VBox/Frontends/VirtualBox/ui/VBoxVMLogViewer.ui.h@ 3927

Download in other formats: