cxSpaceProperty.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 CXSPACEPROPERTY_H_
#define CXSPACEPROPERTY_H_


#include "cxResourceExport.h"

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

namespace cx
{

typedef boost::shared_ptr<class SpaceProperty> SpacePropertyPtr;

class cxResource_EXPORT SpaceProperty: public SpacePropertyBase
{
Q_OBJECT
public:
        static SpacePropertyPtr initialize(const QString& uid, QString name, QString help, Space value=Space(),
                std::vector<Space> range=std::vector<Space>(), QDomNode root = QDomNode());
        void setSpaceProvider(SpaceProviderPtr provider);

public:
        // inherited interface
        virtual QString getDisplayName() const;
        virtual QString getUid() const;
        virtual bool setValue(const Space& value); 
        virtual Space getValue() const; 
        virtual QString getHelp() const; 
        virtual void setHelp(QString val);
        virtual std::vector<Space> getValueRange() const; 
        virtual void setValueRange(std::vector<Space> range);
        virtual QString convertRefObjectInternal2Display(QString internal); 
        virtual void setRefObjectDisplayNames(std::map<QString, QString> names);

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


signals:
        void valueWasSet(); 

private slots:
        void providerChangedSlot();
private:
        SpaceProperty();
        QString mName;
        QString mUid;
        QString mHelp;
        Space mValue;
        std::vector<Space> mRange;
        XmlOptionItem mStore;
        std::map<QString, QString> mDisplayNames;
        bool mIsReadOnly;
        bool mAllowOnlyValuesInRange;

        SpaceProviderPtr mProvider;
};

// --------------------------------------------------------
// --------------------------------------------------------


} // namespace cx

#endif // CXSPACEPROPERTY_H_