QFormatScheme Class Reference
[Language framework]

A storage/configuration class for shared highlighting formats. More...

Inheritance diagram for QFormatScheme:

[legend]

List of all members.

	QFormatScheme (QObject *p=0)
	Constructor.
	QFormatScheme (const QString &f, QObject *p=0)
	Constructor.
virtual	~QFormatScheme ()
	Destructor.
void	clear ()
	Re-initialize the format scheme.
virtual void	load (const QString &filename)
	Load format settings from a file.
virtual void	save (const QString &filename=QString()) const
	Save the format settings to a file.
virtual void	load (const QDomElement &doc, bool ignoreNewIds=false)
virtual void	save (QDomElement &elem) const
virtual void	load (QSettings &s, bool ignoreNewIds=false)
	Load format data from a QSettings object.
virtual void	save (QSettings &s) const
int	formatCount () const
QStringList	formats () const
virtual QString	id (int ifid) const
virtual int	id (const QString &sfid) const
virtual QFormat &	formatRef (int ifid)
virtual QFormat &	formatRef (const QString &sfid)
virtual QFormat	format (int ifid) const
virtual QFormat	format (const QString &sfid) const
virtual void	setFormat (const QString &fid, const QFormat &fmt)
	Set text format for key.
Protected Attributes
QString	m_settings
QVector< QString >	m_formatKeys
QVector< QFormat >	m_formatValues

---

Detailed Description

A storage/configuration class for shared highlighting formats.

It stores text formats used by highlighters interfaces and provides a default serializing format in QXF format (XML-based).

See also:

QLanguageFactory

QHighlighter

---

Constructor & Destructor Documentation

QFormatScheme::QFormatScheme	(	const QString &	f,
		QObject *	p = 0
	)

Constructor.

Parameters:

f

Filename of a format settings file to load

References load().

---

Member Function Documentation

void QFormatScheme::clear

(

)

Re-initialize the format scheme.

Calling this method leaves the format scheme with only one format : the "normal" one, set to a default-constructed QFormat

References setFormat().

Referenced by load().

QFormat QFormatScheme::format

(

const QString &

sfid

)

const [virtual]

Returns:

The text format associated with format key fid

References format().

QFormat QFormatScheme::format

(

int

ifid

)

const [virtual]

Returns:

The text format associated with format key fid

Referenced by format().

int QFormatScheme::formatCount

(

)

const

Returns:

The number of available formats

QFormat & QFormatScheme::formatRef

(

const QString &

sfid

)

[virtual]

Returns:

The a reference to the text format associated with format key fid

Warning:

Use at your own risks : if there are no format associated with the requested id this function will crash.

References id().

QFormat & QFormatScheme::formatRef

(

int

ifid

)

[virtual]

Returns:

The text format associated with format key fid

Warning:

Use at your own risks : if there are no format associated with the requested id this function will crash

QStringList QFormatScheme::formats

(

)

const

Returns:

A list of available format keys

int QFormatScheme::id

(

const QString &

sfid

)

const [virtual]

Returns:

The integer format id associated to format key fid

QString QFormatScheme::id

(

int

ifid

)

const [virtual]

Returns:

The format key associated to integer format id ifid

Referenced by formatRef(), QDocumentSearch::next(), and QDocumentSearch::setOption().

void QFormatScheme::load	(	QSettings &	s,
		bool	ignoreNewIds = false
	)			[virtual]

Load format data from a QSettings object.

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

Parameters:

	s	QSettings object from which data will be fetched
	ignoreNewIds	whether unknown format identifiers should be ignored

The QSettings object is assumed to be initialized properly and to point to a correct location.

Note:

Previous content is not discarded

References setFormat().

void QFormatScheme::load	(	const QDomElement &	elem,
		bool	ignoreNewIds = false
	)			[virtual]

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

Parameters:

	elem	Source element to scan
	ignoreNewIds	whether unknown format identifiers should be ignored

The given dom element must contain a proper version attribute and format data as child elements (<format> tags)

Note:

Previous content is not discarded

References setFormat().

void QFormatScheme::load

(

const QString &

f

)

[virtual]

Load format settings from a file.

Parameters:

f

file to load data from

The default implementation loads data in QXF format (XML-based)

Note:

Previous content is discarded

References clear().

Referenced by QFormatScheme().

void QFormatScheme::save

(

QSettings &

s

)

const [virtual]

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

void QFormatScheme::save

(

QDomElement &

elem

)

const [virtual]

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

void QFormatScheme::save

(

const QString &

f = QString()

)

const [virtual]

Save the format settings to a file.

Parameters:

f

target file (if none specified, last value passed to load is used)

The default implementation saves data in QXF format (XML-based)

void QFormatScheme::setFormat	(	const QString &	fid,
		const QFormat &	fmt
	)			[virtual, slot]

Set text format for key.

Parameters:

	fid	Format key
	fmt	Format value

Referenced by clear(), load(), and QFormatScheme().

---

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

• lib/qformatscheme.h
• lib/qformatscheme.cpp