Inviwo 0.9.12-pre
Inviwo documentation
Loading...
Searching...
No Matches
inviwo::FontFaceOptionProperty Class Reference

#include <modules/fontrendering/properties/fontfaceoptionproperty.h>

+ Inheritance diagram for inviwo::FontFaceOptionProperty:

Public Member Functions

virtual FontFaceOptionPropertyclone () const override
 
 FontFaceOptionProperty (const FontFaceOptionProperty &rhs)
 
 FontFaceOptionProperty (std::string_view identifier, std::string_view displayName, Document help, font::FontType fontType=font::FontType::Default, InvalidationLevel invalidationLevel=InvalidationLevel::InvalidOutput, PropertySemantics semantics=PropertySemantics::Default)
 
 FontFaceOptionProperty (std::string_view identifier, std::string_view displayName, Document help, std::string_view fontFaceName, InvalidationLevel invalidationLevel=InvalidationLevel::InvalidOutput, PropertySemantics semantics=PropertySemantics::Default)
 
 FontFaceOptionProperty (std::string_view identifier, std::string_view displayName, font::FontType fontType=font::FontType::Default, InvalidationLevel invalidationLevel=InvalidationLevel::InvalidOutput, PropertySemantics semantics=PropertySemantics::Default)
 
 FontFaceOptionProperty (std::string_view identifier, std::string_view displayName, std::string_view fontFaceName, InvalidationLevel invalidationLevel=InvalidationLevel::InvalidOutput, PropertySemantics semantics=PropertySemantics::Default)
 
virtual std::string_view getClassIdentifier () const override
 
- Public Member Functions inherited from inviwo::OptionProperty< std::filesystem::path >
OptionPropertyaddOption (std::filesystem::path value)
 
OptionPropertyaddOption (std::string_view identifier, std::string_view displayName)
 
OptionPropertyaddOption (std::string_view identifier, std::string_view displayName, const std::filesystem::path &value)
 Adds an option to the property.
 
OptionPropertyaddOption (std::string_view identifier, std::string_view displayName, std::string_view value)
 
virtual OptionPropertyclearOptions () override
 
virtual void deserialize (Deserializer &d) override
 
const std::filesystem::path & get () const
 
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.
 
virtual Document getDescription () const override
 
virtual std::vector< std::string > getDisplayNames () const override
 
virtual std::vector< std::string > getIdentifiers () const override
 
virtual const std::string & getOptionDisplayName (size_t index) const override
 
virtual const std::string & getOptionIdentifier (size_t index) const override
 
const std::vector< OptionPropertyOption< std::filesystem::path > > & getOptions () const
 
const OptionPropertyOption< std::filesystem::path > & getOptions (size_t index) const
 
const std::filesystem::path & getOptionValue (size_t index) const
 
virtual const std::string & getSelectedDisplayName () const override
 
virtual const std::string & getSelectedIdentifier () const override
 
virtual size_t getSelectedIndex () const override
 
const std::filesystem::path & getSelectedValue () const
 
std::vector< std::filesystem::path > getValues () const
 
virtual bool isDefaultState () const override
 
virtual bool isSelectedDisplayName (std::string_view name) const override
 
virtual bool isSelectedIdentifier (std::string_view identifier) const override
 
virtual bool isSelectedIndex (size_t index) const override
 
bool isSelectedValue (const std::filesystem::path &val) const
 
 operator const std::filesystem::path & () const
 
 operator std::string_view () const
 
const std::filesystem::path & operator* () const
 
const std::filesystem::path * operator-> () const
 
 OptionProperty (const OptionProperty< std::filesystem::path > &rhs)
 
 OptionProperty (std::string_view identifier, std::string_view displayName, const std::vector< OptionPropertyOption< std::filesystem::path > > &options, size_t selectedIndex=0, InvalidationLevel invalidationLevel=InvalidationLevel::InvalidOutput, PropertySemantics semantics=PropertySemantics::Default)
 
 OptionProperty (std::string_view identifier, std::string_view displayName, const std::vector< U > &options, size_t selectedIndex=0, InvalidationLevel invalidationLevel=InvalidationLevel::InvalidOutput, PropertySemantics semantics=PropertySemantics::Default)
 
 OptionProperty (std::string_view identifier, std::string_view displayName, Document help, const std::vector< OptionPropertyOption< std::filesystem::path > > &options, size_t selectedIndex=0, InvalidationLevel invalidationLevel=InvalidationLevel::InvalidOutput, PropertySemantics semantics=PropertySemantics::Default)
 
 OptionProperty (std::string_view identifier, std::string_view displayName, Document help, const std::vector< std::filesystem::path > &options, size_t selectedIndex=0, InvalidationLevel invalidationLevel=InvalidationLevel::InvalidOutput, PropertySemantics semantics=PropertySemantics::Default)
 
 OptionProperty (std::string_view identifier, std::string_view displayName, Document help, InvalidationLevel invalidationLevel=InvalidationLevel::InvalidOutput, PropertySemantics semantics=PropertySemantics::Default)
 
 OptionProperty (std::string_view identifier, std::string_view displayName, InvalidationLevel invalidationLevel=InvalidationLevel::InvalidOutput, PropertySemantics semantics=PropertySemantics::Default)
 
 OptionProperty (std::string_view identifier, std::string_view displayName, OptionPropertyState< std::filesystem::path > state)
 
virtual OptionPropertyremoveOption (size_t index)
 
virtual OptionPropertyremoveOption (std::string_view identifier)
 
OptionPropertyreplaceOptions (const std::vector< std::filesystem::path > &values)
 
