#include <inviwo/core/properties/multifileproperty.h>

Inheritance diagram for inviwo::MultiFileProperty:

Public Types
using	value_type = std::vector<std::filesystem::path>

Public Member Functions
const std::filesystem::path *	back () const
virtual MultiFileProperty *	clone () const override
virtual void	deserialize (Deserializer &d) override
bool	empty () const
const std::filesystem::path *	front () const
const std::vector< std::filesystem::path > &	get () const
virtual std::string_view	getClassIdentifier () const override
virtual Document	getDescription () const override
virtual bool	isDefaultState () const override
	MultiFileProperty (const MultiFileProperty &rhs)=default
	MultiFileProperty (std::string_view identifier, std::string_view displayName, const std::vector< std::filesystem::path > &value, std::string_view contentType, InvalidationLevel invalidationLevel=InvalidationLevel::InvalidOutput, PropertySemantics semantics=PropertySemantics::Default)
	Constructor for the MultiFileProperty.
	MultiFileProperty (std::string_view identifier, std::string_view displayName, Document help={}, const std::vector< 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 MultiFileProperty.
	operator const std::vector< std::filesystem::path > & () const
const std::vector< std::filesystem::path > &	operator* () const
const std::vector< std::filesystem::path > *	operator-> () const
MultiFileProperty &	operator= (const std::vector< std::filesystem::path > &value)
void	requestFile ()
virtual MultiFileProperty &	resetToDefaultState () override
virtual void	serialize (Serializer &s) const override
void	set (const FileProperty *property)
void	set (const MultiFileProperty *property)
virtual void	set (const Property *property) override
void	set (const std::filesystem::path &value)
void	set (const std::vector< std::filesystem::path > &files, const FileExtension &selectedExtension)
void	set (const std::vector< std::filesystem::path > &values)
virtual MultiFileProperty &	setCurrentStateAsDefault () override
MultiFileProperty &	setDefault (const std::vector< std::filesystem::path > &value)
Public Member Functions inherited from inviwo::Property
virtual void	accept (NetworkVisitor &visitor)
	Accept a NetworkVisitor, the visitor will visit this Property.
template<typename P>
Property &	autoLinkToProperty (std::string_view propertyPath)
void	clearInitiatingWidget ()
void	deregisterWidget (PropertyWidget *propertyWidget)
const std::vector< std::pair< std::string, std::string > > &	getAutoLinkToProperty () const
virtual std::string_view	getClassIdentifierForWidget () const
	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.
virtual const std::string &	getDisplayName () const
Document &	getHelp ()
const Document &	getHelp () const
virtual const std::string &	getIdentifier () const
virtual InvalidationLevel	getInvalidationLevel () const
PropertyOwner *	getOwner ()
const PropertyOwner *	getOwner () const
const std::string &	getPath () const
	Get the property path as string.
void	getPath (std::pmr::string &out) const
virtual bool	getReadOnly () const
virtual PropertySemantics	getSemantics () const
virtual PropertySerializationMode	getSerializationMode () const
virtual bool	getVisible () const
const std::vector< PropertyWidget * > &	getWidgets () const
bool	hasWidgets () const
virtual bool	isModified () const
virtual bool	needsSerialization () const
const BaseCallBack *	onChange (std::function< void()> callback)
std::shared_ptr< std::function< void()> >	onChangeScoped (std::function< void()> callback)
	Property (std::string_view identifier, std::string_view displayName, InvalidationLevel invalidationLevel, PropertySemantics semantics=PropertySemantics::Default)
	Property (std::string_view identifier="", std::string_view displayName="", Document help={}, InvalidationLevel invalidationLevel=InvalidationLevel::InvalidOutput, PropertySemantics semantics=PropertySemantics::Default, ReadOnly readOnly=ReadOnly::No)
virtual Property &	propertyModified ()
template<typename P, typename DecisionFunc>
Property &	readonlyDependsOn (P &prop, DecisionFunc callback)
void	registerWidget (PropertyWidget *propertyWidget)
void	removeOnChange (const BaseCallBack *callback)
virtual Property &	setDisplayName (std::string_view displayName)
	A property's name displayed to the user.
Property &	setHelp (Document help)
virtual Property &	setIdentifier (std::string_view identifier)
void	setInitiatingWidget (PropertyWidget *propertyWidget)
virtual Property &	setInvalidationLevel (InvalidationLevel invalidationLevel)
virtual Property &	setModified ()
virtual void	setOwner (PropertyOwner *owner)
virtual Property &	setReadOnly (bool value)
	Enable or disable editing of property.
virtual Property &	setSemantics (const PropertySemantics &semantics)
virtual Property &	setSerializationMode (PropertySerializationMode mode)
virtual void	setValid ()
virtual Property &	setVisible (bool val)
void	updateWidgets ()
template<typename P, typename DecisionFunc>
Property &	visibilityDependsOn (P &prop, DecisionFunc callback)
virtual	~Property ()
	Removes itself from its PropertyOwner.
Public Member Functions inherited from inviwo::Observable< PropertyObserver >
void	addObserver (PropertyObserver *observer)
bool	isObservedBy (PropertyObserver *observer) const
Observable< PropertyObserver > &	operator= (const Observable< PropertyObserver > &other)
void	removeObserver (PropertyObserver *observer)
virtual void	startBlockingNotifications () override final
virtual void	stopBlockingNotifications () override final
Public Member Functions inherited from inviwo::MetaDataOwner
void	copyMetaDataFrom (const MetaDataOwner &src)
void	copyMetaDataTo (MetaDataOwner &dst)
template<typename T> requires std::derived_from<T, MetaData>
T *	createMetaData (std::string_view key)
void	deserialize (Deserializer &d)
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
template<typename T, typename U> requires std::derived_from<T, MetaData> && Gettable<T, U>
U	getMetaData (std::string_view key, U val) const
MetaDataMap *	getMetaDataMap ()
const MetaDataMap *	getMetaDataMap () const
template<typename T> requires std::derived_from<T, MetaData>
bool	hasMetaData (std::string_view key) const
bool	hasMetaData (std::string_view key) const
	MetaDataOwner (const MetaDataOwner &rhs)=default
	MetaDataOwner (MetaDataOwner &rhs)=default
MetaDataOwner &	operator= (const MetaDataOwner &rhs)=default
MetaDataOwner &	operator= (MetaDataOwner &)=default
void	serialize (Serializer &s) const
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
Public Member Functions inherited from inviwo::FileBase
void	addNameFilter (FileExtension ext)
void	addNameFilter (std::string_view filter)
void	addNameFilters (const std::vector< FileExtension > &filters)
void	clearNameFilters ()
	FileBase (std::function< void()> onModified, AcceptMode acceptMode, FileMode fileMode, std::string_view contentType)
AcceptMode	getAcceptMode () const
const std::string &	getContentType () const
FileMode	getFileMode () const
std::vector< FileExtension > &	getNameFilters ()
const std::vector< FileExtension > &	getNameFilters () const
const FileExtension &	getSelectedExtension () const
bool	matchesAnyNameFilter (const std::filesystem::path &file) const
void	setAcceptMode (AcceptMode mode)
void	setContentType (std::string_view contentType)
void	setFileMode (FileMode mode)
void	setSelectedExtension (const FileExtension &ext)

Static Public Attributes
static constexpr std::string_view	classIdentifier {"org.inviwo.MultiFileProperty"}
Static Public Attributes inherited from inviwo::FileBase
static constexpr std::string_view	defaultContentType = "default"

Additional Inherited Members
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
void	notifyAboutChange ()
Property &	operator= (const Property &that)=delete
Property &	operator= (Property &&that)
	Property (const Property &rhs)
	Property (Property &&rhs)
Protected Member Functions inherited from inviwo::PropertyObservable
void	notifyObserversOnSetDisplayName (Property *property, const std::string &displayName)
void	notifyObserversOnSetIdentifier (Property *property, const std::string &identifier)
void	notifyObserversOnSetReadOnly (Property *property, bool readonly)
void	notifyObserversOnSetSemantics (Property *property, const PropertySemantics &semantics)
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)
virtual void	addObserver (Observer *observer)=0
void	removeObservationHelper (Observer *observer)
virtual void	removeObserver (Observer *observer)=0
Protected Member Functions inherited from inviwo::FileBase
std::unique_ptr< FileDialog >	createFileDialog (std::string_view title, const std::filesystem::path &file) const
bool	deserialize (Deserializer &d, PropertySerializationMode mode)
bool	reset ()
void	serialize (Serializer &s, PropertySerializationMode mode) const
void	setAsDefault ()
bool	setFileBase (const FileBase &base)
bool	updateExtension (const std::filesystem::path &file)
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
ValueWrapper< AcceptMode >	acceptMode_
ValueWrapper< std::string >	contentType_
ValueWrapper< FileMode >	fileMode_
std::vector< FileExtension >	nameFilters_
ValueWrapper< FileExtension >	selectedExtension_

