#include <directoryproperty.h>

Inheritance diagram for inviwo::DirectoryProperty:

Public Member Functions
virtual std::string_view	getClassIdentifier () const override

	DirectoryProperty (std::string_view identifier, std::string_view displayName, Document help, std::string_view value="", std::string_view contentType="default", InvalidationLevel invalidationLevel=InvalidationLevel::InvalidOutput, PropertySemantics semantics=PropertySemantics::Default)

	DirectoryProperty (std::string_view identifier, std::string_view displayName, std::string_view value="", std::string_view contentType="default", InvalidationLevel invalidationLevel=InvalidationLevel::InvalidOutput, PropertySemantics semantics=PropertySemantics::Default)

	DirectoryProperty (const DirectoryProperty &rhs)

virtual DirectoryProperty *	clone () const override

virtual std::string_view	getClassIdentifierForWidget () const override
	Returns which property's widget should be used when the WidgetFactory tries to create a widget. Defaults to getClassIdentifier(), should only be overridden if a subclass want to reuse another property's widget.

Public Member Functions inherited from inviwo::FileProperty
	FileProperty (std::string_view identifier, std::string_view displayName, Document help, const std::filesystem::path &value={}, AcceptMode acceptMode=AcceptMode::Open, FileMode fileMode=FileMode::AnyFile, std::string_view contentType=defaultContentType, InvalidationLevel invalidationLevel=InvalidationLevel::InvalidOutput, PropertySemantics semantics=PropertySemantics::Default)
	Constructor for the FileProperty.

	FileProperty (std::string_view identifier, std::string_view displayName, Document help, const std::filesystem::path &value, std::string_view contentType, InvalidationLevel invalidationLevel=InvalidationLevel::InvalidOutput, PropertySemantics semantics=PropertySemantics::Default)
	Constructor for the FileProperty.

	FileProperty (std::string_view identifier, std::string_view displayName, const std::filesystem::path &value={}, std::string_view contentType=defaultContentType, InvalidationLevel invalidationLevel=InvalidationLevel::InvalidOutput, PropertySemantics semantics=PropertySemantics::Default)
	Constructor for the FileProperty.

	FileProperty (const FileProperty &rhs)=default

FileProperty &	operator= (const std::filesystem::path &value)

void	set (const std::filesystem::path &file)

void	set (const std::filesystem::path &file, const FileExtension &selectedExtension)

void	set (const FileProperty *property)

void	set (const MultiFileProperty *property)

virtual void	set (const Property *property) override

	operator const std::filesystem::path & () const

const std::filesystem::path &	get () const

const std::filesystem::path &	operator* () const

const std::filesystem::path *	operator-> () const

virtual void	serialize (Serializer &s) const override

virtual void	deserialize (Deserializer &d) override

virtual void	requestFile ()

virtual Document	getDescription () const override

virtual FileProperty &	setCurrentStateAsDefault () override

FileProperty &	setDefault (const std::filesystem::path &value)

virtual FileProperty &	resetToDefaultState () override

virtual bool	isDefaultState () const override

Public Member Functions inherited from inviwo::Property
	Property (std::string_view identifier="", std::string_view displayName="", Document help={}, InvalidationLevel invalidationLevel=InvalidationLevel::InvalidOutput, PropertySemantics semantics=PropertySemantics::Default, ReadOnly readOnly=ReadOnly::No)

	Property (std::string_view identifier, std::string_view displayName, InvalidationLevel invalidationLevel, PropertySemantics semantics=PropertySemantics::Default)

virtual	~Property ()
	Removes itself from its PropertyOwner.

virtual Property &	setIdentifier (std::string_view identifier)

virtual const std::string &	getIdentifier () const

const std::string &	getPath () const
	Get the property path as string.

void	getPath (std::pmr::string &out) const

virtual Property &	setDisplayName (std::string_view displayName)
	A property's name displayed to the user.

virtual const std::string &	getDisplayName () const

virtual Property &	setSemantics (const PropertySemantics &semantics)

virtual PropertySemantics	getSemantics () const

virtual Property &	setReadOnly (bool value)
	Enable or disable editing of property.

virtual bool	getReadOnly () const

virtual Property &	setInvalidationLevel (InvalidationLevel invalidationLevel)

virtual InvalidationLevel	getInvalidationLevel () const

