CustusX  2023.01.05-dev+develop.0da12
An IGT application
cx::FilePathPropertyBase Class Reference

Base class for properties using a file path. More...

#include <cxFilePathPropertyBase.h>

Inheritance diagram for cx::FilePathPropertyBase:
cx::Property cx::FilePathProperty cx::FilePreviewProperty

Signals

void valueWasSet ()
 
- Signals inherited from cx::Property
void changed ()
 emit when the underlying data value is changed: The user interface will be updated. More...
 

Public Member Functions

 FilePathPropertyBase ()
 
virtual ~FilePathPropertyBase ()
 
virtual QString getDisplayName () const
 name of data entity. Used for display to user. More...
 
virtual QVariant getValueAsVariant () const
 
virtual void setValueFromVariant (QVariant val)
 
virtual QString getUid () const
 
virtual bool setValue (const QString &value)
 
virtual QString getValue () const
 
EmbeddedFilepath getEmbeddedPath ()
 
- Public Member Functions inherited from cx::Property
 Property ()
 
virtual ~Property ()
 
virtual bool getEnabled () const
 Get the enabled/disabled state of the Property. More...
 
virtual bool getAdvanced () const
 Get the advanced flag of the adapter. More...
 
virtual QString getGroup () const
 Flag the adapter as part of a group. More...
 

Protected Attributes

QString mName
 emitted when the value is set using setValue() (similar to changed(), but more constrained) More...
 
QString mUid
 
QString mHelp
 
EmbeddedFilepath mFilePath
 
XmlOptionItem mStore
 
- Protected Attributes inherited from cx::Property
bool mEnabled
 
bool mAdvanced
 
QString mGroup
 

Additional Inherited Members

- Public Slots inherited from cx::Property
virtual bool setEnabled (bool enabled)
 Set the enabled/disabled state of the Property. More...
 
virtual bool setAdvanced (bool advanced)
 Set the advanced flag of the adapter. More...
 
virtual bool setGroup (QString name)
 Flag the adapter as part of a group. More...
 
- Static Public Member Functions inherited from cx::Property
static PropertyPtr findProperty (std::vector< PropertyPtr > properties, QString id)
 

Detailed Description

Base class for properties using a file path.

Date
Apr 23, 2020
Author
Ole Vegard Solberg, SINTEF

Definition at line 57 of file cxFilePathPropertyBase.h.

Constructor & Destructor Documentation

cx::FilePathPropertyBase::FilePathPropertyBase ( )

Definition at line 102 of file cxFilePathPropertyBase.cpp.

virtual cx::FilePathPropertyBase::~FilePathPropertyBase ( )
inlinevirtual

Definition at line 62 of file cxFilePathPropertyBase.h.

Member Function Documentation

QString cx::FilePathPropertyBase::getDisplayName ( ) const
virtual

name of data entity. Used for display to user.

Implements cx::Property.

Definition at line 107 of file cxFilePathPropertyBase.cpp.

EmbeddedFilepath cx::FilePathPropertyBase::getEmbeddedPath ( )

Definition at line 129 of file cxFilePathPropertyBase.cpp.

virtual QString cx::FilePathPropertyBase::getUid ( ) const
inlinevirtual

Implements cx::Property.

Reimplemented in cx::FilePathProperty.

Definition at line 76 of file cxFilePathPropertyBase.h.

QString cx::FilePathPropertyBase::getValue ( ) const
virtual

Definition at line 112 of file cxFilePathPropertyBase.cpp.

virtual QVariant cx::FilePathPropertyBase::getValueAsVariant ( ) const
inlinevirtual

Implements cx::Property.

Reimplemented in cx::FilePathProperty.

Definition at line 67 of file cxFilePathPropertyBase.h.

bool cx::FilePathPropertyBase::setValue ( const QString &  value)
virtual

Definition at line 117 of file cxFilePathPropertyBase.cpp.

virtual void cx::FilePathPropertyBase::setValueFromVariant ( QVariant  val)
inlinevirtual

Implements cx::Property.

Reimplemented in cx::FilePathProperty.

Definition at line 71 of file cxFilePathPropertyBase.h.

void cx::FilePathPropertyBase::valueWasSet ( )
signal

Member Data Documentation

EmbeddedFilepath cx::FilePathPropertyBase::mFilePath
protected

Definition at line 89 of file cxFilePathPropertyBase.h.

QString cx::FilePathPropertyBase::mHelp
protected

Definition at line 88 of file cxFilePathPropertyBase.h.

QString cx::FilePathPropertyBase::mName
protected

emitted when the value is set using setValue() (similar to changed(), but more constrained)

Definition at line 86 of file cxFilePathPropertyBase.h.

XmlOptionItem cx::FilePathPropertyBase::mStore
protected

Definition at line 90 of file cxFilePathPropertyBase.h.

QString cx::FilePathPropertyBase::mUid
protected

Definition at line 87 of file cxFilePathPropertyBase.h.


The documentation for this class was generated from the following files: