class guichet let one fetch config from a bibliotheque, save as or setup manually for a given component type More...

#include <guichet.hpp>

Inheritance diagram for guichet:

[legend]

Collaboration diagram for guichet:

[legend]

Public Member Functions
	guichet (bool subcomponent=false)
	constructor More...

	guichet (const guichet &ref)=delete

	guichet (guichet &&ref) noexcept=delete

guichet &	operator= (const guichet &ref)=delete

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

void	set_child (const std::shared_ptr< bibliotheque > &ptr, bibliotheque::category cat, const std::shared_ptr< body_builder > &to_adopt, bool add_form_around)
	mandatory call to provide the object to adopt and use to display configurations More...

virtual void	load_json (const json &source) override
	inherited from jsoner (used when this object is used as subconfig of another object) More...

virtual json	save_json () const override
	inherited from jsoner (used when this object is used as subconfig of another object) More...

virtual void	clear_json () override
	inherited from jsoner (used when this object is used as subconfig of another object) More...

virtual bibliotheque::using_set	get_using_set () const override
	inherited from bibliotheque_subconfig More...

virtual void	on_event (const std::string &event_name) override
	inherited from actor More...

void	load_from_bibliotheque (const std::string &name)
	load a config of given name (in the category defined by set_child)* More...

virtual void	bind_to_anchor (const std::string &val) override
	inherited from body_builder 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 jsoner
	jsoner (const jsoner &ref)=default

	jsoner (jsoner &&ref) noexcept(false)=default

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

jsoner &	operator= (jsoner &&ref) noexcept(false)=default

virtual void	load_json (const json &source)=0
	setup the components from the json provided information More...

virtual json	save_json () const =0
	produce a json structure from the component configuration More...

virtual void	clear_json ()=0
	instruct the object to get to its default/initial configuration More...

virtual bibliotheque::using_set	get_using_set () const =0
	provide a standard mean for an object to tell its configuration relies on other configuration(s) 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 std::string	inherited_get_body_part (const chemin &path, const request &req) override
	inherited from body_builder More...

virtual void	new_css_library_available () 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

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

Additional Inherited Members
Static Protected Member Functions inherited from jsoner
static json	wrap_config_with_json_header (unsigned int version, const std::string &class_id, const json &config)
	given a version, class_id and configuration generates the global and common json structure More...

static json	unwrap_config_from_json_header (const json &source, unsigned int &version, std::string &class_id)
	from a given json global and common json structure split header parts and return the config part More...

Static Protected Member Functions inherited from bibliotheque_subconfig
static void	subconfig_add_to (bibliotheque::using_set &added_to, const bibliotheque::using_set &to_add)
	helper routing for objects of inheriting of that class

Static Protected Attributes inherited from jsoner
static constexpr const char *	jsoner_version_label = "version"

static constexpr const char *	jsoner_id_label = "class_id"

static constexpr const char *	jsoner_config_label = "config"

Detailed Description

class guichet let one fetch config from a bibliotheque, save as or setup manually for a given component type

the given component is adopted by the guichet and is shown only in manual mode, else it is hidden, but it always updated by the config from the bibliotheque and used to fetch libdar formated options set. The guichet object adds a drop-down list of available configurations for that objects (found in the provided bibliotheque), beside several buttons:

edit : which lead the component to show and the dropbox to be set to manual mode

save-as : in manual mode to save the current configuration as a new one in the bibliotheque (the save-as button is associated to a box to provide a name)

+--------<form>-----------------------------------+
| +----------------------------------+            |
    | | <drop down> list (incl. "manual")|            |
| +----------------------------------+            |
|                                                 |
+---<update>--------------------------------------+

(to_adopt object show only in "manual" mode)
+-----------<optional form around to_adopt>-------+
| < to_adopt>                                     |
|                                                 |
+---<update>--------------------------------------+

