Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
Loading...
Searching...
No Matches
CollectionConfiguration Class Reference

#include <collectionconfiguration.h>

Collaboration diagram for CollectionConfiguration:

Static Public Member Functions

static const QString windowTitle (const QHelpEngineCore &helpEngine)
static void setWindowTitle (QHelpEngineCore &helpEngine, const QString &windowTitle)
static const QString cacheDir (const QHelpEngineCore &helpEngine)
static bool cacheDirIsRelativeToCollection (const QHelpEngineCore &helpEngine)
static void setCacheDir (QHelpEngineCore &helpEngine, const QString &cacheDir, bool relativeToCollection)
static uint creationTime (const QHelpEngineCore &helpEngine)
static void setCreationTime (QHelpEngineCore &helpEngine, uint time)
static bool filterFunctionalityEnabled (const QHelpEngineCore &helpEngine)
static void setFilterFunctionalityEnabled (QHelpEngineCore &helpEngine, bool enabled)
static bool filterToolbarVisible (const QHelpEngineCore &helpEngine)
static void setFilterToolbarVisible (QHelpEngineCore &helpEngine, bool visible)
static bool addressBarEnabled (const QHelpEngineCore &helpEngine)
static void setAddressBarEnabled (QHelpEngineCore &helpEngine, bool enabled)
static bool addressBarVisible (const QHelpEngineCore &helpEngine)
static void setAddressBarVisible (QHelpEngineCore &helpEngine, bool visible)
static bool documentationManagerEnabled (const QHelpEngineCore &helpEngine)
static void setDocumentationManagerEnabled (QHelpEngineCore &helpEngine, bool enabled)
static const QByteArray applicationIcon (const QHelpEngineCore &helpEngine)
static void setApplicationIcon (QHelpEngineCore &helpEngine, const QByteArray &icon)
static const QByteArray aboutMenuTexts (const QHelpEngineCore &helpEngine)
static void setAboutMenuTexts (QHelpEngineCore &helpEngine, const QByteArray &texts)
static const QByteArray aboutIcon (const QHelpEngineCore &helpEngine)
static void setAboutIcon (QHelpEngineCore &helpEngine, const QByteArray &icon)
static const QByteArray aboutTexts (const QHelpEngineCore &helpEngine)
static void setAboutTexts (QHelpEngineCore &helpEngine, const QByteArray &texts)
static const QByteArray aboutImages (const QHelpEngineCore &helpEngine)
static void setAboutImages (QHelpEngineCore &helpEngine, const QByteArray &images)
static const QString defaultHomePage (const QHelpEngineCore &helpEngine)
static void setDefaultHomePage (QHelpEngineCore &helpEngine, const QString &page)
static const QStringList lastShownPages (const QHelpEngineCore &helpEngine)
static void setLastShownPages (QHelpEngineCore &helpEngine, const QStringList &lastShownPages)
static const QStringList lastZoomFactors (const QHelpEngineCore &helpEngine)
static void setLastZoomFactors (QHelpEngineCore &helPEngine, const QStringList &lastZoomFactors)
static int lastTabPage (const QHelpEngineCore &helpEngine)
static void setLastTabPage (QHelpEngineCore &helpEngine, int lastPage)
static bool isNewer (const QHelpEngineCore &newer, const QHelpEngineCore &older)
static void copyConfiguration (const QHelpEngineCore &source, QHelpEngineCore &target)
static const QDateTime lastRegisterTime (const QHelpEngineCore &helpEngine)
static void updateLastRegisterTime (QHelpEngineCore &helpEngine, QDateTime dt)
static void updateLastRegisterTime (QHelpEngineCore &helpEngine)
static bool fullTextSearchFallbackEnabled (const QHelpEngineCore &helpEngine)
static void setFullTextSearchFallbackEnabled (QHelpEngineCore &helpEngine, bool on)

Static Public Attributes

static const QString DefaultZoomFactor
static const QString ListSeparator

Detailed Description

