KTextTemplate::AbstractTemplateLoader

Search for usage in LXR

KTextTemplate::AbstractTemplateLoader Class Referenceabstract

#include <KTextTemplate/TemplateLoader>

Inheritance diagram for KTextTemplate::AbstractTemplateLoader:

Public Member Functions

virtual ~AbstractTemplateLoader ()
 
virtual bool canLoadTemplate (const QString &name) const =0
 
virtual std::pair< QString, QStringgetMediaUri (const QString &fileName) const =0
 
virtual Template loadByName (const QString &name, Engine const *engine) const =0
 

Detailed Description

An retrieval interface to a storage location for Template objects.

This interface can be implemented to define new ways of retrieving the content of Templates.

The interface of this class should not be called directly from applications. TemplateLoaders will typically be created, configured and added to the KTextTemplate::Engine which will call the appropriate API.

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

Definition at line 37 of file templateloader.h.

Constructor & Destructor Documentation

◆ ~AbstractTemplateLoader()

AbstractTemplateLoader::~AbstractTemplateLoader ( )
virtualdefault

Destructor.

Member Function Documentation

◆ canLoadTemplate()

virtual bool KTextTemplate::AbstractTemplateLoader::canLoadTemplate ( const QString & name) const
pure virtual

Return true if a Template identified by name exists and can be loaded.

Implemented in KTextTemplate::CachingLoaderDecorator, KTextTemplate::FileSystemTemplateLoader, and KTextTemplate::InMemoryTemplateLoader.

◆ getMediaUri()

virtual std::pair< QString, QString > KTextTemplate::AbstractTemplateLoader::getMediaUri ( const QString & fileName) const
pure virtual

Return a complete URI for media identified by fileName.

Implemented in KTextTemplate::CachingLoaderDecorator, KTextTemplate::FileSystemTemplateLoader, and KTextTemplate::InMemoryTemplateLoader.

◆ loadByName()

virtual Template KTextTemplate::AbstractTemplateLoader::loadByName ( const QString & name,
Engine const * engine ) const
pure virtual

Load a Template called name.

Return an invalid Template if no content by that name exists.

Implemented in KTextTemplate::CachingLoaderDecorator, KTextTemplate::FileSystemTemplateLoader, and KTextTemplate::InMemoryTemplateLoader.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2024 The KDE developers.
Generated on Fri May 24 2024 11:59:35 by doxygen 1.10.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.