QGIS API Documentation 3.99.0-Master (26c88405ac0)
Loading...
Searching...
No Matches
qgslayernotesutils.h
Go to the documentation of this file.
1/***************************************************************************
2 qgslayernotesutils.h
3 --------------------------------------
4 Date : April 2021
5 Copyright : (C) 2021 by Nyall Dawson
6 Email : nyall dot dawson at gmail dot com
7 ***************************************************************************
8 * *
9 * This program is free software; you can redistribute it and/or modify *
10 * it under the terms of the GNU General Public License as published by *
11 * the Free Software Foundation; either version 2 of the License, or *
12 * (at your option) any later version. *
13 * *
14 ***************************************************************************/
15
16#ifndef QGSLAYERNOTESUTILS_H
17#define QGSLAYERNOTESUTILS_H
18
19#include "qgis_core.h"
20
21#include <QString>
22
23class QgsMapLayer;
24
32class CORE_EXPORT QgsLayerNotesUtils
33{
34 public:
35
41 static QString layerNotes( const QgsMapLayer *layer );
42
46 static void setLayerNotes( QgsMapLayer *layer, const QString &notes );
47
51 static bool layerHasNotes( const QgsMapLayer *layer );
52
56 static void removeNotes( QgsMapLayer *layer );
57
58};
59
60
61#endif // QGSLAYERNOTESUTILS_H
Contains utility functions for working with layer notes.
static void setLayerNotes(QgsMapLayer *layer, const QString &notes)
Sets the notes for the specified layer, where notes is a HTML formatted string.
static void removeNotes(QgsMapLayer *layer)
Removes any notes for the specified layer.
static bool layerHasNotes(const QgsMapLayer *layer)
Returns true if the specified layer has notes available.
static QString layerNotes(const QgsMapLayer *layer)
Returns the notes for the specified layer.
Base class for all map layer types.
Definition qgsmaplayer.h:80