QGIS API Documentation  2.11.0-Master
Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
QgsEditorWidgetRegistry Class Reference

This class manages all known edit widget factories. More...

#include <qgseditorwidgetregistry.h>

Inheritance diagram for QgsEditorWidgetRegistry:
Inheritance graph
[legend]

Public Member Functions

 ~QgsEditorWidgetRegistry ()
 Destructor. More...
 
QgsEditorWidgetWrappercreate (const QString &widgetId, QgsVectorLayer *vl, int fieldIdx, const QgsEditorWidgetConfig &config, QWidget *editor, QWidget *parent, const QgsAttributeEditorContext &context=QgsAttributeEditorContext())
 Create an attribute editor widget wrapper of a given type for a given field. More...
 
QgsEditorConfigWidgetcreateConfigWidget (const QString &widgetId, QgsVectorLayer *vl, int fieldIdx, QWidget *parent)
 Creates a configuration widget. More...
 
QgsSearchWidgetWrappercreateSearchWidget (const QString &widgetId, QgsVectorLayer *vl, int fieldIdx, const QgsEditorWidgetConfig &config, QWidget *parent, const QgsAttributeEditorContext &context=QgsAttributeEditorContext())
 
const QMap< QString, QgsEditorWidgetFactory * > & factories ()
 Get access to all registered factories. More...
 
QgsEditorWidgetFactoryfactory (const QString &widgetId)
 Get a factory for the given widget type id. More...
 
QString name (const QString &widgetId)
 Get the human readable name for a widget type. More...
 
bool registerWidget (const QString &widgetId, QgsEditorWidgetFactory *widgetFactory)
 Register a new widget factory with the given id. More...
 
- Public Member Functions inherited from QObject
 QObject (QObject *parent)
 
 QObject (QObject *parent, const char *name)
 
virtual  ~QObject ()
 
bool blockSignals (bool block)
 
QObjectchild (const char *objName, const char *inheritsClass, bool recursiveSearch) const
 
const QObjectList & children () const
 
const char * className () const
 
bool connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const
 
void deleteLater ()
 
void destroyed (QObject *obj)
 
bool disconnect (const QObject *receiver, const char *method)
 
bool disconnect (const char *signal, const QObject *receiver, const char *method)
 
void dumpObjectInfo ()
 
void dumpObjectTree ()
 
QList< QByteArraydynamicPropertyNames () const
 
virtual bool event (QEvent *e)
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
findChild (const QString &name) const
 
QList< T > findChildren (const QRegExp &regExp) const
 
QList< T > findChildren (const QString &name) const
 
bool inherits (const char *className) const
 
void insertChild (QObject *object)
 
void installEventFilter (QObject *filterObj)
 
bool isA (const char *className) const
 
bool isWidgetType () const
 
void killTimer (int id)
 
virtual const QMetaObjectmetaObject () const
 
void moveToThread (QThread *targetThread)
 
const char * name () const
 
const char * name (const char *defaultName) const
 
QString objectName () const
 
QObjectparent () const
 
QVariant property (const char *name) const
 
void removeChild (QObject *object)
 
void removeEventFilter (QObject *obj)
 
void setName (const char *name)
 
void setObjectName (const QString &name)
 
void setParent (QObject *parent)
 
bool setProperty (const char *name, const QVariant &value)
 
bool signalsBlocked () const
 
int startTimer (int interval)
 
QThreadthread () const
 

Static Public Member Functions

static void initEditors (QgsMapCanvas *mapCanvas=0, QgsMessageBar *messageBar=0)
 Registers all the default widgets. More...
 
static QgsEditorWidgetRegistryinstance ()
 This class is a singleton and has therefore to be accessed with this method instead of a constructor. More...
 
- Static Public Member Functions inherited from QObject
bool connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
 
bool connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
 
bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
 
bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
 
QString tr (const char *sourceText, const char *disambiguation, int n)
 
QString trUtf8 (const char *sourceText, const char *disambiguation, int n)
 

Protected Member Functions

 QgsEditorWidgetRegistry ()
 
- Protected Member Functions inherited from QObject
bool checkConnectArgs (const char *signal, const QObject *object, const char *method)
 
virtual void childEvent (QChildEvent *event)
 
virtual void connectNotify (const char *signal)
 
virtual void customEvent (QEvent *event)
 
virtual void disconnectNotify (const char *signal)
 
int receivers (const char *signal) const
 
QObjectsender () const
 
int senderSignalIndex () const
 
virtual void timerEvent (QTimerEvent *event)
 

Additional Inherited Members

