HelpBrowser Class Reference

Inheritance diagram for HelpBrowser:

Collaboration diagram for HelpBrowser:

Public Slots
void	jumpToHelpSection (const QString &jumpToSection, const QString &jumpToFile="", bool dontChangeIfAlreadyLoaded=false)

Signals
void	closed ()

Public Member Functions
	HelpBrowser (QWidget *parent)
	HelpBrowser (QWidget *parent, const QString &caption, const QString &guiLangage="en", const QString &jumpToSection="", const QString &jumpToFile="")
virtual void	changeEvent (QEvent *e)
void	setHtml (const QString &str)
	Set text to the browser. More...

Public Attributes
QMenu *	histMenu
	History menu. It's public because of history reader - separate class.
QMap< QAction *, histd2 >	mHistory
	Mapping the documents for history.

Static Public Attributes
static bool	firstRun =true

Protected Slots
virtual void	languageChange ()
void	histChosen (QAction *i)
void	loadHelp (const QString &filename)
void	loadMenu ()
QString	bookmarkFile ()
	Returns the name of the cfg file for bookmarks. A helper function. More...
QString	historyFile ()
	Returns the name of the cfg file for persistent history. A helper function. More...
void	itemSelected (const QItemSelection &selected, const QItemSelection &deselected)
	Load doc file when user select filename in content view.
void	itemSearchSelected (QTreeWidgetItem *, int)
	Load doc file when user select filename in search view.
void	itemBookmarkSelected (QTreeWidgetItem *, int)
	Load doc file when user select filename in bookmark view.
void	searchingButton_clicked ()
	Performs searching in documentation. It walks through installed documentation and searching in all text files. More...
void	find ()
	Find text in one document. Classical ctrl+f searching. More...
void	findNext ()
	Find next occurences of the text in one document. More...
void	findPrevious ()
	Find previous occurences of the text in one document. More...
void	print ()
	Print the documentation. Based on the Qt example.
void	bookmarkButton_clicked ()
	Add document into bookmarks.
void	deleteBookmarkButton_clicked ()
	Delete selected document from bookmarks.
void	deleteAllBookmarkButton_clicked ()
	Delete all bookmarks.

Protected Member Functions
void	closeEvent (QCloseEvent *event)
void	setupLocalUI ()
void	readBookmarks ()
	Reads saved bookmarks from external file.
void	searchingInDirectory (const QString &)
	Search in doc files in spec. dir. It uses directory-recursion. I hope that the documentation will have only 2-3 level dir structure so it doesn't matter. More...
void	readHistory ()
	Reads saved history of browsing.
void	displayNoHelp ()
	Tell the user there is no help available.

Protected Attributes
HelpNavigation *	helpNav
QMenu *	fileMenu
QMenu *	editMenu
QMenu *	bookMenu
QAction *	filePrint
QAction *	fileExit
QAction *	editFind
QAction *	editFindNext
QAction *	editFindPrev
QAction *	bookAdd
QAction *	bookDel
QAction *	bookDelAll
QAction *	goHome
QAction *	goBack
QAction *	goFwd
QProgressBar *	progressBar
QString	language
	Selected language is here. If there is no docs for this language, "en" is used.
QString	finalBaseDir
	QString holding location of menu.xml we are using, we load the help files from here.
QString	findText
	Text to be found in document.
PrefsContext *	prefs
	Configuration structure.
ScHelpTreeModel *	menuModel
QMap< QString, QString >	quickHelpIndex
QMap< QString, QPair< QString, QString > >	bookmarkIndex

Member Function Documentation

QString HelpBrowser::bookmarkFile ( )

protectedslot

Returns the name of the cfg file for bookmarks. A helper function.

Author

Petr Vanek petr@.nosp@m.yarp.nosp@m.en.cz

void HelpBrowser::find ( )

protectedslot

Find text in one document. Classical ctrl+f searching.

Author

Petr Vanek petr@.nosp@m.yarp.nosp@m.en.cz

void HelpBrowser::findNext ( )

protectedslot

Find next occurences of the text in one document.

Author

Petr Vanek petr@.nosp@m.yarp.nosp@m.en.cz

void HelpBrowser::findPrevious ( )

protectedslot

Find previous occurences of the text in one document.

Author

Petr Vanek petr@.nosp@m.yarp.nosp@m.en.cz

QString HelpBrowser::historyFile ( )

protectedslot

Returns the name of the cfg file for persistent history. A helper function.

Author

Petr Vanek petr@.nosp@m.yarp.nosp@m.en.cz

void HelpBrowser::searchingButton_clicked ( )

protectedslot

Performs searching in documentation. It walks through installed documentation and searching in all text files.

Author

Petr Vanek petr@.nosp@m.yarp.nosp@m.en.cz

void HelpBrowser::searchingInDirectory ( const QString &  aDir )

protected

Search in doc files in spec. dir. It uses directory-recursion. I hope that the documentation will have only 2-3 level dir structure so it doesn't matter.

Author

Petr Vanek petr@.nosp@m.yarp.nosp@m.en.cz

void HelpBrowser::setHtml

(

const QString &

str

)

Set text to the browser.

Parameters

str	a QString with text (html)

---

The documentation for this class was generated from the following files:

• /Users/ale/src/Scribus/scribus/ui/helpbrowser.h
• /Users/ale/src/Scribus/scribus/ui/helpbrowser.cpp