templates/lib/context.h

/*
  This file is part of the Grantlee template system.

  Copyright (c) 2009,2010 Stephen Kelly <steveire@gmail.com>

  This library is free software; you can redistribute it and/or
  modify it under the terms of the GNU Lesser General Public
  License as published by the Free Software Foundation; either version
  2.1 of the Licence, or (at your option) any later version.

  This library is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  Lesser General Public License for more details.

  You should have received a copy of the GNU Lesser General Public
  License along with this library.  If not, see <http://www.gnu.org/licenses/>.

*/

#ifndef GRANTLEE_CONTEXT_H
#define GRANTLEE_CONTEXT_H

#include "abstractlocalizer.h"
#include "grantlee_templates_export.h"

#include <QtCore/QVariantHash>

namespace Grantlee
{

class RenderContext;

class ContextPrivate;


class GRANTLEE_TEMPLATES_EXPORT Context
{
public:
  Context();
  explicit Context(const QVariantHash &hash);

  Context(const Context &other);

  Context &operator=(const Context &other);

#ifndef Q_QDOC

  bool autoEscape() const;

  void setAutoEscape(bool autoescape);
#endif

  ~Context();

  QVariant lookup(const QString &str) const;

  void insert(const QString &name, QObject *object);

  void insert(const QString &name, const QVariant &variant);

  void push();

  void pop();

#ifndef Q_QDOC

  QVariantHash stackHash(int depth) const;

  bool isMutating() const;

  void setMutating(bool mutating);

  void addExternalMedia(const QString &absolutePart,
                        const QString &relativePart);

  void clearExternalMedia();
#endif

  void setLocalizer(QSharedPointer<AbstractLocalizer> localizer);

  QSharedPointer<AbstractLocalizer> localizer() const;

  QList<QPair<QString, QString>> externalMedia() const;

  enum UrlType {
    AbsoluteUrls, 
    RelativeUrls  
  };

  void setUrlType(UrlType type);

  UrlType urlType() const;

  void setRelativeMediaPath(const QString &relativePath);

  QString relativeMediaPath() const;

  RenderContext *renderContext() const;

private:
  Q_DECLARE_PRIVATE(Context)
  ContextPrivate *const d_ptr;
};
}

#endif