Grantlee 0.2.0
Public Member Functions
Grantlee::TagLibraryInterface Class Reference

The TagLibraryInterface returns available tags and filters from libraries. More...

#include <grantlee/taglibraryinterface.h>

List of all members.

Public Member Functions

virtual QHash< QString, Filter * > filters (const QString &name=QString())
virtual QHash< QString,
AbstractNodeFactory * > 
nodeFactories (const QString &name=QString())

Detailed Description

This interface must be implemented in tag and filter libraries.

The implementation will usually be very simple.

    class MyTagLibrary : public QObject, public TagLibraryInterface
    {
      Q_OBJECT
      Q_INTERFACES( Grantlee::TagLibraryInterface )
    public:
      MyTagLibrary( QObject *parent = 0 )
          : QObject( parent ) {
      }

      QHash<QString, AbstractNodeFactory*> nodeFactories( const QString &name = QString() ) {
        Q_UNUSED( name );
        QHash<QString, AbstractNodeFactory*> nodeFactories;
        nodeFactories.insert( "mytag1", new MyTag1() );
        nodeFactories.insert( "mytag2", new MyTag2() );
        return nodeFactories;
      }

      QHash<QString, Filter*> filters( const QString &name = QString() ) {
        Q_UNUSED( name );

        QHash<QString, Filter*> filters;

        filters.insert( "myfilter1", new MyFilter1() );
        filters.insert( "myfilter2", new MyFilter2() );

        return filters;
      }
    };
Author:
Stephen Kelly <steveire@gmail.com>

Definition at line 76 of file taglibraryinterface.h.


Member Function Documentation

virtual QHash<QString, Filter*> Grantlee::TagLibraryInterface::filters ( const QString &  name = QString()) [inline, virtual]

Returns the Filter implementations available in this library.

Definition at line 93 of file taglibraryinterface.h.

virtual QHash<QString, AbstractNodeFactory*> Grantlee::TagLibraryInterface::nodeFactories ( const QString &  name = QString()) [inline, virtual]

Returns the AbstractNodeFactory implementations available in this library.

Definition at line 84 of file taglibraryinterface.h.