HelpDocSettings Class Reference

#include <helpdocsettings.h>

Collaboration diagram for HelpDocSettings:

Public Member Functions
	HelpDocSettings ()
	HelpDocSettings (const HelpDocSettings &other)
	HelpDocSettings (HelpDocSettings &&other)
	~HelpDocSettings ()
HelpDocSettings &	operator= (const HelpDocSettings &other)
HelpDocSettings &	operator= (HelpDocSettings &&other)
void	swap (HelpDocSettings &other) noexcept
bool	addDocumentation (const QString &fileName)
bool	removeDocumentation (const QString &namespaceName)
QString	namespaceName (const QString &fileName) const
QStringList	components () const
QList< QVersionNumber >	versions () const
QStringList	namespaces () const
QMap< QString, QString >	namespaceToFileName () const

Static Public Member Functions
static HelpDocSettings	readSettings (QHelpEngineCore *helpEngine)
static bool	applySettings (QHelpEngineCore *helpEngine, const HelpDocSettings &settings)

Detailed Description

Definition at line 15 of file helpdocsettings.h.

Constructor & Destructor Documentation

HelpDocSettings() [1/3]

HelpDocSettings::HelpDocSettings

(

)

Definition at line 34 of file helpdocsettings.cpp.

References HelpDocSettings().

Referenced by HelpDocSettings().

Here is the call graph for this function:

Here is the caller graph for this function:

HelpDocSettings() [2/3]

HelpDocSettings::HelpDocSettings ( const HelpDocSettings & other )

default

HelpDocSettings() [3/3]

HelpDocSettings::HelpDocSettings ( HelpDocSettings && other )

default

~HelpDocSettings()

HelpDocSettings::~HelpDocSettings ( )

default

Member Function Documentation

addDocumentation()

bool HelpDocSettings::addDocumentation

(

const QString &

fileName

)

Definition at line 49 of file helpdocsettings.cpp.

applySettings()

bool HelpDocSettings::applySettings ( QHelpEngineCore * helpEngine, const HelpDocSettings & settings )

static

Definition at line 167 of file helpdocsettings.cpp.

References readSettings().

Here is the call graph for this function:

components()

QStringList HelpDocSettings::components

(

)

const

Definition at line 110 of file helpdocsettings.cpp.

namespaceName()

QString HelpDocSettings::namespaceName

(

const QString &

fileName

)

const

Definition at line 105 of file helpdocsettings.cpp.

namespaces()

QStringList HelpDocSettings::namespaces

(

)

const

Definition at line 120 of file helpdocsettings.cpp.

namespaceToFileName()

QMap< QString, QString > HelpDocSettings::namespaceToFileName

(

)

const

Definition at line 125 of file helpdocsettings.cpp.

operator=() [1/2]

HelpDocSettings & HelpDocSettings::operator= ( const HelpDocSettings & other )

default

operator=() [2/2]

HelpDocSettings & HelpDocSettings::operator= ( HelpDocSettings && other )

default

readSettings()

HelpDocSettings HelpDocSettings::readSettings ( QHelpEngineCore * helpEngine )

static

Definition at line 130 of file helpdocsettings.cpp.

Referenced by applySettings().

Here is the caller graph for this function:

removeDocumentation()

bool HelpDocSettings::removeDocumentation

(

const QString &

namespaceName

)

Definition at line 79 of file helpdocsettings.cpp.

swap()

void HelpDocSettings::swap ( HelpDocSettings & other )

inlinenoexcept

Definition at line 26 of file helpdocsettings.h.

versions()

QList< QVersionNumber > HelpDocSettings::versions

(

)

const

Definition at line 115 of file helpdocsettings.cpp.

---

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

• qttools/src/assistant/assistant/helpdocsettings.h (709ed2fd3d34751541dedaede389a99f223b8721)
• qttools/src/assistant/assistant/helpdocsettings.cpp (709ed2fd3d34751541dedaede389a99f223b8721)