Doxygen
|
A list of index interfaces. More...
#include <src/indexlist.h>
Public Member Functions | |
void | disable () |
disable the indices | |
void | enable () |
enable the indices | |
bool | isEnabled () const |
returns true iff the indices are enabled | |
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) |
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 62 of file indexlist.h.
|
private |
Definition at line 64 of file indexlist.h.
|
inline |
Definition at line 115 of file indexlist.h.
References IndexIntf::addContentsItem().
Referenced by PageDefImpl::addSectionsToIndex().
|
inline |
Definition at line 126 of file indexlist.h.
References IndexIntf::addImageFile().
Referenced by FormulaManager::createLatexFile(), DocParser::findAndCopyImage(), PlantumlManager::generatePlantUMLOutput(), DotGraph::writeGraph(), ClassDiagram::writeImage(), HtmlGenerator::writeSearchData(), and HtmlGenerator::writeTabData().
|
inline |
Add an index generator to the list, using a syntax similar to std::make_unique<T>()
Definition at line 100 of file indexlist.h.
|
inline |
Definition at line 123 of file indexlist.h.
References IndexIntf::addIndexFile().
Referenced by HtmlGenerator::startFile().
|
inline |
Definition at line 120 of file indexlist.h.
References IndexIntf::addIndexItem().
Referenced by HtmlDocVisitor::operator()().
|
inline |
Definition at line 129 of file indexlist.h.
References IndexIntf::addStyleSheetFile().
Referenced by HtmlGenerator::writeSearchData(), HtmlGenerator::writeStyleInfo(), and HtmlGenerator::writeTabData().
|
inline |
Definition at line 112 of file indexlist.h.
References IndexIntf::decContentsDepth().
Referenced by PageDefImpl::addSectionsToIndex().
|
inline |
|
inline |
|
inline |
Definition at line 106 of file indexlist.h.
References IndexIntf::finalize().
|
inlineprivate |
Definition at line 67 of file indexlist.h.
|
inlineprivate |
Definition at line 76 of file indexlist.h.
|
inline |
Definition at line 109 of file indexlist.h.
References IndexIntf::incContentsDepth().
Referenced by PageDefImpl::addSectionsToIndex().
|
inline |
Definition at line 103 of file indexlist.h.
References IndexIntf::initialize().
|
inline |
|
private |
Definition at line 133 of file indexlist.h.
|
private |
Definition at line 135 of file indexlist.h.
|
private |
Definition at line 134 of file indexlist.h.