#include <helpenginewrapper.h>

Inheritance diagram for HelpEngineWrapper:

Collaboration diagram for HelpEngineWrapper:

Signals
void	documentationRemoved (const QString &namespaceName)

void	documentationUpdated (const QString &namespaceName)

void	setupFinished ()

Signals inherited from QObject
void	destroyed (QObject *=nullptr)
	This signal is emitted immediately before the object obj is destroyed, after any instances of QPointer have been notified, and cannot be blocked.

void	objectNameChanged (const QString &objectName, QPrivateSignal)
	This signal is emitted after the object's name has been changed.

Public Member Functions
QHelpSearchEngine *	searchEngine () const

QHelpContentModel *	contentModel () const

QHelpIndexModel *	indexModel () const

QHelpContentWidget *	contentWidget ()

QHelpIndexWidget *	indexWidget ()

bool	setupData ()

const QStringList	registeredDocumentations () const

QString	documentationFileName (const QString &namespaceName) const

const QString	collectionFile () const

bool	registerDocumentation (const QString &docFile)

bool	unregisterDocumentation (const QString &namespaceName)

QUrl	findFile (const QUrl &url) const

QByteArray	fileData (const QUrl &url) const

QList< QHelpLink >	documentsForIdentifier (const QString &id) const

QString	error () const

QHelpFilterEngine *	filterEngine () const

void	initialDocSetupDone ()

const QStringList	qtDocInfo (const QString &component) const

void	setQtDocInfo (const QString &component, const QStringList &doc)

const QString	homePage () const

void	setHomePage (const QString &page)

const QString	defaultHomePage () const

void	setDefaultHomePage (const QString &page)

int	lastTabPage () const

void	setLastTabPage (int lastPage)

const QStringList	lastShownPages () const

void	setLastShownPages (const QStringList &lastShownPages)

const QStringList	lastZoomFactors () const

void	setLastZoomFactors (const QStringList &lastZoomFactors)

const QString	cacheDir () const

bool	cacheDirIsRelativeToCollection () const

void	setCacheDir (const QString &cacheDir, bool relativeToCollection)

bool	filterFunctionalityEnabled () const

void	setFilterFunctionalityEnabled (bool enabled)

bool	filterToolbarVisible () const

void	setFilterToolbarVisible (bool visible)

bool	addressBarEnabled () const

void	setAddressBarEnabled (bool enabled)

bool	addressBarVisible () const

void	setAddressBarVisible (bool visible)

bool	documentationManagerEnabled () const

void	setDocumentationManagerEnabled (bool enabled)

const QByteArray	aboutMenuTexts () const

void	setAboutMenuTexts (const QByteArray &texts)

const QByteArray	aboutTexts () const

void	setAboutTexts (const QByteArray &texts)

const QByteArray	aboutIcon () const

void	setAboutIcon (const QByteArray &icon)

const QByteArray	aboutImages () const

void	setAboutImages (const QByteArray &images)

const QString	windowTitle () const

void	setWindowTitle (const QString &windowTitle)

const QByteArray	applicationIcon () const

void	setApplicationIcon (const QByteArray &icon)

const QByteArray	mainWindow () const

void	setMainWindow (const QByteArray &mainWindow)

const QByteArray	mainWindowGeometry () const

void	setMainWindowGeometry (const QByteArray &geometry)

const QByteArray	bookmarks () const

void	setBookmarks (const QByteArray &bookmarks)

int	startOption () const

void	setStartOption (int option)

bool	hasFontSettings () const

bool	usesAppFont () const

void	setUseAppFont (bool useAppFont)

bool	usesBrowserFont () const

void	setUseBrowserFont (bool useBrowserFont)

const QFont	appFont () const

void	setAppFont (const QFont &font)

QFontDatabase::WritingSystem	appWritingSystem () const

void	setAppWritingSystem (QFontDatabase::WritingSystem system)

const QFont	browserFont () const

void	setBrowserFont (const QFont &font)

QFontDatabase::WritingSystem	browserWritingSystem () const

void	setBrowserWritingSystem (QFontDatabase::WritingSystem system)

bool	showTabs () const

void	setShowTabs (bool show)

bool	fullTextSearchFallbackEnabled () const

const QByteArray	topicChooserGeometry () const

void	setTopicChooserGeometry (const QByteArray &geometry)

QHelpEngineCore *	helpEngine () const

