cxStringPropertyBase.h

Go to the documentation of this file.

/*=========================================================================
This file is part of CustusX, an Image Guided Therapy Application.

Copyright (c) 2008-2014, SINTEF Department of Medical Technology
All rights reserved.

Redistribution and use in source and binary forms, with or without 
modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, 
   this list of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright notice, 
   this list of conditions and the following disclaimer in the documentation 
   and/or other materials provided with the distribution.

3. Neither the name of the copyright holder nor the names of its contributors 
   may be used to endorse or promote products derived from this software 
   without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE 
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR 
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER 
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
=========================================================================*/


#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_ */