#include <gui_widget_with_items.h>

Inheritance diagram for pntk::gui_widget_with_items:

Public Member Functions
int	get_entry_sort_index (const std::string &text)

void	set_items (const std::list< std::string > &items)

void	set_items (std::list< std::string > &items)

void	append (const std::string &text)

void	prepend (const std::string &text)

virtual void	insert (const std::string &text, int index)

virtual std::string	get (int index)

virtual void	set (const std::string &text, int index)

virtual void	select_all ()

virtual void	deselect_all ()

virtual void	select (int index)

virtual void	deselect (int index)

virtual void	remove (int index)

virtual int	get_selection ()

virtual std::string	get_selection_text ()

virtual int	get_count ()

virtual bool	is_selected (int index)

virtual int	get_selected (std::list< int > &selected)

virtual void	set_sort (gui_items_sort_callback sort_function)

virtual gui_items_sort_callback	get_sort ()

virtual int	find (const std::string &text)

virtual void	set_items_presorted (const std::list< std::string > &items)

virtual void	clear ()

virtual int	find_at_y (int y)

Public Member Functions inherited from pntk::gui_widget
virtual void	init (bool visible=true)

virtual void	set_configuration (gui_configuration &configuration)

virtual gui_configuration	get_configuration ()

virtual void	set_position (gui_point pos)

virtual void	set_actual_position (gui_point pos)

gui_point	get_position ()

gui_point	get_actual_position ()

gui_point	get_screen_position ()

virtual void	set_size (gui_size size)

virtual void	set_actual_size (gui_size size)

virtual gui_size	get_size ()

gui_size	get_actual_size ()

virtual gui_size	get_min_size ()

virtual gui_size	get_actual_min_size ()

virtual void	show (bool state)

virtual bool	is_owned ()

virtual void	set_border (int border)

virtual int	get_border ()

virtual void	set_border_style (int style)

virtual int	get_border_style ()

virtual void	set_weight (int weight)

virtual int	get_weight ()

virtual void	set_alignment (int alignment)

virtual int	get_alignment ()

virtual void	set_style (int style)

virtual int	get_style ()

virtual void	set_font (gui_font *font)

virtual gui_font *	get_font ()

virtual void	set_system_cursor (gui_system_cursors cursor)

virtual gui_widget *	get_parent ()

gui_widget *	get_sibling (bool next)

gui_widget *	get_sequential (bool next, bool wrap=false)

virtual void	reparent (gui_widget *parent)

virtual bool	is_container ()

virtual native_widget	get_native_widget ()

virtual std::string	get_self_name ()

virtual widget_types	get_self_type ()

virtual void	set_bg_color (gui_color color)

virtual void	set_fg_color (gui_color color)

virtual gui_color	get_bg_color ()

virtual gui_color	get_fg_color ()

virtual void	set_label (const std::string &text)

virtual std::string	get_label ()

virtual void	set_enabled (bool state)

virtual bool	get_enabled ()

virtual bool	is_visible ()

virtual bool	is_ok ()

virtual void	refresh (int flags=0, const gui_rect *area=nullptr)

gui_extra_data &	get_extra_data ()

virtual void	set_focus ()

virtual bool	has_focus ()

void	set_default ()

gui_size	bound_by_requested (gui_size size)

void	feed_mouse (int base_event, int events, bool &veto, gui_point cursor, int button)

virtual void	set_tooltip (std::string label)

virtual std::string	get_tooltip ()

virtual void	__internal_set_size (gui_size size, bool propagate_to_os=true)

virtual void	__internal_set_actual_size (gui_size size, bool propagate_to_os=true)

virtual void	__internal_set_os_actual (gui_size size)

Public Member Functions inherited from pntk::gui_object
void	set_data (void *user_data)

void *	get_data ()

virtual void	connect (gui_event_listener call_back, void data=nullptr, bool managed=false)

virtual void	disconnect (gui_event_listener call_back, void data=nullptr)

pntk::gui_listener_chain *	__internal_disconnect (pntk::gui_listener_chain *matching_chain)

Public Attributes
gui_items_sort_callback	sort_cb

Public Attributes inherited from pntk::gui_widget
gui_font *	font

gui_system_cursors	system_cursor

gui_size	requested_size

gui_size	extent

gui_extra_data	extra_data

Additional Inherited Members
Public Types inherited from pntk::gui_object
typedef std::map< gui_object , gui_listener_chain >	event_map

Static Public Member Functions inherited from pntk::gui_widget
static void	get_widget_geometry (int alignment, gui_point base, gui_size max, gui_point &child_pos, gui_size &child_size)

Static Public Attributes inherited from pntk::gui_object
static event_map	windowing_events

Detailed Description

An abstract foundation for list-like widgets.

Member Function Documentation

◆ append()

void pntk::gui_widget_with_items::append ( const std::string & text )

Inserts a new item at the end of the list

◆ clear()

virtual void pntk::gui_widget_with_items::clear ( )

virtual

Removes all of the elements from the list

Reimplemented in pntk::gui_listbox, pntk::gui_check_listbox, and pntk::gui_combobox.

◆ deselect()

virtual void pntk::gui_widget_with_items::deselect ( int index )

virtual

If the item at the given index is selected, deselects it.