Public Member Functions inherited from QObject
Q_INVOKABLE	QObject (QObject *parent=nullptr)
	Constructs an object with parent object parent.

virtual	~QObject ()
	Destroys the object, deleting all its child objects.

virtual bool	event (QEvent *event)
	This virtual function receives events to an object and should return true if the event e was recognized and processed.

virtual bool	eventFilter (QObject watched, QEvent event)
	Filters events if this object has been installed as an event filter for the watched object.

QString	objectName () const

Q_WEAK_OVERLOAD void	setObjectName (const QString &name)
	Sets the object's name to name.

void	setObjectName (QAnyStringView name)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

QBindable< QString >	bindableObjectName ()

bool	isWidgetType () const
	Returns `true` if the object is a widget; otherwise returns `false`.

bool	isWindowType () const
	Returns `true` if the object is a window; otherwise returns `false`.

bool	isQuickItemType () const
	Returns `true` if the object is a QQuickItem; otherwise returns `false`.

bool	signalsBlocked () const noexcept
	Returns `true` if signals are blocked; otherwise returns `false`.

bool	blockSignals (bool b) noexcept
	If block is true, signals emitted by this object are blocked (i.e., emitting a signal will not invoke anything connected to it).

QThread *	thread () const
	Returns the thread in which the object lives.

bool	moveToThread (QThread *thread QT6_DECL_NEW_OVERLOAD_TAIL)
	Changes the thread affinity for this object and its children and returns `true` on success.

int	startTimer (int interval, Qt::TimerType timerType=Qt::CoarseTimer)
	This is an overloaded function that will start a timer of type timerType and a timeout of interval milliseconds.

int	startTimer (std::chrono::nanoseconds time, Qt::TimerType timerType=Qt::CoarseTimer)

void	killTimer (int id)
	Kills the timer with timer identifier, id.

void	killTimer (Qt::TimerId id)

template<typename T >
T	findChild (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	Returns the child of this object that can be cast into type T and that is called name, or \nullptr if there is no such object.

template<typename T >
QList< T >	findChildren (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	Returns all children of this object with the given name that can be cast to type T, or an empty list if there are no such objects.

template<typename T >
T	findChild (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

template<typename T >
QList< T >	findChildren (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

const QObjectList &	children () const
	Returns a list of child objects.

void	setParent (QObject *parent)
	Makes the object a child of parent.

void	installEventFilter (QObject *filterObj)
	Installs an event filter filterObj on this object.

void	removeEventFilter (QObject *obj)
	Removes an event filter object obj from this object.

QMetaObject::Connection	connect (const QObject sender, const char signal, const char *member, Qt::ConnectionType type=Qt::AutoConnection) const

bool	disconnect (const char signal=nullptr, const QObject receiver=nullptr, const char *member=nullptr) const

bool	disconnect (const QObject receiver, const char member=nullptr) const

void	dumpObjectTree () const
	Dumps a tree of children to the debug output.

void	dumpObjectInfo () const
	Dumps information about signal connections, etc.

bool	setProperty (const char *name, const QVariant &value)
	Sets the value of the object's name property to value.

bool	setProperty (const char *name, QVariant &&value)

QVariant	property (const char *name) const
	Returns the value of the object's name property.

QList< QByteArray >	dynamicPropertyNames () const

QBindingStorage *	bindingStorage ()

const QBindingStorage *	bindingStorage () const

QObject *	parent () const
	Returns a pointer to the parent object.

bool	inherits (const char *classname) const
	Returns `true` if this object is an instance of a class that inherits className or a QObject subclass that inherits className; otherwise returns `false`.

Static Public Member Functions
static HelpEngineWrapper &	instance ()

static HelpEngineWrapper &	instance (const QString &collectionFile)

static void	removeInstance ()

Static Public Member Functions inherited from QObject
static QMetaObject::Connection	connect (const QObject sender, const char signal, const QObject receiver, const char member, Qt::ConnectionType=Qt::AutoConnection)
	\threadsafe

static QMetaObject::Connection	connect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method, Qt::ConnectionType type=Qt::AutoConnection)

template<typename Func1 , typename Func2 >
static QMetaObject::Connection	connect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const typename QtPrivate::ContextTypeForFunctor< Func2 >::ContextType context, Func2 &&slot, Qt::ConnectionType type=Qt::AutoConnection)

template<typename Func1 , typename Func2 >
static QMetaObject::Connection	connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, Func2 &&slot)

static bool	disconnect (const QObject sender, const char signal, const QObject receiver, const char member)
	\threadsafe

static bool	disconnect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &member)

