QGIS API Documentation  2.8.2-Wien
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
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=NULL)
QString qgisRelation ()
void setEditorContext (const QgsAttributeEditorContext &context)
void setQgisRelation (QString qgisRelationId)
 Defines the relation ID (from project relations)
void setRelationFeature (const QgsRelation &relation, const QgsFeature &feature)
void setViewMode (QgsDualView::ViewMode mode)
 Define the view mode for the dual view.
QgsDualView::ViewMode viewMode ()
- Public Member Functions inherited from QgsCollapsibleGroupBox
 QgsCollapsibleGroupBox (QWidget *parent=0, QSettings *settings=0)
 QgsCollapsibleGroupBox (const QString &title, QWidget *parent=0, QSettings *settings=0)
 ~QgsCollapsibleGroupBox ()
bool saveCheckedState ()
bool saveCollapsedState ()
void setSaveCheckedState (bool save)
 set this to true to save/restore checked state
void setSaveCollapsedState (bool save)
 set this to false to not save/restore collapsed state
void setSettingGroup (const QString &group)
 set this to a defined string to share save/restore states across different parent dialogs
void setSettings (QSettings *settings)
QString settingGroup () const
- Public Member Functions inherited from QgsCollapsibleGroupBoxBasic
 QgsCollapsibleGroupBoxBasic (QWidget *parent=0)
 QgsCollapsibleGroupBoxBasic (const QString &title, QWidget *parent=0)
 ~QgsCollapsibleGroupBoxBasic ()
bool isCollapsed () const
bool scrollOnExpand ()
void setCollapsed (bool collapse)
void setScrollOnExpand (bool scroll)
 set this to false to not automatically scroll parent QScrollArea to this widget's contents when expanded
void setSyncGroup (QString grp)
QString syncGroup () const
 Named group which synchronizes collapsing action when triangle is clicked while holding alt modifier key.

Properties

QString qgisRelation
QgsDualView::ViewMode viewMode
- Properties inherited from QgsCollapsibleGroupBox
bool collapsed
bool saveCheckedState
bool saveCollapsedState
bool scrollOnExpand
QString syncGroup
- Properties inherited from QgsCollapsibleGroupBoxBasic
bool collapsed
bool scrollOnExpand
QString syncGroup

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.
- Protected Slots inherited from QgsCollapsibleGroupBox
void loadState ()
void saveState ()
- Protected Member Functions inherited from QgsCollapsibleGroupBox
void init ()
QString saveKey () const
void showEvent (QShowEvent *event) override
- Protected Attributes inherited from QgsCollapsibleGroupBox
bool mDelSettings
bool mSaveCheckedState
bool mSaveCollapsedState
QString mSettingGroup
QPointer< QSettings > mSettings
- Static Protected Attributes inherited from QgsCollapsibleGroupBoxBasic
static QIcon mCollapseIcon
static QIcon mExpandIcon

Detailed Description

Definition at line 34 of file qgsrelationeditorwidget.h.

Constructor & Destructor Documentation

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

Definition at line 31 of file qgsrelationeditorwidget.cpp.

Member Function Documentation

QString QgsRelationEditorWidget::qgisRelation ( )
inline

Definition at line 53 of file qgsrelationeditorwidget.h.

void QgsRelationEditorWidget::setEditorContext ( const QgsAttributeEditorContext context)

Definition at line 168 of file qgsrelationeditorwidget.cpp.

void QgsRelationEditorWidget::setQgisRelation ( QString  qgisRelationId)
inline

Defines the relation ID (from project relations)

Note
use a widget's property to keep compatibility with using basic widget instead of QgsRelationEditorWidget

Definition at line 52 of file qgsrelationeditorwidget.h.

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

Definition at line 127 of file qgsrelationeditorwidget.cpp.

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

Define the view mode for the dual view.

Definition at line 173 of file qgsrelationeditorwidget.cpp.

QgsDualView::ViewMode QgsRelationEditorWidget::viewMode ( )
inline

Definition at line 48 of file qgsrelationeditorwidget.h.

Property Documentation

QString QgsRelationEditorWidget::qgisRelation
readwrite

Definition at line 37 of file qgsrelationeditorwidget.h.

QgsDualView::ViewMode QgsRelationEditorWidget::viewMode
readwrite

Definition at line 38 of file qgsrelationeditorwidget.h.


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