saisie Class Reference

class saisie More...

#include <saisie.hpp>

Inheritance diagram for saisie:

Collaboration diagram for saisie:

Public Member Functions
	saisie ()
	constructor More...
	saisie (const saisie &ref)=delete
	saisie (saisie &&ref) noexcept=delete
saisie &	operator= (const saisie &ref)=delete
saisie &	operator= (saisie &&ref) noexcept=delete
virtual void	on_event (const std::string &event_name) override
	inherited from actor More...
std::string	get_archive_path () const
std::string	get_archive_basename () const
libdar::archive_options_read	get_read_options (std::shared_ptr< html_web_user_interaction > dialog) const
const std::string &	get_fs_root () const
const libdar::archive_options_extract	get_extraction_options () const
const libdar::archive_options_diff	get_comparison_options () const
const libdar::archive_options_test	get_testing_options () const
libdar::archive_options_create	get_creating_options (std::shared_ptr< html_web_user_interaction > dialog) const
const std::string &	get_isolating_path () const
const std::string &	get_isolating_basename () const
libdar::archive_options_isolate	get_isolating_options (std::shared_ptr< html_web_user_interaction > dialog) const
const std::string &	get_merge_path () const
const std::string &	get_merge_basename () const
libdar::archive_options_merge	get_merging_options (std::shared_ptr< html_web_user_interaction > dialog) const
std::string	get_repairing_path () const
std::string	get_repairing_basename () const
libdar::archive_options_repair	get_repairing_options (std::shared_ptr< html_web_user_interaction > dialog) const
bool	do_we_list () const
void	set_session_name (const std::string &name)
std::string	get_session_name () const
	get the current session name
void	set_username (const std::string &username)
	define the username that the current session is owned by
void	set_data_place (std::shared_ptr< html_fichier > &ref)
	define the location where to drop data content before triggering the event_download
Public Member Functions inherited from html_page
	html_page (const std::string &title="")
	html_page (const html_page &ref)=delete
	html_page (html_page &&ref) noexcept=delete
html_page &	operator= (const html_page &ref)=delete
html_page &	operator= (html_page &&ref) noexcept=delete
void	set_title (const std::string &title)
	change page title
const std::string &	get_title () const
	get current title
void	set_refresh_redirection (unsigned int seconds, const std::string &url)
const std::string &	get_refresh_redirection () const
	get current deridection url
Public Member Functions inherited from html_level
	html_level (const html_level &ref)=delete
	html_level (html_level &&ref) noexcept=delete
html_level &	operator= (const html_level &ref)=delete
html_level &	operator= (html_level &&ref) noexcept=delete
void	adopt_static_html (const std::string &html)
	used in concurrency with body_builder::adopt()
void	clear_children ()
	clear all adopted data
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 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
Public Member Functions inherited from events
	events (const events &ref)
	copy constructor More...
	events (events &&ref) noexcept(false)=default
events &	operator= (const events &ref)=default
events &	operator= (events &&ref) noexcept(false)
void	record_actor_on_event (actor *ptr, const std::string &name)
	record an actor for an given event

Static Public Attributes
static const std::string	event_closing = "saisie_closing"
	available event for that class
static const std::string	event_restore = "saisie_restore"
static const std::string	event_compare = "saisie_compare"
static const std::string	event_test = "saisie_test"
static const std::string	event_list = "saisie_list"
static const std::string	event_summary = "saisie_summ"
static const std::string	event_create = "saisie_create"
static const std::string	event_isolate = "saisie_isolate"
static const std::string	event_merge = "saisie_merge"
static const std::string	event_repair = "saisie_repair"
static const std::string	changed_session_name = "saisie_changed_session_name"
static const std::string	event_disconn = "saisie_disconn"
static const std::string	event_download = "saisie_download"

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 html_page
virtual std::string	inherited_get_body_part (const chemin &path, const request &req) override
	inherited from body_builder More...
std::string	get_body_part_given_the_body (const chemin &path, const request &req, const std::string &body)
	encapsulate the provided body into an complete html formatted page
Protected Member Functions inherited from html_level
virtual void	has_adopted (body_builder *obj) override
	inherited from body_builder More...
virtual void	will_foresake (body_builder *obj) override
	inherited from body_builder More...
void	reset_read_next ()
bool	read_next (bundle &bdl) const
	return false if bdl could not be set (nor more entry to read)
std::string	get_body_part_from_children_as_a_block (const chemin &path, const request &req)
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
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
Protected Member Functions inherited from events
virtual void	broken_peering_from (reference *obj) override
	inherited from class reference More...
void	register_name (const std::string &name)
	add a new event for actors to register against
void	unregister_name (const std::string &name)
	remove an event and remove all actors that registed on it
void	rename_name (const std::string &old_name, const std::string &new_name)
	rename an event and keep all existing peering to this new event More...
void	act (const std::string &name)
	trigger a given event

Detailed Description

class saisie

defines the web "pages" when no operation is running in the current session.

• on the left a menu 'choices' that triggers 'this' to modify the middle and top area
• on the right a html_div right_pan contains two main components, archive_show on top and select on the bottom
• 'archive_show' let the user define the archive to read for isolation, creation, merging, repairing archive_show is hidden

• just below and beside the menu, an html_aiguille "select" shows the different "pages" for parameters and options depending on the selection action

  Note

  the downloading process is the following: this object as first to be set set_data_place() Upon download event from html_bibliotheque field (h_biblio), which triggers the browser to save to file the body of the next http response, the saisie object stores to the provided html_fichier by mean of set_data_place() the content of the bibliotheque (field biblio) as json file and triggers the event_download event (which is registered by the user_interface class, mainly).

  +-------------------------------+
  |        disco(html_disconnect) |
  +---------+---------------------+
  | choices | right_pan           |
  | (menu)  |+-------------------+|
  |         ||archive_show       ||
  |         ||(for read actions) ||
  |         |+-------------------+|
  |         |+-------------------+|
  |         ||select             ||
  |         ||(a page for each   ||
  |         || action)           ||
  |         ||                   ||
  |         |+-------------------+|
  +---------+---------------------+

Constructor & Destructor Documentation

saisie()

saisie::saisie

(

)

constructor

configuration of "select"

Member Function Documentation

inherited_get_body_part()

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

overrideprotectedvirtual

inherited from body_builder

we redirect to the root path -> a chooser object answers to this URL

Reimplemented from html_page.

new_css_library_available()

void saisie::new_css_library_available ( )

overrideprotectedvirtual

inherited from body_builder

Reimplemented from html_tooltip.

on_event()

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

overridevirtual

inherited from actor

Implements actor.

set_session_name()

void saisie::set_session_name ( const std::string &  name )

inline

defines the name of the session

Note

this call does not trigger any event

---

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

• saisie.hpp
• saisie.cpp