summaryrefslogtreecommitdiff
path: root/src/bookmarks/bookmarkmanager.hpp
blob: 417eb83d8afd17847ade3a399f95ccdc55a518c7 (plain)
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
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
/* ============================================================
 *     The rekonq project
 * ============================================================
 * SPDX-License-Identifier: GPL-2.0-or-later
 * Copyright (C) 2008-2012 by Andrea Diamantini <adjam7 at gmail dot com>
 * Copyright (C) 2009 by Paweł Prażak <pawelprazak at gmail dot com>
 * Copyright (C) 2009-2010 by Lionel Chauvin <megabigbug@yahoo.fr>
 * Copyright (C) 2010 by Yoann Laissus <yoann dot laissus at gmail dot com>
 * SPDX-License-Identifier: GPL-3.0-only
 * Copyright (C) 2022 aqua <aqua@iserlohn-fortress.net>
 * ============================================================
 * Description: rekonq bookmarks system interface
 * ============================================================ */

#pragma once

#include "bookmarkstreemodel.hpp"
#include "rekonq.hpp"
#include <QObject>

class BookmarkToolBar;
class QAction;

/**
 * This class represent the interface to rekonq bookmarks system.
 * All rekonq needs (Bookmarks Menu, Bookmarks Toolbar) is provided
 * from this class.
 * So it implements code to have each one.
 */
class BookmarkManager : public QObject {
  Q_OBJECT

public:
  /**
   * Entry point.
   * Access to BookmarkManager class by using
   * BookmarkManager::self()->thePublicMethodYouNeed()
   */
  static BookmarkManager *self();

  ~BookmarkManager();

  /**
   * @short set the Bookmarks Toolbar Action
   */
  void registerBookmarkBar(BookmarkToolBar *toolbar);
  void removeBookmarkBar(BookmarkToolBar *toolbar);

  /**
   * @short Get action by name
   * This method returns poiner bookmark action of given name.
   * @pre m_actionCollection != NULL
   * @param name Name of action you want to get
   * @return It returns actions if one exists or empty object
   */
  QAction *actionByName(const QString &name);

  /**
   * returns Bookmark Manager root group
   *
   * @return the root bookmark group
   */
  KBookmarkGroup rootGroup();

  inline KBookmarkManager *manager() { return m_manager; }

  inline BookmarkOwner *owner() { return m_owner; }

  QList<KBookmark> find(const QString &text);

  KBookmark bookmarkForUrl(const KUrl &url);

  KBookmark findByAddress(const QString &);

  void openFolderinTabs(const KBookmarkGroup &bm);

  void emitChanged();

  static inline QString bookmark_mime_type() { return QL1S("application/x-rekonq-bookmark"); }

  KActionMenu *bookmarkActionMenu(QWidget *parent);

private:
  /**
   * @short Class constructor.
   * Connect BookmarksProvider with bookmarks source
   * (actually konqueror's bookmarks).
   * @param parent The WebWindow to provide bookmarks objects.
   */
  explicit BookmarkManager(QObject *parent = nullptr);

public Q_SLOTS:
  /**
   * @short Waits for signal that the group with the address has been modified by the caller.
   * Waits for signal that the group (or any of its children) with the address
   * @p groupAddress (e.g. "/4/5") has been modified by the caller @p caller.
   * @param groupAddress bookmark group address
   * @param caller caller that modified the bookmarks
   * @see  KBookmarkManager::changed
   */
  void slotBookmarksChanged();
  void fillBookmarkBar(BookmarkToolBar *toolBar);

  void slotEditBookmarks();

  KBookmark bookmarkCurrentPage(const KBookmark &bookmark = KBookmark());

Q_SIGNALS:
  /**
   * @short This signal is emitted when an url has to be loaded
   */
  void openUrl(const KUrl &, const Rekonq::OpenType &);

  void bookmarksUpdated();

private:
  void find(QList<KBookmark> *list, const KBookmark &bookmark, const QString &text);
  KBookmark bookmarkForUrl(const KBookmark &bookmark, const KUrl &url);
  void copyBookmarkGroup(const KBookmarkGroup &groupToCopy, KBookmarkGroup destGroup);

  QList<BookmarkToolBar *> m_bookmarkToolBars;
  BookmarkModel *m_model;
};