cxStringProperty.h

Go to the documentation of this file.

/*=========================================================================
This file is part of CustusX, an Image Guided Therapy Application.
                 
Copyright (c) SINTEF Department of Medical Technology.
All rights reserved.
                 
CustusX is released under a BSD 3-Clause license.
                 
See Lisence.txt (https://github.com/SINTEFMedtek/CustusX/blob/master/License.txt) for details.
=========================================================================*/

#ifndef CXSTRINGPROPERTY_H_
#define CXSTRINGPROPERTY_H_

#include "cxResourceExport.h"

#include <QDomElement>
#include <QStringList>
#include "cxStringPropertyBase.h"
#include "cxXmlOptionItem.h"

namespace cx
{

typedef boost::shared_ptr<class StringProperty> StringPropertyPtr;

class cxResource_EXPORT StringProperty: public StringPropertyBase
{
Q_OBJECT
public:
    static StringPropertyPtr initialize(const QString& uid, QString name, QString help, QString value, QStringList range, QDomNode root = QDomNode());
        static StringPropertyPtr initialize(const QString& uid, QString name, QString help, QString value, QDomNode root = QDomNode());

public:
        // inherited interface
        virtual QString getDisplayName() const;
        virtual QString getUid() const;
        virtual bool setValue(const QString& value); 
        virtual QString getValue() const; 
        virtual QString getHelp() const; 
    virtual void setHelp(QString val);
        virtual QStringList getValueRange() const; 
        virtual void setValueRange(QStringList range);
        virtual QString convertInternal2Display(QString internal); 
        virtual void setDisplayNames(std::map<QString, QString> names);
        virtual std::map<QString, QString> getDisplayNames() const { return mDisplayNames; }

        virtual bool isReadOnly() const { return mIsReadOnly; }
        virtual bool getAllowOnlyValuesInRange() const { return mAllowOnlyValuesInRange; }
        void setReadOnly(bool val);
        virtual void setDisplayName(QString val);


signals:
        void valueWasSet(); 

private:
        StringProperty();
        QString mName;
        QString mUid;
        QString mHelp;
        QString mValue;
        QStringList mRange;
        XmlOptionItem mStore;
        std::map<QString, QString> mDisplayNames;
        bool mIsReadOnly;
        bool mAllowOnlyValuesInRange;
};


} // namespace cx

#endif /* CXSTRINGPROPERTY_H_ */