Basic page reply. More...

#include <>>

Inheritance diagram for fawkes::WebPageReply:

Public Member Functions
	WebPageReply (std::string title, std::string page="")
	Constructor.
virtual const std::string &	body ()
	Get body.
virtual std::string::size_type	body_length ()
	Get length of body.
virtual void	pack ()
	Pack the data.
virtual void	pack (std::string active_baseurl, WebPageHeaderGenerator headergen, WebPageFooterGenerator footergen)
	Pack web page reply.
virtual void	set_html_header (std::string h)
	Set HTML header text.
Public Member Functions inherited from fawkes::StaticWebReply
	StaticWebReply (response_code_t code, std::string body="")
	Constructor.
void	append_body (const char *format,...)
	Append to body.
StaticWebReply &	operator+= (std::string text)
	Append simple text line.
Public Member Functions inherited from fawkes::WebReply
	WebReply (response_code_t code)
	Constructor.
virtual	~WebReply ()
	Destructor.
response_code_t	code () const
	Get response code.
void	add_header (std::string header, std::string content)
	Add a HTTP header.
void	add_header (std::string header_string)
	Add a HTTP header.
const HeaderMap &	headers () const
	get headers.

Protected Member Functions
	WebPageReply (response_code_t code)
	Base constructor.

Protected Attributes
std::string	_title
	Title of the page.
Protected Attributes inherited from fawkes::StaticWebReply
std::string	_body
	Body of the reply.

Detailed Description

Basic page reply.

This reply adds header and footer as appropriate to form a HTML document with logo and navigation.

Author:: Tim Niemueller

Definition at line 36 of file page_reply.h.

Constructor & Destructor Documentation

fawkes::WebPageReply::WebPageReply	(	std::string	title,
		std::string	body = `""`
	)

Constructor.

Parameters:

title	title of the page
body	Optional initial body of the page

Definition at line 62 of file page_reply.cpp.

References _title.

fawkes::WebPageReply::WebPageReply ( response_code_t code )

protected

Base constructor.

Constructor that does not set a title or anything. Use for sub-classes.

Parameters:

code	HTTP code for this reply

Definition at line 73 of file page_reply.cpp.

Member Function Documentation

const std::string & fawkes::WebPageReply::body ( )

virtual

Get body.

Returns:: reference to body.

Reimplemented from fawkes::StaticWebReply.

Definition at line 129 of file page_reply.cpp.

std::string::size_type fawkes::WebPageReply::body_length ( )

virtual

Get length of body.

Returns:: body length

Reimplemented from fawkes::StaticWebReply.

Definition at line 122 of file page_reply.cpp.

virtual void fawkes::WebPageReply::pack ( )

inlinevirtual

Pack the data.

This method is called just before the reply is sent. You can implement this method if you need to compose your reply before body() and body_length() provide valid output.

Reimplemented from fawkes::StaticWebReply.

Definition at line 43 of file page_reply.h.

References pack().

Referenced by pack().

void fawkes::WebPageReply::pack	(	std::string	active_baseurl,
		WebPageHeaderGenerator *	headergen,
		WebPageFooterGenerator *	footergen
	)

virtual

Pack web page reply.

This method creates the final page by calling the header and footer generators if supplied (otherwise a standard header is chosen) and the body.

Parameters:

active_baseurl	the active navigation URL, can be used for instance to high-light the current section in the navigation.
headergen	header generator
footergen	footer generator

Definition at line 100 of file page_reply.cpp.

References fawkes::StaticWebReply::_body, _title, fawkes::WebPageFooterGenerator::html_footer(), fawkes::WebPageHeaderGenerator::html_header(), and fawkes::HostInfo::short_name().

void fawkes::WebPageReply::set_html_header ( std::string h )

virtual

Set HTML header text.

The given text is placed in the head section of the HTML page. You can use it for example to add custom stylesheets or JavaScript.

Parameters:

h	header to set

Definition at line 85 of file page_reply.cpp.

Referenced by RRDWebRequestProcessor::process_request(), WebviewBlackBoardRequestProcessor::process_request(), and ROSWebviewRequestProcessor::process_request().

Member Data Documentation

std::string fawkes::WebPageReply::_title

protected

Title of the page.

Definition at line 55 of file page_reply.h.

Referenced by pack(), fawkes::WebErrorPageReply::WebErrorPageReply(), and WebPageReply().

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

src/libs/webview/page_reply.h
src/libs/webview/page_reply.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation