html_derouleur Class Reference

class html_derouleur is a pure virtual class More...

#include <html_derouleur.hpp>

Inheritance diagram for html_derouleur:

Collaboration diagram for html_derouleur:

Public Member Functions
	html_derouleur (const html_derouleur &ref)=delete
	html_derouleur (html_derouleur &&ref) noexcept=delete
html_derouleur &	operator= (const html_derouleur &ref)=delete
html_derouleur &	operator= (html_derouleur &&ref) noexcept=delete
void	clear ()
	clear all adopted data and remove all sections
void	add_section (const std::string &name, const std::string &title)
void	adopt_in_section (const std::string &section_name, body_builder *obj)
void	adopt_in_section (signed int num, body_builder *obj)
void	clear_section (const std::string &section_name)
void	clear_section (signed int num)
void	remove_section (const std::string &section_name)
void	set_active_section (const std::string &name)
void	set_active_section (signed int num)
unsigned int	size () const
void	section_set_visible (const std::string &name, bool visible)
	hide/unhide a section (Warning! this is not the same thing as shrinking/expanding a section!) More...
void	url_clear_css_classes ()
	set css of URL titles
void	url_add_css_class (const std::string &name)
void	url_add_css_class (const css_class_group &name)
virtual void	on_event (const std::string &event_name) override
	implementation in inherited class of the action triggered by the event given in argument More...
Public Member Functions inherited from body_builder
	body_builder ()
	constructor
	body_builder (const body_builder &ref)
	copy constructor More...
	body_builder (body_builder &&ref) noexcept=delete
	move constructor More...
body_builder &	operator= (const body_builder &ref)
	assignment operator drops all existing children More...
body_builder &	operator= (body_builder &&ref) noexcept=delete
	move operator More...
virtual	~body_builder ()
	the (virtual) destructor
void	set_prefix (const chemin &prefix)
void	adopt (body_builder *obj)
bool	is_adopted () const
	whether the object has currently a parent (= is adopted)
void	foresake (body_builder *obj)
void	set_visible (bool mode)
	ask for the object to become visible in HTML page or temporarily hidden More...
bool	get_visible () const
	returns the current visible status of the object More...
bool	get_visible_recursively () const
	return the effective visible status of an object taking into account all of ancestors that adopted it
void	add_css_class (const std::string &name)
	set this object with a additional css_class (assuming it is defined in a css_library available for this object)
void	add_css_class (const css_class_group &cg)
	set this object with an additional set of css_classes (assuming they are all defined in a css_library available for this object)
bool	has_css_class (const std::string &name) const
	check the presence of the given class name
void	remove_css_class (const std::string &name)
	remove the provided css_class name from the list of css_class names this object has been assigned to
void	remove_css_class (const css_class_group &cg)
	remove the provided css_class_group from the list
void	clear_css_classes ()
	clear the whole list of css_class names
const std::set< std::string > &	get_css_classes_as_a_set () const
	provide the list of css_class names that this object has been set with
css_class_group	get_css_class_group () const
	provide the list of css_class names as a css_class_group
std::string	get_css_classes (const std::string &extra="") const
	return the class_name as inlined css, suitable to be added in a html marker More...
void	define_css_class_in_library (const css_class &csscl)
void	define_css_class_in_library (const std::string &name, const css &cssdef)
bool	is_css_class_defined_in_library (const std::string &name) const
	check whether a css_class of given name already exists in a reachable css_library
std::string	get_body_part (const chemin &path, const request &req)
void	ignore_body_changed_from_my_children (bool mode)
	ignore my_body_part_has_changed() invoked from adopted children and myself More...
bool	get_ignore_body_changed_from_my_children () const
	get the current status of ignore_body_changed_from_my_children()
void	set_no_CR (bool no_cr=true)
	ask for the implementation not to add a new line after this control More...
