Scanframe Modular Application 0.1.0
Loading...
Searching...
No Matches
sf::VariableWidgetBase Class Referenceabstract

Base class for sf::Variable based widgets. More...

#include <VariableWidgetBase.h>

Inheritance diagram for sf::VariableWidgetBase:
Collaboration diagram for sf::VariableWidgetBase:

Public Member Functions

 VariableWidgetBase (QWidget *parent, QObject *self)
 Constructor.
 
 ~VariableWidgetBase () override
 Destructor.
 
void addPropertyPages (sf::PropertySheetDialog *sheet) override
 Overridden from base class sf::ObjectExtension::addPropertyPages().
 
void setId (gii::IdType id)
 Property 'variableId' set method.
 
gii::IdType getId () const
 Property 'variableId' get method.
 
VariablegetVariable () const
 Gets the reference to the underlying Variable instance.
 
void setConverted (bool) const
 Property 'converted' set method.
 
bool getConverted () const
 Property 'converted' get method.
 
void setReadOnly (bool)
 Property 'converted' set method.
 
bool getReadOnly () const
 Property 'converted' get method.
 
bool isRequiredProperty (const QString &name) override
 Overridden from base class 'ObjectExtension' to write only the properties that mean anything.
 
- Public Member Functions inherited from sf::ObjectExtension
virtual bool getSaveChildren () const
 Gets if the children needs saving by the FormBuilder class.
 

Static Public Member Functions

static const char * propertyNameEditorObject ()
 Property name of the property which guides the layout editor to the proper parent.
 
- Static Public Member Functions inherited from sf::ObjectExtension
static bool inDesigner ()
 Gets the designer status.
 
static QObject * getExtensionParent (QObject *obj, bool first=true)
 Return if the passed object has this type as parent. It starts by testing the passed object itself.
 

Protected Member Functions

virtual void applyReadOnly (bool yn)=0
 
- Protected Member Functions inherited from sf::ObjectExtension
 ObjectExtension (QObject *object)
 Protected constructor only. Inlined so no external libs are need for designer.
 
virtual ~ObjectExtension ()=default
 Virtual destructor.
 

Protected Attributes

PrivateBase * _p {nullptr}
 Holds the private object or a derived one.
 

Properties

qulonglong idVariable
 
bool converted
 
bool readOnly
 

Detailed Description

Base class for sf::Variable based widgets.

Constructor & Destructor Documentation

◆ VariableWidgetBase()

sf::VariableWidgetBase::VariableWidgetBase ( QWidget *  parent,
QObject *  self 
)
explicit

Constructor.

◆ ~VariableWidgetBase()

sf::VariableWidgetBase::~VariableWidgetBase ( )
override

Destructor.

Member Function Documentation

◆ addPropertyPages()

void sf::VariableWidgetBase::addPropertyPages ( sf::PropertySheetDialog sheet)
overridevirtual

Overridden from base class sf::ObjectExtension::addPropertyPages().

Reimplemented from sf::ObjectExtension.

◆ applyReadOnly()

virtual void sf::VariableWidgetBase::applyReadOnly ( bool  yn)
protectedpure virtual

To handle a request for read only behavior of the widget.

Parameters
yn

Implemented in sf::VariableBar, sf::VariableCheckBox, sf::VariableComboBox, sf::VariableEdit, and sf::LayoutTabs.

◆ getConverted()

bool sf::VariableWidgetBase::getConverted ( ) const

Property 'converted' get method.

◆ getId()

gii::IdType sf::VariableWidgetBase::getId ( ) const

Property 'variableId' get method.

◆ getReadOnly()

bool sf::VariableWidgetBase::getReadOnly ( ) const

Property 'converted' get method.

◆ getVariable()

Variable & sf::VariableWidgetBase::getVariable ( ) const

Gets the reference to the underlying Variable instance.

◆ isRequiredProperty()

bool sf::VariableWidgetBase::isRequiredProperty ( const QString &  name)
overridevirtual

Overridden from base class 'ObjectExtension' to write only the properties that mean anything.

Implements sf::ObjectExtension.

◆ propertyNameEditorObject()

static const char * sf::VariableWidgetBase::propertyNameEditorObject ( )
static

Property name of the property which guides the layout editor to the proper parent.

Returns
Property name.

◆ setConverted()

void sf::VariableWidgetBase::setConverted ( bool  ) const

Property 'converted' set method.

◆ setId()

void sf::VariableWidgetBase::setId ( gii::IdType  id)

Property 'variableId' set method.

◆ setReadOnly()

void sf::VariableWidgetBase::setReadOnly ( bool  )

Property 'converted' set method.

Member Data Documentation

◆ _p

PrivateBase* sf::VariableWidgetBase::_p {nullptr}
protected

Holds the private object or a derived one.

Property Documentation

◆ converted

bool sf::VariableWidgetBase::converted
readwrite

◆ idVariable

qulonglong sf::VariableWidgetBase::idVariable
readwrite

◆ readOnly

bool sf::VariableWidgetBase::readOnly
readwrite

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