QgsFormAnnotationItem Class Reference

An annotation item that embedds a designer form showing the feature attribute. More...

#include <qgsformannotationitem.h>

Inheritance diagram for QgsFormAnnotationItem:

Collaboration diagram for QgsFormAnnotationItem:

List of all members.

Public Member Functions
	QgsFormAnnotationItem (QgsMapCanvas *canvas, QgsVectorLayer *vlayer=0, bool hasFeature=false, int feature=0)
	~QgsFormAnnotationItem ()
QString	designerForm () const
QSizeF	minimumFrameSize () const
void	paint (QPainter *painter)
	function to be implemented by derived classes
void	paint (QPainter *painter, const QStyleOptionGraphicsItem *option, QWidget *widget=0)
	paint function called by map canvas
QSizeF	preferredFrameSize () const
	Returns the optimal frame size.
void	readXML (const QDomDocument &doc, const QDomElement &itemElem)
void	setDesignerForm (const QString &uiFile)
void	setMapPosition (const QgsPoint &pos)
	Reimplemented from QgsAnnotationItem.
QgsVectorLayer *	vectorLayer () const
void	writeXML (QDomDocument &doc) const
Private Slots
void	setFeatureForMapPosition ()
	Sets a feature for the current map position and updates the dialog.
void	updateVisibility ()
	Sets visibility status based on mVectorLayer visibility.
Private Member Functions
QWidget *	createDesignerWidget (const QString &filePath)
Private Attributes
QString	mDesignerForm
	Path to (and including) the .ui file.
QWidget *	mDesignerWidget
QgsFeatureId	mFeature
	Associated feature.
bool	mHasAssociatedFeature
	True if the item is related to a vector feature.
QgsVectorLayer *	mVectorLayer
	Associated vectorlayer (or 0 if attributes are not supposed to be replaced)
QGraphicsProxyWidget *	mWidgetContainer

---

Detailed Description

An annotation item that embedds a designer form showing the feature attribute.

Definition at line 28 of file qgsformannotationitem.h.

---

Constructor & Destructor Documentation

QgsFormAnnotationItem::QgsFormAnnotationItem	(	QgsMapCanvas *	canvas,
		QgsVectorLayer *	vlayer = 0,
		bool	hasFeature = false,
		int	feature = 0
	)

Definition at line 35 of file qgsformannotationitem.cpp.

References QgsVectorLayer::annotationForm(), mDesignerForm, QgsMapCanvasItem::mMapCanvas, mVectorLayer, mWidgetContainer, setFeatureForMapPosition(), and updateVisibility().

QgsFormAnnotationItem::~QgsFormAnnotationItem

(

)

Definition at line 51 of file qgsformannotationitem.cpp.

References mDesignerWidget.

---

Member Function Documentation

QWidget * QgsFormAnnotationItem::createDesignerWidget

(

const QString &

filePath

)

[private]

Definition at line 70 of file qgsformannotationitem.cpp.

References QgsFeature::attributes(), QgsFields::count(), QgsAttributeEditor::createAttributeEditor(), file, QgsVectorLayer::getFeatures(), mFeature, mHasAssociatedFeature, mVectorLayer, QgsFeatureIterator::nextFeature(), QgsFeatureRequest::NoGeometry, and QgsVectorLayer::pendingFields().

Referenced by readXML(), setDesignerForm(), and setFeatureForMapPosition().

QString QgsFormAnnotationItem::designerForm

(

)

const [inline]

Definition at line 48 of file qgsformannotationitem.h.

QSizeF QgsFormAnnotationItem::minimumFrameSize

(

)

const [virtual]

Reimplemented from QgsAnnotationItem.

Definition at line 144 of file qgsformannotationitem.cpp.

References mDesignerWidget, and QgsAnnotationItem::mFrameBorderWidth.

void QgsFormAnnotationItem::paint

(

QPainter *

painter

)

[virtual]

function to be implemented by derived classes

Implements QgsMapCanvasItem.

Definition at line 114 of file qgsformannotationitem.cpp.

void QgsFormAnnotationItem::paint	(	QPainter *	painter,
		const QStyleOptionGraphicsItem *	option,
		QWidget *	widget = 0
	)		[virtual]

paint function called by map canvas

Reimplemented from QgsMapCanvasItem.

Definition at line 119 of file qgsformannotationitem.cpp.

References QgsAnnotationItem::drawFrame(), QgsAnnotationItem::drawMarkerSymbol(), QgsAnnotationItem::drawSelectionBoxes(), QgsAnnotationItem::mFrameBorderWidth, QgsAnnotationItem::mFrameSize, QgsAnnotationItem::mMapPositionFixed, QgsAnnotationItem::mOffsetFromReferencePoint, and mWidgetContainer.

QSizeF QgsFormAnnotationItem::preferredFrameSize

(

)

const

Returns the optimal frame size.

Definition at line 157 of file qgsformannotationitem.cpp.

References mDesignerWidget.

Referenced by setDesignerForm().