virtual void	setOwner (PropertyOwner *owner)

PropertyOwner *	getOwner ()

const PropertyOwner *	getOwner () const

void	registerWidget (PropertyWidget *propertyWidget)

void	deregisterWidget (PropertyWidget *propertyWidget)

const std::vector< PropertyWidget * > &	getWidgets () const

void	setInitiatingWidget (PropertyWidget *propertyWidget)

void	clearInitiatingWidget ()

void	updateWidgets ()

bool	hasWidgets () const

virtual Property &	setSerializationMode (PropertySerializationMode mode)

virtual PropertySerializationMode	getSerializationMode () const

virtual bool	needsSerialization () const

virtual Property &	propertyModified ()

virtual void	setValid ()

virtual Property &	setModified ()

virtual bool	isModified () const

std::shared_ptr< std::function< void()> >	onChangeScoped (std::function< void()> callback)

const BaseCallBack *	onChange (std::function< void()> callback)

void	removeOnChange (const BaseCallBack *callback)

virtual Property &	setVisible (bool val)

virtual bool	getVisible () const

template<typename P , typename DecisionFunc >
Property &	visibilityDependsOn (P &prop, DecisionFunc callback)

template<typename P , typename DecisionFunc >
Property &	readonlyDependsOn (P &prop, DecisionFunc callback)

const Document &	getHelp () const

Document &	getHelp ()

Property &	setHelp (Document help)

template<typename P >
Property &	autoLinkToProperty (std::string_view propertyPath)

const std::vector< std::pair< std::string, std::string > > &	getAutoLinkToProperty () const

virtual void	accept (NetworkVisitor &visitor)
	Accept a NetworkVisitor, the visitor will visit this Property.

Public Member Functions inherited from inviwo::Observable< PropertyObserver >
	Observable (const Observable< PropertyObserver > &other)

	Observable (Observable< PropertyObserver > &&other) noexcept

Observable< PropertyObserver > &	operator= (const Observable< PropertyObserver > &other)

Observable< PropertyObserver > &	operator= (Observable< PropertyObserver > &&other) noexcept

void	addObserver (PropertyObserver *observer)

void	removeObserver (PropertyObserver *observer)

virtual void	startBlockingNotifications () override final

virtual void	stopBlockingNotifications () override final

Public Member Functions inherited from inviwo::ObservableInterface
Public Member Functions inherited from inviwo::Serializable
Public Member Functions inherited from inviwo::MetaDataOwner
	MetaDataOwner (const MetaDataOwner &rhs)=default

	MetaDataOwner (MetaDataOwner &rhs)=default

MetaDataOwner &	operator= (const MetaDataOwner &rhs)=default

MetaDataOwner &	operator= (MetaDataOwner &)=default

void	copyMetaDataFrom (const MetaDataOwner &src)

void	copyMetaDataTo (MetaDataOwner &dst)

template<typename T > requires std::derived_from<T, MetaData>
T *	createMetaData (std::string_view key)

template<typename T , typename U > requires std::derived_from<T, MetaData> && Settable<T, U>
void	setMetaData (std::string_view key, U value)

template<typename T > requires std::derived_from<T, MetaData>
bool	unsetMetaData (std::string_view key)
	unset, i.e. remove the metadata entry matching the given key and type

template<typename T , typename U > requires std::derived_from<T, MetaData> && Gettable<T, U>
U	getMetaData (std::string_view key, U val) const

template<typename T > requires std::derived_from<T, MetaData>
T *	getMetaData (std::string_view key)

template<typename T > requires std::derived_from<T, MetaData>
const T *	getMetaData (std::string_view key) const

MetaDataMap *	getMetaDataMap ()

const MetaDataMap *	getMetaDataMap () const

bool	hasMetaData (std::string_view key) const

template<typename T > requires std::derived_from<T, MetaData>
bool	hasMetaData (std::string_view key) const

void	serialize (Serializer &s) const

void	deserialize (Deserializer &d)

Public Member Functions inherited from inviwo::FileBase
	FileBase (std::function< void()> onModified, AcceptMode acceptMode, FileMode fileMode, std::string_view contentType)

void	addNameFilter (std::string_view filter)

void	addNameFilter (FileExtension ext)

void	addNameFilters (const std::vector< FileExtension > &filters)

void	clearNameFilters ()