Reimplemented in pntk::gui_listbox, pntk::gui_check_listbox, and pntk::gui_combobox.

◆ deselect_all()

virtual void pntk::gui_widget_with_items::deselect_all ( )

virtual

Deselects any selected items.

Reimplemented in pntk::gui_listbox, and pntk::gui_check_listbox.

◆ find()

virtual int pntk::gui_widget_with_items::find ( const std::string & text )

virtual

Returns the index of the first item matching the given text, or -1 if nothing is found.

Reimplemented in pntk::gui_listbox, pntk::gui_check_listbox, and pntk::gui_combobox.

◆ find_at_y()

virtual int pntk::gui_widget_with_items::find_at_y ( int y )

virtual

Get the entry in the list at the given y position

Reimplemented in pntk::gui_listbox, pntk::gui_check_listbox, and pntk::gui_combobox.

◆ get()

virtual std::string pntk::gui_widget_with_items::get ( int index )

virtual

Returns the text value the given index.

Reimplemented in pntk::gui_listbox, pntk::gui_check_listbox, and pntk::gui_combobox.

◆ get_count()

virtual int pntk::gui_widget_with_items::get_count ( )

virtual

Returns the count of the elements in the list.

Reimplemented in pntk::gui_listbox, pntk::gui_check_listbox, and pntk::gui_combobox.

◆ get_selected()

virtual int pntk::gui_widget_with_items::get_selected ( std::list< int > & selected )

virtual

Returns a list of each selected item in the list.

Reimplemented in pntk::gui_listbox, pntk::gui_check_listbox, and pntk::gui_combobox.

◆ get_selection()

virtual int pntk::gui_widget_with_items::get_selection ( )

virtual

Returns the index of the selected element. In a multi-selection list, use get_selected instead.

Reimplemented in pntk::gui_listbox, pntk::gui_check_listbox, and pntk::gui_combobox.

◆ get_selection_text()

virtual std::string pntk::gui_widget_with_items::get_selection_text ( )

virtual

Returns the text of the selected element.

Reimplemented in pntk::gui_listbox, pntk::gui_check_listbox, and pntk::gui_combobox.

◆ get_sort()

virtual gui_items_sort_callback pntk::gui_widget_with_items::get_sort ( )

virtual

Returns a pointer to the lists sort callback.

◆ insert()

virtual void pntk::gui_widget_with_items::insert	(	const std::string &	text,
		int	index
	)

virtual

Inserts a new item to the list at the given index with the given text value.

Reimplemented in pntk::gui_listbox, pntk::gui_check_listbox, and pntk::gui_combobox.

◆ is_selected()

virtual bool pntk::gui_widget_with_items::is_selected ( int index )

virtual

Returns a boolean representing the selected state of the item at the given @ index.

Reimplemented in pntk::gui_listbox, pntk::gui_check_listbox, and pntk::gui_combobox.

◆ prepend()

void pntk::gui_widget_with_items::prepend ( const std::string & text )

Inserts a new item at the beginning of the list

◆ remove()

virtual void pntk::gui_widget_with_items::remove ( int index )

virtual

Removes the item at the given index.

Reimplemented in pntk::gui_listbox, pntk::gui_check_listbox, and pntk::gui_combobox.

◆ select()

virtual void pntk::gui_widget_with_items::select ( int index )

virtual

Selects the item at the given index, if this is a single select list, the previous selection will be deselelcted.

Reimplemented in pntk::gui_listbox, pntk::gui_check_listbox, and pntk::gui_combobox.

◆ select_all()

virtual void pntk::gui_widget_with_items::select_all ( )

virtual

Selects every item, if this is a multi selection list.

Reimplemented in pntk::gui_listbox, and pntk::gui_check_listbox.

◆ set()

virtual void pntk::gui_widget_with_items::set	(	const std::string &	text,
		int	index
	)

virtual

Sets the text value the given index.

Reimplemented in pntk::gui_listbox, pntk::gui_check_listbox, and pntk::gui_combobox.

◆ set_items() [1/2]

void pntk::gui_widget_with_items::set_items ( const std::list< std::string > & items )

Replaces the list (and sorts if needed)

◆ set_items() [2/2]

void pntk::gui_widget_with_items::set_items ( std::list< std::string > & items )

Replaces the list (and sorts in-place if needed)

◆ set_items_presorted()

virtual void pntk::gui_widget_with_items::set_items_presorted ( const std::list< std::string > & items )

virtual

Append a list of items to the list

Reimplemented in pntk::gui_listbox, pntk::gui_check_listbox, and pntk::gui_combobox.

◆ set_sort()

virtual void pntk::gui_widget_with_items::set_sort ( gui_items_sort_callback sort_function )

virtual

Sets the lists sort callback.

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

include/gui_widget_with_items.h

Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ append()

◆ clear()

◆ deselect()

◆ deselect_all()

◆ find()

◆ find_at_y()

◆ get()

◆ get_count()

◆ get_selected()

◆ get_selection()

◆ get_selection_text()

◆ get_sort()

◆ insert()

◆ is_selected()

◆ prepend()

◆ remove()

◆ select()

◆ select_all()

◆ set()

◆ set_items() [1/2]

◆ set_items() [2/2]

◆ set_items_presorted()

◆ set_sort()