#include <html_select_file.hpp>

Inheritance diagram for html_select_file:

[legend]

Collaboration diagram for html_select_file:

[legend]

Public Types
enum	select_mode { sel_file , sel_dir , sel_symlinks }

Public Member Functions
	html_select_file (const std::string &message)
	constructor

	html_select_file (const html_select_file &ref)=delete

	html_select_file (html_select_file &&ref) noexcept(false)=delete

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

html_select_file &	operator= (html_select_file &&ref) noexcept(false)=delete

void	set_select_mode (select_mode val)
	ask the user to select a file path (false) or a directory path (true)

void	set_can_create_dir (bool val)
	whether to show the button allowing the user to create a subdirectory

void	set_filter (const std::string &mask)

void	go_select (const std::shared_ptr< libdar::entrepot > &x_entr, const std::string &start_dir)
	start the user interaction for a path selection

std::string	get_selected_path () const
	obtain the path selected by the user (mandatory after entry_selected event, in order to reuse this object)

virtual void	on_event (const std::string &event_name) override
	action triggered from html_buttons internally used in this class implementation (do not use, even if it must stay a public method)

std::string	get_message () const
	returns the message argument passed at construction time

Public Member Functions inherited from html_popup
	html_popup (unsigned int width_pct, unsigned int height_pct)

	html_popup (const html_popup &ref)=delete

	html_popup (html_popup &&ref) noexcept=delete

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

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

Public Member Functions inherited from html_div
	html_div (const html_div &ref)=delete

	html_div (html_div &&ref) noexcept=delete

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

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

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

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

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 actor
	actor (const actor &ref)=default

	actor (actor &&ref) noexcept(false)=default

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

actor &	operator= (actor &&ref) noexcept(false)

Static Public Attributes
static const std::string	entry_selected = "entry_selected"
	event when user selected a file

static const std::string	op_cancelled = "op_cancelled"
	event when the user cancelled file selection

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

virtual void	new_css_library_available () override
	inherited from body_builder (via html_div)

virtual void	inherited_run () override
	inherited from libthreadar::thread

virtual void	signaled_inherited_cancel () override
	inherited from libthreadar::thread

Protected Member Functions inherited from html_level
virtual void	has_adopted (body_builder *obj) override
	inherited from body_builder

virtual void	will_foresake (body_builder *obj) override
	inherited from body_builder

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)

Protected Member Functions inherited from html_tooltip
std::string	get_tooltip_body_part () const

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

Protected Member Functions inherited from reference
void	reset_read_peers () const
	reset the peers reading

bool	read_next_peer (reference *&peer) const

Detailed Description

class html_select_file

given a libdar::entrepot object, the class html_select_file shows a popup for the user to navigate in the directory tree and select a file or a directory depending on the parameter set to this object

usage for the caller is to:

adopt() this object
register for entry_selected and op_cancelled events on this object, events which will be triggered once the user will have selected a file or cancelled choice selection
call the different set_* methods when needed:
then call go_select() giving a libdar::entrepot (the object becomes visible)

and upon event entry_selected fetch the path selected by the user calling get_selected_path()

Note

the object visibility is managed by go_select() and before triggering entry_select and op_cancelled events

+------------------------popup----------------------------+
|+----------------title box------------------------------+|
|| title                                                 ||
|| entrepot_url                                          ||
|| warning (hidden by default)                           ||
|| webui (hidden by default)                             ||
|+-------------------------------------------------------+|
|+--------------- fieldset ------------------------------+|
|| parentdir                                             ||
|| +--------------+-----content------------------------+ ||
|| |              |                                    | ||
|| +--------------+------------------------------------+ ||
|| |              |                                    | ||
|| +--------------+------------------------------------+ ||
|| |              |                                    | ||
|| +--------------+------------------------------------+ ||
|+-------------------------------------------------------+|
|+-------------------btn_box-----------------------------+|
||+--------+                          +--------++-------+||
|||creatdir|                          |cancel  ||validate||
||+--------+                          +--------++-------+||
||+----- createdir_form------+                           ||
||| createdir_input          |                           ||
||+--------------------------+                           ||
|+-------------------------------------------------------+|
|                                                         |
+---------------------------------------------------------+

Examples: /home/denis/Telechargements/WEBDAR/webdar-1.0.2/src/html_form_input_file.hpp.

Member Enumeration Documentation

◆ select_mode

enum html_select_file::select_mode

Enumerator
sel_file	only non dir and symlinks and non symlink should be selectable
sel_dir	only directories and symlinks pointing to dir
sel_symlinks	only symlinks should be selectable

Constructor & Destructor Documentation

◆ html_select_file()

html_select_file::html_select_file ( const std::string & message )

constructor

Parameters

[in] message is show to the user and should tell what it is expected to select for

Member Function Documentation

◆ go_select()

void html_select_file::go_select	(	const std::shared_ptr< libdar::entrepot > &	x_entr,
		const std::string &	start_dir
	)

start the user interaction for a path selection

Parameters

[in]	x_entr	entrepot to scan directory from
[in]	start_dir	absolute path in x_entr to take as starting directory

Note: if start_dir is not a directory not is an absolute path an exception is thrown

◆ inherited_get_body_part()

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

overrideprotectedvirtual

inherited from body_builder (via html_div)

Reimplemented from html_popup.

◆ new_css_library_available()

void html_select_file::new_css_library_available ( )

overrideprotectedvirtual

inherited from body_builder (via html_div)

Reimplemented from html_popup.

◆ on_event()

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

overridevirtual

action triggered from html_buttons internally used in this class implementation (do not use, even if it must stay a public method)

Implements actor.

◆ set_can_create_dir()

void html_select_file::set_can_create_dir ( bool val )

inline

whether to show the button allowing the user to create a subdirectory

Note: should be setup before calling go_select()

Examples: /home/denis/Telechargements/WEBDAR/webdar-1.0.2/src/html_form_input_file.hpp.

◆ set_filter()

void html_select_file::set_filter ( const std::string & mask )

inline

only show directories and files matching the given glob expression (shell wildcards)

Note: giving an empty string disable filtering, all entries are shown which is the default behavior

◆ set_select_mode()

void html_select_file::set_select_mode ( select_mode val )

inline

ask the user to select a file path (false) or a directory path (true)

Note: should be setup before calling go_select()

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

html_select_file.hpp
html_select_file.cpp

Public Types

Public Member Functions

Static Public Attributes

Protected Member Functions

Detailed Description

Member Enumeration Documentation

◆ select_mode

Constructor & Destructor Documentation

◆ html_select_file()

Member Function Documentation

◆ go_select()

◆ inherited_get_body_part()

◆ new_css_library_available()

◆ on_event()

◆ set_can_create_dir()

◆ set_filter()

◆ set_select_mode()