fawkes::WebNavManager Class Reference

Manage visible navigation entries. More...

#include <>>

List of all members.

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

Public Member Functions
	WebNavManager ()
	Constructor.
	~WebNavManager ()
	Destructor.
void	add_nav_entry (std::string baseurl, std::string name)
	Add a navigation entry.
void	remove_nav_entry (std::string baseurl)
	Remove a navigation entry.
const NavMap &	get_nav_entries () const
	Get navigation entries.
Mutex *	mutex ()
	Get mutex for navigation entries.

---

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 36 of file nav_manager.h.

---

Member Typedef Documentation

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

Navigation map type, mapping URLs to labels.

Definition at line 40 of file nav_manager.h.

---

Constructor & Destructor Documentation

fawkes::WebNavManager::WebNavManager

(

)

Constructor.

Definition at line 42 of file nav_manager.cpp.

fawkes::WebNavManager::~WebNavManager

(

)

Destructor.

Definition at line 49 of file nav_manager.cpp.

---

Member Function Documentation

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 61 of file nav_manager.cpp.

Referenced by RRDWebThread::init(), and WebviewThread::init().

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

inline

Get navigation entries.

Returns:

navigation entries map.

Definition at line 49 of file nav_manager.h.

Mutex* fawkes::WebNavManager::mutex ( )

inline

Get mutex for navigation entries.

Returns:

mutex for navigation entries.

Definition at line 51 of file nav_manager.h.

void fawkes::WebNavManager::remove_nav_entry

(

std::string

baseurl

)

Remove a navigation entry.

Parameters:

baseurl

URL for which to remove the navigation entry.

Definition at line 76 of file nav_manager.cpp.

Referenced by RRDWebThread::finalize(), ROSWebviewThread::finalize(), and WebviewThread::finalize().

---

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

• src/libs/webview/nav_manager.h
• src/libs/webview/nav_manager.cpp