static bool	disconnect (const QMetaObject::Connection &)
	Disconnect a connection.

template<typename Func1 , typename Func2 >
static bool	disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const typename QtPrivate::FunctionPointer< Func2 >::Object receiver, Func2 slot)

template<typename Func1 >
static bool	disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const QObject receiver, void **zero)

Friends
class	TimeoutForwarder

Additional Inherited Members
Public Slots inherited from QObject
void	deleteLater ()
	\threadsafe

Protected Member Functions inherited from QObject
QObject *	sender () const
	Returns a pointer to the object that sent the signal, if called in a slot activated by a signal; otherwise it returns \nullptr.

int	senderSignalIndex () const

int	receivers (const char *signal) const
	Returns the number of receivers connected to the signal.

bool	isSignalConnected (const QMetaMethod &signal) const

virtual void	timerEvent (QTimerEvent *event)
	This event handler can be reimplemented in a subclass to receive timer events for the object.

virtual void	childEvent (QChildEvent *event)
	This event handler can be reimplemented in a subclass to receive child events.

virtual void	customEvent (QEvent *event)
	This event handler can be reimplemented in a subclass to receive custom events.

virtual void	connectNotify (const QMetaMethod &signal)

virtual void	disconnectNotify (const QMetaMethod &signal)

	QObject (QObjectPrivate &dd, QObject *parent=nullptr)

Protected Attributes inherited from QObject
QScopedPointer< QObjectData >	d_ptr

Properties inherited from QObject
QString	objectName
	the name of this object

Related Symbols inherited from QObject
template< class T > T	qobject_cast (const QObject *object)
	Returns the given object cast to type T if the object is of type T (or of a subclass); otherwise returns \nullptr.

template< typename T > T	qFindChildqFindChildren (const QObject *obj, const QString &name)()

template< typename T > QList< T >	qFindChildrenqFindChildren (const QObject *obj, const QString &name)()

	QObjectList
	\macro Q_CLASSINFO(Name, Value)

Detailed Description

Definition at line 37 of file helpenginewrapper.h.

Member Function Documentation

◆ aboutIcon()

const QByteArray HelpEngineWrapper::aboutIcon ( ) const

Definition at line 399 of file helpenginewrapper.cpp.

◆ aboutImages()

const QByteArray HelpEngineWrapper::aboutImages ( ) const

Definition at line 411 of file helpenginewrapper.cpp.

◆ aboutMenuTexts()

const QByteArray HelpEngineWrapper::aboutMenuTexts ( ) const

Definition at line 387 of file helpenginewrapper.cpp.

◆ aboutTexts()

const QByteArray HelpEngineWrapper::aboutTexts ( ) const

Definition at line 423 of file helpenginewrapper.cpp.

◆ addressBarEnabled()

bool HelpEngineWrapper::addressBarEnabled ( ) const

Definition at line 350 of file helpenginewrapper.cpp.

References CollectionConfiguration::addressBarEnabled().

Referenced by MainWindow::MainWindow().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addressBarVisible()

bool HelpEngineWrapper::addressBarVisible ( ) const

Definition at line 362 of file helpenginewrapper.cpp.

References CollectionConfiguration::addressBarVisible().

Here is the call graph for this function:

◆ appFont()

const QFont HelpEngineWrapper::appFont ( ) const

Definition at line 578 of file helpenginewrapper.cpp.

◆ applicationIcon()

const QByteArray HelpEngineWrapper::applicationIcon ( ) const

Definition at line 447 of file helpenginewrapper.cpp.

◆ appWritingSystem()

QFontDatabase::WritingSystem HelpEngineWrapper::appWritingSystem ( ) const

Definition at line 590 of file helpenginewrapper.cpp.

◆ bookmarks()

const QByteArray HelpEngineWrapper::bookmarks ( ) const

Definition at line 483 of file helpenginewrapper.cpp.

◆ browserFont()

const QFont HelpEngineWrapper::browserFont ( ) const

Definition at line 603 of file helpenginewrapper.cpp.

◆ browserWritingSystem()

QFontDatabase::WritingSystem HelpEngineWrapper::browserWritingSystem ( ) const

Definition at line 615 of file helpenginewrapper.cpp.

◆ cacheDir()

const QString HelpEngineWrapper::cacheDir ( ) const

