Fawkes API
Fawkes Development Version
|
Basic page reply. More...
#include <>>
Public Member Functions | |
WebPageReply (std::string title, std::string page="") | |
Constructor. More... | |
virtual const std::string & | body () |
Get body. More... | |
virtual std::string::size_type | body_length () |
Get length of body. More... | |
virtual void | pack () |
Pack the data. More... | |
virtual void | pack (std::string active_baseurl, WebPageHeaderGenerator *headergen, WebPageFooterGenerator *footergen) |
Pack web page reply. More... | |
virtual void | set_html_header (std::string h) |
Set HTML header text. More... | |
void | set_navbar_enabled (bool enabled) |
Enable or disable the Fawkes Navigationbar (default enabled) More... | |
bool | get_navbar_enabled () |
Is the Fawkes Navigation bar enabled? More... | |
void | set_footer_enabled (bool enabled) |
Enable or disable the Fawkes Webview footer (default enabled) More... | |
bool | get_footer_enabled () |
Is the Fawkes Webview footer enabled? More... | |
![]() | |
StaticWebReply (Code code, std::string body="") | |
Constructor. More... | |
void | append_body (const char *format,...) |
Append to body. More... | |
StaticWebReply & | operator+= (std::string text) |
Append simple text line. More... | |
![]() | |
WebReply (Code code) | |
Constructor. More... | |
virtual | ~WebReply () |
Destructor. More... | |
Code | code () const |
Get response code. More... | |
void | add_header (std::string header, std::string content) |
Add a HTTP header. More... | |
void | add_header (std::string header_string) |
Add a HTTP header. More... | |
const HeaderMap & | headers () const |
get headers. More... | |
void | set_request (WebRequest *request) |
Set associated request. More... | |
WebRequest * | get_request () const |
Get associated request. More... | |
Protected Member Functions | |
WebPageReply (Code code) | |
Base constructor. More... | |
Protected Attributes | |
std::string | _title |
Title of the page. More... | |
![]() | |
std::string | _body |
Body of the reply. More... | |
Basic page reply.
This reply adds header and footer as appropriate to form a HTML document with logo and navigation.
Definition at line 36 of file page_reply.h.
fawkes::WebPageReply::WebPageReply | ( | std::string | title, |
std::string | body = "" |
||
) |
Constructor.
title | title of the page |
body | Optional initial body of the page |
Definition at line 63 of file page_reply.cpp.
References _title, and fawkes::WebReply::add_header().
Referenced by pack().
|
protected |
Base constructor.
Constructor that does not set a title or anything. Use for sub-classes.
code | HTTP code for this reply |
Definition at line 78 of file page_reply.cpp.
References fawkes::WebReply::add_header().
|
virtual |
Get body.
Reimplemented from fawkes::StaticWebReply.
Definition at line 138 of file page_reply.cpp.
|
virtual |
Get length of body.
Reimplemented from fawkes::StaticWebReply.
Definition at line 131 of file page_reply.cpp.
bool fawkes::WebPageReply::get_footer_enabled | ( | ) |
Is the Fawkes Webview footer enabled?
Definition at line 171 of file page_reply.cpp.
Referenced by pack().
bool fawkes::WebPageReply::get_navbar_enabled | ( | ) |
Is the Fawkes Navigation bar enabled?
Definition at line 155 of file page_reply.cpp.
Referenced by 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 fawkes::WebReply::code(), get_footer_enabled(), get_navbar_enabled(), pack(), set_footer_enabled(), set_html_header(), set_navbar_enabled(), and WebPageReply().
Referenced by fawkes::dynamic_reply_free_cb(), and pack().
|
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.
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 109 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_footer_enabled | ( | bool | enabled | ) |
Enable or disable the Fawkes Webview footer (default enabled)
enabled | enabled |
Definition at line 163 of file page_reply.cpp.
Referenced by pack().
|
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.
h | header to set |
Definition at line 94 of file page_reply.cpp.
Referenced by pack(), RRDWebRequestProcessor::process_request(), WebviewBlackBoardRequestProcessor::process_request(), ROSWebviewRequestProcessor::process_request(), and WebviewPtzCamRequestProcessor::process_request().
void fawkes::WebPageReply::set_navbar_enabled | ( | bool | enabled | ) |
Enable or disable the Fawkes Navigationbar (default enabled)
enabled | enabled |
Definition at line 147 of file page_reply.cpp.
Referenced by pack().
|
protected |
Title of the page.
Definition at line 60 of file page_reply.h.
Referenced by pack(), fawkes::WebErrorPageReply::WebErrorPageReply(), and WebPageReply().