QGIS API Documentation  3.21.0-Master (5b68dc587e)
Public Types | Public Slots | Signals | Public Member Functions | Static Public Member Functions | Properties | List of all members
QgsMetadataWidget Class Reference

A wizard to edit metadata on a map layer. More...

#include <qgsmetadatawidget.h>

Inheritance diagram for QgsMetadataWidget:
Inheritance graph
[legend]

Public Types

enum  Mode { LayerMetadata = 0 , ProjectMetadata }
 Widget modes. More...
 

Public Slots

void setTitle (const QString &title)
 Sets the title field for the metadata. More...
 

Signals

void titleChanged (const QString &title)
 Emitted when the title field is changed. More...
 

Public Member Functions

 QgsMetadataWidget (QWidget *parent SIP_TRANSFERTHIS=nullptr, QgsMapLayer *layer=nullptr)
 Constructor for the wizard. More...
 
void acceptMetadata ()
 Saves the metadata to the layer. More...
 
bool checkMetadata ()
 Check if values in the wizard are correct. More...
 
void crsChanged ()
 If the CRS is updated. More...
 
QgsAbstractMetadataBasemetadata () SIP_FACTORY
 Returns a QgsAbstractMetadataBase object representing the current state of the widget. More...
 
Mode mode () const
 Returns the widget's current mode. More...
 
void saveMetadata (QgsAbstractMetadataBase *metadata)
 Save all fields in a metadata object. More...
 
void setMapCanvas (QgsMapCanvas *canvas)
 Sets a map canvas associated with the widget. More...
 
void setMetadata (const QgsAbstractMetadataBase *metadata)
 Sets the metadata to display in the widget. More...
 
void setMode (Mode mode)
 Sets the widget's current mode. More...
 
QString title () const
 Returns the current title field for the metadata. More...
 

Static Public Member Functions

static QMap< QString, QString > parseLanguages ()
 Returns a list of languages available by default in the wizard. More...
 
static QStringList parseLicenses ()
 Returns a list of licences available by default in the wizard. More...
 
static QStringList parseLinkTypes ()
 Returns a list of link types available by default in the wizard. More...
 
static QStringList parseMimeTypes ()
 Returns a list of MIME types available by default in the wizard. More...
 
static QMap< QString, QString > parseTypes ()
 Returns a list of types available by default in the wizard. More...
 

Properties

QString title
 

Detailed Description

A wizard to edit metadata on a map layer.

Since
QGIS 3.0

Definition at line 41 of file qgsmetadatawidget.h.

Member Enumeration Documentation

◆ Mode

Widget modes.

Since
QGIS 3.2
Enumerator
LayerMetadata 

Show layer metadata.

ProjectMetadata 

Show project metadata.

Definition at line 52 of file qgsmetadatawidget.h.

Constructor & Destructor Documentation

◆ QgsMetadataWidget()

QgsMetadataWidget::QgsMetadataWidget ( QWidget *parent  SIP_TRANSFERTHIS = nullptr,
QgsMapLayer layer = nullptr 
)

Constructor for the wizard.

If layer is set, then this constructor automatically sets the widget's metadata() to match the layer's metadata..

See also
setMetadata()

Definition at line 34 of file qgsmetadatawidget.cpp.

Member Function Documentation

◆ acceptMetadata()

void QgsMetadataWidget::acceptMetadata ( )

Saves the metadata to the layer.

Definition at line 977 of file qgsmetadatawidget.cpp.

◆ checkMetadata()

bool QgsMetadataWidget::checkMetadata ( )

Check if values in the wizard are correct.

See also
saveMetadata()

Definition at line 775 of file qgsmetadatawidget.cpp.

◆ crsChanged()

void QgsMetadataWidget::crsChanged ( )

If the CRS is updated.

Definition at line 302 of file qgsmetadatawidget.cpp.

◆ metadata()

QgsAbstractMetadataBase * QgsMetadataWidget::metadata ( )

Returns a QgsAbstractMetadataBase object representing the current state of the widget.

Caller takes ownership of the returned object.

See also
saveMetadata()

Definition at line 179 of file qgsmetadatawidget.cpp.

◆ mode()

Mode QgsMetadataWidget::mode ( ) const
inline

Returns the widget's current mode.

See also
setMode()
Since
QGIS 3.2

Definition at line 80 of file qgsmetadatawidget.h.

◆ parseLanguages()

QMap< QString, QString > QgsMetadataWidget::parseLanguages ( )
static

Returns a list of languages available by default in the wizard.

Definition at line 821 of file qgsmetadatawidget.cpp.

◆ parseLicenses()

QStringList QgsMetadataWidget::parseLicenses ( )
static

Returns a list of licences available by default in the wizard.

Definition at line 864 of file qgsmetadatawidget.cpp.

◆ parseLinkTypes()

QStringList QgsMetadataWidget::parseLinkTypes ( )
static

Returns a list of link types available by default in the wizard.

See also
https://github.com/OSGeo/Cat-Interop/blob/master/LinkPropertyLookupTable.csv

Definition at line 888 of file qgsmetadatawidget.cpp.

◆ parseMimeTypes()

QStringList QgsMetadataWidget::parseMimeTypes ( )
static

Returns a list of MIME types available by default in the wizard.

See also
https://fr.wikipedia.org/wiki/Type_MIME

Definition at line 912 of file qgsmetadatawidget.cpp.

◆ parseTypes()

QMap< QString, QString > QgsMetadataWidget::parseTypes ( )
static

Returns a list of types available by default in the wizard.

Definition at line 934 of file qgsmetadatawidget.cpp.

◆ saveMetadata()

void QgsMetadataWidget::saveMetadata ( QgsAbstractMetadataBase metadata)

Save all fields in a metadata object.

See also
metadata()
acceptMetadata()
checkMetadata()

Definition at line 640 of file qgsmetadatawidget.cpp.

◆ setMapCanvas()

void QgsMetadataWidget::setMapCanvas ( QgsMapCanvas canvas)

Sets a map canvas associated with the widget.

Definition at line 957 of file qgsmetadatawidget.cpp.

◆ setMetadata()

void QgsMetadataWidget::setMetadata ( const QgsAbstractMetadataBase metadata)

Sets the metadata to display in the widget.

This method can be called after constructing a QgsMetadataWidget in order to set the displayed metadata to custom, non-layer based metadata.

Calling this method will automatically setMode() to the correct mode corresponding to the specified metadata object.

See also
metadata()

Definition at line 165 of file qgsmetadatawidget.cpp.

◆ setMode()

void QgsMetadataWidget::setMode ( QgsMetadataWidget::Mode  mode)

Sets the widget's current mode.

See also
mode()
Since
QGIS 3.2

Definition at line 127 of file qgsmetadatawidget.cpp.

◆ setTitle

void QgsMetadataWidget::setTitle ( const QString &  title)
slot

Sets the title field for the metadata.

See also
title()
titleChanged()
Since
QGIS 3.2

Definition at line 968 of file qgsmetadatawidget.cpp.

◆ title()

QString QgsMetadataWidget::title ( ) const

Returns the current title field for the metadata.

See also
setTitle()
titleChanged()
Since
QGIS 3.2

Definition at line 963 of file qgsmetadatawidget.cpp.

◆ titleChanged

void QgsMetadataWidget::titleChanged ( const QString &  title)
signal

Emitted when the title field is changed.

See also
title()
setTitle()
Since
QGIS 3.2

Property Documentation

◆ title

QString QgsMetadataWidget::title
readwrite

Definition at line 1 of file qgsmetadatawidget.h.


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