Definition at line 305 of file helpenginewrapper.cpp.

◆ cacheDirIsRelativeToCollection()

bool HelpEngineWrapper::cacheDirIsRelativeToCollection ( ) const

Definition at line 311 of file helpenginewrapper.cpp.

References CollectionConfiguration::cacheDirIsRelativeToCollection().

Here is the call graph for this function:

◆ collectionFile()

const QString HelpEngineWrapper::collectionFile ( ) const

Definition at line 202 of file helpenginewrapper.cpp.

◆ contentModel()

QHelpContentModel * HelpEngineWrapper::contentModel ( ) const

Definition at line 166 of file helpenginewrapper.cpp.

◆ contentWidget()

QHelpContentWidget * HelpEngineWrapper::contentWidget ( )

Definition at line 178 of file helpenginewrapper.cpp.

◆ defaultHomePage()

const QString HelpEngineWrapper::defaultHomePage ( ) const

Definition at line 536 of file helpenginewrapper.cpp.

◆ documentationFileName()

QString HelpEngineWrapper::documentationFileName ( const QString & namespaceName ) const

Definition at line 196 of file helpenginewrapper.cpp.

◆ documentationManagerEnabled()

bool HelpEngineWrapper::documentationManagerEnabled ( ) const

Definition at line 374 of file helpenginewrapper.cpp.

References CollectionConfiguration::documentationManagerEnabled().

Referenced by PreferencesDialog::PreferencesDialog().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ documentationRemoved

void HelpEngineWrapper::documentationRemoved ( const QString & namespaceName )

signal

◆ documentationUpdated

void HelpEngineWrapper::documentationUpdated ( const QString & namespaceName )

signal

◆ documentsForIdentifier()

QList< QHelpLink > HelpEngineWrapper::documentsForIdentifier ( const QString & id ) const

Definition at line 249 of file helpenginewrapper.cpp.

◆ error()

QString HelpEngineWrapper::error ( ) const

Definition at line 255 of file helpenginewrapper.cpp.

◆ fileData()

QByteArray HelpEngineWrapper::fileData ( const QUrl & url ) const

Definition at line 243 of file helpenginewrapper.cpp.

◆ filterEngine()

QHelpFilterEngine * HelpEngineWrapper::filterEngine ( ) const

Definition at line 261 of file helpenginewrapper.cpp.

Referenced by MainWindow::MainWindow().

Here is the caller graph for this function:

◆ filterFunctionalityEnabled()

bool HelpEngineWrapper::filterFunctionalityEnabled ( ) const

Definition at line 325 of file helpenginewrapper.cpp.

References CollectionConfiguration::filterFunctionalityEnabled().

Referenced by PreferencesDialog::PreferencesDialog().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ filterToolbarVisible()

bool HelpEngineWrapper::filterToolbarVisible ( ) const

Definition at line 338 of file helpenginewrapper.cpp.

References CollectionConfiguration::filterToolbarVisible().

Here is the call graph for this function:

◆ findFile()

QUrl HelpEngineWrapper::findFile ( const QUrl & url ) const

Definition at line 237 of file helpenginewrapper.cpp.

◆ fullTextSearchFallbackEnabled()

bool HelpEngineWrapper::fullTextSearchFallbackEnabled ( ) const

Definition at line 640 of file helpenginewrapper.cpp.

References CollectionConfiguration::fullTextSearchFallbackEnabled().

Here is the call graph for this function:

◆ hasFontSettings()

bool HelpEngineWrapper::hasFontSettings ( ) const

Definition at line 548 of file helpenginewrapper.cpp.

Referenced by MainWindow::MainWindow().

Here is the caller graph for this function:

◆ helpEngine()

QHelpEngineCore * HelpEngineWrapper::helpEngine ( ) const

Definition at line 658 of file helpenginewrapper.cpp.

◆ homePage()

const QString HelpEngineWrapper::homePage ( ) const

Definition at line 519 of file helpenginewrapper.cpp.

◆ indexModel()

QHelpIndexModel * HelpEngineWrapper::indexModel ( ) const

Definition at line 172 of file helpenginewrapper.cpp.

◆ indexWidget()

QHelpIndexWidget * HelpEngineWrapper::indexWidget ( )

Definition at line 184 of file helpenginewrapper.cpp.

◆ initialDocSetupDone()

void HelpEngineWrapper::initialDocSetupDone ( )

Definition at line 151 of file helpenginewrapper.cpp.

