/daten/ahuesgen/projects/vhist/code/vhistlib/include/arglib/wsfile.h

/* $HEADERS
$Id: wsfile.h 2179 2011-06-24 09:03:24Z ahuesgen $
*/

#ifndef FILE_INCLUDED
#define FILE_INCLUDED

#include "../shared/misc_defines.h"

#include <QString>
#include <QDir>
#include <QList>
#include <QHash>


namespace vhist
{

class VHIST_EXTERN WSFile
{
    public:
        enum FilePurpose
        {
            INPUT_FILE,
            OUTPUT_FILE
        };
    
    public: // construction and destruction
        WSFile();
        WSFile(const WSFile& rhs);
    
    public: // comparison
        bool operator==(const WSFile& rhs);
        bool operator!=(const WSFile& rhs);
    
    public: // main functionality
        QString toCommandline(bool supportVariables = true);
    
    public: // getter/setter
        QString filetype() const;
        void setFiletype(const QString& filetype);
        
        QString filename() const;
        void setFilename(const QString& filename);
        
        QString filepath() const;
        void setFilepath(const QString& filepath);
        
        void setFilenameAndPath (const QString& file);
        
        bool optional() const;
        void setOptional(bool optional);
        
        bool compress() const;
        void setCompress(bool compress);
        
        bool inputFile() const;
        void setInputFile(bool isInputFile);
        
        FilePurpose filePurpose() const;
        void setFilePurpose(const FilePurpose& purpose);
        
        QString description() const;
        void setDescription(const QString& description);
        
        QString comment() const;
        void setComment(const QString& comment);
        
        bool embed() const;
        void setEmbed(bool embed);
        
        bool autoMD5() const;
        void setAutoMD5(bool compress);
        
        QString md5File() const;
        void setMD5File(const QString& file);
    
        bool previewWS() const;
        void setPreviewWS(bool previewWS);
    
        bool preview() const;
        void setPreview(bool preview);
    
        bool thumbnail() const;
        void setThumbnail(bool thumbnail);
        
        bool thumbnailOnly() const;
        void setThumbnailOnly(bool thumbnailOnly);
        
        void clearUserAttributes();
        void addUserAttribute(const QString& key, const QString& value);
        QStringList userAttributeKeys() const;
        QString userAttribute(const QString& key) const;
    
    private:
        QString m_filetype;
        QString m_filename;
        QString m_filepath;
        QString m_md5File;
        
        bool m_md5;
        bool m_embed;
        bool m_optional;
        bool m_compress;
        bool m_previewws;
        bool m_preview;
        bool m_thumbnail;
        bool m_thumbnailOnly;
        
        FilePurpose m_filePurpose;
        QString m_description;
        QString m_comment;
        QHash<QString, QString> m_userAttributes;
        QStringList m_userAttributesOrder;
};

}

#endif // FILE_INCLUDED