A storage/configuration class for shared highlighting formats.
More...
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
◆ QFormatScheme()
QFormatScheme::QFormatScheme |
( |
const QString & |
f, |
|
|
QObject * |
p = 0 |
|
) |
| |
Constructor.
- Parameters
-
f | Filename of a format settings file to load |
References load().
◆ clear()
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().
◆ format() [1/2]
QFormat QFormatScheme::format |
( |
int |
ifid | ) |
const |
|
virtual |
- Returns
- The text format associated with format key fid
Referenced by format().
◆ format() [2/2]
QFormat QFormatScheme::format |
( |
const QString & |
sfid | ) |
const |
|
virtual |
- Returns
- The text format associated with format key fid
References format().
◆ formatCount()
int QFormatScheme::formatCount |
( |
| ) |
const |
◆ formatRef() [1/2]
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
Referenced by QFormatConfig::apply(), and QFormatConfig::cancel().
◆ formatRef() [2/2]
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().
◆ formats()
QStringList QFormatScheme::formats |
( |
| ) |
const |
- Returns
- A list of available format keys
◆ id() [1/2]
QString QFormatScheme::id |
( |
int |
ifid | ) |
const |
|
virtual |
◆ id() [2/2]
int QFormatScheme::id |
( |
const QString & |
sfid | ) |
const |
|
virtual |
- Returns
- The integer format id associated to format key fid
◆ load() [1/3]
void QFormatScheme::load |
( |
const QString & |
f | ) |
|
|
virtual |
Load format settings from a file.
- Parameters
-
The default implementation loads data in QXF format (XML-based)
- Note
- Previous content is discarded
References clear().
Referenced by QFormatScheme().
◆ load() [2/3]
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
◆ load() [3/3]
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
◆ save() [1/3]
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)
Referenced by QFormatConfig::apply().
◆ save() [2/3]
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.
◆ save() [3/3]
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.
◆ setFormat
void QFormatScheme::setFormat |
( |
const QString & |
fid, |
|
|
const QFormat & |
fmt |
|
) |
| |
|
virtualslot |
The documentation for this class was generated from the following files: