1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
|
/* This file is part of the KDE project
* Copyright (C) 2007 Fredy Yanardi <fyanardi@gmail.com>
* Copyright (C) 2012 C. Boemann <cbo@boemann.dk>
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Library General Public
* License as published by the Free Software Foundation; either
* version 2 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Library General Public License for more details.
*
* You should have received a copy of the GNU Library General Public License
* along with this library; see the file COPYING.LIB. If not, write to
* the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
* Boston, MA 02110-1301, USA.
*/
#ifndef KOBOOKMARKMANAGER_H
#define KOBOOKMARKMANAGER_H
#include "kotext_export.h"
#include <QObject>
#include <QList>
#include <QString>
class KoBookmark;
class KoBookmarkManagerPrivate;
/**
* A manager for all bookmarks in a document. Every bookmark is identified by a unique name.
* Note that only SinglePosition and StartBookmark bookmarks can be retrieved from this
* manager. An end bookmark should be retrieved from it's parent (StartBookmark) using
* KoBookmark::endBookmark()
* This class also maintains a list of bookmark names so that it can be easily used to
* show all available bookmark.
*/
class KOTEXT_EXPORT KoBookmarkManager : public QObject
{
Q_OBJECT
public:
/// constructor
KoBookmarkManager();
~KoBookmarkManager() override;
/// @return a bookmark with the specified name, or 0 if there is none
KoBookmark *bookmark(const QString &name) const;
/// @return a list of QString containing all bookmark names
QList<QString> bookmarkNameList() const;
public Q_SLOTS:
/**
* Insert a new bookmark to this manager. The name of the bookmark
* will be set to @p name, no matter what name has been set on
* it.
* @param name the name of the bookmark
* @param bookmark the bookmark object to insert
*/
void insert(const QString &name, KoBookmark *bookmark);
/**
* Remove a bookmark from this manager.
* @param name the name of the bookmark to remove
*/
void remove(const QString &name);
/**
* Rename a bookmark
* @param oldName the old name of the bookmark
* @param newName the new name of the bookmark
*/
void rename(const QString &oldName, const QString &newName);
private:
KoBookmarkManagerPrivate * const d;
};
#endif
|
