html_form_select Class Reference

class html_form_select implements HTML input of type "select" More...

#include <html_form_select.hpp>

Inheritance diagram for html_form_select:

Collaboration diagram for html_form_select:

Public Member Functions
	html_form_select (const std::string &label, const std::string &x_event_name="")
	default event name for all object of this class More...
	html_form_select (const html_form_select &ref)
	html_form_select (html_form_select &&ref) noexcept=delete
html_form_select &	operator= (const html_form_select &ref)=delete
html_form_select &	operator= (html_form_select &&ref) noexcept=delete
void	change_label (const std::string &label)
virtual void	on_event (const std::string &x_event_name) override
	inherited from actor More...
unsigned int	size () const
	number of available choices provided to the web user by this object
const std::string &	get_id (unsigned int index) const
	provides recorded item id More...
const std::string &	get_label (unsigned int index) const
	provides recorded item label More...
void	set_enabled (bool val)
	set whether the HTML control is enable or disabled
void	set_tooltip (const std::string &msg)
	set tooltip for the html label of the input form
Public Member Functions inherited from html_form_radio
	html_form_radio ()
	default event name for all object of this class
	html_form_radio (const html_form_radio &ref)=default
	html_form_radio (html_form_radio &&ref) noexcept=delete
html_form_radio &	operator= (const html_form_radio &ref)=default
html_form_radio &	operator= (html_form_radio &&ref) noexcept=delete
void	add_choice (const std::string &id, const std::string &label)
void	clear ()
void	set_selected_num (unsigned int x)
	set the radio buttons to item given in argument More...
void	set_selected_id (const std::string &id)
	set the radio buttons to the item id given in argument More...
void	set_selected_id_with_warning (const std::string &id, const std::string &jlabel)
	same as set_selected_id but issue a friendly warning build with jlabel for user understanding
void	unset_selected ()
	unselect all radio buttons
bool	is_selected () const
	returns whether a radio button is selected
unsigned int	get_selected_num () const
	obtain the index (starts at zero) of the selected radio button More...
const std::string &	get_selected_id () const
	obtain the id of the selected radio button More...
void	set_emphase (unsigned int num)
	index of the item to display in bold
void	set_emphase ()
	disable emphasing a particular item (default behavior)
const unsigned int	num_choices () const
	the number of currently available options
void	set_change_event_name (const std::string &name)
	change the default value for the "changed" event
void	set_enabled (bool val)
	set whether the HTML control is enable or disabled
void	set_tooltip (unsigned int index, const std::string &msg)
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 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
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 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...

Static Public Attributes
static const std::string	changed = "html_form_select_changed"
Static Public Attributes inherited from html_form_radio
static const std::string	changed = "html_form_radio::changed"

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_form_radio
virtual std::string	inherited_get_body_part (const chemin &path, const request &req) override
	inherited from body_builder More...
virtual void	css_classes_have_changed () override
	inherited from body_builder More...
virtual void	new_css_library_available () override
	inherited from html_div/body_builder More...
const std::vector< record > &	get_choices () const
void	update_field_from_request (const request &req)
void	unlock_update_field_from_request ()
	unlock update_field_from_request() 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 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
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

Detailed Description

class html_form_select implements HTML input of type "select"

It should be adopted directly or not by an html_form object. It shows a dropdown list of choices the user has to select. To setup the available choices use the add_choice(), clear() methods. To obtain the value selected by the user, use the get_selected_id() or get_selected_num() methods. Note that the change only occurs when the form is submited by the browser. As result of this POST action if the user changed the field, the object triggers the 'changed' event other objects can register on to be notified of change

Constructor & Destructor Documentation

html_form_select()

html_form_select::html_form_select	(	const std::string &	label,
		const std::string &	x_event_name = ""
	)

default event name for all object of this class

constructor

Parameters

[in]	label	is what name shows to the user
[in]	x_event_name	is the event to register upon change on this object

Note

if x_event_name is not given or is an empty string the even to register is given by the value of html_form_select::changed

Member Function Documentation

get_id()

const std::string & html_form_select::get_id ( unsigned int  index ) const

inline

provides recorded item id

Note

index should be equal or greater than zero and strictly less than size()

get_label()

const std::string & html_form_select::get_label ( unsigned int  index ) const

inline

provides recorded item label

Note

index should be equal or greater than zero and strictly less than size()

inherited_get_body_part()

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

overrideprotectedvirtual

inherited from body_builder

Reimplemented from html_form_radio.

on_event()

virtual void html_form_select::on_event ( const std::string &  x_event_name )

inlineoverridevirtual

inherited from actor

Implements actor.

Reimplemented in html_compression, html_crypto_algo, and html_hash_algo.

---

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

• html_form_select.hpp
• html_form_select.cpp