cxStringPropertyBase.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 CXSTRINGPROPERTYBASE_H_
#define CXSTRINGPROPERTYBASE_H_

#include "cxResourceExport.h"

#include <boost/shared_ptr.hpp>
#include <QObject>
#include <QString>
#include <QStringList>
#include <QComboBox>
#include "cxProperty.h"

namespace cx
{

class cxResource_EXPORT StringPropertyBase: public Property
{
        Q_OBJECT
public:
        StringPropertyBase() : mGuiRepresentation(grSTRING) {}
        virtual ~StringPropertyBase(){}

public:
        enum GuiRepresentation
        {
                grSTRING,
                grFILENAME
        };

        // basic methods
        virtual QString getDisplayName() const = 0;

        virtual QVariant getValueAsVariant() const
        {
                return QVariant(this->getValue());
        }
        virtual void setValueFromVariant(QVariant val)
        {
                this->setValue(val.toString());
        }

        virtual QString getUid() const { return this->getDisplayName()+"_uid"; }
        virtual bool setValue(const QString& value) = 0; 
        virtual QString getValue() const = 0; 

public:
        /*
         * If set: setValue will always fail. Adapter is used for display only.
         */
        virtual bool isReadOnly() const { return false; }
        /*
         * If true: value will always be within range. setValue using other values will fail.
         */
        virtual bool getAllowOnlyValuesInRange() const { return true; }
        // optional methods
        virtual QString getHelp() const
        {
                return QString();
        } 
        virtual QStringList getValueRange() const
        {
                return QStringList();
        } 
        virtual QString convertInternal2Display(QString internal)
        {
                return internal;
        } 

        virtual void setGuiRepresentation(GuiRepresentation type) { mGuiRepresentation = type; };
        virtual GuiRepresentation getGuiRepresentation() { return mGuiRepresentation; };

protected:
        GuiRepresentation mGuiRepresentation;

};
typedef boost::shared_ptr<StringPropertyBase> StringPropertyBasePtr;

} // namespace cx

#endif /* CXSTRINGPROPERTYBASE_H_ */