QSettingsDialog  1.0.0
A Qt library to easily create a settings dialog for user configurable settings
Public Member Functions | List of all members
QSettingsLoaderEntry Class Reference

A combination of a QSettingsEntry and a QSimpleSettingsLoader in one class. More...

#include <qsettingsloaderentry.h>

+ Inheritance diagram for QSettingsLoaderEntry:

Public Member Functions

 QSettingsLoaderEntry (int displaytype)
 Creates a new loader entry from a display id.
 
 QSettingsLoaderEntry (int displaytype, const QString &name, bool optional=false, const QString &tooltip=QString(), const UiPropertyMap &properties=UiPropertyMap())
 Creates a new loader entry from a display id and it's properties.
 
template<typename... Args>
 QSettingsLoaderEntry (int displaytype, const QString &name, bool optional, const QString &tooltip, Args...properties)
 Creates a new loader entry from a display id and it's properties.
 
QSettingsLoadergetLoader () final
 Will be called to get a reference to loader this entry holds.
 
void freeLoader (QSettingsLoader *) final
 Will be called to remove a reference to the loader this entry holds.
 
- Public Member Functions inherited from QSettingsEntry
 QSettingsEntry (int displaytype, QSettingsLoader *loader)
 Creates a new entry from a display id and a loader. More...
 
 QSettingsEntry (int displaytype, QSettingsLoader *loader, const QString &name, bool optional=false, const QString &tooltip=QString(), const UiPropertyMap &properties=UiPropertyMap())
 Creates a new entry from a display id, a loader and it's properties. More...
 
template<typename... Args>
 QSettingsEntry (int displaytype, QSettingsLoader *loader, const QString &name, bool optional, const QString &tooltip, Args...properties)
 Creates a new entry from a display id, a loader and it's properties. More...
 
virtual ~QSettingsEntry ()
 Virtual destructor.
 
QString entryName () const
 Returns the display name of this entry.
 
void setEntryName (const QString &name)
 Sets the display name of this entry.
 
bool isOptional () const
 Specifies, whether the entry is optional or not.
 
void setOptional (bool optional)
 Sets the entry be optional or not optional.
 
QString tooltip () const
 Returns the tooltip this entry has.
 
void setTooltip (const QString &tooltip)
 Sets this entries tooltip.
 
UiPropertyMap uiProperties () const
 Returns the properties that should be set on the ui-elements for this entry.
 
void setUiProperties (const UiPropertyMap &properties)
 Sets the properties that should be set on the ui-elements for this entry.
 
void setUiProperty (const QString &name, const QVariant &value)
 Adds a new property to the existing ones that should be set on the ui-elements for this entry.
 
virtual int displaytype ()
 Returns the display type id for this entry.
 
- Public Member Functions inherited from QSimpleSettingsLoader
bool isAsync () const final
 Specifies, whether this loader is async or not.
 
virtual bool load (QVariant outParam data, bool outParam userEdited)=0
 Will be called if settings need to be loaded form this loader. More...
 
virtual bool save (const QVariant &data)=0
 Will be called to save settings from the dialog to this loader. More...
 
virtual bool reset ()=0
 Will be called to reset the data this loader manages. More...
 
- Public Member Functions inherited from QSettingsLoader
virtual ~QSettingsLoader ()
 Virtual destructor.
 
QSimpleSettingsLoadersimple ()
 Casts this instance to a QSimpleSettingsLoader. Will assert if the conversion fails.
 
QAsyncSettingsLoaderasync ()
 Casts this instance to a QAsyncSettingsLoader. Will assert if the conversion fails.
 

Detailed Description

A combination of a QSettingsEntry and a QSimpleSettingsLoader in one class.


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