Manage visible navigation entries. More...

#include <>>

Public Types
typedef std::map< std::string, std::string >	NavMap
	Navigation map type, mapping URLs to labels. More...

Public Member Functions
	WebNavManager ()
	Constructor. More...

	~WebNavManager ()
	Destructor. More...

void	add_nav_entry (std::string baseurl, std::string name)
	Add a navigation entry. More...

void	remove_nav_entry (std::string baseurl)
	Remove a navigation entry. More...

const NavMap &	get_nav_entries () const
	Get navigation entries. More...

Mutex *	mutex ()
	Get mutex for navigation entries. More...

Detailed Description

Manage visible navigation entries.

This class maintains a map from URLs to names, which are to be added to the page navigation.

Author: Tim Niemueller

Definition at line 33 of file nav_manager.h.

Member Typedef Documentation

◆ NavMap

typedef std::map<std::string, std::string> fawkes::WebNavManager::NavMap

Navigation map type, mapping URLs to labels.

Definition at line 37 of file nav_manager.h.

Constructor & Destructor Documentation

◆ WebNavManager()

fawkes::WebNavManager::WebNavManager ( )

Constructor.

Definition at line 38 of file nav_manager.cpp.

◆ ~WebNavManager()

fawkes::WebNavManager::~WebNavManager ( )

Destructor.

Definition at line 44 of file nav_manager.cpp.

Member Function Documentation

◆ add_nav_entry()

void fawkes::WebNavManager::add_nav_entry	(	std::string	baseurl,
		std::string	name
	)

Add a navigation entry.

Parameters

baseurl	URL for the navigation target
name	name to display to the user

Exceptions

Exception thrown if navigation entry already exists

Definition at line 55 of file nav_manager.cpp.

◆ get_nav_entries()

const NavMap& fawkes::WebNavManager::get_nav_entries ( ) const

inline

Get navigation entries.

Returns: navigation entries map.

Definition at line 47 of file nav_manager.h.

◆ mutex()

Mutex* fawkes::WebNavManager::mutex ( )

inline

Get mutex for navigation entries.

Returns: mutex for navigation entries.

Definition at line 53 of file nav_manager.h.

◆ remove_nav_entry()

void fawkes::WebNavManager::remove_nav_entry ( std::string baseurl )

Remove a navigation entry.