inviwo::MultiFileProperty Class Reference

#include <multifileproperty.h>

Inheritance diagram for inviwo::MultiFileProperty:

Public Member Functions
virtual std::string	getClassIdentifier () const override
	MultiFileProperty (std::string identifier, std::string displayName, const std::vector< std::string > &value={}, std::string contentType="default", InvalidationLevel invalidationLevel=InvalidationLevel::InvalidOutput, PropertySemantics semantics=PropertySemantics::Default)
	Constructor for the MultiFileProperty. More...
	MultiFileProperty (const MultiFileProperty &rhs)
MultiFileProperty &	operator= (const std::vector< std::string > &value)
virtual MultiFileProperty *	clone () const override
void	set (const std::string &value)
virtual void	set (const std::vector< std::string > &values) override
virtual void	set (const Property *property) override
virtual void	serialize (Serializer &s) const override
virtual void	deserialize (Deserializer &d) override
virtual void	addNameFilter (std::string)
virtual void	addNameFilter (FileExtension)
virtual void	addNameFilters (const std::vector< FileExtension > &filters)
virtual void	clearNameFilters ()
virtual std::vector< FileExtension >	getNameFilters ()
virtual void	setAcceptMode (AcceptMode mode)
AcceptMode	getAcceptMode () const
virtual void	setFileMode (FileMode mode)
FileMode	getFileMode () const
void	setContentType (const std::string &contentType)
std::string	getContentType () const
const FileExtension &	getSelectedExtension () const
void	setSelectedExtension (const FileExtension &ext)
void	requestFile ()
virtual Document	getDescription () const override
Public Member Functions inherited from inviwo::TemplateProperty< std::vector< std::string > >
	TemplateProperty (const std::string &identifier, const std::string &displayName, const std::vector< std::string > &value=std::vector< std::string >(), InvalidationLevel invalidationLevel=InvalidationLevel::InvalidOutput, PropertySemantics semantics=PropertySemantics::Default)
TemplateProperty< std::vector< std::string > > &	operator= (const std::vector< std::string > &value)
virtual	operator std::vector< std::string > & ()
virtual	operator const std::vector< std::string > & () const
virtual std::vector< std::string > &	get ()
virtual const std::vector< std::string > &	get () const
const std::vector< std::string > &	operator * () const
std::vector< std::string > &	operator * ()
const std::vector< std::string > *	operator-> () const
std::vector< std::string > *	operator-> ()
void	set (const TemplateProperty< std::vector< std::string > > *srcProperty)
virtual TemplateProperty &	setCurrentStateAsDefault () override
virtual TemplateProperty &	resetToDefaultState () override
Public Member Functions inherited from inviwo::Property
	Property (const std::string &identifier="", const std::string &displayName="", InvalidationLevel invalidationLevel=InvalidationLevel::InvalidOutput, PropertySemantics semantics=PropertySemantics::Default)
virtual	~Property ()
	Removes itself from its PropertyOwner.
virtual Property &	setIdentifier (const std::string &identifier)
virtual std::string	getIdentifier () const
virtual std::vector< std::string >	getPath () const
virtual Property &	setDisplayName (const std::string &displayName)
	A property's name displayed to the user.
virtual std::string	getDisplayName () const
virtual std::string	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 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 ()
bool	hasWidgets () 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)
template<typename T >
const BaseCallBack *	onChange (T *object, void(T::*method)())
template<typename T >
void	removeOnChange (T *object)
virtual Property &	setUsageMode (UsageMode usageMode)
virtual UsageMode	getUsageMode () const
virtual void	setSerializationMode (PropertySerializationMode mode)
virtual PropertySerializationMode	getSerializationMode () const
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)
template<typename P >
Property &	autoLinkToProperty (const std::string &propertyPath)
const std::vector< std::pair< std::string, std::string > > &	getAutoLinkToProperty () const
Public Member Functions inherited from inviwo::Observable< PropertyObserver >
	Observable (const Observable< PropertyObserver > &other)
	Observable (Observable< PropertyObserver > &&other)
Observable< PropertyObserver > &	operator= (const Observable< PropertyObserver > &other)
Observable< PropertyObserver > &	operator= (Observable< PropertyObserver > &&other)
void	addObserver (PropertyObserver *observer)
void	removeObserver (PropertyObserver *observer)
virtual void	startBlockingNotifications () override final
virtual void	stopBlockingNotifications () override final
Public Member Functions inherited from inviwo::MetaDataOwner
	MetaDataOwner (const MetaDataOwner &rhs)=default
MetaDataOwner &	operator= (const MetaDataOwner &rhs)=default
void	copyMetaDataFrom (const MetaDataOwner &src)
void	copyMetaDataTo (MetaDataOwner &dst)
template<typename T >
T *	createMetaData (const std::string &key)
template<typename T , typename U >
void	setMetaData (const std::string &key, U value)
template<typename T >
bool	unsetMetaData (const std::string &key)
	unset, i.e. remove the metadata entry matching the given key and type More...
template<typename T , typename U >
U	getMetaData (const std::string &key, U val) const
template<typename T >
T *	getMetaData (const std::string &key)
template<typename T >
const T *	getMetaData (const std::string &key) const
MetaDataMap *	getMetaDataMap ()
const MetaDataMap *	getMetaDataMap () const
template<typename T >
bool	hasMetaData (const std::string &key) const

Static Public Attributes
static const std::string	classIdentifier = "org.inviwo.MultiFileProperty"

Additional Inherited Members
Public Types inherited from inviwo::TemplateProperty< std::vector< std::string > >
using	value_type = std::vector< std::string >
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::TemplateProperty< std::vector< std::string > >
	TemplateProperty (const TemplateProperty &rhs)=default
Protected Member Functions inherited from inviwo::Property
	Property (const Property &rhs)
Property &	operator= (const Property &that)=delete
void	updateWidgets ()
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)
void	notifyObserversOnSetUsageMode (Property *property, UsageMode usageMode)
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 Attributes inherited from inviwo::TemplateProperty< std::vector< std::string > >
ValueWrapper< std::vector< std::string > >	value_
Protected Attributes inherited from inviwo::Property
CallBackList	onChangeCallback_
PropertySerializationMode	serializationMode_
Protected Attributes inherited from inviwo::MetaDataOwner
MetaDataMap	metaData_

Detailed Description

A class for file representations. Holds the value of the path to multiple files as strings.

See also

TemplateProperty, FileProperty

Constructor & Destructor Documentation

MultiFileProperty()

inviwo::MultiFileProperty::MultiFileProperty	(	std::string	identifier,
		std::string	displayName,
		const std::vector< std::string > &	value = {},
		std::string	contentType = "default",
		InvalidationLevel	invalidationLevel = InvalidationLevel::InvalidOutput,
		PropertySemantics	semantics = PropertySemantics::Default
	)

Constructor for the MultiFileProperty.

The PropertySemantics can be set to TextEditor. Then a TextEditorWidget will be used instead of a FilePropertyWidget

Parameters

identifier	identifier for the property
displayName	displayName for the property
value	the path to the file
contentType
invalidationLevel
semantics	Can be set to Editor

Member Function Documentation

clone()

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::TemplateProperty< std::vector< std::string > >.

requestFile()

void inviwo::MultiFileProperty::requestFile

(

)

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

set()

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::TemplateProperty< std::vector< std::string > >.

---

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

• multifileproperty.h
• multifileproperty.cpp