Definition at line 17 of file collectionconfiguration.h.

Member Function Documentation

◆ aboutIcon()

const QByteArray CollectionConfiguration::aboutIcon ( const QHelpEngineCore & helpEngine)
static

Definition at line 160 of file collectionconfiguration.cpp.

◆ aboutImages()

const QByteArray CollectionConfiguration::aboutImages ( const QHelpEngineCore & helpEngine)
static

Definition at line 182 of file collectionconfiguration.cpp.

◆ aboutMenuTexts()

const QByteArray CollectionConfiguration::aboutMenuTexts ( const QHelpEngineCore & helpEngine)
static

Definition at line 149 of file collectionconfiguration.cpp.

◆ aboutTexts()

const QByteArray CollectionConfiguration::aboutTexts ( const QHelpEngineCore & helpEngine)
static

Definition at line 171 of file collectionconfiguration.cpp.

◆ addressBarEnabled()

bool CollectionConfiguration::addressBarEnabled ( const QHelpEngineCore & helpEngine)
static

Definition at line 87 of file collectionconfiguration.cpp.

Referenced by HelpEngineWrapper::addressBarEnabled(), and copyConfiguration().

Here is the caller graph for this function:

◆ addressBarVisible()

bool CollectionConfiguration::addressBarVisible ( const QHelpEngineCore & helpEngine)
static

Definition at line 98 of file collectionconfiguration.cpp.

Referenced by HelpEngineWrapper::addressBarVisible(), and copyConfiguration().

Here is the caller graph for this function:

◆ applicationIcon()

const QByteArray CollectionConfiguration::applicationIcon ( const QHelpEngineCore & helpEngine)
static

Definition at line 138 of file collectionconfiguration.cpp.

◆ cacheDir()

const QString CollectionConfiguration::cacheDir ( const QHelpEngineCore & helpEngine)
static

Definition at line 109 of file collectionconfiguration.cpp.

◆ cacheDirIsRelativeToCollection()

bool CollectionConfiguration::cacheDirIsRelativeToCollection ( const QHelpEngineCore & helpEngine)
static

Definition at line 114 of file collectionconfiguration.cpp.

Referenced by HelpEngineWrapper::cacheDirIsRelativeToCollection().

Here is the caller graph for this function:

◆ copyConfiguration()

void CollectionConfiguration::copyConfiguration ( const QHelpEngineCore & source,
QHelpEngineCore & target )
static

Definition at line 262 of file collectionconfiguration.cpp.

References addressBarEnabled(), addressBarVisible(), documentationManagerEnabled(), filterFunctionalityEnabled(), filterToolbarVisible(), fullTextSearchFallbackEnabled(), setAddressBarEnabled(), setAddressBarVisible(), setDocumentationManagerEnabled(), setFilterFunctionalityEnabled(), setFilterToolbarVisible(), and setFullTextSearchFallbackEnabled().

Referenced by preliminarySetup().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ creationTime()

uint CollectionConfiguration::creationTime ( const QHelpEngineCore & helpEngine)
static

Definition at line 44 of file collectionconfiguration.cpp.

◆ defaultHomePage()

const QString CollectionConfiguration::defaultHomePage ( const QHelpEngineCore & helpEngine)
static

Definition at line 193 of file collectionconfiguration.cpp.

◆ documentationManagerEnabled()

bool CollectionConfiguration::documentationManagerEnabled ( const QHelpEngineCore & helpEngine)
static

Definition at line 127 of file collectionconfiguration.cpp.

Referenced by copyConfiguration(), and HelpEngineWrapper::documentationManagerEnabled().

Here is the caller graph for this function:

◆ filterFunctionalityEnabled()

bool CollectionConfiguration::filterFunctionalityEnabled ( const QHelpEngineCore & helpEngine)
static

Definition at line 65 of file collectionconfiguration.cpp.

Referenced by copyConfiguration(), and HelpEngineWrapper::filterFunctionalityEnabled().

Here is the caller graph for this function:

