QGIS API Documentation  2.6.0-Brighton
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Public Member Functions | List of all members
QgsTextEditWidgetFactory Class Reference

#include <qgstexteditwidgetfactory.h>

Inheritance diagram for QgsTextEditWidgetFactory:
Inheritance graph
[legend]

Public Member Functions

 QgsTextEditWidgetFactory (const QString &name)
QgsEditorWidgetWrappercreate (QgsVectorLayer *vl, int fieldIdx, QWidget *editor, QWidget *parent) const
 Override this in your implementation.
QgsEditorConfigWidgetconfigWidget (QgsVectorLayer *vl, int fieldIdx, QWidget *parent) const
 Override this in your implementation.
void writeConfig (const QgsEditorWidgetConfig &config, QDomElement &configElement, QDomDocument &doc, const QgsVectorLayer *layer, int fieldIdx)
 Serialize your configuration and save it in a xml doc.
- Public Member Functions inherited from QgsEditorWidgetFactory
 QgsEditorWidgetFactory (const QString &name)
 Constructor.
virtual ~QgsEditorWidgetFactory ()
QString name ()
 Return The human readable identifier name of this widget type.
QgsEditorWidgetConfig readEditorConfig (const QDomElement &configElement, QgsVectorLayer *layer, int fieldIdx)
 Read the config from an XML file and map it to a proper QgsEditorWidgetConfig.
bool supportsField (QgsVectorLayer *vl, int fieldIdx)
 Check if this editor widget type supports a certain field.
virtual QString representValue (QgsVectorLayer *vl, int fieldIdx, const QgsEditorWidgetConfig &config, const QVariant &cache, const QVariant &value) const
 Create a pretty String representation of the value.
virtual QVariant createCache (QgsVectorLayer *vl, int fieldIdx, const QgsEditorWidgetConfig &config)
 Create a cache for a given field.

Constructor & Destructor Documentation

QgsTextEditWidgetFactory::QgsTextEditWidgetFactory ( const QString &  name)

Member Function Documentation

QgsEditorConfigWidget * QgsTextEditWidgetFactory::configWidget ( QgsVectorLayer vl,
int  fieldIdx,
QWidget *  parent 
) const
virtual

Override this in your implementation.

Create a new configuration widget for this widget type.

Parameters
vlThe layer for which the widget will be created
fieldIdxThe field index for which the widget will be created
parentThe parent widget of the created config widget
Returns
A configuration widget

Implements QgsEditorWidgetFactory.

QgsEditorWidgetWrapper * QgsTextEditWidgetFactory::create ( QgsVectorLayer vl,
int  fieldIdx,
QWidget *  editor,
QWidget *  parent 
) const
virtual

Override this in your implementation.

Create a new editor widget wrapper. Call QgsEditorWidgetRegistry::create() instead of calling this method directly.

Parameters
vlThe vector layer on which this widget will act
fieldIdxThe field index on which this widget will act
editorAn editor widget if already existent. If NULL is provided, a new widget will be created.
parentThe parent for the wrapper class and any created widget.
Returns
A new widget wrapper

Implements QgsEditorWidgetFactory.

void QgsTextEditWidgetFactory::writeConfig ( const QgsEditorWidgetConfig config,
QDomElement &  configElement,
QDomDocument &  doc,
const QgsVectorLayer layer,
int  fieldIdx 
)
virtual

Serialize your configuration and save it in a xml doc.

Parameters
configThe configuration to serialize
configElementThe element, where you can write your configuration into
docThe document. You can use this to create new nodes
layerThe layer for which this configuration applies
fieldIdxThe field on the layer for which this configuration applies

Reimplemented from QgsEditorWidgetFactory.


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