KTextTemplate::TagLibraryInterface Class Reference

#include <KTextTemplate/TagLibraryInterface>

Public Member Functions
virtual QHash< QString, Filter * >	filters (const QString &name={})
virtual QHash< QString, AbstractNodeFactory * >	nodeFactories (const QString &name={})

Detailed Description

The TagLibraryInterface returns available tags and filters from libraries.

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( KTextTemplate::TagLibraryInterface )
public:
  MyTagLibrary( QObject *parent = {} )
      : QObject( parent ) {
  }
 
  QHash<QString, AbstractNodeFactory*>
  nodeFactories(const QString &name = {}) {
    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 = {} ) {
    Q_UNUSED( name );
 
    QHash<QString, Filter*> filters;
 
    filters.insert( "myfilter1", new MyFilter1() );
    filters.insert( "myfilter2", new MyFilter2() );
 
    return filters;
  }
};

Author

Stephen Kelly steve.nosp@m.ire@.nosp@m.gmail.nosp@m..com

Definition at line 67 of file taglibraryinterface.h.

Constructor & Destructor Documentation

~TagLibraryInterface()

virtual KTextTemplate::TagLibraryInterface::~TagLibraryInterface ( )

inlinevirtual

Definition at line 70 of file taglibraryinterface.h.

Member Function Documentation

filters()

virtual QHash< QString, Filter * > KTextTemplate::TagLibraryInterface::filters ( const QString & name = {} )

inlinevirtual

Returns the Filter implementations available in this library.

Definition at line 87 of file taglibraryinterface.h.

nodeFactories()

virtual QHash< QString, AbstractNodeFactory * > KTextTemplate::TagLibraryInterface::nodeFactories ( const QString & name = {} )

inlinevirtual

Returns the AbstractNodeFactory implementations available in this library.

Definition at line 77 of file taglibraryinterface.h.

---

The documentation for this class was generated from the following file:

• taglibraryinterface.h