◆ filterToolbarVisible()

bool CollectionConfiguration::filterToolbarVisible ( const QHelpEngineCore & helpEngine)
static

Definition at line 76 of file collectionconfiguration.cpp.

Referenced by copyConfiguration(), and HelpEngineWrapper::filterToolbarVisible().

Here is the caller graph for this function:

◆ fullTextSearchFallbackEnabled()

bool CollectionConfiguration::fullTextSearchFallbackEnabled ( const QHelpEngineCore & helpEngine)
static

Definition at line 283 of file collectionconfiguration.cpp.

Referenced by copyConfiguration(), and HelpEngineWrapper::fullTextSearchFallbackEnabled().

Here is the caller graph for this function:

◆ isNewer()

bool CollectionConfiguration::isNewer ( const QHelpEngineCore & newer,
const QHelpEngineCore & older )
static

Definition at line 256 of file collectionconfiguration.cpp.

Referenced by preliminarySetup().

Here is the caller graph for this function:

◆ lastRegisterTime()

const QDateTime CollectionConfiguration::lastRegisterTime ( const QHelpEngineCore & helpEngine)
static

Definition at line 241 of file collectionconfiguration.cpp.

◆ lastShownPages()

const QStringList CollectionConfiguration::lastShownPages ( const QHelpEngineCore & helpEngine)
static

Definition at line 204 of file collectionconfiguration.cpp.

◆ lastTabPage()

int CollectionConfiguration::lastTabPage ( const QHelpEngineCore & helpEngine)
static

Definition at line 230 of file collectionconfiguration.cpp.

Referenced by HelpEngineWrapper::lastTabPage().

Here is the caller graph for this function:

◆ lastZoomFactors()

const QStringList CollectionConfiguration::lastZoomFactors ( const QHelpEngineCore & helpEngine)
static

Definition at line 217 of file collectionconfiguration.cpp.

◆ setAboutIcon()

void CollectionConfiguration::setAboutIcon ( QHelpEngineCore & helpEngine,
const QByteArray & icon )
static

Definition at line 165 of file collectionconfiguration.cpp.

◆ setAboutImages()

void CollectionConfiguration::setAboutImages ( QHelpEngineCore & helpEngine,
const QByteArray & images )
static

Definition at line 187 of file collectionconfiguration.cpp.

◆ setAboutMenuTexts()

void CollectionConfiguration::setAboutMenuTexts ( QHelpEngineCore & helpEngine,
const QByteArray & texts )
static

Definition at line 154 of file collectionconfiguration.cpp.

◆ setAboutTexts()

void CollectionConfiguration::setAboutTexts ( QHelpEngineCore & helpEngine,
const QByteArray & texts )
static

Definition at line 176 of file collectionconfiguration.cpp.

◆ setAddressBarEnabled()

void CollectionConfiguration::setAddressBarEnabled ( QHelpEngineCore & helpEngine,
bool enabled )
static

Definition at line 92 of file collectionconfiguration.cpp.

Referenced by copyConfiguration(), generateCollectionFile(), and HelpEngineWrapper::setAddressBarEnabled().

Here is the caller graph for this function:

◆ setAddressBarVisible()

void CollectionConfiguration::setAddressBarVisible ( QHelpEngineCore & helpEngine,
bool visible )
static

Definition at line 103 of file collectionconfiguration.cpp.

Referenced by copyConfiguration(), generateCollectionFile(), and HelpEngineWrapper::setAddressBarVisible().

Here is the caller graph for this function:

◆ setApplicationIcon()

void CollectionConfiguration::setApplicationIcon ( QHelpEngineCore & helpEngine,
const QByteArray & icon )
static

Definition at line 143 of file collectionconfiguration.cpp.

◆ setCacheDir()

void CollectionConfiguration::setCacheDir ( QHelpEngineCore & helpEngine,
const QString & cacheDir,
bool relativeToCollection )
static

Definition at line 119 of file collectionconfiguration.cpp.

