Doxygen
|
A list of index interfaces. More...
#include <src/indexlist.h>
Public Member Functions | |
void | disable () |
disable the indices | |
void | enable () |
enable the indices | |
template<class T, class... As> | |
void | addIndex (As &&... args) |
Add an index generator to the list, using a syntax similar to std::make_unique<T>(). | |
void | initialize () |
void | finalize () |
void | incContentsDepth () |
void | decContentsDepth () |
void | addContentsItem (bool isDir, const QCString &name, const QCString &ref, const QCString &file, const QCString &anchor, bool separateIndex=FALSE, bool addToNavIndex=FALSE, const Definition *def=nullptr, const QCString &nameAsHtml=QCString()) |
void | addIndexItem (const Definition *context, const MemberDef *md, const QCString §ionAnchor=QCString(), const QCString &title=QCString()) |
void | addIndexFile (const QCString &name) |
void | addImageFile (const QCString &name) |
void | addStyleSheetFile (const QCString &name) |
Private Types | |
using | IndexPtr = std::unique_ptr<IndexIntf> |
Private Member Functions | |
template<class... Ts, class... As> | |
void | foreach (void(IndexIntf::*methodPtr)(Ts...), As &&... args) |
template<class... Ts, class... As> | |
void | foreach_locked (void(IndexIntf::*methodPtr)(Ts...), As &&... args) |
Private Attributes | |
bool | m_enabled = true |
std::mutex | m_mutex |
std::vector< IndexPtr > | m_indices |
A list of index interfaces.
This class itself implements all methods of IndexIntf and just forwards the calls to all items in the list (composite design pattern).
Definition at line 63 of file indexlist.h.
|
private |
Definition at line 65 of file indexlist.h.
|
inline |
Definition at line 112 of file indexlist.h.
References IndexIntf::addContentsItem(), FALSE, foreach_locked(), and m_enabled.
|
inline |
Definition at line 123 of file indexlist.h.
References IndexIntf::addImageFile(), foreach_locked(), and m_enabled.
|
inline |
Add an index generator to the list, using a syntax similar to std::make_unique<T>().
Definition at line 97 of file indexlist.h.
References m_indices.
|
inline |
Definition at line 120 of file indexlist.h.
References IndexIntf::addIndexFile(), foreach_locked(), and m_enabled.
|
inline |
Definition at line 117 of file indexlist.h.
References IndexIntf::addIndexItem(), foreach_locked(), and m_enabled.
|
inline |
Definition at line 126 of file indexlist.h.
References IndexIntf::addStyleSheetFile(), foreach_locked(), and m_enabled.
|
inline |
Definition at line 109 of file indexlist.h.
References IndexIntf::decContentsDepth(), foreach_locked(), and m_enabled.
|
inline |
|
inline |
|
inline |
Definition at line 103 of file indexlist.h.
References IndexIntf::finalize().
|
inlineprivate |
Definition at line 68 of file indexlist.h.
|
inlineprivate |
Definition at line 77 of file indexlist.h.
References m_indices, and m_mutex.
Referenced by addContentsItem(), addImageFile(), addIndexFile(), addIndexItem(), addStyleSheetFile(), decContentsDepth(), and incContentsDepth().
|
inline |
Definition at line 106 of file indexlist.h.
References foreach_locked(), IndexIntf::incContentsDepth(), and m_enabled.
|
inline |
Definition at line 100 of file indexlist.h.
References IndexIntf::initialize().
|
private |
Definition at line 130 of file indexlist.h.
Referenced by addContentsItem(), addImageFile(), addIndexFile(), addIndexItem(), addStyleSheetFile(), decContentsDepth(), disable(), enable(), and incContentsDepth().
|
private |
Definition at line 132 of file indexlist.h.
Referenced by addIndex(), and foreach_locked().
|
private |
Definition at line 131 of file indexlist.h.
Referenced by foreach_locked().