QGIS API Documentation  2.5.0-Master
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Public Slots | Public Member Functions | Protected Member Functions | Private Slots | Private Attributes | List of all members
QgsFileNameWidget Class Reference

#include <qgsfilenamewidget.h>

Inheritance diagram for QgsFileNameWidget:
Inheritance graph
[legend]
Collaboration diagram for QgsFileNameWidget:
Collaboration graph
[legend]

Public Slots

void setValue (const QVariant &value)
 
- Public Slots inherited from QgsEditorWidgetWrapper
void setFeature (const QgsFeature &feature)
 Will be called when the feature changes. More...
 
virtual void setValue (const QVariant &value)=0
 Is called, when the value of the widget needs to be changed. More...
 
- Public Slots inherited from QgsWidgetWrapper
virtual void setFeature (const QgsFeature &feature)=0
 Is called, when the value of the widget needs to be changed. More...
 

Public Member Functions

 QgsFileNameWidget (QgsVectorLayer *vl, int fieldIdx, QWidget *editor=0, QWidget *parent=0)
 
QVariant value ()
 Will be used to access the widget's value. More...
 
- Public Member Functions inherited from QgsEditorWidgetWrapper
 QgsEditorWidgetWrapper (QgsVectorLayer *vl, int fieldIdx, QWidget *editor=0, QWidget *parent=0)
 Create a new widget wrapper. More...
 
int fieldIdx ()
 Access the field index. More...
 
QgsField field ()
 Access the field. More...
 
void setEnabled (bool enabled)
 Is used to enable or disable the edit functionality of the managed widget. More...
 
- Public Member Functions inherited from QgsWidgetWrapper
 QgsWidgetWrapper (QgsVectorLayer *vl, QWidget *editor=0, QWidget *parent=0)
 Create a new widget wrapper. More...
 
QWidget * widget ()
 Access the widget managed by this wrapper. More...
 
template<class T >
T * widget ()
 Access the widget managed by this wrapper and cast it to a given type Example: QPushButton* pb = wrapper->widget<QPushButton*>();. More...
 
void setConfig (const QgsEditorWidgetConfig &config)
 Will set the config of this wrapper to the specified config. More...
 
void setContext (const QgsAttributeEditorContext &context)
 Set the context in which this widget is shown. More...
 
QVariant config (QString key, QVariant defaultVal=QVariant())
 Use this inside your overriden classes to access the configuration. More...
 
const QgsEditorWidgetConfig config ()
 Returns the whole config. More...
 
const QgsAttributeEditorContextcontext ()
 Returns information about the context in which this widget is shown. More...
 
QgsVectorLayerlayer ()
 Access the QgsVectorLayer, you are working on. More...
 

Protected Member Functions

QWidget * createWidget (QWidget *parent)
 This method should create a new widget with the provided parent. More...
 
void initWidget (QWidget *editor)
 This method should initialize the editor widget with runtime data. More...
 

Private Slots

void selectFileName ()
 

Private Attributes

QLineEdit * mLineEdit
 
QPushButton * mPushButton
 
QLabel * mLabel
 

Additional Inherited Members

- Signals inherited from QgsEditorWidgetWrapper
void valueChanged (const QVariant &value)
 Emit this signal, whenever the value changed. More...
 
- Static Public Member Functions inherited from QgsEditorWidgetWrapper
static QgsEditorWidgetWrapperfromWidget (QWidget *widget)
 Will return a wrapper for a given widget. More...
 
- Static Public Member Functions inherited from QgsWidgetWrapper
static QgsWidgetWrapperfromWidget (QWidget *widget)
 Will return a wrapper for a given widget. More...
 
- Protected Slots inherited from QgsEditorWidgetWrapper
void valueChanged (const QString &value)
 If you emit to this slot in your implementation, an appropriate change notification will be broadcasted. More...
 
void valueChanged (int value)
 If you emit to this slot in your implementation, an appropriate change notification will be broadcasted. More...
 
void valueChanged (double value)
 If you emit to this slot in your implementation, an appropriate change notification will be broadcasted. More...
 
void valueChanged (bool value)
 If you emit to this slot in your implementation, an appropriate change notification will be broadcasted. More...
 
void valueChanged (qlonglong value)
 If you emit to this slot in your implementation, an appropriate change notification will be broadcasted. More...
 
void valueChanged ()
 Will call the value() method to determine the emitted value. More...
 

Detailed Description

Definition at line 25 of file qgsfilenamewidget.h.

Constructor & Destructor Documentation

QgsFileNameWidget::QgsFileNameWidget ( QgsVectorLayer vl,
int  fieldIdx,
QWidget *  editor = 0,
QWidget *  parent = 0 
)
explicit

Definition at line 23 of file qgsfilenamewidget.cpp.

Member Function Documentation

QWidget * QgsFileNameWidget::createWidget ( QWidget *  parent)
protectedvirtual

This method should create a new widget with the provided parent.

This will only be called if the form did not already provide a widget, so it is not guaranteed to be called! You should not do initialisation stuff, which also has to be done for custom editor widgets inside this method. Things like filling comboboxes and assigning other data which will also be used to make widgets on forms created in the QtDesigner usable should be assigned in initWidget(QWidget*).

Parameters
parentYou should set this parent on the created widget.
Returns
A new widget

Implements QgsWidgetWrapper.

Definition at line 41 of file qgsfilenamewidget.cpp.

References tr.

void QgsFileNameWidget::initWidget ( QWidget *  editor)
protectedvirtual

This method should initialize the editor widget with runtime data.

Fill your comboboxes here.

Parameters
editorThe widget which will represent this attribute editor in a form.

Reimplemented from QgsWidgetWrapper.

Definition at line 60 of file qgsfilenamewidget.cpp.

References mLabel, mLineEdit, mPushButton, selectFileName(), and QgsEditorWidgetWrapper::valueChanged().

void QgsFileNameWidget::selectFileName ( )
privateslot

Definition at line 88 of file qgsfilenamewidget.cpp.

References mLabel, mLineEdit, and tr.

Referenced by initWidget().

void QgsFileNameWidget::setValue ( const QVariant &  value)
slot

Definition at line 79 of file qgsfilenamewidget.cpp.

References mLabel, and mLineEdit.

QVariant QgsFileNameWidget::value ( )
virtual

Will be used to access the widget's value.

Read the value from the widget and return it properly formatted to be saved in the attribute.

If an invalid variant is returned this will be interpreted as no change. Be sure to return a NULL QVariant if it should be set to NULL.

Returns
The current value the widget represents

Implements QgsEditorWidgetWrapper.

Definition at line 28 of file qgsfilenamewidget.cpp.

References mLabel, and mLineEdit.

Member Data Documentation

QLabel* QgsFileNameWidget::mLabel
private

Definition at line 48 of file qgsfilenamewidget.h.

Referenced by initWidget(), selectFileName(), setValue(), and value().

QLineEdit* QgsFileNameWidget::mLineEdit
private

Definition at line 46 of file qgsfilenamewidget.h.

Referenced by initWidget(), selectFileName(), setValue(), and value().

QPushButton* QgsFileNameWidget::mPushButton
private

Definition at line 47 of file qgsfilenamewidget.h.

Referenced by initWidget().


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