const std::vector< FileExtension > &	getNameFilters () const

std::vector< FileExtension > &	getNameFilters ()

bool	matchesAnyNameFilter (const std::filesystem::path &file) const

void	setAcceptMode (AcceptMode mode)

AcceptMode	getAcceptMode () const

void	setFileMode (FileMode mode)

FileMode	getFileMode () const

void	setContentType (std::string_view contentType)

const std::string &	getContentType () const

const FileExtension &	getSelectedExtension () const

void	setSelectedExtension (const FileExtension &ext)

Static Public Attributes
static constexpr std::string_view	classIdentifier {"org.inviwo.DirectoryProperty"}

Static Public Attributes inherited from inviwo::FileProperty
static constexpr std::string_view	classIdentifier {"org.inviwo.FileProperty"}

Static Public Attributes inherited from inviwo::FileBase
static constexpr std::string_view	defaultContentType = "default"

Additional Inherited Members
Public Types inherited from inviwo::FileProperty
using	value_type = std::filesystem::path

Static Public Member Functions inherited from inviwo::Property
template<typename T , typename U >
static void	setStateAsDefault (T &property, const U &state)

Protected Member Functions inherited from inviwo::Property
	Property (const Property &rhs)

Property &	operator= (const Property &that)=delete

void	notifyAboutChange ()

Protected Member Functions inherited from inviwo::PropertyObservable
void	notifyObserversOnSetIdentifier (Property *property, const std::string &identifier)

void	notifyObserversOnSetDisplayName (Property *property, const std::string &displayName)

void	notifyObserversOnSetSemantics (Property *property, const PropertySemantics &semantics)

void	notifyObserversOnSetReadOnly (Property *property, bool readonly)

void	notifyObserversOnSetVisible (Property *property, bool visible)

Protected Member Functions inherited from inviwo::Observable< PropertyObserver >
void	forEachObserver (C callback)

Protected Member Functions inherited from inviwo::ObservableInterface
void	addObservationHelper (Observer *observer)

void	removeObservationHelper (Observer *observer)

Protected Member Functions inherited from inviwo::FileBase
bool	setFileBase (const FileBase &base)

bool	updateExtension (const std::filesystem::path &file)

void	setAsDefault ()

bool	reset ()

void	serialize (Serializer &s, PropertySerializationMode mode) const

bool	deserialize (Deserializer &d, PropertySerializationMode mode)

std::unique_ptr< FileDialog >	createFileDialog (std::string_view title, const std::filesystem::path &file) const

Static Protected Member Functions inherited from inviwo::FileBase
template<typename Arg , typename... Args>
static constexpr bool	any_of (Arg &&arg, Args &&... args)

Protected Attributes inherited from inviwo::Property
CallBackList	onChangeCallback_

PropertySerializationMode	serializationMode_

Protected Attributes inherited from inviwo::MetaDataOwner
MetaDataMap	metaData_

Protected Attributes inherited from inviwo::FileBase
std::vector< FileExtension >	nameFilters_

ValueWrapper< FileExtension >	selectedExtension_

ValueWrapper< AcceptMode >	acceptMode_

ValueWrapper< FileMode >	fileMode_

ValueWrapper< std::string >	contentType_

Detailed Description

A class for file representations. Holds the value of the path to a file as a string.

See also: FileProperty, StringProperty

Member Function Documentation

◆ clone()

virtual DirectoryProperty * inviwo::DirectoryProperty::clone ( ) const

overridevirtual

Creates a clone of this property. The clone will have the same identifier, hence the identifier must be changed if the clone should be added to the same owner as this. The new clone does not have any owner set.

Reimplemented from inviwo::FileProperty.

◆ getClassIdentifier()

virtual std::string_view inviwo::DirectoryProperty::getClassIdentifier ( ) const

overridevirtual

Reimplemented from inviwo::FileProperty.

◆ getClassIdentifierForWidget()

virtual std::string_view inviwo::DirectoryProperty::getClassIdentifierForWidget ( ) const

overridevirtual

Returns which property's widget should be used when the WidgetFactory tries to create a widget. Defaults to getClassIdentifier(), should only be overridden if a subclass want to reuse another property's widget.

Reimplemented from inviwo::Property.

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

directoryproperty.h

Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ clone()

◆ getClassIdentifier()

◆ getClassIdentifierForWidget()