References setupData().

Here is the call graph for this function:

◆ instance() [1/2]

HelpEngineWrapper & HelpEngineWrapper::instance ( )

static

Definition at line 89 of file helpenginewrapper.cpp.

References instance().

Referenced by BookmarkDialog::BookmarkDialog(), CentralWidget::CentralWidget(), MainWindow::MainWindow(), PreferencesDialog::PreferencesDialog(), RemoteControl::RemoteControl(), CentralWidget::~CentralWidget(), TopicChooser::~TopicChooser(), HelpBrowserSupport::fileDataForLocalUrl(), getData(), instance(), HelpViewer::launchWithExternalApp(), HelpBrowserSupport::resolveUrl(), and CentralWidget::updateUserInterface().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ instance() [2/2]

HelpEngineWrapper & HelpEngineWrapper::instance ( const QString & collectionFile )

static

Definition at line 94 of file helpenginewrapper.cpp.

◆ lastShownPages()

const QStringList HelpEngineWrapper::lastShownPages ( ) const

Definition at line 281 of file helpenginewrapper.cpp.

◆ lastTabPage()

int HelpEngineWrapper::lastTabPage ( ) const

Definition at line 495 of file helpenginewrapper.cpp.

References CollectionConfiguration::lastTabPage().

Here is the call graph for this function:

◆ lastZoomFactors()

const QStringList HelpEngineWrapper::lastZoomFactors ( ) const

Definition at line 293 of file helpenginewrapper.cpp.

◆ mainWindow()

const QByteArray HelpEngineWrapper::mainWindow ( ) const

Definition at line 459 of file helpenginewrapper.cpp.

◆ mainWindowGeometry()

const QByteArray HelpEngineWrapper::mainWindowGeometry ( ) const

Definition at line 471 of file helpenginewrapper.cpp.

◆ qtDocInfo()

const QStringList HelpEngineWrapper::qtDocInfo ( const QString & component ) const

Definition at line 266 of file helpenginewrapper.cpp.

◆ registerDocumentation()

bool HelpEngineWrapper::registerDocumentation ( const QString & docFile )

Definition at line 208 of file helpenginewrapper.cpp.

◆ registeredDocumentations()

const QStringList HelpEngineWrapper::registeredDocumentations ( ) const

Definition at line 190 of file helpenginewrapper.cpp.

◆ removeInstance()

void HelpEngineWrapper::removeInstance ( )

static

Definition at line 106 of file helpenginewrapper.cpp.

Referenced by main().

Here is the caller graph for this function:

◆ searchEngine()

QHelpSearchEngine * HelpEngineWrapper::searchEngine ( ) const

Definition at line 160 of file helpenginewrapper.cpp.

Referenced by MainWindow::MainWindow().

Here is the caller graph for this function:

◆ setAboutIcon()

void HelpEngineWrapper::setAboutIcon ( const QByteArray & icon )

Definition at line 405 of file helpenginewrapper.cpp.

◆ setAboutImages()

void HelpEngineWrapper::setAboutImages ( const QByteArray & images )

Definition at line 417 of file helpenginewrapper.cpp.

◆ setAboutMenuTexts()

void HelpEngineWrapper::setAboutMenuTexts ( const QByteArray & texts )

Definition at line 393 of file helpenginewrapper.cpp.

◆ setAboutTexts()

void HelpEngineWrapper::setAboutTexts ( const QByteArray & texts )

Definition at line 429 of file helpenginewrapper.cpp.

◆ setAddressBarEnabled()

void HelpEngineWrapper::setAddressBarEnabled ( bool enabled )

Definition at line 356 of file helpenginewrapper.cpp.

References CollectionConfiguration::setAddressBarEnabled().

Here is the call graph for this function:

◆ setAddressBarVisible()

void HelpEngineWrapper::setAddressBarVisible ( bool visible )

Definition at line 368 of file helpenginewrapper.cpp.

References CollectionConfiguration::setAddressBarVisible().

Here is the call graph for this function:

◆ setAppFont()

void HelpEngineWrapper::setAppFont ( const QFont & font )

Definition at line 584 of file helpenginewrapper.cpp.

◆ setApplicationIcon()

void HelpEngineWrapper::setApplicationIcon ( const QByteArray & icon )

Definition at line 453 of file helpenginewrapper.cpp.

◆ setAppWritingSystem()

void HelpEngineWrapper::setAppWritingSystem ( QFontDatabase::WritingSystem system )

Definition at line 597 of file helpenginewrapper.cpp.

◆ setBookmarks()

void HelpEngineWrapper::setBookmarks ( const QByteArray & bookmarks )

Definition at line 489 of file helpenginewrapper.cpp.

◆ setBrowserFont()

void HelpEngineWrapper::setBrowserFont ( const QFont & font )

Definition at line 609 of file helpenginewrapper.cpp.

◆ setBrowserWritingSystem()

void HelpEngineWrapper::setBrowserWritingSystem ( QFontDatabase::WritingSystem system )

Definition at line 622 of file helpenginewrapper.cpp.

◆ setCacheDir()

void HelpEngineWrapper::setCacheDir	(	const QString &	cacheDir,
		bool	relativeToCollection )

Definition at line 317 of file helpenginewrapper.cpp.

◆ setDefaultHomePage()

void HelpEngineWrapper::setDefaultHomePage ( const QString & page )

Definition at line 542 of file helpenginewrapper.cpp.

◆ setDocumentationManagerEnabled()

void HelpEngineWrapper::setDocumentationManagerEnabled ( bool enabled )

Definition at line 380 of file helpenginewrapper.cpp.

References CollectionConfiguration::setDocumentationManagerEnabled().

Here is the call graph for this function:

◆ setFilterFunctionalityEnabled()

void HelpEngineWrapper::setFilterFunctionalityEnabled ( bool enabled )

Definition at line 331 of file helpenginewrapper.cpp.

References CollectionConfiguration::setFilterFunctionalityEnabled().

Here is the call graph for this function:

◆ setFilterToolbarVisible()

void HelpEngineWrapper::setFilterToolbarVisible ( bool visible )

Definition at line 344 of file helpenginewrapper.cpp.

References CollectionConfiguration::setFilterToolbarVisible().

Here is the call graph for this function:

◆ setHomePage()

void HelpEngineWrapper::setHomePage ( const QString & page )

Definition at line 529 of file helpenginewrapper.cpp.

◆ setLastShownPages()

void HelpEngineWrapper::setLastShownPages ( const QStringList & lastShownPages )

Definition at line 287 of file helpenginewrapper.cpp.

◆ setLastTabPage()

void HelpEngineWrapper::setLastTabPage ( int lastPage )

Definition at line 501 of file helpenginewrapper.cpp.

References CollectionConfiguration::setLastTabPage().

Referenced by CentralWidget::~CentralWidget().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setLastZoomFactors()

void HelpEngineWrapper::setLastZoomFactors ( const QStringList & lastZoomFactors )

Definition at line 299 of file helpenginewrapper.cpp.

◆ setMainWindow()

void HelpEngineWrapper::setMainWindow ( const QByteArray & mainWindow )

Definition at line 465 of file helpenginewrapper.cpp.

◆ setMainWindowGeometry()

void HelpEngineWrapper::setMainWindowGeometry ( const QByteArray & geometry )

Definition at line 477 of file helpenginewrapper.cpp.

◆ setQtDocInfo()

void HelpEngineWrapper::setQtDocInfo	(	const QString &	component,
		const QStringList &	doc )

Definition at line 273 of file helpenginewrapper.cpp.

◆ setShowTabs()

void HelpEngineWrapper::setShowTabs ( bool show )

Definition at line 634 of file helpenginewrapper.cpp.

◆ setStartOption()

void HelpEngineWrapper::setStartOption ( int option )

Definition at line 513 of file helpenginewrapper.cpp.

◆ setTopicChooserGeometry()

void HelpEngineWrapper::setTopicChooserGeometry ( const QByteArray & geometry )

Definition at line 652 of file helpenginewrapper.cpp.

◆ setupData()

bool HelpEngineWrapper::setupData ( )

Definition at line 231 of file helpenginewrapper.cpp.

Referenced by initialDocSetupDone().

Here is the caller graph for this function:

◆ setupFinished

void HelpEngineWrapper::setupFinished ( )

signal

◆ setUseAppFont()

void HelpEngineWrapper::setUseAppFont ( bool useAppFont )

Definition at line 560 of file helpenginewrapper.cpp.

Referenced by MainWindow::MainWindow().

Here is the caller graph for this function:

◆ setUseBrowserFont()

void HelpEngineWrapper::setUseBrowserFont ( bool useBrowserFont )

Definition at line 572 of file helpenginewrapper.cpp.

