class html_text manage text and header in html document More...

#include <html_text.hpp>

Inheritance diagram for html_text:

[legend]

Collaboration diagram for html_text:

[legend]

Public Member Functions
	html_text (unsigned int level, const std::string &text)

	html_text (const html_text &ref)=default

	html_text (html_text &&ref) noexcept=delete

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

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

void	add_text (unsigned int level, const std::string &text)

html_text &	add_nl ()

html_text &	add_paragraph ()

void	set_raw_value (const std::string &val)
	clear and replace component value by the provided string More...

std::string	get_raw_value () const
	get raw value

void	clear ()
	clear the whole component value (gets as if it was just created)

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

Public Member Functions inherited from html_tooltip
	html_tooltip ()

	html_tooltip (const html_tooltip &ref)=default

	html_tooltip (html_tooltip &&ref) noexcept=delete

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

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

const std::string &	get_tooltip () const
	get the helper string to show as popup

void	set_tooltip (const std::string &helper)
	set the helper to the tooltip (helper popup)

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
virtual std::string	inherited_get_body_part (const chemin &path, const request &req) override
	inherited from body_builder More...

Protected Member Functions inherited from html_tooltip
virtual void	new_css_library_available () override
	inherited from body_builder More...

virtual void	has_adopted (body_builder *obj)
	inherited from body builder More...

std::string	get_tooltip_body_part () const

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

class html_text manage text and header in html document

Note: this class allow user to add by step, at each addition the level tells whether the given text to add is normal text (level 0) or header text (1 for h1, 2 for h2, and so on) some additional methods add new paragraph (

markup) or newline (
) header markup (<h*>) receive the css_class assigned to this object

Examples: /home/denis/Webdar/webdar/src/html_form_input_file.hpp.

Member Function Documentation

◆ add_text()

void html_text::add_text	(	unsigned int	level,
		const std::string &	text
	)

adding text

Parameters

[in]

level

set to 1 for

text

etc. and zero for normal text

Parameters

[in] text is the text to add under the provided level

◆ get_body_part()

string html_text::get_body_part ( ) const

overridevirtual

inherited from static_body_builder

Implements static_body_builder.

◆ inherited_get_body_part()

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

overrideprotectedvirtual

inherited from body_builder

Implements body_builder.

◆ set_raw_value()

void html_text::set_raw_value ( const std::string & val )

inline

clear and replace component value by the provided string

Note: the provided string is used as is and is assumed to comply with HTML text

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

html_text.hpp
html_text.cpp

Public Member Functions