QGIS API Documentation
4.3.0-Master (9dce731a7a1)
Toggle main menu visibility
Loading...
Searching...
No Matches
src
core
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
23
class
QgsMapLayer
;
24
32
class
CORE_EXPORT
QgsLayerNotesUtils
33
{
34
public
:
40
static
QString
layerNotes
(
const
QgsMapLayer
*layer );
41
45
static
void
setLayerNotes
(
QgsMapLayer
*layer,
const
QString ¬es );
46
50
static
bool
layerHasNotes
(
const
QgsMapLayer
*layer );
51
55
static
void
removeNotes
(
QgsMapLayer
*layer );
56
};
57
58
59
#endif
// QGSLAYERNOTESUTILS_H
QgsLayerNotesUtils
Contains utility functions for working with layer notes.
Definition
qgslayernotesutils.h:33
QgsLayerNotesUtils::setLayerNotes
static void setLayerNotes(QgsMapLayer *layer, const QString ¬es)
Sets the notes for the specified layer, where notes is a HTML formatted string.
Definition
qgslayernotesutils.cpp:32
QgsLayerNotesUtils::removeNotes
static void removeNotes(QgsMapLayer *layer)
Removes any notes for the specified layer.
Definition
qgslayernotesutils.cpp:51
QgsLayerNotesUtils::layerHasNotes
static bool layerHasNotes(const QgsMapLayer *layer)
Returns true if the specified layer has notes available.
Definition
qgslayernotesutils.cpp:43
QgsLayerNotesUtils::layerNotes
static QString layerNotes(const QgsMapLayer *layer)
Returns the notes for the specified layer.
Definition
qgslayernotesutils.cpp:24
QgsMapLayer
Base class for all map layer types.
Definition
qgsmaplayer.h:83
Generated on
for QGIS API Documentation by
1.17.0