Grantlee  0.5.1
Public Member Functions
Grantlee::Variable Class Reference

A container for static variables defined in Templates. More...

#include <grantlee/variable.h>

List of all members.

Public Member Functions

 Variable ()
 Variable (const QString &var)
 Variable (const Variable &other)
 ~Variable ()
bool isConstant () const
bool isLocalized () const
bool isTrue (Context *c) const
bool isValid () const
QVariant literal () const
QStringList lookups () const
Variableoperator= (const Variable &other)
QVariant resolve (Context *c) const

Detailed Description

This class is only relevant to Template tag authors.

When processing a template tag in a AbstractNodeFactory implementation, it will sometimes make sense to process arguments to the tag as Grantlee::Variables. Note that usually they should be processed as FilterExpression objects instead.

Arguments to the tag can be used to construct Variables, which may then be resolved into the objects they represent in the given Context in the render stage.

Author:
Stephen Kelly <steveire@gmail.com>

Definition at line 50 of file variable.h.


Constructor & Destructor Documentation

Constructs an invalid Variable

Grantlee::Variable::Variable ( const QString &  var) [explicit]

Creates a Variable represented by the given var

Copy constructor

Destructor


Member Function Documentation

Returns whether this Variable is a constant in the Template. A constant is represented as a static string in the template

      Text content
      {% some_tag "constant" variable %}

Returns whether this variable is localized, that is, if it is wrapped with _().

See also:
Internationalization and Localization
bool Grantlee::Variable::isTrue ( Context c) const

Returns whether this Variable evaluates to true with the Context c.

Returns whether this Variable is valid.

QVariant Grantlee::Variable::literal ( ) const

Returns whether this variable is a literal string or number. A literal Variable does not have any lookup components.

QStringList Grantlee::Variable::lookups ( ) const

Returns the lookup components of this variable.

Variable& Grantlee::Variable::operator= ( const Variable other)

Assignment operator.

QVariant Grantlee::Variable::resolve ( Context c) const

Resolves this Variable with the Context c.