class html_form_radio implements HTML "input" of type "radio" More...

#include <html_form_radio.hpp>

Inheritance diagram for html_form_radio:

[legend]

Collaboration diagram for html_form_radio:

[legend]

Classes
struct	record
	used to record parameters of each option of the radio button More...

Public Member Functions
	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

Static Public Attributes
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...

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_radio implements HTML "input" of type "radio"

these html_form_field objects are set calling add_choice(), clear() set_selected() methods and provide in return the menu selected by the user using get_selected_id() or get_selected_num() These object provide an event "changed" that is triggered when user change the selection of the radio button set. This change is only visible to the application once the user validated the change by clicking the button of the parent or grand-parent html_form.

Member Function Documentation

◆ css_classes_have_changed()

void html_form_radio::css_classes_have_changed ( )

overrideprotectedvirtual

inherited from body_builder

Reimplemented from body_builder.

◆ get_selected_id()

const string & html_form_radio::get_selected_id ( ) const

obtain the id of the selected radio button

Note: if no item is selected exception is thrown (BUG). first check with is_selected() before calling this method

◆ get_selected_num()

unsigned int html_form_radio::get_selected_num ( ) const

inline

obtain the index (starts at zero) of the selected radio button

Note: if nothing is selected the index passed the last valid index is returned

◆ inherited_get_body_part()

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

overrideprotectedvirtual

inherited from body_builder

Implements body_builder.

Reimplemented in html_form_select.

◆ new_css_library_available()

void html_form_radio::new_css_library_available ( )

overrideprotectedvirtual

inherited from html_div/body_builder

Reimplemented from body_builder.

◆ set_selected_id()

void html_form_radio::set_selected_id ( const std::string & id )

set the radio buttons to the item id given in argument

Note: set_selected() and set_selected_id() do the same thing but using different way to design the radio button to select; if provided id is not valid a bug is reported

◆ set_selected_num()

void html_form_radio::set_selected_num ( unsigned int x )

set the radio buttons to item given in argument

Note: index zero is the first choice

◆ set_tooltip()

void html_form_radio::set_tooltip	(	unsigned int	index,
		const std::string &	msg
	)

set tooltip for item at the given index (index starts at zero)

Note: index must stay less than the value returned by num_choices()

◆ unlock_update_field_from_request()

void html_form_radio::unlock_update_field_from_request ( )

protected

unlock update_field_from_request()

Note: when a set_select() call is invoked to avoid a POST request to overwrite at the time of inherited_get_body_part(), update_field_from_request() is ignored and the POST request is not taken into account, until an call to unlock_update_field_from_request() is done. This should be done at the end of inherited_get_body_part()

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

html_form_radio.hpp
html_form_radio.cpp

Classes

Public Member Functions

Static Public Attributes

Protected Member Functions

Detailed Description

Member Function Documentation

◆ css_classes_have_changed()

◆ get_selected_id()

◆ get_selected_num()

◆ inherited_get_body_part()

◆ new_css_library_available()

◆ set_selected_id()

◆ set_selected_num()

◆ set_tooltip()

◆ unlock_update_field_from_request()