void	assign_anchor (bool mode)
	assign an anchor to this object (the object's inherited_get_body_part() will be wrapped into an HTML anchor: ) More...
std::string	get_assigned_anchor () const
	return the anchor value that has been assiged to this object (without the leading #) More...
virtual void	bind_to_anchor (const std::string &val)
	ask inherited components to use this anchor in case they redirect to an new URL or generate new URLs within their body part. More...
Public Member Functions inherited from actor
	actor (const actor &ref)=default
	actor (actor &&ref) noexcept(false)=default
actor &	operator= (const actor &ref)=default
actor &	operator= (actor &&ref) noexcept(false)
virtual void	on_event (const std::string &event_name)=0
	implementation in inherited class of the action triggered by the event given in argument More...
Public Member Functions inherited from reference
	reference ()
	usual constructor
	reference (const reference &ref)
	copy constructor More...
	reference (reference &&ref) noexcept(false)
	move constructor (only operational for objects without peering) More...
reference &	operator= (const reference &ref)
	assignment operator (only operational for objects without peering) More...
reference &	operator= (reference &&ref) noexcept(false)
	move assigment operator More...
virtual	~reference ()
	destructor
void	peer_with (reference *obj)
	method used to create a relation between two objects More...
void	break_peer_with (reference *obj)
	break the peering with the object given as argument
bool	is_peer (reference *obj) const
	whether a peering exists with that object
bool	is_empty () const
	whether the current object has peering
unsigned int	size () const
	the number of peers

Protected Member Functions
virtual void	css_classes_have_changed () override
	Be informed about css class modification. More...
virtual std::string	inherited_get_body_part (const chemin &path, const request &req) override
	implementation of get_body_part() method for inherited classes More...
virtual void	new_css_library_available () override
Protected Member Functions inherited from body_builder
virtual std::string	inherited_get_body_part (const chemin &path, const request &req)=0
	implementation of get_body_part() method for inherited classes More...
void	my_body_part_has_changed ()
	let a class record a change in what inherited_get_body_part() would return if it was called again with the same request More...
virtual void	my_visibility_has_changed ()
	available for inherited class to be informed when their visibility changes More...
bool	has_my_body_part_changed () const
	obtain the body_part changed status More...
chemin	get_path () const
	return the path of 'this' according to its descent in the body_builder tree of adopted children
std::string	get_recorded_name () const
void	store_css_library ()
	this creates a css_library accessible from adopted objects to hold html class definitions More...
bool	has_local_css_library () const
	return true if this object has a css_library locally stored (not from a adopter object)
std::unique_ptr< css_library > &	lookup_css_library () const
	lookup toward registered parent body_builder object for the closest stored css_library More...
std::string	get_body_part_from_target_child (const chemin &path, const request &req)
std::string	get_body_part_from_all_children (const chemin &path, const request &req)
virtual void	path_has_changed ()
	For inherited classes, called when the path has changed,. More...
virtual void	has_adopted (body_builder *obj)
	Be informed that a new child has been adopted. More...
virtual void	will_foresake (body_builder *obj)
	Be informed that a child is about to be foresaken. More...
virtual void	has_been_adopted_by (body_builder *obj)
	Be informed that we have been adopted by obj, our new parent.
virtual void	will_be_foresaken_by (body_builder *obj)
	Be informed that we are about to be foresaken by obj, our soon former parent.
virtual void	css_classes_have_changed ()
	Be informed about css class modification. More...
virtual void	new_css_library_available ()
unsigned int	size () const
	access to adopted childs
body_builder *	operator[] (unsigned int i)
	access to adopted childs
body_builder *	get_parent () const
	return the parent object or nullptr if no object has adopted this object
template<class T >
void	closest_ancestor_of_type (T *&ancestor)
	access to the closest ancestor (parent) matching (dynamic_cast) the provided type More...
void	orphan_all_children ()
	orphan all adopted children
bool	get_no_CR () const
	true if it has been requested no to add Carriage Return after the HTML object
Protected Member Functions inherited from reference
virtual void	broken_peering_from (reference *obj)
	to be informed when a peer has broke the peering with me More...
void	reset_read_peers () const
	reset the peers reading
bool	read_next_peer (reference *&peer) const

Detailed Description

class html_derouleur is a pure virtual class

it groups adopted objets under several labeled sections which can be expanded and shrinked, still the section title stay visible, but only one section content is visible at a any given time

Member Function Documentation

css_classes_have_changed()

void html_derouleur::css_classes_have_changed ( )

overrideprotectedvirtual

Be informed about css class modification.

Reimplemented from body_builder.

inherited_get_body_part()

string html_derouleur::inherited_get_body_part ( const chemin &  path, const request &  req  )

overrideprotectedvirtual

implementation of get_body_part() method for inherited classes

Note

this method defines what the class will return from the public method body_builder::get_body_part() which also make some housekeeping at body_builder level. In particular, the body_builder class record the "body_changed" status that is reset before calling inherited_get_body_part() and modified by the inherited class when they call the my_body_part_has_changed(). get_body_part() also caches the result of inherited_get_body_part() to avoid calling inherited_get_body_part() if for the same request it has not signaled (calling my_body_part_has_changed()) that for example an event lead its status to change and would require inherited_get_body_part() to be reevaluated

Implements body_builder.

new_css_library_available()

void html_derouleur::new_css_library_available ( )

overrideprotectedvirtual

this is a trigger, ran when a css_library becomes available in a parent or "this"

Note

this may also be triggered upon adoption by a object having acces to a css_library

Reimplemented from body_builder.

on_event()

void html_derouleur::on_event ( const std::string &  event_name )

overridevirtual

implementation in inherited class of the action triggered by the event given in argument

Implements actor.

section_set_visible()

void html_derouleur::section_set_visible	(	const std::string &	name,
		bool	visible
	)

hide/unhide a section (Warning! this is not the same thing as shrinking/expanding a section!)

Note

invisible section not only shrink (their content is no more visible) but the section title itself disapears and the section does not show at all to the user

---

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

• html_derouleur.hpp
• html_derouleur.cpp