class html_form_mask_expression provide mean to setup libdar::mask component for filename filtering More...

#include <html_form_mask_expression.hpp>

Inheritance diagram for html_form_mask_expression:

[legend]

Collaboration diagram for html_form_mask_expression:

[legend]

Public Member Functions
	html_form_mask_expression (const std::string &subject)
	constructor

	html_form_mask_expression (const html_form_mask_expression &ref)

	html_form_mask_expression (html_form_mask_expression &&ref) noexcept=delete

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

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

void	clear ()
	reset object to default

std::unique_ptr< libdar::mask >	get_mask () const override
	inherited from html_mask

virtual bool	is_relative () const override
	inherited from html_mask

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

virtual void	load_json (const json &source) override
	inherited from jsoner

virtual json	save_json () const override
	inherited from jsoner

virtual void	clear_json () override
	inherited from jsoner

void	manually_set_mask_type (const std::string &mtype)
	manual setup for the type of mask (see type_glob and type_regex static fields above, maybe more in the future)

void	manually_set_negate (bool mode)
	manual setup for the mask negation (true = mask negation set)

void	manually_set_casesensitivity (bool mode)
	manual setup for the case sensitivity (true = case sensitive mask)

void	manually_set_expression (const std::string &expr)
	manual setup for the mask expression

Public Member Functions inherited from body_builder
	body_builder ()
	constructor

	body_builder (const body_builder &ref)
	copy constructor

	body_builder (body_builder &&ref) noexcept=delete
	move constructor

body_builder &	operator= (const body_builder &ref)
	assignment operator drops all existing children

body_builder &	operator= (body_builder &&ref) noexcept=delete
	move operator

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

bool	get_visible () const
	returns the current visible status of the object

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

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

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

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: )

std::string	get_assigned_anchor () const
	return the anchor value that has been assiged to this object (without the leading #)

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.

Public Member Functions inherited from html_mask
	html_mask (const html_mask &ref)=default

	html_mask (html_mask &&ref) noexcept=default

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

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

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)

Public Member Functions inherited from reference
	reference ()
	usual constructor

	reference (const reference &ref)
	copy constructor

	reference (reference &&ref) noexcept(false)
	move constructor (only operational for objects without peering)

reference &	operator= (const reference &ref)
	assignment operator (only operational for objects without peering)

reference &	operator= (reference &&ref) noexcept(false)
	move assigment operator

virtual	~reference ()
	destructor

void	peer_with (reference *obj)
	method used to create a relation between two objects

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 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

Public Member Functions inherited from events
	events (const events &ref)
	copy constructor

	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	changed = "hfme_changed"

static constexpr const char *	type_glob = "glob"

static constexpr const char *	type_regex = "regex"

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

virtual void	new_css_library_available () override
	inherited from body_builder

Protected Member Functions inherited from body_builder
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

virtual void	my_visibility_has_changed ()
	available for inherited class to be informed when their visibility changes

bool	has_my_body_part_changed () const
	obtain the body_part changed status

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

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

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,.

virtual void	has_adopted (body_builder *obj)
	Be informed that a new child has been adopted.

virtual void	will_foresake (body_builder *obj)
	Be informed that a child is about to be foresaken.

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.

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

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
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

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

void	act (const std::string &name)
	trigger a given event

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

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

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 html_form_mask_expression provide mean to setup libdar::mask component for filename filtering

this html components is consitued of:

+----html_fieldset----------------------------------+
|                                                   |
| mask type:  +----------------+                    |
|             |dropdown list   |                    |
|             +----------------+                    |
|                                                   |
|             +--+                                  |
| negate      |  |                                  |
|             +--+                                  |
|             +--+                                  |
| case sensit.|  |                                  |
|             +--+                                  |
|                                                   |
| mask expr.  +----------------------------+        |
|             |  input form                |        |
|             +----------------------------+        |
+---------------------------------------------------+

Note: : this component does must have an html_form object as parent or ancestor for validation to be processed and changes to be recorded. Avoiding including the html_form in that component let it be part of more complex masks like and and or combinasons.

Constructor & Destructor Documentation

◆ html_form_mask_expression()

html_form_mask_expression::html_form_mask_expression ( const std::string & subject )

constructor

Parameters

[in] subject is the name of the type of thing the filters will be applied to. This parameter is used in the synthesis string representing what the filter does: "{subject} matches the regular expression {regex}"

Member Function Documentation

◆ clear_json()

virtual void html_form_mask_expression::clear_json ( )

inlineoverridevirtual

inherited from jsoner

Implements jsoner.

◆ get_mask()

unique_ptr< libdar::mask > html_form_mask_expression::get_mask ( ) const

overridevirtual

inherited from html_mask

Implements html_mask.

◆ inherited_get_body_part()

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

overrideprotectedvirtual

inherited methods from body_builder

Implements body_builder.

◆ is_relative()

virtual bool html_form_mask_expression::is_relative ( ) const

inlineoverridevirtual

inherited from html_mask

Implements html_mask.

◆ load_json()

void html_form_mask_expression::load_json ( const json & source )

overridevirtual

inherited from jsoner

Implements jsoner.

◆ new_css_library_available()

void html_form_mask_expression::new_css_library_available ( )

overrideprotectedvirtual

inherited from body_builder

Reimplemented from body_builder.

◆ on_event()

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

overridevirtual

inherited from actor

Implements actor.

◆ save_json()

json html_form_mask_expression::save_json ( ) const

overridevirtual

inherited from jsoner

Implements jsoner.

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

html_form_mask_expression.hpp
html_form_mask_expression.cpp

Public Member Functions

Static Public Attributes

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ html_form_mask_expression()

Member Function Documentation

◆ clear_json()

◆ get_mask()

◆ inherited_get_body_part()

◆ is_relative()

◆ load_json()

◆ new_css_library_available()

◆ on_event()

◆ save_json()