QGIS API Documentation  2.99.0-Master (6a61179)
Public Member Functions | Properties | List of all members
QgsRelationEditorWidget Class Reference

#include <qgsrelationeditorwidget.h>

Inheritance diagram for QgsRelationEditorWidget:
Inheritance graph
[legend]

Public Member Functions

 QgsRelationEditorWidget (QWidget *parent=nullptr)
 
QgsIFeatureSelectionManagerfeatureSelectionManager ()
 The feature selection manager is responsible for the selected features which are currently being edited. More...
 
void setEditorContext (const QgsAttributeEditorContext &context)
 
void setFeature (const QgsFeature &feature)
 
void setRelationFeature (const QgsRelation &relation, const QgsFeature &feature)
 
void setRelations (const QgsRelation &relation, const QgsRelation &nmrelation)
 Set the relation(s) for this widget If only one relation is set, it will act as a simple 1:N relation widget If both relations are set, it will act as an N:M relation widget inserting and deleting entries on the intermediate table as required. More...
 
void setShowLabel (bool showLabel)
 Defines if a title label should be shown for this widget. More...
 
void setShowLinkButton (bool showLinkButton)
 Determines if the "link feature" button should be shown. More...
 
void setShowUnlinkButton (bool showUnlinkButton)
 Determines if the "unlink feature" button should be shown. More...
 
void setViewMode (QgsDualView::ViewMode mode)
 Define the view mode for the dual view. More...
 
bool showLabel () const
 Defines if a title label should be shown for this widget. More...
 
bool showLinkButton () const
 Determines if the "link feature" button should be shown. More...
 
bool showUnlinkButton () const
 Determines if the "unlink feature" button should be shown. More...
 
QgsDualView::ViewMode viewMode ()
 Get the view mode for the dual view. More...
 
- Public Member Functions inherited from QgsCollapsibleGroupBox
 QgsCollapsibleGroupBox (QWidget *parent=nullptr, QSettings *settings=nullptr)
 
 QgsCollapsibleGroupBox (const QString &title, QWidget *parent=nullptr, QSettings *settings=nullptr)
 
 ~QgsCollapsibleGroupBox ()
 
bool saveCheckedState ()
 
bool saveCollapsedState ()
 
void setSaveCheckedState (bool save)
 Set this to true to save/restore checked state. More...
 
void setSaveCollapsedState (bool save)
 set this to false to not save/restore collapsed state More...
 
void setSettingGroup (const QString &group)
 Set this to a defined string to share save/restore states across different parent dialogs. More...
 
void setSettings (QSettings *settings)
 
QString settingGroup () const
 Returns the name of the setting group in which the collapsed state will be saved. More...
 
- Public Member Functions inherited from QgsCollapsibleGroupBoxBasic
 QgsCollapsibleGroupBoxBasic (QWidget *parent=nullptr)
 
 QgsCollapsibleGroupBoxBasic (const QString &title, QWidget *parent=nullptr)
 
 ~QgsCollapsibleGroupBoxBasic ()
 
bool isCollapsed () const
 Returns the current collapsed state of this group box. More...
 
bool scrollOnExpand ()
 If this is set to false the parent QScrollArea will not be automatically scrolled to this widget's contents when expanded. More...
 
void setCollapsed (bool collapse)
 Collapse or uncollapse this groupbox. More...
 
void setScrollOnExpand (bool scroll)
 Set this to false to not automatically scroll parent QScrollArea to this widget's contents when expanded. More...
 
void setSyncGroup (const QString &grp)
 Named group which synchronizes collapsing action when triangle is clicked while holding alt modifier key. More...
 
QString syncGroup () const
 Named group which synchronizes collapsing action when triangle is clicked while holding alt modifier key. More...
 

Properties

bool showLabel
 
QgsDualView::ViewMode viewMode
 
- Properties inherited from QgsCollapsibleGroupBox
bool saveCheckedState
 Shall the checked state of this group box be saved and loaded persistently in QSettings. More...
 
bool saveCollapsedState
 Shall the collapsed state of this group box be saved and loaded persistently in QSettings. More...
 
- Properties inherited from QgsCollapsibleGroupBoxBasic
bool collapsed
 The collapsed state of this group box. More...
 
bool scrollOnExpand
 If this property is set to true, a parent scroll area will try to make sure that the whole group box is visible when uncollapsing it. More...
 
QString syncGroup
 An optional group to be collapsed and uncollapsed in sync with this group box if the Alt-modifier is pressed while collapsing / uncollapsing. More...
 

Additional Inherited Members

- Public Slots inherited from QgsCollapsibleGroupBoxBasic
void checkClicked (bool ckd)
 
void checkToggled (bool ckd)
 
void toggleCollapsed ()
 
- Signals inherited from QgsCollapsibleGroupBoxBasic
void collapsedStateChanged (bool collapsed)
 Signal emitted when groupbox collapsed/expanded state is changed, and when first shown. More...
 
- Protected Slots inherited from QgsCollapsibleGroupBox
void loadState ()
 Will load the collapsed and checked state. More...
 
void saveState () const
 Will save the collapsed and checked state. More...
 
- Protected Member Functions inherited from QgsCollapsibleGroupBox
void init ()
 
QString saveKey () const
 
void showEvent (QShowEvent *event) override
 