- Static Protected Member Functions inherited from QObject
QByteArray normalizeSignalSlot (const char *signalSlot)
 
- Properties inherited from QObject
 objectName
 

Detailed Description

This class manages all known edit widget factories.

Definition at line 32 of file qgseditorwidgetregistry.h.

Constructor & Destructor Documentation

QgsEditorWidgetRegistry::~QgsEditorWidgetRegistry ( )

Destructor.

Deletes all the registered widgets

Definition at line 80 of file qgseditorwidgetregistry.cpp.

QgsEditorWidgetRegistry::QgsEditorWidgetRegistry ( )
protected

Definition at line 72 of file qgseditorwidgetregistry.cpp.

Member Function Documentation

QgsEditorWidgetWrapper * QgsEditorWidgetRegistry::create ( const QString widgetId,
QgsVectorLayer vl,
int  fieldIdx,
const QgsEditorWidgetConfig config,
QWidget editor,
QWidget parent,
const QgsAttributeEditorContext context = QgsAttributeEditorContext() 
)

Create an attribute editor widget wrapper of a given type for a given field.

The editor may be NULL if you want the widget wrapper to create a default widget.

Parameters
widgetIdThe id of the widget type to create an attribute editor for
vlThe vector layer for which this widget will be created
fieldIdxThe field index on the specified layer for which this widget will be created
configA configuration which should be used for the widget creation
editorAn editor widget which will be used instead of an autocreated widget
parentThe parent which will be used for the created wrapper and the created widget
contextThe editor context (not available in python bindings)
Returns
A new widget wrapper

Definition at line 85 of file qgseditorwidgetregistry.cpp.

QgsEditorConfigWidget * QgsEditorWidgetRegistry::createConfigWidget ( const QString widgetId,
QgsVectorLayer vl,
int  fieldIdx,
QWidget parent 
)

Creates a configuration widget.

Parameters
widgetIdThe id of the widget type to create a configuration widget for
vlThe vector layer for which this widget will be created
fieldIdxThe field index on the specified layer for which this widget will be created
parentThe parent widget for the created widget
Returns
A new configuration widget

Definition at line 123 of file qgseditorwidgetregistry.cpp.

QgsSearchWidgetWrapper * QgsEditorWidgetRegistry::createSearchWidget ( const QString widgetId,
QgsVectorLayer vl,
int  fieldIdx,
const QgsEditorWidgetConfig config,
QWidget parent,
const QgsAttributeEditorContext context = QgsAttributeEditorContext() 
)

Definition at line 104 of file qgseditorwidgetregistry.cpp.

const QMap< QString, QgsEditorWidgetFactory * > & QgsEditorWidgetRegistry::factories ( )

Get access to all registered factories.

Returns
All ids and factories

Definition at line 142 of file qgseditorwidgetregistry.cpp.

QgsEditorWidgetFactory * QgsEditorWidgetRegistry::factory ( const QString widgetId)

Get a factory for the given widget type id.

Returns
A factory or Null if not existent

Definition at line 147 of file qgseditorwidgetregistry.cpp.

void QgsEditorWidgetRegistry::initEditors ( QgsMapCanvas mapCanvas = 0,
QgsMessageBar messageBar = 0 
)
static

Registers all the default widgets.

Only call this once on startup of an application.

Parameters
mapCanvasSpecify a map canvas with which the widgets (relation reference) work
messageBarSpecify a message bar on which messages by widgets will be shown while working with the map canvas
Note
Added in QGIS 2.8
Not required for plugins, the QGIS application does that already

Definition at line 49 of file qgseditorwidgetregistry.cpp.

QgsEditorWidgetRegistry * QgsEditorWidgetRegistry::instance ( )
static

This class is a singleton and has therefore to be accessed with this method instead of a constructor.

Returns
The one and only instance of the editor widget registry

Definition at line 43 of file qgseditorwidgetregistry.cpp.

QString QgsEditorWidgetRegistry::name ( const QString widgetId)

Get the human readable name for a widget type.

Parameters
widgetIdThe widget type to get the name for
Returns
A human readable name

Definition at line 132 of file qgseditorwidgetregistry.cpp.

bool QgsEditorWidgetRegistry::registerWidget ( const QString widgetId,
QgsEditorWidgetFactory widgetFactory 
)

Register a new widget factory with the given id.

Parameters
widgetIdThe id which will be used later to refer to this widget type
widgetFactoryThe factory which will create this widget type
Returns
true, if successful, false, if the widgetId is already in use or widgetFactory is NULL

Definition at line 152 of file qgseditorwidgetregistry.cpp.


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