QGIS API Documentation  3.21.0-Master (5b68dc587e)
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 #include <QString>
21 
22 class QgsMapLayer;
23 
31 class CORE_EXPORT QgsLayerNotesUtils
32 {
33  public:
34 
40  static QString layerNotes( const QgsMapLayer *layer );
41 
45  static void setLayerNotes( QgsMapLayer *layer, const QString &notes );
46 
50  static bool layerHasNotes( const QgsMapLayer *layer );
51 
55  static void removeNotes( QgsMapLayer *layer );
56 
57 };
58 
59 
60 #endif // QGSLAYERNOTESUTILS_H
Contains utility functions for working with layer notes.
Base class for all map layer types.
Definition: qgsmaplayer.h:73