- Protected Member Functions inherited from QgsCollapsibleGroupBoxBasic
void changeEvent (QEvent *event) override
 
void clearModifiers ()
 
void collapseExpandFixes ()
 Visual fixes for when group box is collapsed/expanded. More...
 
void init ()
 
void mousePressEvent (QMouseEvent *event) override
 
void mouseReleaseEvent (QMouseEvent *event) override
 
void showEvent (QShowEvent *event) override
 
QRect titleRect () const
 
void updateStyle ()
 
- Protected Attributes inherited from QgsCollapsibleGroupBox
bool mDelSettings
 
bool mSaveCheckedState
 
bool mSaveCollapsedState
 
QString mSettingGroup
 
QPointer< QSettings > mSettings
 
- Protected Attributes inherited from QgsCollapsibleGroupBoxBasic
bool mAltDown
 
QgsGroupBoxCollapseButtonmCollapseButton
 
bool mCollapsed
 
QIcon mCollapseIcon
 
QIcon mExpandIcon
 
bool mInitFlat
 
bool mInitFlatChecked
 
QScrollArea * mParentScrollArea
 
bool mScrollOnExpand
 
bool mShiftDown
 
bool mShown
 
QString mSyncGroup
 
QWidget * mSyncParent
 
bool mTitleClicked
 

Detailed Description

Definition at line 37 of file qgsrelationeditorwidget.h.

Constructor & Destructor Documentation

§ QgsRelationEditorWidget()

QgsRelationEditorWidget::QgsRelationEditorWidget ( QWidget *  parent = nullptr)
Parameters
parentparent widget

Definition at line 35 of file qgsrelationeditorwidget.cpp.

Member Function Documentation

§ featureSelectionManager()

QgsIFeatureSelectionManager * QgsRelationEditorWidget::featureSelectionManager ( )

The feature selection manager is responsible for the selected features which are currently being edited.

Definition at line 252 of file qgsrelationeditorwidget.cpp.

§ setEditorContext()

void QgsRelationEditorWidget::setEditorContext ( const QgsAttributeEditorContext context)

Definition at line 247 of file qgsrelationeditorwidget.cpp.

§ setFeature()

void QgsRelationEditorWidget::setFeature ( const QgsFeature feature)

Definition at line 264 of file qgsrelationeditorwidget.cpp.

§ setRelationFeature()

void QgsRelationEditorWidget::setRelationFeature ( const QgsRelation relation,
const QgsFeature feature 
)

Definition at line 143 of file qgsrelationeditorwidget.cpp.

§ setRelations()

void QgsRelationEditorWidget::setRelations ( const QgsRelation relation,
const QgsRelation nmrelation 
)

Set the relation(s) for this widget If only one relation is set, it will act as a simple 1:N relation widget If both relations are set, it will act as an N:M relation widget inserting and deleting entries on the intermediate table as required.

Parameters
relationRelation referencing the edited table
nmrelationOptional reference from the referencing table to a 3rd N:M table

Definition at line 187 of file qgsrelationeditorwidget.cpp.

§ setShowLabel()

void QgsRelationEditorWidget::setShowLabel ( bool  showLabel)

Defines if a title label should be shown for this widget.

Note
Added in QGIS 2.18

Definition at line 573 of file qgsrelationeditorwidget.cpp.

§ setShowLinkButton()

void QgsRelationEditorWidget::setShowLinkButton ( bool  showLinkButton)

Determines if the "link feature" button should be shown.

Note
Added in QGIS 2.18

Definition at line 553 of file qgsrelationeditorwidget.cpp.

§ setShowUnlinkButton()

void QgsRelationEditorWidget::setShowUnlinkButton ( bool  showUnlinkButton)

Determines if the "unlink feature" button should be shown.

Note
Added in QGIS 2.18

Definition at line 563 of file qgsrelationeditorwidget.cpp.

§ setViewMode()

void QgsRelationEditorWidget::setViewMode ( QgsDualView::ViewMode  mode)

Define the view mode for the dual view.

Definition at line 257 of file qgsrelationeditorwidget.cpp.

§ showLabel()

bool QgsRelationEditorWidget::showLabel ( ) const

Defines if a title label should be shown for this widget.

Note
Added in QGIS 2.18

§ showLinkButton()

bool QgsRelationEditorWidget::showLinkButton ( ) const

Determines if the "link feature" button should be shown.

Note
Added in QGIS 2.18

Definition at line 548 of file qgsrelationeditorwidget.cpp.

§ showUnlinkButton()

bool QgsRelationEditorWidget::showUnlinkButton ( ) const

Determines if the "unlink feature" button should be shown.

Note
Added in QGIS 2.18

Definition at line 558 of file qgsrelationeditorwidget.cpp.

§ viewMode()

QgsDualView::ViewMode QgsRelationEditorWidget::viewMode ( )
inline

Get the view mode for the dual view.

Definition at line 54 of file qgsrelationeditorwidget.h.

Property Documentation

§ showLabel

bool QgsRelationEditorWidget::showLabel
readwrite

Definition at line 41 of file qgsrelationeditorwidget.h.

§ viewMode

QgsDualView::ViewMode QgsRelationEditorWidget::viewMode
readwrite

Definition at line 40 of file qgsrelationeditorwidget.h.


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