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 18 of file collectionconfiguration.h.

Member Function Documentation

◆ aboutIcon()

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

Definition at line 161 of file collectionconfiguration.cpp.

◆ aboutImages()

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

Definition at line 183 of file collectionconfiguration.cpp.

◆ aboutMenuTexts()

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

Definition at line 150 of file collectionconfiguration.cpp.

◆ aboutTexts()

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

Definition at line 172 of file collectionconfiguration.cpp.

◆ addressBarEnabled()

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

Definition at line 88 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 99 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 139 of file collectionconfiguration.cpp.

◆ cacheDir()

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

Definition at line 110 of file collectionconfiguration.cpp.

◆ cacheDirIsRelativeToCollection()

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

Definition at line 115 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 263 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 45 of file collectionconfiguration.cpp.

◆ defaultHomePage()

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

Definition at line 194 of file collectionconfiguration.cpp.

◆ documentationManagerEnabled()

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

Definition at line 128 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 66 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 77 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 284 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 257 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 242 of file collectionconfiguration.cpp.

◆ lastShownPages()

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

Definition at line 205 of file collectionconfiguration.cpp.

◆ lastTabPage()

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

Definition at line 231 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 218 of file collectionconfiguration.cpp.

◆ setAboutIcon()

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

Definition at line 166 of file collectionconfiguration.cpp.

◆ setAboutImages()

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

Definition at line 188 of file collectionconfiguration.cpp.

◆ setAboutMenuTexts()

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

Definition at line 155 of file collectionconfiguration.cpp.

◆ setAboutTexts()

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

Definition at line 177 of file collectionconfiguration.cpp.

◆ setAddressBarEnabled()

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

Definition at line 93 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 104 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 144 of file collectionconfiguration.cpp.

◆ setCacheDir()

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

Definition at line 120 of file collectionconfiguration.cpp.

◆ setCreationTime()

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

Definition at line 50 of file collectionconfiguration.cpp.

◆ setDefaultHomePage()

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

Definition at line 199 of file collectionconfiguration.cpp.

◆ setDocumentationManagerEnabled()

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

Definition at line 133 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 71 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 82 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 290 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 211 of file collectionconfiguration.cpp.

◆ setLastTabPage()

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

Definition at line 236 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 224 of file collectionconfiguration.cpp.

◆ setWindowTitle()

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

Definition at line 60 of file collectionconfiguration.cpp.

◆ updateLastRegisterTime() [1/2]

void CollectionConfiguration::updateLastRegisterTime ( QHelpEngineCore & helpEngine)
static

Definition at line 252 of file collectionconfiguration.cpp.

References updateLastRegisterTime().

Referenced by generateCollectionFile(), and updateLastRegisterTime().

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

◆ updateLastRegisterTime() [2/2]

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

Definition at line 247 of file collectionconfiguration.cpp.

◆ windowTitle()

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

Definition at line 55 of file collectionconfiguration.cpp.

Member Data Documentation

◆ DefaultZoomFactor

const QString CollectionConfiguration::DefaultZoomFactor
static

Definition at line 107 of file collectionconfiguration.h.

◆ ListSeparator

const QString CollectionConfiguration::ListSeparator
static

Definition at line 108 of file collectionconfiguration.h.

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