Grantlee  0.5.1
cachingloaderdecorator.h
1 /*
2  This file is part of the Grantlee template system.
3 
4  Copyright (c) 2010 Stephen Kelly <steveire@gmail.com>
5 
6  This library is free software; you can redistribute it and/or
7  modify it under the terms of the GNU Lesser General Public
8  License as published by the Free Software Foundation; either version
9  2.1 of the Licence, or (at your option) any later version.
10 
11  This library is distributed in the hope that it will be useful,
12  but WITHOUT ANY WARRANTY; without even the implied warranty of
13  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14  Lesser General Public License for more details.
15 
16  You should have received a copy of the GNU Lesser General Public
17  License along with this library. If not, see <http://www.gnu.org/licenses/>.
18 
19 */
20 
21 #ifndef GRANTLEE_CACHINGLOADERDECORATOR_H
22 #define GRANTLEE_CACHINGLOADERDECORATOR_H
23 
24 #include "templateloader.h"
25 
26 #include "grantlee_core_export.h"
27 
28 namespace Grantlee
29 {
30 
31 class CachingLoaderDecoratorPrivate;
32 
34 
64 class GRANTLEE_CORE_EXPORT CachingLoaderDecorator : public AbstractTemplateLoader
65 {
66 public:
67 #ifndef Q_QDOC
68  typedef QSharedPointer<CachingLoaderDecorator> Ptr;
69 #endif
70 
75 
79  virtual ~CachingLoaderDecorator();
80 
81  /* reimp */ bool canLoadTemplate( const QString& name ) const;
82 
83  /* reimp */ QPair< QString, QString > getMediaUri( const QString& fileName ) const;
84 
85  /* reimp */ Template loadByName( const QString& name, const Grantlee::Engine* engine ) const;
86 
90  void clear();
91 
95  int size() const;
96 
100  bool isEmpty() const;
101 
102 private:
103  Q_DECLARE_PRIVATE( CachingLoaderDecorator )
104  CachingLoaderDecoratorPrivate * const d_ptr;
105 };
106 
107 }
108 
109 
110 #endif
The Template class is a tree of nodes which may be rendered.
Definition: template.h:89
QSharedPointer< AbstractTemplateLoader > Ptr
An retrieval interface to a storage location for Template objects.
Implements a loader decorator which caches compiled Template objects.
Grantlee::Engine is the main entry point for creating Grantlee Templates.
Definition: engine.h:110