void QgsFormAnnotationItem::readXML	(	const QDomDocument &	doc,
		const QDomElement &	itemElem
	)		[virtual]

Implements QgsAnnotationItem.

Definition at line 189 of file qgsformannotationitem.cpp.

References QgsAnnotationItem::_readXML(), createDesignerWidget(), QgsMapLayerRegistry::instance(), QgsMapLayerRegistry::mapLayer(), mDesignerForm, mDesignerWidget, mFeature, QgsAnnotationItem::mFrameBackgroundColor, mHasAssociatedFeature, QgsMapCanvasItem::mMapCanvas, mVectorLayer, mWidgetContainer, setFeatureForMapPosition(), and updateVisibility().

void QgsFormAnnotationItem::setDesignerForm

(

const QString &

uiFile

)

Definition at line 56 of file qgsformannotationitem.cpp.

References createDesignerWidget(), mDesignerForm, mDesignerWidget, QgsAnnotationItem::mFrameBackgroundColor, mWidgetContainer, preferredFrameSize(), and QgsAnnotationItem::setFrameSize().

void QgsFormAnnotationItem::setFeatureForMapPosition

(

)

[private, slot]

Sets a feature for the current map position and updates the dialog.

Definition at line 220 of file qgsformannotationitem.cpp.

References createDesignerWidget(), QGis::DEFAULT_IDENTIFY_RADIUS, QgsFeatureRequest::ExactIntersect, QgsMapCanvas::extent(), QgsVectorLayer::getFeatures(), QgsFeature::id(), mDesignerForm, mDesignerWidget, mFeature, QgsAnnotationItem::mFrameBackgroundColor, mHasAssociatedFeature, QgsMapCanvasItem::mMapCanvas, QgsAnnotationItem::mMapPosition, mVectorLayer, mWidgetContainer, QgsFeatureRequest::NoGeometry, QgsRectangle::width(), QgsPoint::x(), and QgsPoint::y().

Referenced by QgsFormAnnotationItem(), readXML(), and setMapPosition().

void QgsFormAnnotationItem::setMapPosition

(

const QgsPoint &

pos

)

[virtual]

Reimplemented from QgsAnnotationItem.

Reimplemented from QgsAnnotationItem.

Definition at line 108 of file qgsformannotationitem.cpp.

References setFeatureForMapPosition().

void QgsFormAnnotationItem::updateVisibility

(

)

[private, slot]

Sets visibility status based on mVectorLayer visibility.

Definition at line 260 of file qgsformannotationitem.cpp.

References QgsMapCanvas::layers(), QgsMapCanvasItem::mMapCanvas, and mVectorLayer.

Referenced by QgsFormAnnotationItem(), and readXML().

QgsVectorLayer* QgsFormAnnotationItem::vectorLayer

(

)

const [inline]

Definition at line 53 of file qgsformannotationitem.h.

void QgsFormAnnotationItem::writeXML

(

QDomDocument &

doc

)

const [virtual]

Implements QgsAnnotationItem.

Definition at line 169 of file qgsformannotationitem.cpp.

References QgsAnnotationItem::_writeXML(), QgsMapLayer::id(), mDesignerForm, mFeature, mHasAssociatedFeature, and mVectorLayer.

---

Member Data Documentation

QString QgsFormAnnotationItem::mDesignerForm [private]

Path to (and including) the .ui file.

Definition at line 71 of file qgsformannotationitem.h.

Referenced by QgsFormAnnotationItem(), readXML(), setDesignerForm(), setFeatureForMapPosition(), and writeXML().

QWidget* QgsFormAnnotationItem::mDesignerWidget [private]

Definition at line 63 of file qgsformannotationitem.h.

Referenced by minimumFrameSize(), preferredFrameSize(), readXML(), setDesignerForm(), setFeatureForMapPosition(), and ~QgsFormAnnotationItem().

QgsFeatureId QgsFormAnnotationItem::mFeature [private]

Associated feature.

Definition at line 69 of file qgsformannotationitem.h.

Referenced by createDesignerWidget(), readXML(), setFeatureForMapPosition(), and writeXML().

bool QgsFormAnnotationItem::mHasAssociatedFeature [private]

True if the item is related to a vector feature.

Definition at line 67 of file qgsformannotationitem.h.

Referenced by createDesignerWidget(), readXML(), setFeatureForMapPosition(), and writeXML().

QgsVectorLayer* QgsFormAnnotationItem::mVectorLayer [private]

Associated vectorlayer (or 0 if attributes are not supposed to be replaced)

Definition at line 65 of file qgsformannotationitem.h.

Referenced by createDesignerWidget(), QgsFormAnnotationItem(), readXML(), setFeatureForMapPosition(), updateVisibility(), and writeXML().

QGraphicsProxyWidget* QgsFormAnnotationItem::mWidgetContainer [private]

Definition at line 62 of file qgsformannotationitem.h.

Referenced by paint(), QgsFormAnnotationItem(), readXML(), setDesignerForm(), and setFeatureForMapPosition().

---

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

• src/gui/qgsformannotationitem.h
• src/gui/qgsformannotationitem.cpp