QgsAttributesFormProperties Class Reference

Creates panels to configure attributes forms. More...

#include <qgsattributesformproperties.h>

Inheritance diagram for QgsAttributesFormProperties:

Public Member Functions
	QgsAttributesFormProperties (QgsVectorLayer *layer, QWidget *parent=nullptr, QgsSourceFieldsProperties *sourceFieldsProperties=nullptr)
	The QgsAttributesFormProperties constructor.
void	apply ()
	Applies the attribute from properties to the vector layer.
QgsExpressionContext	createExpressionContext () const override
	This method needs to be reimplemented in all classes which implement this interface and return an expression context.
void	init ()
void	initAvailableWidgetsActions (const QList< QgsAction > actions)
	Refresh layer actions in the Available Widgets view.
void	initAvailableWidgetsView ()
	Initializes the available widgets tree view, repopulating the underlying model.
void	initFormLayoutView ()
	Initializes the form layout tree view, repopulating the underlying model.
void	initInitPython ()
void	initLayoutConfig ()
void	initSuppressCombo ()
void	loadRelations ()
void	store ()
	Stores currently opened widget configuration.
Public Member Functions inherited from QgsExpressionContextGenerator
virtual	~QgsExpressionContextGenerator ()=default

Static Public Attributes
static const QgsSettingsEntryBool *	settingShowAliases = new QgsSettingsEntryBool( u"show-aliases"_s, sTreeAttributesForm, false, u"Whether to show aliases (true) or names (false) in both the Available Widgets and the Form Layout panels."_s )
static QgsSettingsTreeNode *	sTreeAttributesForm = QgsSettingsTree::sTreeApp->createChildNode( u"attributes-form"_s )

Protected Member Functions
void	updateButtons ()

Protected Attributes
QgsAttributeFormContainerEdit *	mAttributeContainerEdit = nullptr
QgsAttributeTypeDialog *	mAttributeTypeDialog = nullptr
QgsAttributeWidgetEdit *	mAttributeWidgetEdit = nullptr
QgsAttributesFormBaseView *	mAvailableWidgetsView = nullptr
QgsAttributesFormBaseView *	mFormLayoutView = nullptr
QLabel *	mInfoTextWidget = nullptr
QgsVectorLayer *	mLayer = nullptr

Friends
class	TestQgsAttributesFormProperties

Detailed Description

Creates panels to configure attributes forms.

Warning

Not part of stable API and may change in future QGIS releases.

Since

QGIS 3.0

Definition at line 66 of file qgsattributesformproperties.h.

Constructor & Destructor Documentation

QgsAttributesFormProperties()

QgsAttributesFormProperties::QgsAttributesFormProperties ( QgsVectorLayer * layer, QWidget * parent = nullptr, QgsSourceFieldsProperties * sourceFieldsProperties = nullptr )

explicit

The QgsAttributesFormProperties constructor.

Parameters

layer	The vector layer being configured
parent	The parent QObject
sourceFieldsProperties	The source fields properties widget, an optional parameter used to generate preview forms (since QGIS 4.0)

Definition at line 52 of file qgsattributesformproperties.cpp.

Member Function Documentation

apply()

void QgsAttributesFormProperties::apply

(

)

Applies the attribute from properties to the vector layer.

Definition at line 814 of file qgsattributesformproperties.cpp.

createExpressionContext()

QgsExpressionContext QgsAttributesFormProperties::createExpressionContext ( ) const

overridevirtual

This method needs to be reimplemented in all classes which implement this interface and return an expression context.

Implements QgsExpressionContextGenerator.

Definition at line 226 of file qgsattributesformproperties.cpp.

init()

void QgsAttributesFormProperties::init

(

)

Definition at line 165 of file qgsattributesformproperties.cpp.

initAvailableWidgetsActions()

void QgsAttributesFormProperties::initAvailableWidgetsActions

(

const QList< QgsAction >

actions

)

Refresh layer actions in the Available Widgets view.

