KTextTemplate::Exception

Search for usage in LXR

KTextTemplate::Exception Class Reference

#include <KTextTemplate/Exception>

Public Member Functions

 Exception (Error errorCode, const QString &what)
 

Detailed Description

An exception for use when implementing template tags.

The Exception class can be used when implementing AbstractNodeFactory::getNode. An exception can be thrown to indicate that the syntax of a particular tag is invalid.

For example, the following template markup should throw an error because the include tag should have exactly one argument:

<div>
{% include %}
</div>

The corresponding implementation of IncludeNodeFactory::getNode is

QStringList tagContents = smartSplit( tagContent );
if ( tagContents.size() != 2 )
throw KTextTemplate::Exception( TagSyntaxError,
"Error: Include tag takes exactly one argument" );
// The item at index 0 in the list is the tag name, "include"
QString includeName = tagContents.at( 1 );
An exception for use when implementing template tags.
Definition exception.h:74
const_reference at(qsizetype i) const const
qsizetype size() const const
Author
Stephen Kelly steve.nosp@m.ire@.nosp@m.gmail.nosp@m..com

Definition at line 73 of file exception.h.

Constructor & Destructor Documentation

◆ Exception()

KTextTemplate::Exception::Exception ( Error errorCode,
const QString & what )
inline

Creates an exception for the error errorCode and the verbose message what.

Definition at line 80 of file exception.h.

◆ ~Exception()

virtual KTextTemplate::Exception::~Exception ( )
throw ( )
inlinevirtual

Definition at line 86 of file exception.h.


The documentation for this class was generated from the following file:
This file is part of the KDE documentation.
Documentation copyright © 1996-2024 The KDE developers.
Generated on Tue Mar 26 2024 11:19:42 by doxygen 1.10.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.