(edit shows if non-"manual" choice is selected here above)
(clear shows only in "manual" mode)
+---------------+ +---------------+
| edit config   | | clear config  |
+---------------+ +---------------+

(the below form only shows if to_adopt is visible ("manual" mode))
+---<save-as-form>--------------------------------+
|                     +-------------------------+ |
| configuration name  |                         | |
|                     +-------------------------+ |
|                                                 |
+---<save as>-------------------------------------+

Constructor & Destructor Documentation

◆ guichet()

guichet::guichet ( bool subcomponent = false )

constructor

Parameters

[in] subcomponent has to be set to true when it is used as indirect (or direct) subcomponent of another mask object (for example another guichet object) and used to refer existing configurations from a bibliotheque. This avoids the form to be used, the edit button to show, and other cosmetic things. By oposition, it should be left to false, when used directly in non-configuration components.

Member Function Documentation

◆ bind_to_anchor()

void guichet::bind_to_anchor ( const std::string & val )

overridevirtual

inherited from body_builder

Reimplemented from body_builder.

◆ clear_json()

void guichet::clear_json ( )

overridevirtual

inherited from jsoner (used when this object is used as subconfig of another object)

Implements jsoner.

◆ get_using_set()

bibliotheque::using_set guichet::get_using_set ( ) const

overridevirtual

inherited from bibliotheque_subconfig

Implements bibliotheque_subconfig.

◆ inherited_get_body_part()

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

overrideprotectedvirtual

inherited from body_builder

Implements body_builder.

◆ load_from_bibliotheque()

void guichet::load_from_bibliotheque ( const std::string & name )

inline

load a config of given name (in the category defined by set_child)*

Note: exception thrown if the requested configuration does not exist

◆ load_json()

void guichet::load_json ( const json & source )

overridevirtual

inherited from jsoner (used when this object is used as subconfig of another object)

Implements jsoner.

◆ new_css_library_available()

void guichet::new_css_library_available ( )

overrideprotectedvirtual

inherited from body_builder

Reimplemented from body_builder.

◆ on_event()

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

overridevirtual

inherited from actor

Implements actor.

◆ save_json()

json guichet::save_json ( ) const

overridevirtual

inherited from jsoner (used when this object is used as subconfig of another object)

Implements jsoner.

◆ set_child()

void guichet::set_child	(	const std::shared_ptr< bibliotheque > &	ptr,
		bibliotheque::category	cat,
		const std::shared_ptr< body_builder > &	to_adopt,
		bool	add_form_around
	)

mandatory call to provide the object to adopt and use to display configurations

Parameters

[in]	ptr	the bibliotheque object where to fetch from configurations
[in]	cat	the category for configurations to use in the bibliotheque
[in]	to_adopt	a body_builder and a jsoner inherited object to adopt and apply configurations to. Important: the pointed to object by to_adopt is not expected to be changed during the lifetime of this guichet object!
[in]	add_form_around	adopt to_adopt in a form in turn adopted by "this" (needed for to update components manually when they do not include a form themselves).

Note: the to_adopt pointed to object is interrogated directly by owner of guichet to fetch the specific object properties, guichet only uses its jsoner interface, it is also expected to be a body_builder inherited object for it can be adopted by "this", and of course it must not have already been adopted. This object will not be visible when using an existing configuration in the bibliotheque, or visible when setup manually.; the object that owns the guichet should not fetch json stuff from the to_adopt object but should pass through this guichet object to either get the to_adopted json config (wrapped with some metadata provided by guichet) or a guichet structure pointing to the configuration name to use in the bibliotheque.

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

guichet.hpp
guichet.cpp

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ guichet()

Member Function Documentation

◆ bind_to_anchor()

◆ clear_json()

◆ get_using_set()

◆ inherited_get_body_part()

◆ load_from_bibliotheque()

◆ load_json()

◆ new_css_library_available()

◆ on_event()

◆ save_json()

◆ set_child()