Detailed Description

A class for a list of file/directory paths

See also: FileProperty

Constructor & Destructor Documentation

◆ MultiFileProperty() [1/2]

inviwo::MultiFileProperty::MultiFileProperty	(	std::string_view	identifier,
		std::string_view	displayName,
		const std::vector< std::filesystem::path > &	value,
		std::string_view	contentType,
		InvalidationLevel	invalidationLevel = InvalidationLevel::InvalidOutput,
		PropertySemantics	semantics = PropertySemantics::Default )

Constructor for the MultiFileProperty.

Parameters

identifier	identifier for the property
displayName	displayName for the property
value	paths to a list of files/directories
contentType	key use to remember the last file dialog location for this type
invalidationLevel
semantics

◆ MultiFileProperty() [2/2]

inviwo::MultiFileProperty::MultiFileProperty	(	std::string_view	identifier,
		std::string_view	displayName,
		Document	help = {},
		const std::vector< 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 MultiFileProperty.

Parameters

identifier	identifier for the property
displayName	displayName for the property
help	descriptive text
value	paths to a list of files/directories
acceptMode

See also: AcceptMode

Parameters

fileMode

See also: FileMode

Parameters

contentType	key use to remember the last file dialog location for this type
invalidationLevel
semantics

Member Function Documentation

◆ back()

const std::filesystem::path * inviwo::MultiFileProperty::back ( ) const

Returns: The pointer to the last path or nullptr if empty

◆ clone()

virtual MultiFileProperty * inviwo::MultiFileProperty::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.

Implements inviwo::Property.

◆ deserialize()

virtual void inviwo::MultiFileProperty::deserialize ( Deserializer & d )

overridevirtual

Reimplemented from inviwo::Property.

◆ empty()

bool inviwo::MultiFileProperty::empty ( ) const

Returns: True if the property holds no paths false otherwise

◆ front()

const std::filesystem::path * inviwo::MultiFileProperty::front ( ) const

Returns: The pointer to the first path or nullptr if empty

◆ getClassIdentifier()

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

overridevirtual

Implements inviwo::Property.

◆ getDescription()

virtual Document inviwo::MultiFileProperty::getDescription ( ) const

overridevirtual

This function should describe the state of the property By default this will return a document describing all the state. i.e. Identifier, DisplayName, Help, InvalidationLevel, PropertySemantics, etc. Derived properties should extend this function and add their state, usually values etc. The description is usually shown as a tooltip in the GUI.

Reimplemented from inviwo::Property.

◆ isDefaultState()

virtual bool inviwo::MultiFileProperty::isDefaultState ( ) const

overridevirtual

Check if the property is in it's default state, i.e. resetToDefaultState would do nothing

See also: setCurrentStateAsDefault; resetToDefaultState

Reimplemented from inviwo::Property.

◆ requestFile()

void inviwo::MultiFileProperty::requestFile ( )

Request a file from the user through the use of a widget or a FileDialog.

◆ resetToDefaultState()

virtual MultiFileProperty & inviwo::MultiFileProperty::resetToDefaultState ( )

overridevirtual

Reset the state of the property back to it's default value. It is important that all overriding properties make sure to call the base class implementation.

Reimplemented from inviwo::Property.

◆ serialize()

virtual void inviwo::MultiFileProperty::serialize ( Serializer & s ) const

overridevirtual

Reimplemented from inviwo::Property.

◆ set() [1/2]

void inviwo::MultiFileProperty::set ( const FileProperty * property )

Replace the current list of paths with the one from the FileProperty.

◆ set() [2/2]

virtual void inviwo::MultiFileProperty::set ( const Property * src )

overridevirtual

Set the value of this to that of src. The "value" is in this case considered to be for example the string in a StringProperty or the float value in a FloatProperty. But not things like the identifier of display name.

Reimplemented from inviwo::Property.

◆ setCurrentStateAsDefault()

virtual MultiFileProperty & inviwo::MultiFileProperty::setCurrentStateAsDefault ( )

overridevirtual

Save the current state of the property as the default. This state will then be used as a reference when serializing, only state different from the default will be serialized. This method should usually only be called once directly after construction in the processor constructor after setting property specific state. It is important that all overriding properties make sure to call the base class implementation.

Reimplemented from inviwo::Property.

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

include/inviwo/core/properties/multifileproperty.h

Public Types

Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ MultiFileProperty() [1/2]

◆ MultiFileProperty() [2/2]

Member Function Documentation

◆ back()

◆ clone()

◆ deserialize()

◆ empty()

◆ front()

◆ getClassIdentifier()

◆ getDescription()

◆ isDefaultState()

◆ requestFile()

◆ resetToDefaultState()

◆ serialize()

◆ set() [1/2]

◆ set() [2/2]

◆ setCurrentStateAsDefault()