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

Inheritance diagram for inviwo::ImageEditorProperty:

Public Member Functions
void	addLabel (vec2 start, vec2 end, std::string name="")

void	clearLabels ()

virtual ImageEditorProperty *	clone () const override

virtual void	deserialize (Deserializer &d) override

virtual std::string_view	getClassIdentifier () const override

const std::vector< ImageLabel > &	getLabels () const

	ImageEditorProperty (const ImageEditorProperty &rhs)

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

virtual void	serialize (Serializer &s) const override

void	setDimensions (ivec2 imgSize)

Public Member Functions inherited from inviwo::FileProperty
	FileProperty (const FileProperty &rhs)=default

	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 (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, 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.

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

virtual Document	getDescription () const override

virtual bool	isDefaultState () const override

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

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

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

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

virtual void	requestFile ()

virtual FileProperty &	resetToDefaultState () override

void	set (const FileProperty *property)

void	set (const MultiFileProperty *property)

virtual void	set (const Property *property) override

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

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

virtual FileProperty &	setCurrentStateAsDefault () override

FileProperty &	setDefault (const 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 std::string_view	getDisplayName () const

Document &	getHelp ()

const Document &	getHelp () const

virtual std::string_view	getIdentifier () const

virtual InvalidationLevel	getInvalidationLevel () const

PropertyOwner *	getOwner ()

const PropertyOwner *	getOwner () const

std::string_view	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 (const Observable< PropertyObserver > &other)

	Observable (Observable< PropertyObserver > &&other) noexcept

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

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

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

bool	hasMetaData (std::string_view key) const

template<typename T > requires std::derived_from<T, MetaData>
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.ImageEditorProperty"}

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
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)

void	removeObservationHelper (Observer *observer)

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 file representations. Holds the value of the path to a file as a string.

See also: FileProperty

Member Function Documentation

◆ clone()

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