Webdar 1.0.0
Web user interface to libdar
Public Member Functions | Protected Member Functions | List of all members
html_label Class Reference

class html_label implements label and tooltips (helper string showing when mouse hovering) More...

#include <html_label.hpp>

Inheritance diagram for html_label:
Inheritance graph
[legend]
Collaboration diagram for html_label:
Collaboration graph
[legend]

Public Member Functions

 html_label (const std::string &x_label)
 
 html_label (const std::string &x_label, const std::string &x_tooltip)
 
 html_label (const html_label &ref)=default
 
 html_label (html_label &&ref) noexcept=delete
 
html_labeloperator= (const html_label &ref)=default
 
html_labeloperator= (html_label &&ref) noexcept=delete
 
void set_label (const std::string &val)
 change the label value from the value provided at construction time
 
const std::string & get_label () const
 get the current value of the label
 
void set_emphase (bool em)
 set the label in bold or equivalent method to emphase it compare to the others
 
void set_for_field (const std::string &val)
 define the 'for' field to link this label to other CSS structure
 
const std::string & get_for_field () const
 read the current 'for' field value
 
virtual std::string get_body_part () const override
 inherited from static_body_builder More...
 
- Public Member Functions inherited from html_tooltip
 html_tooltip ()
 
 html_tooltip (const html_tooltip &ref)=default
 
 html_tooltip (html_tooltip &&ref) noexcept=delete
 
html_tooltipoperator= (const html_tooltip &ref)=default
 
html_tooltipoperator= (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_builderoperator= (const body_builder &ref)
 assignment operator drops all existing children More...
 
body_builderoperator= (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 static_body_builder
 static_body_builder (const static_body_builder &ref)=default
 
 static_body_builder (static_body_builder &&ref) noexcept=default
 
static_body_builderoperator= (const static_body_builder &ref)=default
 
static_body_builderoperator= (static_body_builder &&ref) noexcept=default
 
virtual std::string get_body_part () const =0
 

Protected Member Functions

virtual std::string inherited_get_body_part (const chemin &path, const request &req) override
 inherited from body_builder More...
 
virtual void has_adopted (body_builder *obj)
 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_builderoperator[] (unsigned int i)
 access to adopted childs
 
body_builderget_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
 

Detailed Description

class html_label implements label and tooltips (helper string showing when mouse hovering)

it is not expect to adopt any child, but to be adopted

Constructor & Destructor Documentation

◆ html_label() [1/2]

html_label::html_label ( const std::string &  x_label)
Parameters
[in]x_labelthe text to show as label

◆ html_label() [2/2]

html_label::html_label ( const std::string &  x_label,
const std::string &  x_tooltip 
)
Parameters
[in]x_labelthe text to show as label
[in]x_tooltipsthe helper text that should popup upon mouse hover

Member Function Documentation

◆ get_body_part()

string html_label::get_body_part ( ) const
overridevirtual

inherited from static_body_builder

Implements static_body_builder.

◆ has_adopted()

virtual void html_label::has_adopted ( body_builder obj)
inlineprotectedvirtual

inherited from body builder

Note
we forbid any adoption throwing an exception from this call

Reimplemented from html_tooltip.

◆ inherited_get_body_part()

string html_label::inherited_get_body_part ( const chemin path,
const request req 
)
overrideprotectedvirtual

inherited from body_builder

Implements body_builder.


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