Parameters

actions

Up-to-date list of actions

Definition at line 221 of file qgsattributesformproperties.cpp.

initAvailableWidgetsView()

void QgsAttributesFormProperties::initAvailableWidgetsView

(

)

Initializes the available widgets tree view, repopulating the underlying model.

Definition at line 175 of file qgsattributesformproperties.cpp.

initFormLayoutView()

void QgsAttributesFormProperties::initFormLayoutView

(

)

Initializes the form layout tree view, repopulating the underlying model.

Definition at line 188 of file qgsattributesformproperties.cpp.

initInitPython()

void QgsAttributesFormProperties::initInitPython

(

)

Definition at line 243 of file qgsattributesformproperties.cpp.

initLayoutConfig()

void QgsAttributesFormProperties::initLayoutConfig

(

)

Definition at line 233 of file qgsattributesformproperties.cpp.

initSuppressCombo()

void QgsAttributesFormProperties::initSuppressCombo

(

)

Definition at line 205 of file qgsattributesformproperties.cpp.

loadRelations()

void QgsAttributesFormProperties::loadRelations

(

)

store()

void QgsAttributesFormProperties::store

(

)

Stores currently opened widget configuration.

Since

QGIS 3.36

Definition at line 807 of file qgsattributesformproperties.cpp.

updateButtons()

void QgsAttributesFormProperties::updateButtons ( )

protected

Friends And Related Symbol Documentation

TestQgsAttributesFormProperties

friend class TestQgsAttributesFormProperties

friend

Definition at line 221 of file qgsattributesformproperties.h.

Member Data Documentation

mAttributeContainerEdit

QgsAttributeFormContainerEdit* QgsAttributesFormProperties::mAttributeContainerEdit = nullptr

protected

Definition at line 130 of file qgsattributesformproperties.h.

mAttributeTypeDialog

QgsAttributeTypeDialog* QgsAttributesFormProperties::mAttributeTypeDialog = nullptr

protected

Definition at line 129 of file qgsattributesformproperties.h.

mAttributeWidgetEdit

QgsAttributeWidgetEdit* QgsAttributesFormProperties::mAttributeWidgetEdit = nullptr

protected

Definition at line 128 of file qgsattributesformproperties.h.

mAvailableWidgetsView

QgsAttributesFormBaseView* QgsAttributesFormProperties::mAvailableWidgetsView = nullptr

protected

Definition at line 125 of file qgsattributesformproperties.h.

mFormLayoutView

QgsAttributesFormBaseView* QgsAttributesFormProperties::mFormLayoutView = nullptr

protected

Definition at line 126 of file qgsattributesformproperties.h.

mInfoTextWidget

QLabel* QgsAttributesFormProperties::mInfoTextWidget = nullptr

protected

Definition at line 131 of file qgsattributesformproperties.h.

mLayer

QgsVectorLayer* QgsAttributesFormProperties::mLayer = nullptr

protected

Definition at line 123 of file qgsattributesformproperties.h.

settingShowAliases

const QgsSettingsEntryBool * QgsAttributesFormProperties::settingShowAliases = new QgsSettingsEntryBool( u"show-aliases"_s, sTreeAttributesForm, false, u"Whether to show aliases (true) or names (false) in both the Available Widgets and the Form Layout panels."_s )

static

Definition at line 72 of file qgsattributesformproperties.h.

sTreeAttributesForm

QgsSettingsTreeNode* QgsAttributesFormProperties::sTreeAttributesForm = QgsSettingsTree::sTreeApp->createChildNode( u"attributes-form"_s )

inlinestatic

Definition at line 71 of file qgsattributesformproperties.h.

---

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

• /build/qgis-3.99.0+git20260128+d270888f95f+99sid/src/gui/vector/qgsattributesformproperties.h
• /build/qgis-3.99.0+git20260128+d270888f95f+99sid/src/gui/vector/qgsattributesformproperties.cpp