templates.h

Go to the documentation of this file.

//
// C++ Interface: templates
//
// Description: 
//
//
// Author: Konrad Rosenbaum <konrad@silmor.de>, (C) 2008-2011
//
// Copyright: See README/COPYING.GPL files that come with this distribution
//
//

#ifndef MAGICSMOKE_TEMPLATES_H
#define MAGICSMOKE_TEMPLATES_H

#include <QString>
#include <QList>
#include <functional>

#ifndef MSIFACE_EXPORT
#define MSIFACE_EXPORT Q_DECL_IMPORT
#endif

class MSIFACE_EXPORT MTemplate
{
        public:
                MTemplate();
                
                MTemplate(QString fn);
                
                MTemplate(const MTemplate&)=default;
                
                MTemplate& operator=(const MTemplate&)=default;
                
                void setFile(const QString&);
                
                QString cacheFileName()const;
                
                QString fileName()const;
                
                QString completeFileName()const;
                
                QString baseName()const;
                
                QString extension()const;
                
                QString variantID()const;
                
                QString checksum()const;
                
                QString description()const;
                
                bool isValid()const;
                
                QString targetExtension()const;
                
                bool isOdf()const;
                
                bool isLabel()const;

                bool isZip()const;

                bool isHtml()const;
                
                QString flags()const{return m_flags;}
                
                enum Type{
                        UnknownTemplate=0,
                        OdtTemplate=1,
                        OdsTemplate=2,
                        OdpTemplate=4,
                        OdgTemplate=8,
                        OdbTemplate=0x10,
                        OdfTemplateMask=0xff,
                        LabelTemplate=0x100,
                        ZipTemplate=0x200,
                        HtmlTemplate=0x400,
                        MimeTemplate=0x800
                };
                Q_DECLARE_FLAGS(Types,Type)
                
                
                Type type()const;
                
                static QStringList legalBaseNames();
                
                static Types legalTypes(QString);
                
                static QStringList legalSuffixes(QString);
                
                typedef std::function<MTemplate(const QList<MTemplate>&)>TemplateChoserFunction;
                
                static void setTemplateChoiceFunction(const TemplateChoserFunction&);

        protected:
                friend class MTemplateStore;
                friend class MTemplateChoice;
                MTemplate(QString fn,QString chk,QString dsc,QString flg);
        private:
                QString m_fname,m_checksum,m_descr,m_flags;
};
Q_DECLARE_OPERATORS_FOR_FLAGS(MTemplate::Types)

class MSIFACE_EXPORT MTemplateStore
{
        protected:
                friend class MSInterface;
                friend class MTemplateEditor;
                MTemplateStore(QString);
                
                bool setTemplate(QString templatename,QString localfile);
                
                bool setTemplateDescription(QString templatename,QString description);
                
                bool setTemplateFlags(QString templatename,QString flags);
                
                bool deleteTemplate(QString);
                
                void updateTemplates(bool force);
                
        private:
                MTemplateStore()=delete;
                
                bool retrieveFile(QString,QString);
                
        public:
                MTemplate getTemplate(QString base,bool useFirst=false);
                MTemplate getTemplateByFile(QString full);
                
                QList<MTemplate> allTemplates();

        private:
                QString profileid;
};

#endif