KSieveCore::XMLPrintingScriptBuilder Class
The XMLPrintingScriptBuilder class Author: Laurent Montel <montel@kde.org>. More...
| Header: | #include <KSieveCore/XMLPrintingScriptBuilder> |
| CMake: | find_package(KPim6KSieveCore REQUIRED)target_link_libraries(mytarget PRIVATE KPim6::KSieveCore) |
Public Functions
| XMLPrintingScriptBuilder() | |
| XMLPrintingScriptBuilder(int indent) | |
| virtual | ~XMLPrintingScriptBuilder() override |
| void | clear() |
| QString | error() const |
| bool | hasError() const |
| QString | result() const |
Reimplemented Public Functions
| virtual void | blockEnd(int lineNumber) override |
| virtual void | blockStart(int lineNumber) override |
| virtual void | bracketComment(const QString &comment) override |
| virtual void | commandEnd(int lineNumber) override |
| virtual void | commandStart(const QString &identifier, int lineNumber) override |
| virtual void | error(const KSieve::Error &error) override |
| virtual void | finished() override |
| virtual void | hashComment(const QString &comment) override |
| virtual void | lineFeed() override |
| virtual void | numberArgument(unsigned long number, char quantifier) override |
| virtual void | stringArgument(const QString &string, bool multiLine, const QString &) override |
| virtual void | stringListArgumentEnd() override |
| virtual void | stringListArgumentStart() override |
| virtual void | stringListEntry(const QString &string, bool multiline, const QString &hashComment) override |
| virtual void | taggedArgument(const QString &tag) override |
| virtual void | testEnd() override |
| virtual void | testListEnd() override |
| virtual void | testListStart() override |
| virtual void | testStart(const QString &identifier) override |
Detailed Description
Member Function Documentation
XMLPrintingScriptBuilder::XMLPrintingScriptBuilder()
Constructs an XMLPrintingScriptBuilder with default indentation.
[explicit] XMLPrintingScriptBuilder::XMLPrintingScriptBuilder(int indent)
Constructs an XMLPrintingScriptBuilder with specified indentation. indent The indentation level.
[override virtual noexcept] XMLPrintingScriptBuilder::~XMLPrintingScriptBuilder()
Destroys the XMLPrintingScriptBuilder.
[override virtual] void XMLPrintingScriptBuilder::blockEnd(int lineNumber)
Marks the end of a block. lineNumber The line number in the source script.
[override virtual] void XMLPrintingScriptBuilder::blockStart(int lineNumber)
Marks the start of a block. lineNumber The line number in the source script.
[override virtual] void XMLPrintingScriptBuilder::bracketComment(const QString &comment)
Processes a bracket-style comment. comment The comment text.
void XMLPrintingScriptBuilder::clear()
[override virtual] void XMLPrintingScriptBuilder::commandEnd(int lineNumber)
Marks the end of a Sieve command. lineNumber The line number in the source script.
[override virtual] void XMLPrintingScriptBuilder::commandStart(const QString &identifier, int lineNumber)
Marks the start of a Sieve command. identifier The command name. lineNumber The line number in the source script.
QString XMLPrintingScriptBuilder::error() const
Returns any error message generated. Returns The error string.
[override virtual] void XMLPrintingScriptBuilder::error(const KSieve::Error &error)
Reports an error encountered during parsing. error The error information.
[override virtual] void XMLPrintingScriptBuilder::finished()
Marks the end of script processing.
bool XMLPrintingScriptBuilder::hasError() const
[override virtual] void XMLPrintingScriptBuilder::hashComment(const QString &comment)
Processes a hash-style comment. comment The comment text.
[override virtual] void XMLPrintingScriptBuilder::lineFeed()
Adds a line feed to the output.
[override virtual] void XMLPrintingScriptBuilder::numberArgument(unsigned long number, char quantifier)
Processes a numeric argument in the script. number The number value. quantifier The unit quantifier (e.g., 'K' for kilo).
QString XMLPrintingScriptBuilder::result() const
Returns the generated XML output. Returns The result as an XML string.
[override virtual] void XMLPrintingScriptBuilder::stringArgument(const QString &string, bool multiLine, const QString &)
Processes a string argument in the script. string The string value. multiLine true if the string spans multiple lines.
[override virtual] void XMLPrintingScriptBuilder::stringListArgumentEnd()
Marks the end of a string list argument.
[override virtual] void XMLPrintingScriptBuilder::stringListArgumentStart()
Marks the start of a string list argument.
[override virtual] void XMLPrintingScriptBuilder::stringListEntry(const QString &string, bool multiline, const QString &hashComment)
Adds an entry to a string list. string The string entry. multiline true if the string spans multiple lines. hashComment Associated hash comment.
[override virtual] void XMLPrintingScriptBuilder::taggedArgument(const QString &tag)
Processes a tagged argument in the script. tag The tag string.
[override virtual] void XMLPrintingScriptBuilder::testEnd()
Marks the end of a Sieve test.
[override virtual] void XMLPrintingScriptBuilder::testListEnd()
Marks the end of a test list.
[override virtual] void XMLPrintingScriptBuilder::testListStart()
Marks the start of a test list.
[override virtual] void XMLPrintingScriptBuilder::testStart(const QString &identifier)
Marks the start of a Sieve test. identifier The test name.