Referenced by MainWindow::MainWindow().

Here is the caller graph for this function:

◆ setWindowTitle()

void HelpEngineWrapper::setWindowTitle ( const QString & windowTitle )

Definition at line 441 of file helpenginewrapper.cpp.

◆ showTabs()

bool HelpEngineWrapper::showTabs ( ) const

Definition at line 628 of file helpenginewrapper.cpp.

Referenced by CentralWidget::CentralWidget(), and CentralWidget::updateUserInterface().

Here is the caller graph for this function:

◆ startOption()

int HelpEngineWrapper::startOption ( ) const

Definition at line 507 of file helpenginewrapper.cpp.

References ShowLastPages.

◆ topicChooserGeometry()

const QByteArray HelpEngineWrapper::topicChooserGeometry ( ) const

Definition at line 646 of file helpenginewrapper.cpp.

◆ unregisterDocumentation()

bool HelpEngineWrapper::unregisterDocumentation ( const QString & namespaceName )

Definition at line 219 of file helpenginewrapper.cpp.

◆ usesAppFont()

bool HelpEngineWrapper::usesAppFont ( ) const

Definition at line 554 of file helpenginewrapper.cpp.

Referenced by BookmarkDialog::BookmarkDialog(), and PreferencesDialog::PreferencesDialog().

Here is the caller graph for this function:

◆ usesBrowserFont()

bool HelpEngineWrapper::usesBrowserFont ( ) const

Definition at line 566 of file helpenginewrapper.cpp.

◆ windowTitle()

const QString HelpEngineWrapper::windowTitle ( ) const

Definition at line 435 of file helpenginewrapper.cpp.

Friends And Related Symbol Documentation

◆ TimeoutForwarder

friend class TimeoutForwarder

friend

Definition at line 41 of file helpenginewrapper.h.

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

qttools/src/assistant/assistant/helpenginewrapper.h (14fe0bbea5b04dff01495e815b33a0a1dd2e191a)
qttools/src/assistant/assistant/helpenginewrapper.cpp (e174bbb7ab3d807a39b15f9ec1084b5e751b8d2c)

Signals

Public Member Functions

Static Public Member Functions

Friends

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ aboutIcon()

◆ aboutImages()

◆ aboutMenuTexts()

◆ aboutTexts()

◆ addressBarEnabled()

◆ addressBarVisible()

◆ appFont()

◆ applicationIcon()

◆ appWritingSystem()

◆ bookmarks()

◆ browserFont()

◆ browserWritingSystem()

◆ cacheDir()

◆ cacheDirIsRelativeToCollection()

◆ collectionFile()

◆ contentModel()

◆ contentWidget()

◆ defaultHomePage()

◆ documentationFileName()

◆ documentationManagerEnabled()

◆ documentationRemoved

◆ documentationUpdated

◆ documentsForIdentifier()

◆ error()

◆ fileData()

◆ filterEngine()

◆ filterFunctionalityEnabled()

◆ filterToolbarVisible()

◆ findFile()

◆ fullTextSearchFallbackEnabled()

◆ hasFontSettings()

◆ helpEngine()

◆ homePage()

◆ indexModel()

◆ indexWidget()

◆ initialDocSetupDone()

◆ instance() [1/2]

◆ instance() [2/2]

◆ lastShownPages()

◆ lastTabPage()

◆ lastZoomFactors()

◆ mainWindow()

◆ mainWindowGeometry()

◆ qtDocInfo()

◆ registerDocumentation()

◆ registeredDocumentations()

◆ removeInstance()

◆ searchEngine()

◆ setAboutIcon()

◆ setAboutImages()

◆ setAboutMenuTexts()

◆ setAboutTexts()

◆ setAddressBarEnabled()

◆ setAddressBarVisible()

◆ setAppFont()

◆ setApplicationIcon()

◆ setAppWritingSystem()

◆ setBookmarks()

◆ setBrowserFont()

◆ setBrowserWritingSystem()

◆ setCacheDir()

◆ setDefaultHomePage()

◆ setDocumentationManagerEnabled()

◆ setFilterFunctionalityEnabled()

◆ setFilterToolbarVisible()

◆ setHomePage()

◆ setLastShownPages()

◆ setLastTabPage()

◆ setLastZoomFactors()

◆ setMainWindow()

◆ setMainWindowGeometry()

◆ setQtDocInfo()

◆ setShowTabs()