Contains utility functions for working with layer notes. More...

Static Public Member Functions
static bool	layerHasNotes (const QgsMapLayer *layer)
	Returns `true` if the specified layer has notes available. More...

static QString	layerNotes (const QgsMapLayer *layer)
	Returns the notes for the specified layer. More...

static void	removeNotes (QgsMapLayer *layer)
	Removes any notes for the specified layer. More...

static void	setLayerNotes (QgsMapLayer *layer, const QString &notes)
	Sets the notes for the specified layer, where notes is a HTML formatted string. More...

Detailed Description

Contains utility functions for working with layer notes.

Definition at line 31 of file qgslayernotesutils.h.

Member Function Documentation

bool QgsLayerNotesUtils::layerHasNotes ( const QgsMapLayer * layer )

static

Returns true if the specified layer has notes available.

Definition at line 38 of file qgslayernotesutils.cpp.

QString QgsLayerNotesUtils::layerNotes ( const QgsMapLayer * layer )

static

Returns the notes for the specified layer.

The returned string is a HTML formatted set of user notations for the layer.

Definition at line 19 of file qgslayernotesutils.cpp.

void QgsLayerNotesUtils::removeNotes ( QgsMapLayer * layer )

static

Removes any notes for the specified layer.

Definition at line 46 of file qgslayernotesutils.cpp.

void QgsLayerNotesUtils::setLayerNotes	(	QgsMapLayer *	layer,
		const QString &	notes
	)

static

Sets the notes for the specified layer, where notes is a HTML formatted string.

Definition at line 27 of file qgslayernotesutils.cpp.

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