◆ setCreationTime()

void CollectionConfiguration::setCreationTime ( QHelpEngineCore & helpEngine,
uint time )
static

Definition at line 49 of file collectionconfiguration.cpp.

◆ setDefaultHomePage()

void CollectionConfiguration::setDefaultHomePage ( QHelpEngineCore & helpEngine,
const QString & page )
static

Definition at line 198 of file collectionconfiguration.cpp.

◆ setDocumentationManagerEnabled()

void CollectionConfiguration::setDocumentationManagerEnabled ( QHelpEngineCore & helpEngine,
bool enabled )
static

Definition at line 132 of file collectionconfiguration.cpp.

Referenced by copyConfiguration(), generateCollectionFile(), and HelpEngineWrapper::setDocumentationManagerEnabled().

Here is the caller graph for this function:

◆ setFilterFunctionalityEnabled()

void CollectionConfiguration::setFilterFunctionalityEnabled ( QHelpEngineCore & helpEngine,
bool enabled )
static

Definition at line 70 of file collectionconfiguration.cpp.

Referenced by copyConfiguration(), generateCollectionFile(), and HelpEngineWrapper::setFilterFunctionalityEnabled().

Here is the caller graph for this function:

◆ setFilterToolbarVisible()

void CollectionConfiguration::setFilterToolbarVisible ( QHelpEngineCore & helpEngine,
bool visible )
static

Definition at line 81 of file collectionconfiguration.cpp.

Referenced by copyConfiguration(), generateCollectionFile(), and HelpEngineWrapper::setFilterToolbarVisible().

Here is the caller graph for this function:

◆ setFullTextSearchFallbackEnabled()

void CollectionConfiguration::setFullTextSearchFallbackEnabled ( QHelpEngineCore & helpEngine,
bool on )
static

Definition at line 289 of file collectionconfiguration.cpp.

Referenced by copyConfiguration(), and generateCollectionFile().

Here is the caller graph for this function:

◆ setLastShownPages()

void CollectionConfiguration::setLastShownPages ( QHelpEngineCore & helpEngine,
const QStringList & lastShownPages )
static

Definition at line 210 of file collectionconfiguration.cpp.

◆ setLastTabPage()

void CollectionConfiguration::setLastTabPage ( QHelpEngineCore & helpEngine,
int lastPage )
static

Definition at line 235 of file collectionconfiguration.cpp.

Referenced by HelpEngineWrapper::setLastTabPage().

Here is the caller graph for this function:

◆ setLastZoomFactors()

void CollectionConfiguration::setLastZoomFactors ( QHelpEngineCore & helPEngine,
const QStringList & lastZoomFactors )
static

Definition at line 223 of file collectionconfiguration.cpp.

◆ setWindowTitle()

void CollectionConfiguration::setWindowTitle ( QHelpEngineCore & helpEngine,
const QString & windowTitle )
static

Definition at line 59 of file collectionconfiguration.cpp.

◆ updateLastRegisterTime() [1/2]

void CollectionConfiguration::updateLastRegisterTime ( QHelpEngineCore & helpEngine)
static

Definition at line 251 of file collectionconfiguration.cpp.

Referenced by generateCollectionFile().

Here is the caller graph for this function:

◆ updateLastRegisterTime() [2/2]

void CollectionConfiguration::updateLastRegisterTime ( QHelpEngineCore & helpEngine,
QDateTime dt )
static

Definition at line 246 of file collectionconfiguration.cpp.

◆ windowTitle()

const QString CollectionConfiguration::windowTitle ( const QHelpEngineCore & helpEngine)
static

Definition at line 54 of file collectionconfiguration.cpp.

Member Data Documentation

◆ DefaultZoomFactor

const QString CollectionConfiguration::DefaultZoomFactor
static

Definition at line 106 of file collectionconfiguration.h.

◆ ListSeparator

const QString CollectionConfiguration::ListSeparator
static

Definition at line 107 of file collectionconfiguration.h.

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