QGIS API Documentation 3.39.0-Master (be2050b798e)
Loading...
Searching...
No Matches
Public Slots | Public Member Functions | Protected Member Functions | List of all members
QgsSpacerWidgetWrapper Class Reference

Wraps a spacer widget. More...

#include <qgsspacerwidgetwrapper.h>

Inheritance diagram for QgsSpacerWidgetWrapper:
Inheritance graph
[legend]

Public Slots

void setFeature (const QgsFeature &feature) override
 
- Public Slots inherited from QgsWidgetWrapper
virtual void setEnabled (bool enabled)
 Is used to enable or disable the edit functionality of the managed widget.
 
virtual void setFeature (const QgsFeature &feature)=0
 Is called when the value of the widget needs to be changed.
 

Public Member Functions

 QgsSpacerWidgetWrapper (QgsVectorLayer *layer, QWidget *editor=nullptr, QWidget *parent=nullptr)
 Create a new widget wrapper.
 
bool drawLine () const
 Returns true if the spacer element will contain an horizontal line.
 
void setDrawLine (bool drawLine)
 Sets a flag to define if the spacer element will contain an horizontal line.
 
bool valid () const override
 Returns true if the widget has been properly initialized.
 
- Public Member Functions inherited from QgsWidgetWrapper
 QgsWidgetWrapper (QgsVectorLayer *vl, QWidget *editor=nullptr, QWidget *parent=nullptr)
 Create a new widget wrapper.
 
QVariantMap config () const
 Returns the whole config.
 
QVariant config (const QString &key, const QVariant &defaultVal=QVariant()) const
 Use this inside your overridden classes to access the configuration.
 
const QgsAttributeEditorContextcontext () const
 Returns information about the context in which this widget is shown.
 
QgsPropertyCollectiondataDefinedProperties ()
 Returns a reference to the editor widget's property collection, used for data defined overrides.
 
const QgsPropertyCollectiondataDefinedProperties () const
 Returns a reference to the editor widget's property collection, used for data defined overrides.
 
QgsVectorLayerlayer () const
 Returns the vector layer associated with the widget.
 
void notifyAboutToSave ()
 Notify this widget, that the containing form is about to save and that any pending changes should be pushed to the edit buffer or they might be lost.
 
void setConfig (const QVariantMap &config)
 Will set the config of this wrapper to the specified config.
 
void setContext (const QgsAttributeEditorContext &context)
 Set the context in which this widget is shown.
 
void setDataDefinedProperties (const QgsPropertyCollection &collection)
 Sets the editor widget's property collection, used for data defined overrides.
 
QWidget * widget ()
 Access the widget managed by this wrapper.
 
template<class T >
T * widget ()
 Access the widget managed by this wrapper and cast it to a given type.
 

Protected Member Functions

QWidget * createWidget (QWidget *parent) override
 This method should create a new widget with the provided parent.
 
- Protected Member Functions inherited from QgsWidgetWrapper
virtual void initWidget (QWidget *editor)
 This method should initialize the editor widget with runtime data.
 

Additional Inherited Members

- Public Types inherited from QgsWidgetWrapper
enum class  Property : int { RootPath = 0 , DocumentViewerContent , StorageUrl }
 Data defined properties for different editor widgets. More...
 
- Signals inherited from QgsWidgetWrapper
void contextChanged ()
 Signal when QgsAttributeEditorContext mContext changed.
 
- Static Public Member Functions inherited from QgsWidgetWrapper
static QgsWidgetWrapperfromWidget (QWidget *widget)
 Will return a wrapper for a given widget.
 
static const QgsPropertiesDefinitionpropertyDefinitions ()
 Returns the editor widget property definitions.
 
- Protected Attributes inherited from QgsWidgetWrapper
QgsPropertyCollection mPropertyCollection
 Data defined property collection.
 

Detailed Description

Wraps a spacer widget.

Since
QGIS 3.30

Definition at line 27 of file qgsspacerwidgetwrapper.h.

Constructor & Destructor Documentation

◆ QgsSpacerWidgetWrapper()

QgsSpacerWidgetWrapper::QgsSpacerWidgetWrapper ( QgsVectorLayer layer,
QWidget *  editor = nullptr,
QWidget *  parent = nullptr 
)
explicit

Create a new widget wrapper.

Parameters
layerThe vector layer of the form the widget belongs to.
editorAn editor widget. Can be nullptr if one should be autogenerated.
parentA parent widget for this widget wrapper and the created widget.

Definition at line 21 of file qgsspacerwidgetwrapper.cpp.

Member Function Documentation

◆ createWidget()

QWidget * QgsSpacerWidgetWrapper::createWidget ( QWidget *  parent)
overrideprotectedvirtual

This method should create a new widget with the provided parent.

This will only be called if the form did not already provide a widget, so it is not guaranteed to be called! You should not do initialization stuff, which also has to be done for custom editor widgets inside this method. Things like filling comboboxes and assigning other data which will also be used to make widgets on forms created in the QtDesigner usable should be assigned in initWidget().

Parameters
parentYou should set this parent on the created widget.
Returns
A new widget

Implements QgsWidgetWrapper.

Definition at line 32 of file qgsspacerwidgetwrapper.cpp.

◆ drawLine()

bool QgsSpacerWidgetWrapper::drawLine ( ) const

Returns true if the spacer element will contain an horizontal line.

Definition at line 44 of file qgsspacerwidgetwrapper.cpp.

◆ setDrawLine()

void QgsSpacerWidgetWrapper::setDrawLine ( bool  drawLine)

Sets a flag to define if the spacer element will contain an horizontal line.

Parameters
drawLineflag status

Definition at line 49 of file qgsspacerwidgetwrapper.cpp.

◆ setFeature

void QgsSpacerWidgetWrapper::setFeature ( const QgsFeature feature)
overrideslot

Definition at line 39 of file qgsspacerwidgetwrapper.cpp.

◆ valid()

bool QgsSpacerWidgetWrapper::valid ( ) const
overridevirtual

Returns true if the widget has been properly initialized.

This acts as hint for the calling party if this wrapper can be used after initializing it. If it cannot be used this is a hint to the caller that he may try to find another suitable widget type instead.

Returns
Validity status of this widget.

Implements QgsWidgetWrapper.

Definition at line 27 of file qgsspacerwidgetwrapper.cpp.


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