doxygen
Public Member Functions | Static Public Member Functions | List of all members
SectionManager Class Reference

singleton class that owns the list of all sections More...

#include <section.h>

Inheritance diagram for SectionManager:
Inheritance graph
[legend]
Collaboration diagram for SectionManager:
Collaboration graph
[legend]

Public Member Functions

SectionInfoadd (const SectionInfo &si)
 Add a new section given the data of an existing section. More...
 
SectionInfoadd (const QCString &label, const QCString &fileName, int lineNr, const QCString &title, SectionType type, int level, const QCString &ref=QCString())
 Add a new section Return a non-owning pointer to the newly added section.
 
SectionInforeplace (const QCString &label, const QCString &fileName, int lineNr, const QCString &title, SectionType type, int level, const QCString &ref=QCString())
 Replace an existing section with a new one Return a non-owning pointer to the newly added section.
 
- Public Member Functions inherited from LinkedMap< SectionInfo >
const SectionInfofind (const std::string &key) const
 Find an object given the key. More...
 
const SectionInfofind (const QCString &key) const
 Find an object given the key. More...
 
const SectionInfofind (const char *key) const
 Find an object given the key. More...
 
SectionInfofind (const char *key)
 A non-const wrapper for find() const.
 
SectionInfofind (const QCString &key)
 A non-const wrapper for find() const.
 
SectionInfofind (const std::string &key)
 A non-const wrapper for find() const.
 
SectionInfoadd (const char *k, Args &&... args)
 Adds a new object to the ordered vector if it was not added already. More...
 
SectionInfoadd (const QCString &k, Args &&... args)
 
SectionInfoadd (const char *k, Ptr &&ptr)
 Adds an existing object to the ordered vector (unless another object was already added under the same key). More...
 
SectionInfoadd (const QCString &k, Ptr &&ptr)
 
SectionInfoprepend (const char *k, Args &&... args)
 Prepends a new object to the ordered vector if it was not added already. More...
 
SectionInfoprepend (const QCString &key, Args &&... args)
 
bool del (const QCString &key)
 Removes an object from the container and deletes it. More...
 
Ptr & operator[] (size_t pos)
 
const Ptr & operator[] (size_t pos) const
 
iterator begin ()
 
const_iterator begin () const
 
iterator end ()
 
const_iterator end () const
 
reverse_iterator rbegin ()
 
const_reverse_iterator rbegin () const
 
reverse_iterator rend ()
 
const_reverse_iterator rend () const
 
bool empty () const
 
size_t size () const
 
void clear ()
 

Static Public Member Functions

static SectionManagerinstance ()
 returns a reference to the singleton
 

Additional Inherited Members

- Public Types inherited from LinkedMap< SectionInfo >
using Ptr = std::unique_ptr< SectionInfo >
 
using Vec = std::vector< Ptr >
 
using iterator = typename Vec::iterator
 
using const_iterator = typename Vec::const_iterator
 
using reverse_iterator = typename Vec::reverse_iterator
 
using const_reverse_iterator = typename Vec::const_reverse_iterator
 

Detailed Description

singleton class that owns the list of all sections

Member Function Documentation

◆ add()

SectionInfo* SectionManager::add ( const SectionInfo si)
inline

Add a new section given the data of an existing section.

Returns a non-owning pointer to the newly added section.


The documentation for this class was generated from the following file: