html component implementing the usual hyperlink component More...

#include <html_static_url.hpp>

Inheritance diagram for html_static_url:

[legend]

Collaboration diagram for html_static_url:

[legend]

Public Member Functions
	html_static_url (const std::string &url, const std::string &label)

	html_static_url (const html_static_url &ref)=default

	html_static_url (html_static_url &&ref) noexcept=delete

html_static_url &	operator= (const html_static_url &ref)=default

html_static_url &	operator= (html_static_url &&ref) noexcept=delete

void	change_label (const std::string &newlabel)

const std::string &	get_label () const

virtual std::string	get_body_part () const override
	inherited from static_body_builder More...

Public Member Functions inherited from html_url
	html_url (const std::string &url)

	html_url (const html_url &ref)=default

	html_url (html_url &&ref) noexcept=delete

html_url &	operator= (const html_url &ref)=default

html_url &	operator= (html_url &&ref) noexcept=delete

void	change_url (const std::string &newurl)

const std::string &	get_url () const

virtual void	bind_to_anchor (const std::string &val) override
	inherited from body_builder More...

void	set_download (bool mode)
	whether to download or display the URL target

void	set_filename (const std::string &name)

void	set_target_new_page (bool mode)
	open a new page (_blank target)

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 static_body_builder
	static_body_builder (const static_body_builder &ref)=default

	static_body_builder (static_body_builder &&ref) noexcept=default

static_body_builder &	operator= (const static_body_builder &ref)=default

static_body_builder &	operator= (static_body_builder &&ref) noexcept=default

virtual std::string	get_body_part () const =0

Protected Member Functions
void	adopt (body_builder *obj)

Protected Member Functions inherited from html_url
virtual std::string	inherited_get_body_part (const chemin &path, const request &req) override
	inherited from body_builder More...

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

Detailed Description

html component implementing the usual hyperlink component

Member Function Documentation

◆ adopt()

void body_builder::adopt ( body_builder * obj )

protected

Common interface for classes that have to ask other body_builder to contribute in building their body_part()

this call is not mandatory, but let a body_builder object the possibility to rely on the set of body_builder available protected routines to recursively build the body part from the list of adopted children. An object can only have one parent.

Note: this call semantic is that the adopted object becomes a child of the body_builder. The adopted child stays managed by its real parent, the adoption relationship builds a tree of dependant objects using one another to provide a body_part (see get_body_part() method). this tree is automatically broken when an object is destroyed, in that way all recorded children exist (the recorded addresses always points to real existing objects)

◆ get_body_part()

string html_static_url::get_body_part ( ) const

overridevirtual

inherited from static_body_builder

Implements static_body_builder.

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

html_static_url.hpp
html_static_url.cpp

Public Member Functions

Protected Member Functions

Detailed Description

Member Function Documentation

◆ adopt()

◆ get_body_part()