qgstranslationcontext.h

Go to the documentation of this file.

/***************************************************************************
  qgstranslationcontext.h
 
 ---------------------
 begin                : 23.5.2018
 copyright            : (C) 2018 by David Signer
 email                : david at opengis dot ch
 ***************************************************************************
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/
#ifndef QGSTRANSLATIONCONTEXT_H
#define QGSTRANSLATIONCONTEXT_H
 
#include "qgis_core.h"
#include "qgis_sip.h"
 
#include <QList>
#include <QString>
 
class QgsProject;

 
class CORE_EXPORT QgsTranslationContext
{

    struct TranslatableObject
    {
      QString context; 
      QString source; 
 
      bool operator==( const TranslatableObject &other ) const { return context == other.context && source == other.source; }
    };
 
  public:
 
    QgsTranslationContext() = default;

    QgsProject *project() const;

    void setProject( QgsProject *project );

    QString fileName() const;

    void setFileName( const QString &fileName );

    void registerTranslation( const QString &context, const QString &source );

    void writeTsFile( const QString &locale ) const;
 
  private:
 
    QgsProject *mProject = nullptr;
    QString mFileName;
    QList < TranslatableObject > mTranslatableObjects;
 
};
 
#endif // QGSTRANSLATIONCONTEXT_H