field expression widget: better documentation

qgis · May 6, 2014 · 73d11ae · 73d11ae
1 parent 1607396
commit 73d11ae
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/src/gui/qgsfieldexpressionwidget.h b/src/gui/qgsfieldexpressionwidget.h
@@ -28,6 +28,14 @@ class QgsMapLayer;
 class QgsVectorLayer;
 class QgsFieldModel;
 
+/**
+ * @brief The QgsFieldExpressionWidget class reates a widget to choose fields and edit expressions
+ * It contains a combo boxto display the fields and expression and a button to open the expression dialog.
+ * The combo box is editable, allowing expressions to be edited inline.
+ * The validity of the expression is checked live on key press, invalid expressions are displayed in red.
+ * The expression will be added to the model (and the fieldChanged signals emitted)
+ * only when editing in the line edit is finished (focus lost, enter key pressed).
+ */
 class GUI_EXPORT QgsFieldExpressionWidget : public QWidget
 {
     Q_OBJECT