virtual OptionPropertyreplaceOptions (const std::vector< std::string > &ids, const std::vector< std::string > &displayNames, const std::vector< std::filesystem::path > &values)
 
virtual OptionPropertyreplaceOptions (std::vector< OptionPropertyOption< std::filesystem::path > > options)
 
virtual OptionPropertyresetToDefaultState () override
 
virtual void serialize (Serializer &s) const override
 
void set (const OptionProperty *srcProperty)
 
virtual void set (const Property *srcProperty) override
 
bool set (const std::filesystem::path &value)
 Set the selected index to that of the value provided if found in the list of options.
 
bool set (std::string_view value)
 Set the selected index to that of the value provided if found in the list of options.
 
virtual OptionPropertysetCurrentStateAsDefault () override
 
OptionProperty< std::filesystem::path > & setDefault (const std::filesystem::path &value)
 
OptionProperty< std::filesystem::path > & setDefaultSelectedIndex (size_t index)
 
virtual bool setSelectedDisplayName (std::string_view name) override
 
virtual bool setSelectedIdentifier (std::string_view identifier) override
 
virtual bool setSelectedIndex (size_t index) override
 
bool setSelectedValue (const std::filesystem::path &val)
 Set the selected index to that of the value provided if found in the list of options.
 
bool setSelectedValue (std::string_view value)
 Set the selected index to that of the value provided if found in the list of options.
 
virtual size_t size () const override
 
OptionPropertyupdateOptions (Func &&updater)
 
OptionProperty< std::filesystem::path > & updateOptions (Func &&updater)
 
- Public Member Functions inherited from inviwo::BaseOptionProperty
 BaseOptionProperty (const BaseOptionProperty &rhs)
 
 BaseOptionProperty (std::string_view identifier, std::string_view displayName, Document help, InvalidationLevel invalidationLevel=InvalidationLevel::InvalidOutput, PropertySemantics semantics=PropertySemantics::Default)
 
bool empty () const
 
void set (const BaseOptionProperty *srcProperty)
 
- Public Member Functions inherited from inviwo::Property
virtual void accept (NetworkVisitor &visitor)
 Accept a NetworkVisitor, the visitor will visit this Property.
 
template<typename P >
PropertyautoLinkToProperty (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 getDisplayName () const
 
DocumentgetHelp ()
 
const DocumentgetHelp () const
 
virtual std::string_view getIdentifier () const
 
virtual InvalidationLevel getInvalidationLevel () const
 
PropertyOwnergetOwner ()
 
const PropertyOwnergetOwner () 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 PropertypropertyModified ()
 
template<typename P , typename DecisionFunc >
PropertyreadonlyDependsOn (P &prop, DecisionFunc callback)
 
void registerWidget (PropertyWidget *propertyWidget)
 
void removeOnChange (const BaseCallBack *callback)
 
virtual PropertysetDisplayName (std::string_view displayName)
 A property's name displayed to the user.
 
PropertysetHelp (Document help)
 
virtual PropertysetIdentifier (std::string_view identifier)
 
void setInitiatingWidget (PropertyWidget *propertyWidget)
 
virtual PropertysetInvalidationLevel (InvalidationLevel invalidationLevel)
 
virtual PropertysetModified ()
 
virtual void setOwner (PropertyOwner *owner)
 
virtual PropertysetReadOnly (bool value)
 Enable or disable editing of property.
 
virtual PropertysetSemantics (const PropertySemantics &semantics)
 
virtual PropertysetSerializationMode (PropertySerializationMode mode)
 
virtual void setValid ()
 
virtual PropertysetVisible (bool val)
 
void updateWidgets ()
 
template<typename P , typename DecisionFunc >
PropertyvisibilityDependsOn (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>
getMetaData (std::string_view key, U val) const
 
MetaDataMapgetMetaDataMap ()
 
const MetaDataMapgetMetaDataMap () 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
 
MetaDataOwneroperator= (const MetaDataOwner &rhs)=default
 
MetaDataOwneroperator= (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
 

Static Public Attributes

static constexpr std::string_view classIdentifier {"org.inviwo.FontFaceOptionProperty"}
 

Additional Inherited Members

- Public Types inherited from inviwo::OptionProperty< std::filesystem::path >
using value_type
 
- 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::OptionProperty< std::filesystem::path >
std::optional< size_t > findId (std::string_view id)
 
const OptionPropertyOption< std::filesystem::path > & opt (size_t index) const
 
const std::vector< OptionPropertyOption< std::filesystem::path > > & opts () const
 
std::vector< OptionPropertyOption< std::filesystem::path > > & optsMut ()
 
- Protected Member Functions inherited from inviwo::Property
void notifyAboutChange ()
 
Propertyoperator= (const Property &that)=delete
 
Propertyoperator= (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 Attributes inherited from inviwo::OptionProperty< std::filesystem::path >
size_t selectedIndex_
 
- Protected Attributes inherited from inviwo::Property
CallBackList onChangeCallback_
 
PropertySerializationMode serializationMode_
 
- Protected Attributes inherited from inviwo::MetaDataOwner
MetaDataMap metaData_
 

Detailed Description

This option property lists all available font faces which can be used for font rendering.

Member Function Documentation

◆ clone()

virtual FontFaceOptionProperty * inviwo::FontFaceOptionProperty::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::OptionProperty< std::filesystem::path >.

◆ getClassIdentifier()

virtual std::string_view inviwo::FontFaceOptionProperty::getClassIdentifier ( ) const
overridevirtual

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