clanGUI Components

Classes

class  clan::BrowseFolderDialog
 BrowseFolderDialog component. More...
 
class  clan::CheckBox
 Check box component. More...
 
class  clan::ComboBox
 Combo box component. More...
 
class  clan::DragBox
 Drag box component. More...
 
class  clan::Frame
 Frame component. More...
 
class  clan::GroupBox
 Group box component. More...
 
class  clan::ImageView
 Frame component. More...
 
class  clan::Label
 Check box component. More...
 
class  clan::LineEdit
 Single line edit component. More...
 
class  clan::ListView
 List view component. More...
 
class  clan::ListViewColumnData
 ListView column data. More...
 
class  clan::ListViewColumnHeader
 ListView column header class. More...
 
class  clan::ListViewHeader
 ListViewHeader component. More...
 
class  clan::ListViewIcon
 ListView icon. More...
 
class  clan::ListViewIconList
 ListView icon list. More...
 
class  clan::ListViewItem
 ListView item. More...
 
class  clan::ListViewItemUserData
 
class  clan::ListViewSelectedItem
 ListView selected item. More...
 
class  clan::ListViewSelection
 ListView selection. More...
 
class  clan::MenuBar
 Menu bar component. More...
 
class  clan::OpenFileDialog
 OpenFileDialog component. More...
 
class  clan::PopupMenu
 Pop-up menu. More...
 
class  clan::PopupMenuItem
 Popup menu item. More...
 
class  clan::ProgressBar
 Progress bar component. More...
 
class  clan::PushButton
 Push button component. More...
 
class  clan::RadioButton
 Radio button component. More...
 
class  clan::SaveFileDialog
 SaveFileDialog component. More...
 
class  clan::ScrollBar
 Scroll bar component. More...
 
class  clan::Slider
 Track bar component. More...
 
class  clan::Spin
 Spin component. More...
 
class  clan::StatusBar
 Status bar component. More...
 
class  clan::Tab
 Tab component. More...
 
class  clan::TabPage
 Tab component. More...
 
class  clan::TextEdit
 Text edit component. More...
 
class  clan::ToolBar
 Tool bar component. More...
 
class  clan::ToolBarItem
 Toolbar menu item. More...
 
class  clan::ToolTip
 Tool tip component. More...
 
class  clan::Window
 Window component. More...
 

Enumerations

enum  clan::MessageBoxButtons { clan::mb_buttons_yes_no, clan::mb_buttons_yes_no_cancel, clan::mb_buttons_ok, clan::mb_buttons_ok_cancel }
 
enum  clan::MessageBoxIcon {
  clan::mb_icon_none, clan::mb_icon_warning, clan::mb_icon_info, clan::mb_icon_error,
  clan::mb_icon_question
}
 
enum  clan::MessageBoxResult { clan::mb_result_yes, clan::mb_result_no, clan::mb_result_cancel, clan::mb_result_ok }
 

Functions

virtual clan::ListViewItemUserData::~ListViewItemUserData ()
 
MessageBoxResult clan::message_box (GUIComponent *owner, std::string title, std::string detail_text, MessageBoxButtons buttons, MessageBoxIcon icon)
 
MessageBoxResult clan::message_box (GUIManager *gui_manager, std::string title, std::string detail_text, MessageBoxButtons buttons, MessageBoxIcon icon)
 

Construction

 clan::CheckBox::CheckBox (GUIComponent *parent)
 Constructs a CheckBox. More...
 
virtual clan::CheckBox::~CheckBox ()
 

Attributes

static CheckBox * clan::CheckBox::get_named_item (GUIComponent *reference_component, const std::string &id)
 Find the child CheckBox with the specified component ID name. More...
 
bool clan::CheckBox::is_indeterminated () const
 Is Indeterminated. More...
 
bool clan::CheckBox::is_checked () const
 Is Checked. More...
 
bool clan::CheckBox::is_3state () const
 Is 3state. More...
 
const std::string & clan::CheckBox::get_text () const
 

Operations

void clan::CheckBox::set_indeterminated ()
 Set indeterminated. More...
 
void clan::CheckBox::set_checked (bool enable)
 Set checked. More...
 
void clan::CheckBox::set_3state (bool enable)
 Set 3state. More...
 
void clan::CheckBox::set_text (const std::string &text)
 Set text. More...
 

Events

Callback_v0 & clan::CheckBox::func_checked ()
 Func checked. More...
 
Callback_v0 & clan::CheckBox::func_unchecked ()
 Func unchecked. More...
 
Callback_v0 & clan::CheckBox::func_indeterminated ()
 Func indeterminated. More...
 
Callback_v0 & clan::CheckBox::func_state_changed ()
 Func state changed. More...
 

Construction

 clan::ComboBox::ComboBox (GUIComponent *parent)
 Constructs a ComboBox. More...
 
virtual clan::ComboBox::~ComboBox ()
 

Attributes

static ComboBox * clan::ComboBox::get_named_item (GUIComponent *reference_component, const std::string &id)
 Find the child ComboBox with the specified component ID name. More...
 
bool clan::ComboBox::is_editable () const
 Is Editable. More...
 
int clan::ComboBox::get_dropdown_height () const
 Get Dropdown height. More...
 
int clan::ComboBox::get_selected_item () const
 Get Selected item. More...
 
std::string clan::ComboBox::get_text () const
 Get Text. More...
 
std::string clan::ComboBox::get_item (int index) const
 Get item. More...
 

Operations

void clan::ComboBox::set_editable (bool enable=true)
 Set editable. More...
 
void clan::ComboBox::set_dropdown_height (int height)
 Set dropdown height. More...
 
void clan::ComboBox::set_dropdown_minimum_width (int min_width)
 Set dropdown minimum width. More...
 
void clan::ComboBox::set_text (const std::string &text)
 Set text. More...
 
void clan::ComboBox::set_selected_item (int index)
 Set selected item. More...
 
void clan::ComboBox::set_popup_menu (PopupMenu &menu)
 Set popup menu. More...
 

Events

Callback_v0 & clan::ComboBox::func_dropdown_opened ()
 Func dropdown opened. More...
 
Callback_v0 & clan::ComboBox::func_dropdown_closed ()
 Func dropdown closed. More...
 
Callback_v0 & clan::ComboBox::func_enter_pressed ()
 Func enter pressed. More...
 
Callback_v0 & clan::ComboBox::func_before_edit_changed ()
 Func before edit changed. More...
 
Callback_v0 & clan::ComboBox::func_after_edit_changed ()
 Func after edit changed. More...
 
Callback_v1< int > & clan::ComboBox::func_item_selected ()
 Func after item selected. More...
 
Callback_v1< int > & clan::ComboBox::func_selection_changed ()
 Func after selection changed. More...
 

Construction

 clan::DragBox::DragBox (GUIComponent *parent)
 Constructs a DragBox. More...
 
 clan::DragBox::DragBox (GUIManager *manager, const GUITopLevelDescription &description)
 Constructs a DragBox. More...
 
virtual clan::DragBox::~DragBox ()
 

Attributes

static DragBox * clan::DragBox::get_named_item (GUIComponent *reference_component, const std::string &id)
 Find the child DragBox with the specified component ID name. More...
 

Construction

 clan::BrowseFolderDialog::BrowseFolderDialog (GUIComponent *owner)
 Constructs an browse folder dialog. More...
 
virtual clan::BrowseFolderDialog::~BrowseFolderDialog ()
 

Attributes

std::string clan::BrowseFolderDialog::get_selected_path () const
 Get the full path of the directory selected. More...
 

Operations

void clan::BrowseFolderDialog::set_initial_directory (const std::string &path)
 Sets the initial directory that is displayed. More...
 
void clan::BrowseFolderDialog::set_title (const std::string &title)
 Sets the text that appears in the title bar. More...
 
bool clan::BrowseFolderDialog::show ()
 Shows the file dialog. More...
 

Construction

 clan::Frame::Frame (GUIComponent *parent)
 Constructs a Frame. More...
 
virtual clan::Frame::~Frame ()
 

Attributes

static Frame * clan::Frame::get_named_item (GUIComponent *reference_component, const std::string &id)
 Find the child Frame with the specified component ID name. More...
 
Sprite clan::Frame::get_header_icon () const
 Get Header icon. More...
 
std::string clan::Frame::get_header_text () const
 Get Header text. More...
 

Operations

void clan::Frame::set_header_icon (const Sprite &icon)
 Set header icon. More...
 
void clan::Frame::set_header_text (const std::string &text)
 Set header text. More...
 

Construction

 clan::GroupBox::GroupBox (GUIComponent *parent)
 Constructs a GroupBox. More...
 
virtual clan::GroupBox::~GroupBox ()
 

Attributes

static GroupBox * clan::GroupBox::get_named_item (GUIComponent *reference_component, const std::string &id)
 Find the child GroupBox with the specified component ID name. More...
 

Construction

 clan::ImageView::ImageView (GUIComponent *parent)
 Constructs a ImageView. More...
 
virtual clan::ImageView::~ImageView ()
 

Attributes

static ImageView * clan::ImageView::get_named_item (GUIComponent *reference_component, const std::string &id)
 Find the child ImageView with the specified component ID name. More...
 
Sprite clan::ImageView::get_sprite () const
 Get Sprite. More...
 
Image clan::ImageView::get_image () const
 Get Image. More...
 

Operations

void clan::ImageView::set_sprite (const Sprite &image)
 Set sprite. More...
 
void clan::ImageView::set_image (const Image &image)
 Set image. More...
 
void clan::ImageView::set_image (const PixelBuffer &image)
 Set image. More...
 
void clan::ImageView::set_scale_to_fit (bool enable)
 Set scale to fit. More...
 
void clan::ImageView::set_scale (float x, float y)
 Set scale. More...
 
float clan::ImageView::get_preferred_content_width ()
 Returns the preferred content width. More...
 
float clan::ImageView::get_preferred_content_height (float width)
 Returns the preferred content height for the specified content width. More...
 

Construction

 clan::Label::Label (GUIComponent *parent)
 Constructs a Label. More...
 
virtual clan::Label::~Label ()
 

Attributes

enum  clan::Label::Alignment { clan::Label::align_left, clan::Label::align_center, clan::Label::align_right, clan::Label::align_justify }
 
static Label * clan::Label::get_named_item (GUIComponent *reference_component, const std::string &id)
 Find the child Label with the specified component ID name. More...
 
Alignment clan::Label::get_alignment () const
 Get Alignment. More...
 
const std::string & clan::Label::get_text () const
 Get Text. More...
 
float clan::Label::get_preferred_content_width ()
 Returns the preferred content width. More...
 
float clan::Label::get_preferred_content_height (float width)
 Returns the preferred content height for the specified content width. More...
 

Operations

void clan::Label::set_text (const std::string &text)
 Set text. More...
 
void clan::Label::set_text_color (const Colorf color)
 
void clan::Label::set_alignment (Alignment alignment)
 Set alignment. More...
 

Construction

 clan::LineEdit::LineEdit (GUIComponent *parent)
 Constructs a LineEdit. More...
 
virtual clan::LineEdit::~LineEdit ()
 

Attributes

enum  clan::LineEdit::Alignment { clan::LineEdit::align_left, clan::LineEdit::align_center, clan::LineEdit::align_right }
 
static LineEdit * clan::LineEdit::get_named_item (GUIComponent *reference_component, const std::string &id)
 Find the child LineEdit with the specified component ID name. More...
 
Alignment clan::LineEdit::get_alignment () const
 Get Alignment. More...
 
bool clan::LineEdit::is_read_only () const
 Is Read only. More...
 
bool clan::LineEdit::is_lowercase () const
 Is Lowercase. More...
 
bool clan::LineEdit::is_uppercase () const
 Is Uppercase. More...
 
bool clan::LineEdit::is_password_mode () const
 Is Password mode. More...
 
int clan::LineEdit::get_max_length () const
 Get Max length. More...
 
std::string clan::LineEdit::get_text () const
 Get Text. More...
 
int clan::LineEdit::get_text_int () const
 Returns the text converted to integer. More...
 
float clan::LineEdit::get_text_float () const
 Returns the text converted to float. More...
 
std::string clan::LineEdit::get_selection () const
 Get Selection. More...
 
int clan::LineEdit::get_selection_start () const
 Get Selection start. More...
 
int clan::LineEdit::get_selection_length () const
 Get Selection length. More...
 
int clan::LineEdit::get_cursor_pos () const
 Get Cursor pos. More...
 
Size clan::LineEdit::get_text_size ()
 Returns the size (pixels) of the text in the lineedit, or of the string given as parameter. More...
 
Size clan::LineEdit::get_text_size (const std::string &str)
 Get text size. More...
 
float clan::LineEdit::get_preferred_content_width ()
 Returns the preferred content width. More...
 
float clan::LineEdit::get_preferred_content_height (float width)
 Returns the preferred content height for the specified content width. More...
 

Operations

void clan::LineEdit::set_select_all_on_focus_gain (bool enable)
 
void clan::LineEdit::select_all ()
 Select all. More...
 
void clan::LineEdit::set_alignment (Alignment alignment)
 Set alignment. More...
 
void clan::LineEdit::set_read_only (bool enable=true)
 Set read only. More...
 
void clan::LineEdit::set_lowercase (bool enable=true)
 Set lowercase. More...
 
void clan::LineEdit::set_uppercase (bool enable=true)
 Set uppercase. More...
 
void clan::LineEdit::set_password_mode (bool enable=true)
 Set password mode. More...
 
void clan::LineEdit::set_numeric_mode (bool enable=true, bool decimals=false)
 Set numeric mode. More...
 
void clan::LineEdit::set_max_length (int length)
 Set max length. More...
 
void clan::LineEdit::set_text (const std::string &text)
 Set text. More...
 
void clan::LineEdit::set_text (int number)
 Set text. More...
 
void clan::LineEdit::set_text (float number, int num_decimal_places=6)
 Set text. More...
 
void clan::LineEdit::set_selection (int pos, int length)
 Set selection. More...
 
void clan::LineEdit::clear_selection ()
 Clear selection. More...
 
void clan::LineEdit::set_cursor_pos (int pos)
 Set cursor pos. More...
 
void clan::LineEdit::delete_selected_text ()
 Delete selected text. More...
 
void clan::LineEdit::resize_to_fit (int max_width)
 Resize the components width so that its whole text becomes visible. More...
 
void clan::LineEdit::set_input_mask (const std::string &mask)
 Use mask to restrict accepted input. More...
 
void clan::LineEdit::set_decimal_character (const std::string &decimal_char)
 Set decimal character. More...
 
void clan::LineEdit::set_cursor_drawing_enabled (bool enable)
 Set cursor drawing enabled/disabled. More...
 

Events

Callback_v1< InputEvent & > & clan::LineEdit::func_before_edit_changed ()
 
Callback_v1< InputEvent & > & clan::LineEdit::func_after_edit_changed ()
 
Callback_v0 & clan::LineEdit::func_selection_changed ()
 Func selection changed. More...
 
Callback_v0 & clan::LineEdit::func_focus_gained ()
 Callback invoked after the lineedit gained focus. More...
 
Callback_v0 & clan::LineEdit::func_focus_lost ()
 Callback invoked when the lineedit is about to lose focus. More...
 
Callback_v0 & clan::LineEdit::func_enter_pressed ()
 Func enter pressed. More...
 

Construction

 clan::ListView::ListView (GUIComponent *parent)
 Constructs a ListView. More...
 
virtual clan::ListView::~ListView ()
 

Attributes

static ListView * clan::ListView::get_named_item (GUIComponent *reference_component, const std::string &id)
 Find the child ListView with the specified component ID name. More...
 
int clan::ListView::get_scroll_position ()
 Get current listview scrollbar position. More...
 
int clan::ListView::get_scroll_max_position ()
 Get maximal listview scrollbar position. More...
 
ListViewHeader * clan::ListView::get_header () const
 Get Header. More...
 
ListViewItem clan::ListView::get_document_item () const
 Get Document item. More...
 
bool clan::ListView::get_select_whole_row () const
 Get Select whole row. More...
 
ListViewIconList clan::ListView::get_icon_list () const
 Get Icon list. More...
 
ListViewSelection clan::ListView::get_selected_items () const
 Returns a container class holding the selected items in a linked list structure. More...
 
ListViewItem clan::ListView::get_selected_item ()
 Returns the currently selected item in single selection mode. More...
 
Size clan::ListView::get_css_size () const
 Returns the preferred size of the component, as defined in its CSS file. More...
 
ListViewDisplayMode clan::ListView::get_display_mode () const
 Get Display mode. More...
 

Operations

ListViewItem clan::ListView::create_item ()
 Create item. More...
 
void clan::ListView::set_scroll_position (int pos)
 Set listview scrollbar position. More...
 
void clan::ListView::on_process_message (std::shared_ptr< GUIMessage > &msg)
 On process message. More...
 
void clan::ListView::set_select_whole_row (bool value)
 When true, the whole row is drawn selected, as opposed to only the first column. More...
 
void clan::ListView::set_multi_select (bool value)
 When true, multiple items can be selected. More...
 
void clan::ListView::set_display_mode (ListViewDisplayMode mode)
 Set display mode. More...
 
void clan::ListView::show_detail_icon (bool enable=true)
 Set if icons are shown in the detail display mode. More...
 
void clan::ListView::show_detail_opener (bool enable=true)
 Set if node opener is shown in the detail display mode. More...
 
void clan::ListView::clear ()
 Remove all items. More...
 
void clan::ListView::clear_selection ()
 Unselect all selected items. More...
 
void clan::ListView::set_selected (ListViewItem &item, bool selected=true)
 Set selected. More...
 
ListViewItem clan::ListView::find (const std::string &col_id, const std::string &str, bool recursive=true)
 Returns a ListViewItem with the string 'str' in the column 'col_id' or a NULL item if none found. More...
 
ListViewItem clan::ListView::find (int id, bool recursive=true)
 Returns the first ListViewItem with the specified ID, or a NULL item if none found. More...
 
ListViewItem clan::ListView::find (std::shared_ptr< ListViewItemUserData > userdata, bool recursive=true)
 Returns a ListViewItem with the userdata 'ptr', or a NULL item if none found. More...
 

Events

Callback_v1< ListViewSelection > & clan::ListView::func_selection_changed ()
 Selected items are returned as children of the returned item. More...
 
Callback_v1< const
ListViewItem & > & 
clan::ListView::func_item_doubleclick ()
 Invoked on double clicking a listview item. More...
 
Callback_2< bool, ListViewItem,
std::string & > & 
clan::ListView::func_item_edited ()
 Invoked when enter is pressed in the ListViews built-in LineEdit control. The caller may change the passed string. Returning false from the callback cancels the edit. More...
 
Callback_v1< InputEvent & > & clan::ListView::func_key_pressed ()
 
Callback_v1< InputEvent & > & clan::ListView::func_key_released ()
 
Callback_v1< Point > & clan::ListView::func_mouse_right_up ()
 Callback called when the right mouse button is released (a click). Use this callback for listview context menus. Click position sent as parameter. More...
 
Callback_v1< const
ListViewItem & > & 
clan::ListView::func_item_opened ()
 Callback called when an item node is opened. More...
 
Callback_v1< const
ListViewItem & > & 
clan::ListView::func_item_closed ()
 Callback called when an item node is closed. More...
 
Callback_v0 & clan::ListView::func_begin_drag ()
 Callback called when the user begins a drag'n'drop action. More...
 

Implementation

class clan::ListView::ListViewRenderer
 

Construction

 clan::ListViewColumnData::ListViewColumnData ()
 
 clan::ListViewColumnData::~ListViewColumnData ()
 

Attributes

std::string clan::ListViewColumnData::get_text () const
 Get Text. More...
 
std::string clan::ListViewColumnData::get_column_id () const
 Get Column id. More...
 

Operations

void clan::ListViewColumnData::set_text (const std::string &text)
 Set text. More...
 
void clan::ListViewColumnData::set_column_id (const std::string &column_id)
 Set column id. More...
 

Construction

 clan::ListViewColumnHeader::ListViewColumnHeader ()
 
 clan::ListViewColumnHeader::~ListViewColumnHeader ()
 

Attributes

enum  clan::ListViewColumnHeader::TextAlignment { clan::ListViewColumnHeader::align_left, clan::ListViewColumnHeader::align_right, clan::ListViewColumnHeader::align_center }
 
bool clan::ListViewColumnHeader::is_null () const
 Returns true if this object is invalid. More...
 
void clan::ListViewColumnHeader::throw_if_null () const
 Throw an exception if this object is invalid. More...
 
std::string clan::ListViewColumnHeader::get_column_id () const
 Get Column id. More...
 
std::string clan::ListViewColumnHeader::get_caption () const
 Get Caption. More...
 
int clan::ListViewColumnHeader::get_width ()
 Get Width. More...
 
int clan::ListViewColumnHeader::get_used_width ()
 Returns the used width (last column expanded to the rest of the list view) More...
 
ListViewColumnHeader::TextAlignment clan::ListViewColumnHeader::get_alignment ()
 
ListViewColumnHeader clan::ListViewColumnHeader::get_next_sibling ()
 Get Next sibling. More...
 
ListViewColumnHeader clan::ListViewColumnHeader::get_prev_sibling ()
 Get Prev sibling. More...
 

Operations

void clan::ListViewColumnHeader::set_alignment (ListViewColumnHeader::TextAlignment align)
 Set alignment. More...
 
void clan::ListViewColumnHeader::set_width (int width)
 Set width. More...
 
void clan::ListViewColumnHeader::set_caption (const std::string &str)
 Set caption. More...
 
void clan::ListViewColumnHeader::set_column_id (const std::string &str)
 Set column id. More...
 

Events

Callback_v1
< ListViewColumnHeader > & 
clan::ListViewColumnHeader::func_size_changed ()
 

Implementation

class clan::ListViewColumnHeader::ListView_Impl
 
class clan::ListViewColumnHeader::ListViewHeader
 
class clan::ListViewColumnHeader::ListViewHeader_Impl
 

Construction

 clan::ListViewHeader::ListViewHeader (GUIComponent *parent)
 Constructs a ListViewHeader. More...
 
 clan::ListViewHeader::~ListViewHeader ()
 

Attributes

ListViewColumnHeader clan::ListViewHeader::get_first_column ()
 Get First column. More...
 
ListViewColumnHeader clan::ListViewHeader::get_column (const std::string &column_id)
 Get column. More...
 
bool clan::ListViewHeader::get_visible () const
 Get Visible. More...
 
virtual Size clan::ListViewHeader::get_css_size () const
 Get Preferred size. More...
 

Operations

ListViewColumnHeader clan::ListViewHeader::create_column (const std::string &column_id, const std::string &caption)
 Create column. More...
 
ListViewColumnHeader clan::ListViewHeader::append (ListViewColumnHeader column)
 Append. More...
 
ListViewColumnHeader clan::ListViewHeader::remove (const std::string &column_id)
 Remove. More...
 
ListViewColumnHeader clan::ListViewHeader::insert_after (const std::string &column_id, ListViewColumnHeader new_column)
 Insert after. More...
 
ListViewColumnHeader clan::ListViewHeader::insert_before (const std::string &column_id, ListViewColumnHeader new_column)
 Insert before. More...
 
void clan::ListViewHeader::set_display_mode (ListViewDisplayMode mode)
 Set display mode. More...
 

Events

Callback_v1
< ListViewColumnHeader > & 
clan::ListViewHeader::func_column_added ()
 
Callback_v1
< ListViewColumnHeader > & 
clan::ListViewHeader::func_column_removed ()
 
Callback_v1
< ListViewColumnHeader > & 
clan::ListViewHeader::func_column_size_changed ()
 

Implementation

class clan::ListViewHeader::ListView_Impl
 

Construction

 clan::ListViewIcon::ListViewIcon ()
 
 clan::ListViewIcon::~ListViewIcon ()
 

Attributes

Sprite clan::ListViewIcon::get_sprite (ListViewDisplayMode mode)
 Get sprite. More...
 
PixelBuffer clan::ListViewIcon::get_pixel_buffer (ListViewDisplayMode mode)
 Get pixel buffer. More...
 
Point clan::ListViewIcon::get_offset (ListViewDisplayMode mode)
 Get offset. More...
 
bool clan::ListViewIcon::is_scalable () const
 Is Scalable. More...
 

Operations

void clan::ListViewIcon::set_sprite (const Sprite &sprite, ListViewDisplayMode mode)
 Set sprite. More...
 
void clan::ListViewIcon::set_offset (const Point &offset, ListViewDisplayMode mode)
 
void clan::ListViewIcon::set_pixel_buffer (PixelBuffer &pbuf, ListViewDisplayMode mode)
 Set pixel buffer. More...
 
void clan::ListViewIcon::draw (Canvas &canvas, const Rect &rect, ListViewDisplayMode mode, const Colorf &color)
 Draw. More...
 
void clan::ListViewIcon::set_scalable (bool value)
 Set scalable. More...
 

Construction

 clan::ListViewIconList::ListViewIconList ()
 
 clan::ListViewIconList::~ListViewIconList ()
 

Attributes

ListViewIcon clan::ListViewIconList::get_icon (int index)
 Get icon. More...
 
Colorf clan::ListViewIconList::get_color ()
 Get Color. More...
 
Colorf clan::ListViewIconList::get_selected_color ()
 Get Selected color. More...
 
Colorf clan::ListViewIconList::get_color_overlay ()
 Get Color overlay. More...
 
Colorf clan::ListViewIconList::get_selected_color_overlay ()
 Get Selected color overlay. More...
 

Operations

void clan::ListViewIconList::clear ()
 Clear the icon list. More...
 
void clan::ListViewIconList::erase (int index)
 Erase the icon at the specified index. More...
 
void clan::ListViewIconList::set_icon (int index, const ListViewIcon &icon)
 Set the icon at the specified index. More...
 
void clan::ListViewIconList::set_color (const Colorf &color)
 Set color. More...
 
void clan::ListViewIconList::set_selected_color (const Colorf &color)
 Set selected color. More...
 
void clan::ListViewIconList::set_color_overlay (const Colorf &color)
 Set color overlay. More...
 
void clan::ListViewIconList::set_selected_color_overlay (const Colorf &color)
 Set selected color overlay. More...
 

Construction

 clan::ListViewItem::ListViewItem ()
 Construct a null instance. More...
 
 clan::ListViewItem::~ListViewItem ()
 

Attributes

bool clan::ListViewItem::is_null () const
 Returns true if this object is invalid. More...
 
void clan::ListViewItem::throw_if_null () const
 Throw an exception if this object is invalid. More...
 
bool clan::ListViewItem::is_item () const
 Is Item. More...
 
ListViewColumnData clan::ListViewItem::get_column (const std::string &column_id)
 Get column. More...
 
ListViewItem clan::ListViewItem::get_parent ()
 Get Parent. More...
 
ListViewItem clan::ListViewItem::get_next_sibling ()
 Get Next sibling. More...
 
ListViewItem clan::ListViewItem::get_prev_sibling ()
 Get Prev sibling. More...
 
ListViewItem clan::ListViewItem::get_first_child ()
 Get First child. More...
 
ListViewItem clan::ListViewItem::get_last_child ()
 Get Last child. More...
 
ListViewItem clan::ListViewItem::get_document_item ()
 Get Document item. More...
 
int clan::ListViewItem::get_parent_count ()
 Get Parent count. More...
 
int clan::ListViewItem::get_child_count (bool recursive=false, bool recurse_only_into_open_items=false)
 Get child count. More...
 
bool clan::ListViewItem::has_children () const
 Has children. More...
 
bool clan::ListViewItem::is_open () const
 Is Open. More...
 
bool clan::ListViewItem::is_selected () const
 Is Selected. More...
 
bool clan::ListViewItem::is_editable () const
 Is Editable. More...
 
int clan::ListViewItem::get_icon () const
 Get the item icon id. Defaults to 0 if unset. More...
 
int clan::ListViewItem::get_id () const
 Get the item id. Defaults to 0 if unset. More...
 
std::shared_ptr
< ListViewItemUserData > 
clan::ListViewItem::get_userdata () const
 Get Userdata. More...
 
bool clan::ListViewItem::operator== (ListViewItem &other) const
 
bool clan::ListViewItem::operator!= (ListViewItem &other) const
 
std::vector< int > clan::ListViewItem::get_overlay_icons ()
 

Operations

ListViewItem clan::ListViewItem::append_child (ListViewItem &item)
 Append child. More...
 
ListViewItem clan::ListViewItem::remove ()
 Removes this item from the item tree. More...
 
void clan::ListViewItem::remove_children ()
 Remove all children of this item. More...
 
void clan::ListViewItem::set_column_text (const std::string &column_id, const std::string &text)
 Set column text. More...
 
void clan::ListViewItem::set_open (bool open)
 Set open. More...
 
void clan::ListViewItem::set_icon (int icon_index)
 Set icon. More...
 
void clan::ListViewItem::set_id (int id)
 Set the item id. Defaults to 0 if unset. More...
 
void clan::ListViewItem::add_overlay_icon (int icon_index)
 Add overlay icon. More...
 
void clan::ListViewItem::remove_overlay_icon (int icon_index)
 Remove overlay icon. More...
 
void clan::ListViewItem::set_editable (bool editable)
 Set editable. More...
 
void clan::ListViewItem::set_userdata (std::shared_ptr< ListViewItemUserData > ptr)
 Set userdata. More...
 

Events

Callback_v1< Rect > & clan::ListViewItem::func_render_icon ()
 

Implementation

class clan::ListViewItem::ListView
 
class clan::ListViewItem::ListView_Impl
 
class clan::ListViewItem::ListViewSelection
 
class clan::ListViewItem::ListViewLayout
 

Construction

 clan::ListViewSelectedItem::ListViewSelectedItem ()
 Contruct a null instance. More...
 
 clan::ListViewSelectedItem::ListViewSelectedItem (const ListViewItem &item)
 Constructs a ListViewSelectedItem. More...
 

Attributes

bool clan::ListViewSelectedItem::is_null () const
 Returns true if this object is invalid. More...
 
void clan::ListViewSelectedItem::throw_if_null () const
 Throw an exception if this object is invalid. More...
 
bool clan::ListViewSelectedItem::is_item () const
 Is Item. More...
 
ListViewItem clan::ListViewSelectedItem::get_item ()
 Get Item. More...
 
ListViewSelectedItem clan::ListViewSelectedItem::prev ()
 Prev. More...
 
ListViewSelectedItem clan::ListViewSelectedItem::get_next_sibling ()
 Get Next sibling. More...
 

Implementation

class clan::ListViewSelectedItem::ListViewSelection
 

Construction

 clan::ListViewSelection::ListViewSelection ()
 

Attributes

ListViewSelectedItem clan::ListViewSelection::get_first ()
 Get First. More...
 
ListViewSelectedItem clan::ListViewSelection::get_last ()
 Get Last. More...
 

Operations

void clan::ListViewSelection::append (const ListViewItem &item)
 Append. More...
 
void clan::ListViewSelection::remove (const ListViewItem &item)
 Remove. More...
 
void clan::ListViewSelection::clear ()
 Clear. More...
 

Construction

 clan::MenuBar::MenuBar (GUIComponent *parent)
 Constructs a MenuBar. More...
 
virtual clan::MenuBar::~MenuBar ()
 

Attributes

static MenuBar * clan::MenuBar::get_named_item (GUIComponent *reference_component, const std::string &id)
 Find the child MenuBar with the specified component ID name. More...
 
virtual Size clan::MenuBar::get_css_size () const
 Get Preferred size. More...
 
PopupMenu clan::MenuBar::get_menu (int index) const
 Get menu. More...
 

Operations

void clan::MenuBar::clear ()
 Clear. More...
 
int clan::MenuBar::add_menu (const std::string &name, PopupMenu popup_menu)
 Add menu. More...
 
void clan::MenuBar::remove_menu (int index)
 Remove menu. More...
 

Implementation

class clan::MenuBar::MenuModalLoop
 

Construction

 clan::OpenFileDialog::OpenFileDialog (GUIComponent *owner)
 Constructs an open file dialog. More...
 
virtual clan::OpenFileDialog::~OpenFileDialog ()
 

Attributes

std::string clan::OpenFileDialog::get_filename () const
 Get the full path of the file selected. More...
 
std::vector< std::string > clan::OpenFileDialog::get_filenames () const
 Gets an array that contains one file name for each selected file. More...
 

Operations

void clan::OpenFileDialog::set_multi_select (bool multiselect)
 Sets if multiple files can be selected or not. More...
 
void clan::OpenFileDialog::set_filename (const std::string &filename)
 Sets a string containing the full path of the file selected. More...
 
void clan::OpenFileDialog::add_filter (const std::string &filter_description, const std::string &filter_extension, bool is_default=false)
 Add a filter that determines what types of files are displayed. More...
 
void clan::OpenFileDialog::clear_filters ()
 Clears all filters. More...
 
void clan::OpenFileDialog::set_filter_index (int filter_index)
 Sets a default filter, on a 0-based index. More...
 
void clan::OpenFileDialog::set_initial_directory (const std::string &path)
 Sets the initial directory that is displayed. More...
 
void clan::OpenFileDialog::set_title (const std::string &title)
 Sets the text that appears in the title bar. More...
 
bool clan::OpenFileDialog::show ()
 Shows the file dialog. More...
 

Construction

 clan::PopupMenu::PopupMenu ()
 
virtual clan::PopupMenu::~PopupMenu ()
 
static PopupMenu clan::PopupMenu::create_null_object ()
 Create null object. More...
 

Attributes

bool clan::PopupMenu::is_null () const
 Returns true if this object is invalid. More...
 
void clan::PopupMenu::throw_if_null () const
 Throw an exception if this object is invalid. More...
 
std::string clan::PopupMenu::get_class () const
 Get Class name. More...
 
PopupMenuItem clan::PopupMenu::get_item (int id)
 Get item. More...
 
PopupMenuItem clan::PopupMenu::get_item_at (int index)
 Get item at. More...
 
int clan::PopupMenu::get_item_count () const
 Item count. More...
 
int clan::PopupMenu::get_minimum_width () const
 Get Minimum width. More...
 
virtual Size clan::PopupMenu::get_css_size () const
 Get Preferred size. More...
 

Events

Callback_v0 & clan::PopupMenu::func_close ()
 bool func_close() More...
 

Operations

void clan::PopupMenu::start (GUIComponent *parent, const Point &pos)
 Start the popup menu for dialog (not modal) More...
 
PopupMenuItem clan::PopupMenu::insert_item (const std::string &text, int id=-1, int index=-1)
 Insert item. More...
 
PopupMenuItem clan::PopupMenu::insert_item_accel (const std::string &text, const std::string &accel_text="", int id=-1, int index=-1)
 Insert item accel. More...
 
PopupMenuItem clan::PopupMenu::insert_separator (int index=-1)
 Insert separator. More...
 
void clan::PopupMenu::set_minimum_width (int width_pixels)
 Set minimum width. More...
 
void clan::PopupMenu::set_maximum_height (int height_pixels)
 Set maximum height. More...
 
void clan::PopupMenu::set_class_name (const std::string &class_name)
 Set class name. More...
 
int clan::PopupMenu::find_item (const std::string &text, bool case_sensitive=false)
 Returns the index of the item that matches the start or the string furthest. More...
 
void clan::PopupMenu::clear ()
 Delete all menu items. More...
 

Implementation

class clan::PopupMenu::MenuBar
 
class clan::PopupMenu::MenuBar_Impl
 
class clan::PopupMenu::PopupMenuWindow
 

Construction

 clan::PopupMenuItem::PopupMenuItem ()
 Construct a null instance. More...
 
 clan::PopupMenuItem::PopupMenuItem (int id)
 Constructs a PopupMenuItem. More...
 
 clan::PopupMenuItem::PopupMenuItem (const std::shared_ptr< PopupMenuItem_Impl > &impl)
 Constructs a PopupMenuItem. More...
 
virtual clan::PopupMenuItem::~PopupMenuItem ()
 

Attributes

std::string clan::PopupMenuItem::get_text () const
 Get Text. More...
 
std::string clan::PopupMenuItem::get_accelerator_text () const
 Get Accelerator text. More...
 
int clan::PopupMenuItem::get_id () const
 Get Id. More...
 
bool clan::PopupMenuItem::is_null () const
 Returns true if this object is invalid. More...
 
void clan::PopupMenuItem::throw_if_null () const
 Throw an exception if this object is invalid. More...
 
bool clan::PopupMenuItem::has_submenu () const
 Has submenu. More...
 
bool clan::PopupMenuItem::is_disabled () const
 Is Disabled. More...
 
bool clan::PopupMenuItem::is_separator () const
 Is Separator. More...
 
PopupMenu clan::PopupMenuItem::get_submenu ()
 Get Submenu. More...
 
bool clan::PopupMenuItem::is_checkable () const
 Is Checkable. More...
 
bool clan::PopupMenuItem::is_checked () const
 Is Checked. More...
 
PixelBuffer clan::PopupMenuItem::get_icon () const
 Get Icon. More...
 

Events

Callback_v0 & clan::PopupMenuItem::func_clicked ()
 Func clicked. More...
 

Operations

void clan::PopupMenuItem::set_id (int id)
 Set id. More...
 
void clan::PopupMenuItem::set_text (const std::string &text)
 Set text. More...
 
void clan::PopupMenuItem::set_icon (const PixelBuffer &image)
 Set icon. More...
 
void clan::PopupMenuItem::set_submenu (PopupMenu &submenu)
 Set submenu. More...
 
void clan::PopupMenuItem::set_enabled (bool enabled)
 Set enabled. More...
 
void clan::PopupMenuItem::set_separator (bool separator)
 Set separator. More...
 
void clan::PopupMenuItem::set_accelerator_text (const std::string &str)
 Set accelerator text. More...
 
void clan::PopupMenuItem::set_checkable (bool checkable)
 Set checkable. More...
 
void clan::PopupMenuItem::set_checked (bool checked)
 Set checked. More...
 

Construction

 clan::ProgressBar::ProgressBar (GUIComponent *parent)
 Constructs a ProgressBar. More...
 
virtual clan::ProgressBar::~ProgressBar ()
 

Attributes

static ProgressBar * clan::ProgressBar::get_named_item (GUIComponent *reference_component, const std::string &id)
 Find the child ProgressBar with the specified component ID name. More...
 
int clan::ProgressBar::get_min () const
 Get Min. More...
 
int clan::ProgressBar::get_max () const
 Get Max. More...
 
int clan::ProgressBar::get_step_size () const
 Get Step size. More...
 
int clan::ProgressBar::get_position () const
 Get Position. More...
 
bool clan::ProgressBar::is_marquee_mode () const
 Is Marquee mode. More...
 
int clan::ProgressBar::get_marquee_animation_speed () const
 Get Marquee animation speed. More...
 
int clan::ProgressBar::get_marquee_box_width () const
 Get Marquee box width. More...
 
int clan::ProgressBar::get_marquee_step_size () const
 Get Marquee step size. More...
 

Operations

void clan::ProgressBar::set_min (int progress_min)
 Set min. More...
 
void clan::ProgressBar::set_max (int progress_max)
 Set max. More...
 
void clan::ProgressBar::set_range (int progress_min, int progress_max)
 Set range. More...
 
void clan::ProgressBar::set_step_size (int size)
 Set step size. More...
 
void clan::ProgressBar::set_position (int pos)
 Set position. More...
 
void clan::ProgressBar::advance_position (int pos)
 Advance position. More...
 
void clan::ProgressBar::step_position ()
 Step position. More...
 
void clan::ProgressBar::set_marquee_mode (bool enable)
 Set marquee mode. More...
 
void clan::ProgressBar::set_marquee_animation_speed (int milliseconds)
 Set marquee animation speed. More...
 
void clan::ProgressBar::set_marquee_box_width (int width)
 Set marquee box width. More...
 
void clan::ProgressBar::set_marquee_step_size (int size)
 Set marquee step size. More...
 

Construction

 clan::PushButton::PushButton (GUIComponent *parent)
 Constructs a PushButton. More...
 
virtual clan::PushButton::~PushButton ()
 

Attributes

enum  clan::PushButton::IconPosition { clan::PushButton::icon_left, clan::PushButton::icon_top, clan::PushButton::icon_right, clan::PushButton::icon_bottom }
 
static PushButton * clan::PushButton::get_named_item (GUIComponent *reference_component, const std::string &id)
 Find the child PushButton with the specified component ID name. More...
 
bool clan::PushButton::is_pushed () const
 Is Pushed. More...
 
bool clan::PushButton::is_toggle () const
 Is Toggle. More...
 
Image clan::PushButton::get_icon () const
 Get Icon. More...
 
IconPosition clan::PushButton::get_icon_position () const
 Get Icon position. More...
 
const std::string & clan::PushButton::get_text () const
 
float clan::PushButton::get_preferred_content_width ()
 Returns the preferred content width. More...
 
float clan::PushButton::get_preferred_content_height (float width)
 Returns the preferred content height for the specified content width. More...
 

Operations

void clan::PushButton::set_pushed (bool enable)
 Set pushed. More...
 
void clan::PushButton::set_toggle (bool enable)
 Set toggle. More...
 
void clan::PushButton::set_icon (const Image &icon)
 Set icon. More...
 
void clan::PushButton::set_icon_position (IconPosition pos)
 Set icon position. More...
 
void clan::PushButton::set_text (const std::string &text)
 Set text. More...
 

Events

Callback_v0 & clan::PushButton::func_clicked ()
 Func clicked. More...
 

Construction

 clan::RadioButton::RadioButton (GUIComponent *parent)
 Constructs a RadioButton. More...
 
virtual clan::RadioButton::~RadioButton ()
 

Attributes

static RadioButton * clan::RadioButton::get_named_item (GUIComponent *reference_component, const std::string &id)
 Find the child RadioButton with the specified component ID name. More...
 
std::string clan::RadioButton::get_text () const
 Get Text. More...
 
int clan::RadioButton::get_radio_id () const
 Get Id. More...
 
bool clan::RadioButton::is_selected () const
 Is Selected. More...
 
std::string clan::RadioButton::get_group_name () const
 Get Group name. More...
 
float clan::RadioButton::get_preferred_content_width ()
 Returns the preferred content width. More...
 
float clan::RadioButton::get_preferred_content_height (float width)
 Returns the preferred content height for the specified content width. More...
 

Operations

void clan::RadioButton::set_text (const std::string &text)
 Set text. More...
 
void clan::RadioButton::set_radio_id (int id)
 Set id. More...
 
void clan::RadioButton::set_selected (bool selected)
 Set selected. More...
 
void clan::RadioButton::set_group_name (const std::string &str)
 Set group name. More...
 

Events

Callback_v0 & clan::RadioButton::func_selected ()
 Func selected. More...
 
Callback_v0 & clan::RadioButton::func_unselected ()
 Func unselected. More...
 
Callback_v1< RadioButton * > & clan::RadioButton::func_group_selection_changed ()
 Callback invoked when any of the radio buttons in the group is selected. More...
 

Implementation

class clan::RadioButton::RadioButton_Impl
 

Construction

 clan::SaveFileDialog::SaveFileDialog (GUIComponent *owner)
 Constructs a save file dialog. More...
 
virtual clan::SaveFileDialog::~SaveFileDialog ()
 

Attributes

std::string clan::SaveFileDialog::get_filename () const
 Get the full path of the file selected. More...
 

Operations

void clan::SaveFileDialog::set_filename (const std::string &filename)
 Sets a string containing the full path of the file selected. More...
 
void clan::SaveFileDialog::add_filter (const std::string &filter_description, const std::string &filter_extension, bool is_default=false)
 Add a filter that determines what types of files are displayed. More...
 
void clan::SaveFileDialog::clear_filters ()
 Clears all filters. More...
 
void clan::SaveFileDialog::set_filter_index (int filter_index)
 Sets a default filter, on a 0-based index. More...
 
void clan::SaveFileDialog::set_initial_directory (const std::string &path)
 Sets the initial directory that is displayed. More...
 
void clan::SaveFileDialog::set_title (const std::string &title)
 Sets the text that appears in the title bar. More...
 
bool clan::SaveFileDialog::show ()
 Shows the file dialog. More...
 

Construction

 clan::ScrollBar::ScrollBar (GUIComponent *parent)
 Constructs a ScrollBar. More...
 
virtual clan::ScrollBar::~ScrollBar ()
 

Attributes

static ScrollBar * clan::ScrollBar::get_named_item (GUIComponent *reference_component, const std::string &id)
 Find the child ScrollBar with the specified component ID name. More...
 
bool clan::ScrollBar::is_vertical () const
 Is Vertical. More...
 
bool clan::ScrollBar::is_horizontal () const
 Is Horizontal. More...
 
int clan::ScrollBar::get_min () const
 Get Min. More...
 
int clan::ScrollBar::get_max () const
 Get Max. More...
 
int clan::ScrollBar::get_line_step () const
 Get Line step. More...
 
int clan::ScrollBar::get_page_step () const
 Get Page step. More...
 
int clan::ScrollBar::get_position () const
 Get Position. More...
 

Operations

void clan::ScrollBar::set_vertical ()
 Set vertical. More...
 
void clan::ScrollBar::set_horizontal ()
 Set horizontal. More...
 
void clan::ScrollBar::set_min (int scroll_min)
 Set min. More...
 
void clan::ScrollBar::set_max (int scroll_max)
 Set max. More...
 
void clan::ScrollBar::set_line_step (int step)
 Set line step. More...
 
void clan::ScrollBar::set_page_step (int step)
 Set page step. More...
 
void clan::ScrollBar::set_ranges (int scroll_min, int scroll_max, int line_step, int page_step)
 Set ranges. More...
 
void clan::ScrollBar::calculate_ranges (int view_size, int total_size)
 Calculate the scrollbar range and page_step size for scrolling in pixels. More...
 
void clan::ScrollBar::set_position (int pos)
 Set position. More...
 
float clan::ScrollBar::get_preferred_content_width ()
 Returns the preferred content width. More...
 
float clan::ScrollBar::get_preferred_content_height (float width)
 Returns the preferred content height for the specified content width. More...
 

Events

Callback_v0 & clan::ScrollBar::func_scroll ()
 Called for every type of scrollbar scrolling. More...
 
Callback_v0 & clan::ScrollBar::func_scroll_min ()
 Called when scrolled to minimum position. More...
 
Callback_v0 & clan::ScrollBar::func_scroll_max ()
 Called when scrolled to maximum position. More...
 
Callback_v0 & clan::ScrollBar::func_scroll_line_decrement ()
 Called when decrement button is clicked. More...
 
Callback_v0 & clan::ScrollBar::func_scroll_line_increment ()
 Called when increment button is clicked. More...
 
Callback_v0 & clan::ScrollBar::func_scroll_page_decrement ()
 Called when decrement track is clicked. More...
 
Callback_v0 & clan::ScrollBar::func_scroll_page_increment ()
 Called when increment track is clicked. More...
 
Callback_v0 & clan::ScrollBar::func_scroll_thumb_release ()
 Called when user released scroll thumb. More...
 
Callback_v0 & clan::ScrollBar::func_scroll_thumb_track ()
 Called as user moves the scroll thumb. More...
 
Callback_v0 & clan::ScrollBar::func_scroll_end ()
 Called when user releases the mouse after scrolling. More...
 

Construction

 clan::Slider::Slider (GUIComponent *parent)
 Constructs a Slider. More...
 
virtual clan::Slider::~Slider ()
 

Attributes

static Slider * clan::Slider::get_named_item (GUIComponent *reference_component, const std::string &id)
 Find the child Slider with the specified component ID name. More...
 
bool clan::Slider::is_vertical () const
 Is Vertical. More...
 
bool clan::Slider::is_horizontal () const
 Is Horizontal. More...
 
int clan::Slider::get_min () const
 Get Min. More...
 
int clan::Slider::get_max () const
 Get Max. More...
 
int clan::Slider::get_tick_count () const
 Get Tick count. More...
 
int clan::Slider::get_page_step () const
 Get Page step. More...
 
int clan::Slider::get_position () const
 Get Position. More...
 
bool clan::Slider::get_lock_to_ticks () const
 Get Lock to ticks. More...
 
float clan::Slider::get_preferred_content_width ()
 Returns the preferred content width. More...
 
float clan::Slider::get_preferred_content_height (float width)
 Returns the preferred content height for the specified content width. More...
 

Operations

void clan::Slider::set_vertical (bool enable)
 Set vertical. More...
 
void clan::Slider::set_horizontal (bool enable)
 Set horizontal. More...
 
void clan::Slider::set_min (int slider_min)
 Set min. More...
 
void clan::Slider::set_max (int slider_max)
 Set max. More...
 
void clan::Slider::set_tick_count (int tick_count)
 Set tick count. More...
 
void clan::Slider::set_page_step (int steps)
 Set page step. More...
 
void clan::Slider::set_lock_to_ticks (bool lock)
 Set lock to ticks. More...
 
void clan::Slider::set_ranges (int slider_min, int slider_max, unsigned int tick_count, int page_step)
 Set ranges. More...
 
void clan::Slider::set_position (int pos)
 Set position. More...
 

Callbacks

Callback_v0 & clan::Slider::func_value_changed ()
 Emitted while the slider is being moved. More...
 
Callback_v0 & clan::Slider::func_value_decremented ()
 Emitted when the slider value is decremented (while moving or when clicking the track). More...
 
Callback_v0 & clan::Slider::func_value_incremented ()
 Emitted when the slider value is incremented. More...
 
Callback_v0 & clan::Slider::func_slider_moved ()
 Emitted after the slider has been moved. More...
 

Construction

 clan::Spin::Spin (GUIComponent *parent)
 Constructs a Spin. More...
 
virtual clan::Spin::~Spin ()
 

Attributes

static Spin * clan::Spin::get_named_item (GUIComponent *reference_component, const std::string &id)
 Find the child Spin with the specified component ID name. More...
 
int clan::Spin::get_value () const
 Get Value. More...
 
float clan::Spin::get_value_float () const
 Get Value float. More...
 
int clan::Spin::get_min () const
 Get Min. More...
 
int clan::Spin::get_max () const
 Get Max. More...
 
float clan::Spin::get_min_float () const
 Get Min float. More...
 
float clan::Spin::get_max_float () const
 Get Max float. More...
 
bool clan::Spin::get_floating_point_mode () const
 Get Floating point mode. More...
 

Operations

void clan::Spin::set_value (int value)
 Set value. More...
 
void clan::Spin::set_value_float (float value)
 Set value float. More...
 
void clan::Spin::set_ranges (int min, int max)
 Set ranges. More...
 
void clan::Spin::set_ranges_float (float min, float max)
 Set ranges float. More...
 
void clan::Spin::set_step_size (int step_size)
 Set step size. More...
 
void clan::Spin::set_step_size_float (float step_size)
 Set step size float. More...
 
void clan::Spin::set_number_of_decimal_places (int decimal_places)
 Set number of decimal places. More...
 
void clan::Spin::set_floating_point_mode (bool use_floating_point)
 Set floating point mode. More...
 

Events

Callback_v0 & clan::Spin::func_value_changed ()
 Func value changed. More...
 

Construction

 clan::StatusBar::StatusBar (GUIComponent *parent)
 Constructs a StatusBar. More...
 
virtual clan::StatusBar::~StatusBar ()
 

Attributes

static StatusBar * clan::StatusBar::get_named_item (GUIComponent *reference_component, const std::string &id)
 Find the child StatusBar with the specified component ID name. More...
 
Callback_v0 & clan::StatusBar::func_part_double_clicked (int id)
 Func part double clicked. More...
 

Operations

void clan::StatusBar::set_status_text (const std::string &text)
 Set status text. More...
 
void clan::StatusBar::set_part_text (int id, const std::string &text)
 Set part text. More...
 
void clan::StatusBar::set_part_text (int id, const Image &icon, const std::string &text)
 Set part text. More...
 
void clan::StatusBar::add_part (int id, int width, GUIComponent *component=0)
 Add part. More...
 
void clan::StatusBar::show_part (int id, bool show=true)
 Show part. More...
 
void clan::StatusBar::remove_part (int id)
 Remove part. More...
 
void clan::StatusBar::show_size_grip (bool show=true)
 Show size grip. More...
 

Construction

 clan::Tab::Tab (GUIComponent *parent)
 Constructs a Tab. More...
 
virtual clan::Tab::~Tab ()
 

Attributes

static Tab * clan::Tab::get_named_item (GUIComponent *reference_component, const std::string &id)
 Find the child Tab with the specified component ID name. More...
 
TabPage * clan::Tab::get_page (int index) const
 Get page. More...
 
TabPage * clan::Tab::get_page_by_id (int id) const
 Get page by id. More...
 
int clan::Tab::get_current_page_index () const
 Get Current page index. More...
 
int clan::Tab::get_current_page_id () const
 Get Current page id. More...
 
int clan::Tab::get_page_count () const
 returns the number of pages in the tab. More...
 

Events

Callback_v1< TabPage * > & clan::Tab::func_page_selected ()
 void func_page_selected(Page *tab_page) More...
 

Operations

TabPage * clan::Tab::add_page (const std::string &label, int id=0)
 Create new tab page. By default the ID of the tab is 0. More...
 
void clan::Tab::show_page (int index)
 Show a page by its index. More...
 
void clan::Tab::show_page_by_id (int id)
 Show a page by its ID. In case of non-unique ID's the first match will be shown. More...
 
void clan::Tab::remove_page (int index)
 Remove a page by its index. More...
 
void clan::Tab::remove_page_by_id (int id)
 Remove a page by its ID. More...
 
void clan::Tab::set_label (int index, const std::string &new_label)
 Set the label of the component specified by index. More...
 
void clan::Tab::set_label_by_id (int id, const std::string &new_label)
 Set the label of the component specified by index. More...
 

Construction

 clan::TabPage::TabPage (GUIComponent *parent)
 Constructs a TabPage. More...
 
virtual clan::TabPage::~TabPage ()
 

Attributes

static TabPage * clan::TabPage::get_named_item (GUIComponent *reference_component, const std::string &id)
 Find the child ToolTip with the specified component ID name. More...
 
int clan::TabPage::get_id () const
 Get Id. More...
 
std::string clan::TabPage::get_label () const
 Get Label. More...
 

Implementation

class clan::TabPage::Tab
 

Construction

 clan::TextEdit::TextEdit (GUIComponent *parent)
 Constructs a LineEdit. More...
 
virtual clan::TextEdit::~TextEdit ()
 

Attributes

static TextEdit * clan::TextEdit::get_named_item (GUIComponent *reference_component, const std::string &id)
 Find the child TextEdit with the specified component ID name. More...
 
bool clan::TextEdit::is_read_only () const
 Is Read only. More...
 
bool clan::TextEdit::is_lowercase () const
 Is Lowercase. More...
 
bool clan::TextEdit::is_uppercase () const
 Is Uppercase. More...
 
int clan::TextEdit::get_max_length () const
 Get Max length. More...
 
std::string clan::TextEdit::get_text () const
 Get Text. More...
 
int clan::TextEdit::get_line_count () const
 Get line count. More...
 
std::string clan::TextEdit::get_line_text (int line) const
 Get line text. More...
 
std::string clan::TextEdit::get_selection () const
 Get Selection. More...
 
int clan::TextEdit::get_selection_start () const
 Get Selection start. More...
 
int clan::TextEdit::get_selection_length () const
 Get Selection length. More...
 
int clan::TextEdit::get_cursor_pos () const
 Get Cursor pos. More...
 
int clan::TextEdit::get_cursor_line_number () const
 Get Cursor line number. More...
 
int clan::TextEdit::get_total_height ()
 Returns the height required to display all lines with the current width of the control. More...
 

Operations

void clan::TextEdit::set_select_all_on_focus_gain (bool enable)
 
void clan::TextEdit::select_all ()
 Select all. More...
 
void clan::TextEdit::set_read_only (bool enable=true)
 Set read only. More...
 
void clan::TextEdit::set_lowercase (bool enable=true)
 Set lowercase. More...
 
void clan::TextEdit::set_uppercase (bool enable=true)
 Set uppercase. More...
 
void clan::TextEdit::set_max_length (int length)
 Set max length. More...
 
void clan::TextEdit::set_text (const std::string &text)
 Set text. More...
 
void clan::TextEdit::add_text (const std::string &text)
 Add text to end. More...
 
void clan::TextEdit::set_selection (int pos, int length)
 Set selection. More...
 
void clan::TextEdit::clear_selection ()
 Clear selection. More...
 
void clan::TextEdit::set_cursor_pos (int pos)
 Set cursor pos. More...
 
void clan::TextEdit::delete_selected_text ()
 Delete selected text. More...
 
void clan::TextEdit::set_input_mask (const std::string &mask)
 Use mask to restrict accepted input. More...
 
void clan::TextEdit::set_cursor_drawing_enabled (bool enable)
 Set cursor drawing enabled/disabled. More...
 

Events

Callback_v1< InputEvent & > & clan::TextEdit::func_before_edit_changed ()
 
Callback_v1< InputEvent & > & clan::TextEdit::func_after_edit_changed ()
 
Callback_v0 & clan::TextEdit::func_selection_changed ()
 Func selection changed. More...
 
Callback_v0 & clan::TextEdit::func_focus_gained ()
 Callback invoked after the lineedit gained focus. More...
 
Callback_v0 & clan::TextEdit::func_focus_lost ()
 Callback invoked when the lineedit is about to lose focus. More...
 
Callback_v0 & clan::TextEdit::func_enter_pressed ()
 Func enter pressed. More...
 

Construction

 clan::ToolBar::ToolBar (GUIComponent *parent)
 Constructs a ToolBar. More...
 
virtual clan::ToolBar::~ToolBar ()
 

Attributes

static ToolBar * clan::ToolBar::get_named_item (GUIComponent *reference_component, const std::string &id)
 Find the child ToolBar with the specified component ID name. More...
 
Size clan::ToolBar::get_css_size () const
 Get Preferred size. More...
 
ToolBarItem clan::ToolBar::get_item_by_id (int id)
 Get item by id. More...
 
ToolBarItem clan::ToolBar::get_item (int index)
 Get item. More...
 
int clan::ToolBar::get_item_index (int id)
 Get item index. More...
 
int clan::ToolBar::get_item_count () const
 Get Item count. More...
 

Operations

ToolBarItem clan::ToolBar::add_item (const Sprite &icon, int frame, const std::string &text, int id)
 Add item. More...
 
ToolBarItem clan::ToolBar::insert_item (const Sprite &icon, int frame, const std::string &text, int id=-1, int index=-1)
 Insert item. More...
 
ToolBarItem clan::ToolBar::insert_separator (int index=-1)
 Insert separator. More...
 
void clan::ToolBar::delete_item (int index)
 Delete item. More...
 
void clan::ToolBar::set_single_selection (bool value)
 Set single selection. More...
 
void clan::ToolBar::clear_selection ()
 Clear selection. More...
 

Events

Callback_v1< ToolBarItem > & clan::ToolBar::func_item_clicked ()
 
Callback_v1< ToolBarItem > & clan::ToolBar::func_item_selected ()
 
Callback_v1< ToolBarItem > & clan::ToolBar::func_item_unselected ()
 
Callback_v2< Point, int > & clan::ToolBar::func_mouse_right_up ()
 Signal invoked when the toolbar is right-clicked. The parameters are click position and clicked item index. More...
 

Construction

 clan::ToolBarItem::ToolBarItem ()
 Construct a null instance. More...
 
 clan::ToolBarItem::ToolBarItem (int id)
 Constructs a ToolBarItem. More...
 
 clan::ToolBarItem::ToolBarItem (const std::shared_ptr< ToolBarItem_Impl > &impl)
 Constructs a ToolBarItem. More...
 
virtual clan::ToolBarItem::~ToolBarItem ()
 

Attributes

std::string clan::ToolBarItem::get_text () const
 Get Text. More...
 
int clan::ToolBarItem::get_id () const
 Get Id. More...
 
bool clan::ToolBarItem::is_null () const
 Returns true if this object is invalid. More...
 
void clan::ToolBarItem::throw_if_null () const
 Throw an exception if this object is invalid. More...
 
bool clan::ToolBarItem::is_disabled () const
 Is Disabled. More...
 
bool clan::ToolBarItem::is_toggling () const
 Is Toggling. More...
 
bool clan::ToolBarItem::is_pressed () const
 Is Pressed. More...
 

Operations

void clan::ToolBarItem::set_id (int id)
 Set id. More...
 
void clan::ToolBarItem::set_text (const std::string &text)
 Set text. More...
 
void clan::ToolBarItem::set_icon (const Sprite &image, int frame=0)
 Set icon. More...
 
void clan::ToolBarItem::set_toggling (bool toggling)
 Controls if buttons stay down when pressed. More...
 
void clan::ToolBarItem::set_pressed (bool value)
 Set pressed. More...
 

Implementation

class clan::ToolBarItem::ToolBar
 
class clan::ToolBarItem::ToolBar_Impl
 

Construction

 clan::ToolTip::ToolTip (GUIManager gui_manager)
 Constructs a ToolTip. More...
 
virtual clan::ToolTip::~ToolTip ()
 

Attributes

static ToolTip * clan::ToolTip::get_named_item (GUIComponent *reference_component, const std::string &id)
 Find the child ToolTip with the specified component ID name. More...
 
std::string clan::ToolTip::get_text () const
 Get Text. More...
 

Operations

void clan::ToolTip::set_text (const std::string &text)
 Set text. More...
 
void clan::ToolTip::show (const Point &position)
 Show. More...
 
void clan::ToolTip::show_delayed (const Point &position, int delay_time=750)
 Show delayed. More...
 
void clan::ToolTip::hide ()
 Hide. More...
 

Detailed Description

Enumeration Type Documentation

Enumerator
align_left 
align_center 
align_right 
align_justify 
Enumerator
align_left 
align_center 
align_right 
Enumerator
icon_left 
icon_top 
icon_right 
icon_bottom 
Enumerator
mb_buttons_yes_no 
mb_buttons_yes_no_cancel 
mb_buttons_ok 
mb_buttons_ok_cancel 
Enumerator
mb_icon_none 
mb_icon_warning 
mb_icon_info 
mb_icon_error 
mb_icon_question 
Enumerator
mb_result_yes 
mb_result_no 
mb_result_cancel 
mb_result_ok 
Enumerator
align_left 
align_right 
align_center 

Function Documentation

clan::BrowseFolderDialog::BrowseFolderDialog ( GUIComponent owner)

Constructs an browse folder dialog.

Parameters
owner= Owning GUIComponent
clan::CheckBox::CheckBox ( GUIComponent parent)

Constructs a CheckBox.

Parameters
parent= GUIComponent
clan::ComboBox::ComboBox ( GUIComponent parent)

Constructs a ComboBox.

Parameters
parent= GUIComponent
clan::DragBox::DragBox ( GUIComponent parent)

Constructs a DragBox.

Parameters
parent= GUIComponent
clan::DragBox::DragBox ( GUIManager manager,
const GUITopLevelDescription description 
)

Constructs a DragBox.

Parameters
manager= GUIManager
description= GUITop Level Description
clan::Frame::Frame ( GUIComponent parent)

Constructs a Frame.

Parameters
parent= GUIComponent
clan::GroupBox::GroupBox ( GUIComponent parent)

Constructs a GroupBox.

Parameters
parent= GUIComponent
clan::ImageView::ImageView ( GUIComponent parent)

Constructs a ImageView.

Parameters
parent= GUIComponent
clan::Label::Label ( GUIComponent parent)

Constructs a Label.

Parameters
parent= GUIComponent
clan::LineEdit::LineEdit ( GUIComponent parent)

Constructs a LineEdit.

Parameters
parent= GUIComponent
clan::ListView::ListView ( GUIComponent parent)

Constructs a ListView.

Parameters
parent= GUIComponent
clan::ListViewColumnData::ListViewColumnData ( )
clan::ListViewColumnHeader::ListViewColumnHeader ( )
clan::ListViewHeader::ListViewHeader ( GUIComponent parent)

Constructs a ListViewHeader.

Parameters
parent= GUIComponent
clan::ListViewIcon::ListViewIcon ( )
clan::ListViewIconList::ListViewIconList ( )
clan::ListViewItem::ListViewItem ( )

Construct a null instance.

clan::ListViewSelectedItem::ListViewSelectedItem ( )

Contruct a null instance.

clan::ListViewSelectedItem::ListViewSelectedItem ( const ListViewItem item)

Constructs a ListViewSelectedItem.

Parameters
item= List View Item
clan::ListViewSelection::ListViewSelection ( )
clan::MenuBar::MenuBar ( GUIComponent parent)

Constructs a MenuBar.

Parameters
parent= GUIComponent
clan::OpenFileDialog::OpenFileDialog ( GUIComponent owner)

Constructs an open file dialog.

Parameters
owner= Owning GUIComponent
clan::PopupMenu::PopupMenu ( )
clan::PopupMenuItem::PopupMenuItem ( )

Construct a null instance.

clan::PopupMenuItem::PopupMenuItem ( int  id)

Constructs a PopupMenuItem.

Parameters
id= value
clan::PopupMenuItem::PopupMenuItem ( const std::shared_ptr< PopupMenuItem_Impl > &  impl)

Constructs a PopupMenuItem.

Parameters
PopupMenuItem_Impl= Shared Ptr
clan::ProgressBar::ProgressBar ( GUIComponent parent)

Constructs a ProgressBar.

Parameters
parent= GUIComponent
clan::PushButton::PushButton ( GUIComponent parent)

Constructs a PushButton.

Parameters
parent= GUIComponent
clan::RadioButton::RadioButton ( GUIComponent parent)

Constructs a RadioButton.

Parameters
parent= GUIComponent
clan::SaveFileDialog::SaveFileDialog ( GUIComponent owner)

Constructs a save file dialog.

Parameters
owner= Owning GUIComponent
clan::ScrollBar::ScrollBar ( GUIComponent parent)

Constructs a ScrollBar.

Parameters
parent= GUIComponent
clan::Slider::Slider ( GUIComponent parent)

Constructs a Slider.

Parameters
parent= GUIComponent
clan::Spin::Spin ( GUIComponent parent)

Constructs a Spin.

Parameters
parent= GUIComponent
clan::StatusBar::StatusBar ( GUIComponent parent)

Constructs a StatusBar.

Parameters
parent= GUIComponent
clan::Tab::Tab ( GUIComponent parent)

Constructs a Tab.

Parameters
parent= GUIComponent
clan::TabPage::TabPage ( GUIComponent parent)

Constructs a TabPage.

Parameters
parent= GUIComponent
clan::TextEdit::TextEdit ( GUIComponent parent)

Constructs a LineEdit.

Parameters
parent= GUIComponent
clan::ToolBar::ToolBar ( GUIComponent parent)

Constructs a ToolBar.

Parameters
parent= GUIComponent
clan::ToolBarItem::ToolBarItem ( )

Construct a null instance.

clan::ToolBarItem::ToolBarItem ( int  id)

Constructs a ToolBarItem.

Parameters
id= value
clan::ToolBarItem::ToolBarItem ( const std::shared_ptr< ToolBarItem_Impl > &  impl)

Constructs a ToolBarItem.

Parameters
ToolBarItem_Impl= Shared Ptr
clan::ToolTip::ToolTip ( GUIManager  gui_manager)

Constructs a ToolTip.

Parameters
gui_manager= GUIManager
virtual clan::BrowseFolderDialog::~BrowseFolderDialog ( )
virtual
virtual clan::CheckBox::~CheckBox ( )
virtual
virtual clan::ComboBox::~ComboBox ( )
virtual
virtual clan::DragBox::~DragBox ( )
virtual
virtual clan::Frame::~Frame ( )
virtual
virtual clan::GroupBox::~GroupBox ( )
virtual
virtual clan::ImageView::~ImageView ( )
virtual
virtual clan::Label::~Label ( )
virtual
virtual clan::LineEdit::~LineEdit ( )
virtual
virtual clan::ListView::~ListView ( )
virtual
clan::ListViewColumnData::~ListViewColumnData ( )
clan::ListViewColumnHeader::~ListViewColumnHeader ( )
clan::ListViewHeader::~ListViewHeader ( )
clan::ListViewIcon::~ListViewIcon ( )
clan::ListViewIconList::~ListViewIconList ( )
clan::ListViewItem::~ListViewItem ( )
virtual clan::ListViewItemUserData::~ListViewItemUserData ( )
inlinevirtual
virtual clan::MenuBar::~MenuBar ( )
virtual
virtual clan::OpenFileDialog::~OpenFileDialog ( )
virtual
virtual clan::PopupMenu::~PopupMenu ( )
virtual
virtual clan::PopupMenuItem::~PopupMenuItem ( )
virtual
virtual clan::ProgressBar::~ProgressBar ( )
virtual
virtual clan::PushButton::~PushButton ( )
virtual
virtual clan::RadioButton::~RadioButton ( )
virtual
virtual clan::SaveFileDialog::~SaveFileDialog ( )
virtual
virtual clan::ScrollBar::~ScrollBar ( )
virtual
virtual clan::Slider::~Slider ( )
virtual
virtual clan::Spin::~Spin ( )
virtual
virtual clan::StatusBar::~StatusBar ( )
virtual
virtual clan::Tab::~Tab ( )
virtual
virtual clan::TabPage::~TabPage ( )
virtual
virtual clan::TextEdit::~TextEdit ( )
virtual
virtual clan::ToolBar::~ToolBar ( )
virtual
virtual clan::ToolBarItem::~ToolBarItem ( )
virtual
virtual clan::ToolTip::~ToolTip ( )
virtual
void clan::SaveFileDialog::add_filter ( const std::string &  filter_description,
const std::string &  filter_extension,
bool  is_default = false 
)

Add a filter that determines what types of files are displayed.

Parameters
filter_description= filter_description
filter_extension= filter_extension
is_default= is_default
void clan::OpenFileDialog::add_filter ( const std::string &  filter_description,
const std::string &  filter_extension,
bool  is_default = false 
)

Add a filter that determines what types of files are displayed.

Parameters
filter_description= filter_description
filter_extension= filter_extension
is_default= is_default
ToolBarItem clan::ToolBar::add_item ( const Sprite icon,
int  frame,
const std::string &  text,
int  id 
)

Add item.

Parameters
icon= Sprite
frame= value
text= String Ref
id= value
Returns
Tool Bar Item
int clan::MenuBar::add_menu ( const std::string &  name,
PopupMenu  popup_menu 
)

Add menu.

Parameters
name= String Ref
popup_menu= Popup Menu
Returns
int
void clan::ListViewItem::add_overlay_icon ( int  icon_index)

Add overlay icon.

Parameters
icon_index= value
TabPage* clan::Tab::add_page ( const std::string &  label,
int  id = 0 
)

Create new tab page. By default the ID of the tab is 0.

void clan::StatusBar::add_part ( int  id,
int  width,
GUIComponent component = 0 
)

Add part.

Parameters
id= value
width= value
component= GUIComponent
void clan::TextEdit::add_text ( const std::string &  text)

Add text to end.

Parameters
text= String Ref
void clan::ProgressBar::advance_position ( int  pos)

Advance position.

Parameters
pos= value
ListViewColumnHeader clan::ListViewHeader::append ( ListViewColumnHeader  column)

Append.

Parameters
column= List View Column Header
Returns
List View Column Header
void clan::ListViewSelection::append ( const ListViewItem item)

Append.

Parameters
item= List View Item
ListViewItem clan::ListViewItem::append_child ( ListViewItem item)

Append child.

Parameters
item= List View Item
Returns
List View Item
void clan::ScrollBar::calculate_ranges ( int  view_size,
int  total_size 
)

Calculate the scrollbar range and page_step size for scrolling in pixels.

This is equal to calling set_min(0), set_max(total_size-view_size) and set_page_step((total_size-scroll_max)*scroll_max)/(total_size)). The range of the scrollbar will be the amount of pixels the view needs to be moved to show all the data.

void clan::MenuBar::clear ( )

Clear.

void clan::ListViewIconList::clear ( )

Clear the icon list.

void clan::ListViewSelection::clear ( )

Clear.

void clan::PopupMenu::clear ( )

Delete all menu items.

Parameters
class_name= String Ref
void clan::ListView::clear ( )

Remove all items.

void clan::SaveFileDialog::clear_filters ( )

Clears all filters.

void clan::OpenFileDialog::clear_filters ( )

Clears all filters.

void clan::ToolBar::clear_selection ( )

Clear selection.

void clan::TextEdit::clear_selection ( )

Clear selection.

void clan::ListView::clear_selection ( )

Unselect all selected items.

void clan::LineEdit::clear_selection ( )

Clear selection.

ListViewColumnHeader clan::ListViewHeader::create_column ( const std::string &  column_id,
const std::string &  caption 
)

Create column.

Parameters
column_id= String Ref
caption= String Ref
Returns
List View Column Header
ListViewItem clan::ListView::create_item ( )

Create item.

Returns
List View Item
static PopupMenu clan::PopupMenu::create_null_object ( )
static

Create null object.

Returns
Popup Menu
void clan::ToolBar::delete_item ( int  index)

Delete item.

Parameters
index= value
void clan::TextEdit::delete_selected_text ( )

Delete selected text.

void clan::LineEdit::delete_selected_text ( )

Delete selected text.

void clan::ListViewIcon::draw ( Canvas canvas,
const Rect rect,
ListViewDisplayMode  mode,
const Colorf color 
)

Draw.

Parameters
canvas= Canvas
rect= Rect
mode= List View Display Mode
color= Colorf
void clan::ListViewIconList::erase ( int  index)

Erase the icon at the specified index.

ListViewItem clan::ListView::find ( const std::string &  col_id,
const std::string &  str,
bool  recursive = true 
)

Returns a ListViewItem with the string 'str' in the column 'col_id' or a NULL item if none found.

ListViewItem clan::ListView::find ( int  id,
bool  recursive = true 
)

Returns the first ListViewItem with the specified ID, or a NULL item if none found.

ListViewItem clan::ListView::find ( std::shared_ptr< ListViewItemUserData userdata,
bool  recursive = true 
)

Returns a ListViewItem with the userdata 'ptr', or a NULL item if none found.

int clan::PopupMenu::find_item ( const std::string &  text,
bool  case_sensitive = false 
)

Returns the index of the item that matches the start or the string furthest.

Callback_v0& clan::ComboBox::func_after_edit_changed ( )

Func after edit changed.

Returns
Callback_v0
Callback_v1<InputEvent &>& clan::TextEdit::func_after_edit_changed ( )
Callback_v1<InputEvent &>& clan::LineEdit::func_after_edit_changed ( )
Callback_v0& clan::ComboBox::func_before_edit_changed ( )

Func before edit changed.

Returns
Callback_v0
Callback_v1<InputEvent &>& clan::TextEdit::func_before_edit_changed ( )
Callback_v1<InputEvent &>& clan::LineEdit::func_before_edit_changed ( )
Callback_v0& clan::ListView::func_begin_drag ( )

Callback called when the user begins a drag'n'drop action.

Callback_v0& clan::CheckBox::func_checked ( )

Func checked.

Returns
Callback_v0
Callback_v0& clan::PopupMenuItem::func_clicked ( )

Func clicked.

Returns
Callback_v0
Callback_v0& clan::PushButton::func_clicked ( )

Func clicked.

Returns
Callback_v0
Callback_v0& clan::PopupMenu::func_close ( )
Callback_v1<ListViewColumnHeader>& clan::ListViewHeader::func_column_added ( )
Callback_v1<ListViewColumnHeader>& clan::ListViewHeader::func_column_removed ( )
Callback_v1<ListViewColumnHeader>& clan::ListViewHeader::func_column_size_changed ( )
Callback_v0& clan::ComboBox::func_dropdown_closed ( )

Func dropdown closed.

Returns
Callback_v0
Callback_v0& clan::ComboBox::func_dropdown_opened ( )

Func dropdown opened.

Returns
Callback_v0
Callback_v0& clan::ComboBox::func_enter_pressed ( )

Func enter pressed.

Returns
Callback_v0
Callback_v0& clan::TextEdit::func_enter_pressed ( )

Func enter pressed.

Returns
Callback_v0
Callback_v0& clan::LineEdit::func_enter_pressed ( )

Func enter pressed.

Returns
Callback_v0
Callback_v0& clan::TextEdit::func_focus_gained ( )

Callback invoked after the lineedit gained focus.

Callback_v0& clan::LineEdit::func_focus_gained ( )

Callback invoked after the lineedit gained focus.

Callback_v0& clan::TextEdit::func_focus_lost ( )

Callback invoked when the lineedit is about to lose focus.

Callback_v0& clan::LineEdit::func_focus_lost ( )

Callback invoked when the lineedit is about to lose focus.

Callback_v1<RadioButton*>& clan::RadioButton::func_group_selection_changed ( )

Callback invoked when any of the radio buttons in the group is selected.

The newly selected radio button is passed as parameter to the callback.

Callback_v0& clan::CheckBox::func_indeterminated ( )

Func indeterminated.

Returns
Callback_v0
Callback_v1<ToolBarItem>& clan::ToolBar::func_item_clicked ( )
Callback_v1<const ListViewItem &>& clan::ListView::func_item_closed ( )

Callback called when an item node is closed.

Callback_v1<const ListViewItem &>& clan::ListView::func_item_doubleclick ( )

Invoked on double clicking a listview item.

Callback_2<bool, ListViewItem, std::string &>& clan::ListView::func_item_edited ( )

Invoked when enter is pressed in the ListViews built-in LineEdit control. The caller may change the passed string. Returning false from the callback cancels the edit.

Callback_v1<const ListViewItem &>& clan::ListView::func_item_opened ( )

Callback called when an item node is opened.

Callback_v1<ToolBarItem>& clan::ToolBar::func_item_selected ( )
Callback_v1<int>& clan::ComboBox::func_item_selected ( )

Func after item selected.

Returns
Callback_v1<int>
Callback_v1<ToolBarItem>& clan::ToolBar::func_item_unselected ( )
Callback_v1<InputEvent&>& clan::ListView::func_key_pressed ( )
Callback_v1<InputEvent&>& clan::ListView::func_key_released ( )
Callback_v2<Point, int>& clan::ToolBar::func_mouse_right_up ( )

Signal invoked when the toolbar is right-clicked. The parameters are click position and clicked item index.

Callback_v1<Point>& clan::ListView::func_mouse_right_up ( )

Callback called when the right mouse button is released (a click). Use this callback for listview context menus. Click position sent as parameter.

Callback_v1<TabPage*>& clan::Tab::func_page_selected ( )

void func_page_selected(Page *tab_page)

Callback_v0& clan::StatusBar::func_part_double_clicked ( int  id)

Func part double clicked.

Parameters
id= value
Returns
Callback_v0
Callback_v1<Rect>& clan::ListViewItem::func_render_icon ( )
Callback_v0& clan::ScrollBar::func_scroll ( )

Called for every type of scrollbar scrolling.

Callback_v0& clan::ScrollBar::func_scroll_end ( )

Called when user releases the mouse after scrolling.

Callback_v0& clan::ScrollBar::func_scroll_line_decrement ( )

Called when decrement button is clicked.

Callback_v0& clan::ScrollBar::func_scroll_line_increment ( )

Called when increment button is clicked.

Callback_v0& clan::ScrollBar::func_scroll_max ( )

Called when scrolled to maximum position.

Callback_v0& clan::ScrollBar::func_scroll_min ( )

Called when scrolled to minimum position.

Callback_v0& clan::ScrollBar::func_scroll_page_decrement ( )

Called when decrement track is clicked.

Callback_v0& clan::ScrollBar::func_scroll_page_increment ( )

Called when increment track is clicked.

Callback_v0& clan::ScrollBar::func_scroll_thumb_release ( )

Called when user released scroll thumb.

Callback_v0& clan::ScrollBar::func_scroll_thumb_track ( )

Called as user moves the scroll thumb.

Callback_v0& clan::RadioButton::func_selected ( )

Func selected.

Returns
Callback_v0
Callback_v1<int>& clan::ComboBox::func_selection_changed ( )

Func after selection changed.

Returns
Callback_v1<int>
Callback_v1<ListViewSelection>& clan::ListView::func_selection_changed ( )

Selected items are returned as children of the returned item.

Callback_v0& clan::TextEdit::func_selection_changed ( )

Func selection changed.

Returns
Callback_v0
Callback_v0& clan::LineEdit::func_selection_changed ( )

Func selection changed.

Returns
Callback_v0
Callback_v1<ListViewColumnHeader>& clan::ListViewColumnHeader::func_size_changed ( )
Callback_v0& clan::Slider::func_slider_moved ( )

Emitted after the slider has been moved.

Callback_v0& clan::CheckBox::func_state_changed ( )

Func state changed.

Returns
Callback_v0
Callback_v0& clan::CheckBox::func_unchecked ( )

Func unchecked.

Returns
Callback_v0
Callback_v0& clan::RadioButton::func_unselected ( )

Func unselected.

Returns
Callback_v0
Callback_v0& clan::Spin::func_value_changed ( )

Func value changed.

Returns
Callback_v0
Callback_v0& clan::Slider::func_value_changed ( )

Emitted while the slider is being moved.

Callback_v0& clan::Slider::func_value_decremented ( )

Emitted when the slider value is decremented (while moving or when clicking the track).

Invoked while moving or when clicking the track.

Callback_v0& clan::Slider::func_value_incremented ( )

Emitted when the slider value is incremented.

Invoked while moving or when clicking the track.

std::string clan::PopupMenuItem::get_accelerator_text ( ) const

Get Accelerator text.

Returns
accelerator_text
Alignment clan::Label::get_alignment ( ) const

Get Alignment.

Returns
alignment
Alignment clan::LineEdit::get_alignment ( ) const

Get Alignment.

Returns
alignment
ListViewColumnHeader::TextAlignment clan::ListViewColumnHeader::get_alignment ( )
std::string clan::ListViewColumnHeader::get_caption ( ) const

Get Caption.

Returns
caption
int clan::ListViewItem::get_child_count ( bool  recursive = false,
bool  recurse_only_into_open_items = false 
)

Get child count.

Parameters
recursive= bool
recurse_only_into_open_items= bool
Returns
int
std::string clan::PopupMenu::get_class ( ) const

Get Class name.

Returns
class_name
Colorf clan::ListViewIconList::get_color ( )

Get Color.

Returns
color
Colorf clan::ListViewIconList::get_color_overlay ( )

Get Color overlay.

Returns
color_overlay
ListViewColumnHeader clan::ListViewHeader::get_column ( const std::string &  column_id)

Get column.

Parameters
column_id= String Ref
Returns
List View Column Header
ListViewColumnData clan::ListViewItem::get_column ( const std::string &  column_id)

Get column.

Parameters
column_id= String Ref
Returns
List View Column Data
std::string clan::ListViewColumnData::get_column_id ( ) const

Get Column id.

Returns
column_id
std::string clan::ListViewColumnHeader::get_column_id ( ) const

Get Column id.

Returns
column_id
virtual Size clan::MenuBar::get_css_size ( ) const
virtual

Get Preferred size.

Returns
preferred_size
Size clan::ToolBar::get_css_size ( ) const

Get Preferred size.

Returns
preferred_size
virtual Size clan::ListViewHeader::get_css_size ( ) const
virtual

Get Preferred size.

Returns
preferred_size
virtual Size clan::PopupMenu::get_css_size ( ) const
virtual

Get Preferred size.

Returns
preferred_size
Size clan::ListView::get_css_size ( ) const

Returns the preferred size of the component, as defined in its CSS file.

int clan::Tab::get_current_page_id ( ) const

Get Current page id.

Returns
current_page_id
int clan::Tab::get_current_page_index ( ) const

Get Current page index.

Returns
current_page_index
int clan::TextEdit::get_cursor_line_number ( ) const

Get Cursor line number.

Returns
cursor line number
int clan::TextEdit::get_cursor_pos ( ) const

Get Cursor pos.

Returns
cursor_pos
int clan::LineEdit::get_cursor_pos ( ) const

Get Cursor pos.

Returns
cursor_pos
ListViewDisplayMode clan::ListView::get_display_mode ( ) const

Get Display mode.

Returns
display_mode
ListViewItem clan::ListView::get_document_item ( ) const

Get Document item.

Returns
document_item
ListViewItem clan::ListViewItem::get_document_item ( )

Get Document item.

Returns
document_item
int clan::ComboBox::get_dropdown_height ( ) const

Get Dropdown height.

Returns
dropdown_height
std::string clan::SaveFileDialog::get_filename ( ) const

Get the full path of the file selected.

Returns
std::string
std::string clan::OpenFileDialog::get_filename ( ) const

Get the full path of the file selected.

If multiple files are selected, this returns the first file.

Returns
std::string
std::vector<std::string> clan::OpenFileDialog::get_filenames ( ) const

Gets an array that contains one file name for each selected file.

Returns
std::vector<std::string>
ListViewSelectedItem clan::ListViewSelection::get_first ( )

Get First.

Returns
first
ListViewItem clan::ListViewItem::get_first_child ( )

Get First child.

Returns
first_child
ListViewColumnHeader clan::ListViewHeader::get_first_column ( )

Get First column.

Returns
first_column
bool clan::Spin::get_floating_point_mode ( ) const

Get Floating point mode.

Returns
floating_point_mode
std::string clan::RadioButton::get_group_name ( ) const

Get Group name.

Returns
group_name
ListViewHeader* clan::ListView::get_header ( ) const

Get Header.

Returns
header
Sprite clan::Frame::get_header_icon ( ) const

Get Header icon.

Returns
header_icon
std::string clan::Frame::get_header_text ( ) const

Get Header text.

Returns
header_text
ListViewIcon clan::ListViewIconList::get_icon ( int  index)

Get icon.

Parameters
index= value
Returns
List View Icon
Image clan::PushButton::get_icon ( ) const

Get Icon.

Returns
icon
PixelBuffer clan::PopupMenuItem::get_icon ( ) const

Get Icon.

Returns
icon
int clan::ListViewItem::get_icon ( ) const

Get the item icon id. Defaults to 0 if unset.

ListViewIconList clan::ListView::get_icon_list ( ) const

Get Icon list.

Returns
icon_list
IconPosition clan::PushButton::get_icon_position ( ) const

Get Icon position.

Returns
icon_position
int clan::TabPage::get_id ( ) const

Get Id.

Returns
id
int clan::ToolBarItem::get_id ( ) const

Get Id.

Returns
id
int clan::PopupMenuItem::get_id ( ) const

Get Id.

Returns
id
int clan::ListViewItem::get_id ( ) const

Get the item id. Defaults to 0 if unset.

Image clan::ImageView::get_image ( ) const

Get Image.

Returns
image
ListViewItem clan::ListViewSelectedItem::get_item ( )

Get Item.

Returns
item
PopupMenuItem clan::PopupMenu::get_item ( int  id)

Get item.

Parameters
id= value
Returns
Popup Menu Item
ToolBarItem clan::ToolBar::get_item ( int  index)

Get item.

Parameters
index= value
Returns
Tool Bar Item
std::string clan::ComboBox::get_item ( int  index) const

Get item.

Parameters
index= value
Returns
String Ref
PopupMenuItem clan::PopupMenu::get_item_at ( int  index)

Get item at.

Parameters
index= value
Returns
Popup Menu Item
ToolBarItem clan::ToolBar::get_item_by_id ( int  id)

Get item by id.

Parameters
id= value
Returns
Tool Bar Item
int clan::PopupMenu::get_item_count ( ) const

Item count.

Returns
int
int clan::ToolBar::get_item_count ( ) const

Get Item count.

Returns
item_count
int clan::ToolBar::get_item_index ( int  id)

Get item index.

Parameters
id= value
Returns
int
std::string clan::TabPage::get_label ( ) const

Get Label.

Returns
label
ListViewSelectedItem clan::ListViewSelection::get_last ( )

Get Last.

Returns
last
ListViewItem clan::ListViewItem::get_last_child ( )

Get Last child.

Returns
last_child
int clan::TextEdit::get_line_count ( ) const

Get line count.

Returns
line count
int clan::ScrollBar::get_line_step ( ) const

Get Line step.

Returns
line_step
std::string clan::TextEdit::get_line_text ( int  line) const

Get line text.

Returns
text
bool clan::Slider::get_lock_to_ticks ( ) const

Get Lock to ticks.

Returns
lock_to_ticks
int clan::ProgressBar::get_marquee_animation_speed ( ) const

Get Marquee animation speed.

Returns
marquee_animation_speed
int clan::ProgressBar::get_marquee_box_width ( ) const

Get Marquee box width.

Returns
marquee_box_width
int clan::ProgressBar::get_marquee_step_size ( ) const

Get Marquee step size.

Returns
marquee_step_size
int clan::ProgressBar::get_max ( ) const

Get Max.

Returns
max
int clan::ScrollBar::get_max ( ) const

Get Max.

Returns
max
int clan::Slider::get_max ( ) const

Get Max.

Returns
max
int clan::Spin::get_max ( ) const

Get Max.

Returns
max
float clan::Spin::get_max_float ( ) const

Get Max float.

Returns
max_float
int clan::TextEdit::get_max_length ( ) const

Get Max length.

Returns
max_length
int clan::LineEdit::get_max_length ( ) const

Get Max length.

Returns
max_length
PopupMenu clan::MenuBar::get_menu ( int  index) const

Get menu.

Parameters
index= value
Returns
Popup Menu
int clan::ProgressBar::get_min ( ) const

Get Min.

Returns
min
int clan::ScrollBar::get_min ( ) const

Get Min.

Returns
min
int clan::Slider::get_min ( ) const

Get Min.

Returns
min
int clan::Spin::get_min ( ) const

Get Min.

Returns
min
float clan::Spin::get_min_float ( ) const

Get Min float.

Returns
min_float
int clan::PopupMenu::get_minimum_width ( ) const

Get Minimum width.

Returns
minimum_width
static TextEdit* clan::TextEdit::get_named_item ( GUIComponent reference_component,
const std::string &  id 
)
static

Find the child TextEdit with the specified component ID name.

If it was not found, an exception is thrown.

static CheckBox* clan::CheckBox::get_named_item ( GUIComponent reference_component,
const std::string &  id 
)
static

Find the child CheckBox with the specified component ID name.

If it was not found, an exception is thrown.

static TabPage* clan::TabPage::get_named_item ( GUIComponent reference_component,
const std::string &  id 
)
static

Find the child ToolTip with the specified component ID name.

If it was not found, an exception is thrown.

static RadioButton* clan::RadioButton::get_named_item ( GUIComponent reference_component,
const std::string &  id 
)
static

Find the child RadioButton with the specified component ID name.

If it was not found, an exception is thrown.

static ScrollBar* clan::ScrollBar::get_named_item ( GUIComponent reference_component,
const std::string &  id 
)
static

Find the child ScrollBar with the specified component ID name.

If it was not found, an exception is thrown.

static Slider* clan::Slider::get_named_item ( GUIComponent reference_component,
const std::string &  id 
)
static

Find the child Slider with the specified component ID name.

If it was not found, an exception is thrown.

static ToolTip* clan::ToolTip::get_named_item ( GUIComponent reference_component,
const std::string &  id 
)
static

Find the child ToolTip with the specified component ID name.

If it was not found, an exception is thrown.

static MenuBar* clan::MenuBar::get_named_item ( GUIComponent reference_component,
const std::string &  id 
)
static

Find the child MenuBar with the specified component ID name.

If it was not found, an exception is thrown.

static ImageView* clan::ImageView::get_named_item ( GUIComponent reference_component,
const std::string &  id 
)
static

Find the child ImageView with the specified component ID name.

If it was not found, an exception is thrown.

static ProgressBar* clan::ProgressBar::get_named_item ( GUIComponent reference_component,
const std::string &  id 
)
static

Find the child ProgressBar with the specified component ID name.

If it was not found, an exception is thrown.

static Frame* clan::Frame::get_named_item ( GUIComponent reference_component,
const std::string &  id 
)
static

Find the child Frame with the specified component ID name.

If it was not found, an exception is thrown.

static Spin* clan::Spin::get_named_item ( GUIComponent reference_component,
const std::string &  id 
)
static

Find the child Spin with the specified component ID name.

If it was not found, an exception is thrown.

static StatusBar* clan::StatusBar::get_named_item ( GUIComponent reference_component,
const std::string &  id 
)
static

Find the child StatusBar with the specified component ID name.

If it was not found, an exception is thrown.

static ComboBox* clan::ComboBox::get_named_item ( GUIComponent reference_component,
const std::string &  id 
)
static

Find the child ComboBox with the specified component ID name.

If it was not found, an exception is thrown.

static GroupBox* clan::GroupBox::get_named_item ( GUIComponent reference_component,
const std::string &  id 
)
static

Find the child GroupBox with the specified component ID name.

If it was not found, an exception is thrown.

static Tab* clan::Tab::get_named_item ( GUIComponent reference_component,
const std::string &  id 
)
static

Find the child Tab with the specified component ID name.

If it was not found, an exception is thrown.

static ToolBar* clan::ToolBar::get_named_item ( GUIComponent reference_component,
const std::string &  id 
)
static

Find the child ToolBar with the specified component ID name.

If it was not found, an exception is thrown.

static PushButton* clan::PushButton::get_named_item ( GUIComponent reference_component,
const std::string &  id 
)
static

Find the child PushButton with the specified component ID name.

If it was not found, an exception is thrown.

static DragBox* clan::DragBox::get_named_item ( GUIComponent reference_component,
const std::string &  id 
)
static

Find the child DragBox with the specified component ID name.

If it was not found, an exception is thrown.

static Label* clan::Label::get_named_item ( GUIComponent reference_component,
const std::string &  id 
)
static

Find the child Label with the specified component ID name.

If it was not found, an exception is thrown.

static LineEdit* clan::LineEdit::get_named_item ( GUIComponent reference_component,
const std::string &  id 
)
static

Find the child LineEdit with the specified component ID name.

If it was not found, an exception is thrown.

static ListView* clan::ListView::get_named_item ( GUIComponent reference_component,
const std::string &  id 
)
static

Find the child ListView with the specified component ID name.

If it was not found, an exception is thrown.

ListViewSelectedItem clan::ListViewSelectedItem::get_next_sibling ( )

Get Next sibling.

Returns
next_sibling
ListViewItem clan::ListViewItem::get_next_sibling ( )

Get Next sibling.

Returns
next_sibling
ListViewColumnHeader clan::ListViewColumnHeader::get_next_sibling ( )

Get Next sibling.

Returns
next_sibling
Point clan::ListViewIcon::get_offset ( ListViewDisplayMode  mode)

Get offset.

Parameters
mode= List View Display Mode
Returns
Point
std::vector<int> clan::ListViewItem::get_overlay_icons ( )
TabPage* clan::Tab::get_page ( int  index) const

Get page.

Parameters
index= value
Returns
Tab Page
TabPage* clan::Tab::get_page_by_id ( int  id) const

Get page by id.

Parameters
id= value
Returns
Tab Page
int clan::Tab::get_page_count ( ) const

returns the number of pages in the tab.

int clan::ScrollBar::get_page_step ( ) const

Get Page step.

Returns
page_step
int clan::Slider::get_page_step ( ) const

Get Page step.

Returns
page_step
ListViewItem clan::ListViewItem::get_parent ( )

Get Parent.

Returns
parent
int clan::ListViewItem::get_parent_count ( )

Get Parent count.

Returns
parent_count
PixelBuffer clan::ListViewIcon::get_pixel_buffer ( ListViewDisplayMode  mode)

Get pixel buffer.

Parameters
mode= List View Display Mode
Returns
Pixel Buffer
int clan::ProgressBar::get_position ( ) const

Get Position.

Returns
position
int clan::Slider::get_position ( ) const

Get Position.

Returns
position
int clan::ScrollBar::get_position ( ) const

Get Position.

Returns
position
float clan::Label::get_preferred_content_height ( float  width)
virtual

Returns the preferred content height for the specified content width.

Override this function if the component has non-css content.

Reimplemented from clan::GUIComponent.

float clan::RadioButton::get_preferred_content_height ( float  width)
virtual

Returns the preferred content height for the specified content width.

Override this function if the component has non-css content.

Reimplemented from clan::GUIComponent.

float clan::PushButton::get_preferred_content_height ( float  width)
virtual

Returns the preferred content height for the specified content width.

Override this function if the component has non-css content.

Reimplemented from clan::GUIComponent.

float clan::ImageView::get_preferred_content_height ( float  width)
virtual

Returns the preferred content height for the specified content width.

Override this function if the component has non-css content.

Reimplemented from clan::GUIComponent.

float clan::Slider::get_preferred_content_height ( float  width)
virtual

Returns the preferred content height for the specified content width.

Override this function if the component has non-css content.

Reimplemented from clan::GUIComponent.

float clan::LineEdit::get_preferred_content_height ( float  width)
virtual

Returns the preferred content height for the specified content width.

Override this function if the component has non-css content.

Reimplemented from clan::GUIComponent.

float clan::ScrollBar::get_preferred_content_height ( float  width)
virtual

Returns the preferred content height for the specified content width.

Override this function if the component has non-css content.

Reimplemented from clan::GUIComponent.

float clan::Label::get_preferred_content_width ( )
virtual

Returns the preferred content width.

Override this function if the component has non-css content.

Reimplemented from clan::GUIComponent.

float clan::RadioButton::get_preferred_content_width ( )
virtual

Returns the preferred content width.

Override this function if the component has non-css content.

Reimplemented from clan::GUIComponent.

float clan::PushButton::get_preferred_content_width ( )
virtual

Returns the preferred content width.

Override this function if the component has non-css content.

Reimplemented from clan::GUIComponent.

float clan::ImageView::get_preferred_content_width ( )
virtual

Returns the preferred content width.

Override this function if the component has non-css content.

Reimplemented from clan::GUIComponent.

float clan::Slider::get_preferred_content_width ( )
virtual

Returns the preferred content width.

Override this function if the component has non-css content.

Reimplemented from clan::GUIComponent.

float clan::LineEdit::get_preferred_content_width ( )
virtual

Returns the preferred content width.

Override this function if the component has non-css content.

Reimplemented from clan::GUIComponent.

float clan::ScrollBar::get_preferred_content_width ( )
virtual

Returns the preferred content width.

Override this function if the component has non-css content.

Reimplemented from clan::GUIComponent.

ListViewItem clan::ListViewItem::get_prev_sibling ( )

Get Prev sibling.

Returns
prev_sibling
ListViewColumnHeader clan::ListViewColumnHeader::get_prev_sibling ( )

Get Prev sibling.

Returns
prev_sibling
int clan::RadioButton::get_radio_id ( ) const

Get Id.

Returns
id
int clan::ListView::get_scroll_max_position ( )

Get maximal listview scrollbar position.

Returns
int
int clan::ListView::get_scroll_position ( )

Get current listview scrollbar position.

Returns
int
bool clan::ListView::get_select_whole_row ( ) const

Get Select whole row.

Returns
select_whole_row
Colorf clan::ListViewIconList::get_selected_color ( )

Get Selected color.

Returns
selected_color
Colorf clan::ListViewIconList::get_selected_color_overlay ( )

Get Selected color overlay.

Returns
selected_color_overlay
int clan::ComboBox::get_selected_item ( ) const

Get Selected item.

Returns
selected_item
ListViewItem clan::ListView::get_selected_item ( )

Returns the currently selected item in single selection mode.

If multiple items are selected, the item selected first (chronological order) is returned. If no element is selected, an empty ListViewItem is returned.

ListViewSelection clan::ListView::get_selected_items ( ) const

Returns a container class holding the selected items in a linked list structure.

std::string clan::BrowseFolderDialog::get_selected_path ( ) const

Get the full path of the directory selected.

Returns
std::string
std::string clan::TextEdit::get_selection ( ) const

Get Selection.

Returns
selection
std::string clan::LineEdit::get_selection ( ) const

Get Selection.

Returns
selection
int clan::TextEdit::get_selection_length ( ) const

Get Selection length.

Returns
selection_length
int clan::LineEdit::get_selection_length ( ) const

Get Selection length.

Returns
selection_length
int clan::TextEdit::get_selection_start ( ) const

Get Selection start.

Returns
selection_start
int clan::LineEdit::get_selection_start ( ) const

Get Selection start.

Returns
selection_start
Sprite clan::ListViewIcon::get_sprite ( ListViewDisplayMode  mode)

Get sprite.

Parameters
mode= List View Display Mode
Returns
Sprite
Sprite clan::ImageView::get_sprite ( ) const

Get Sprite.

Returns
sprite
int clan::ProgressBar::get_step_size ( ) const

Get Step size.

Returns
step_size
PopupMenu clan::PopupMenuItem::get_submenu ( )

Get Submenu.

Returns
submenu
std::string clan::ListViewColumnData::get_text ( ) const

Get Text.

Returns
text
std::string clan::ToolTip::get_text ( ) const

Get Text.

Returns
text
std::string clan::RadioButton::get_text ( ) const

Get Text.

Returns
text
std::string clan::ToolBarItem::get_text ( ) const

Get Text.

Returns
text
std::string clan::PopupMenuItem::get_text ( ) const

Get Text.

Returns
text
const std::string& clan::CheckBox::get_text ( ) const
const std::string& clan::Label::get_text ( ) const

Get Text.

Returns
text
std::string clan::ComboBox::get_text ( ) const

Get Text.

Returns
text
std::string clan::TextEdit::get_text ( ) const

Get Text.

Returns
text
const std::string& clan::PushButton::get_text ( ) const
std::string clan::LineEdit::get_text ( ) const

Get Text.

Returns
text
float clan::LineEdit::get_text_float ( ) const

Returns the text converted to float.

int clan::LineEdit::get_text_int ( ) const

Returns the text converted to integer.

Size clan::LineEdit::get_text_size ( )

Returns the size (pixels) of the text in the lineedit, or of the string given as parameter.

Size clan::LineEdit::get_text_size ( const std::string &  str)

Get text size.

Parameters
str= String
Returns
Size
int clan::Slider::get_tick_count ( ) const

Get Tick count.

Returns
tick_count
int clan::TextEdit::get_total_height ( )

Returns the height required to display all lines with the current width of the control.

int clan::ListViewColumnHeader::get_used_width ( )

Returns the used width (last column expanded to the rest of the list view)

Returns
width
std::shared_ptr<ListViewItemUserData> clan::ListViewItem::get_userdata ( ) const

Get Userdata.

Returns
userdata
int clan::Spin::get_value ( ) const

Get Value.

Returns
value
float clan::Spin::get_value_float ( ) const

Get Value float.

Returns
value_float
bool clan::ListViewHeader::get_visible ( ) const

Get Visible.

Returns
visible
int clan::ListViewColumnHeader::get_width ( )

Get Width.

Returns
width
bool clan::ListViewItem::has_children ( ) const

Has children.

Returns
bool
bool clan::PopupMenuItem::has_submenu ( ) const

Has submenu.

Returns
bool
void clan::ToolTip::hide ( )

Hide.

ListViewColumnHeader clan::ListViewHeader::insert_after ( const std::string &  column_id,
ListViewColumnHeader  new_column 
)

Insert after.

Parameters
column_id= String Ref
new_column= List View Column Header
Returns
List View Column Header
ListViewColumnHeader clan::ListViewHeader::insert_before ( const std::string &  column_id,
ListViewColumnHeader  new_column 
)

Insert before.

Parameters
column_id= String Ref
new_column= List View Column Header
Returns
List View Column Header
PopupMenuItem clan::PopupMenu::insert_item ( const std::string &  text,
int  id = -1,
int  index = -1 
)

Insert item.

Parameters
text= String Ref
id= value
index= value
Returns
Popup Menu Item
ToolBarItem clan::ToolBar::insert_item ( const Sprite icon,
int  frame,
const std::string &  text,
int  id = -1,
int  index = -1 
)

Insert item.

Parameters
icon= Sprite
frame= value
text= String Ref
id= value
index= value
Returns
Tool Bar Item
PopupMenuItem clan::PopupMenu::insert_item_accel ( const std::string &  text,
const std::string &  accel_text = "",
int  id = -1,
int  index = -1 
)

Insert item accel.

Parameters
text= String Ref
accel_text= String Ref
Returns
Popup Menu Item
ToolBarItem clan::ToolBar::insert_separator ( int  index = -1)

Insert separator.

Parameters
index= value
Returns
Tool Bar Item
PopupMenuItem clan::PopupMenu::insert_separator ( int  index = -1)

Insert separator.

Parameters
index= value
Returns
Popup Menu Item
bool clan::CheckBox::is_3state ( ) const

Is 3state.

Returns
true = 3state
bool clan::PopupMenuItem::is_checkable ( ) const

Is Checkable.

Returns
true = checkable
bool clan::CheckBox::is_checked ( ) const

Is Checked.

Returns
true = checked
bool clan::PopupMenuItem::is_checked ( ) const

Is Checked.

Returns
true = checked
bool clan::ToolBarItem::is_disabled ( ) const

Is Disabled.

Returns
true = disabled
bool clan::PopupMenuItem::is_disabled ( ) const

Is Disabled.

Returns
true = disabled
bool clan::ComboBox::is_editable ( ) const

Is Editable.

Returns
true = editable
bool clan::ListViewItem::is_editable ( ) const

Is Editable.

Returns
true = editable
bool clan::ScrollBar::is_horizontal ( ) const

Is Horizontal.

Returns
true = horizontal
bool clan::Slider::is_horizontal ( ) const

Is Horizontal.

Returns
true = horizontal
bool clan::CheckBox::is_indeterminated ( ) const

Is Indeterminated.

Returns
true = indeterminated
bool clan::ListViewSelectedItem::is_item ( ) const

Is Item.

Returns
true = item
bool clan::ListViewItem::is_item ( ) const

Is Item.

Returns
true = item
bool clan::TextEdit::is_lowercase ( ) const

Is Lowercase.

Returns
true = lowercase
bool clan::LineEdit::is_lowercase ( ) const

Is Lowercase.

Returns
true = lowercase
bool clan::ProgressBar::is_marquee_mode ( ) const

Is Marquee mode.

Returns
true = marquee_mode
bool clan::ListViewSelectedItem::is_null ( ) const
inline

Returns true if this object is invalid.

bool clan::PopupMenu::is_null ( ) const
inline

Returns true if this object is invalid.

bool clan::ListViewColumnHeader::is_null ( ) const
inline

Returns true if this object is invalid.

bool clan::ListViewItem::is_null ( ) const
inline

Returns true if this object is invalid.

bool clan::ToolBarItem::is_null ( ) const
inline

Returns true if this object is invalid.

bool clan::PopupMenuItem::is_null ( ) const
inline

Returns true if this object is invalid.

bool clan::ListViewItem::is_open ( ) const

Is Open.

Returns
true = open
bool clan::LineEdit::is_password_mode ( ) const

Is Password mode.

Returns
true = password_mode
bool clan::ToolBarItem::is_pressed ( ) const

Is Pressed.

Returns
true = pressed
bool clan::PushButton::is_pushed ( ) const

Is Pushed.

Returns
true = pushed
bool clan::TextEdit::is_read_only ( ) const

Is Read only.

Returns
true = read_only
bool clan::LineEdit::is_read_only ( ) const

Is Read only.

Returns
true = read_only
bool clan::ListViewIcon::is_scalable ( ) const

Is Scalable.

Returns
true = scalable
bool clan::RadioButton::is_selected ( ) const

Is Selected.

Returns
true = selected
bool clan::ListViewItem::is_selected ( ) const

Is Selected.

Returns
true = selected
bool clan::PopupMenuItem::is_separator ( ) const

Is Separator.

Returns
true = separator
bool clan::PushButton::is_toggle ( ) const

Is Toggle.

Returns
true = toggle
bool clan::ToolBarItem::is_toggling ( ) const

Is Toggling.

Returns
true = toggling
bool clan::TextEdit::is_uppercase ( ) const

Is Uppercase.

Returns
true = uppercase
bool clan::LineEdit::is_uppercase ( ) const

Is Uppercase.

Returns
true = uppercase
bool clan::Slider::is_vertical ( ) const

Is Vertical.

Returns
true = vertical
bool clan::ScrollBar::is_vertical ( ) const

Is Vertical.

Returns
true = vertical
MessageBoxResult clan::message_box ( GUIComponent *  owner,
std::string  title,
std::string  detail_text,
MessageBoxButtons  buttons,
MessageBoxIcon  icon 
)
MessageBoxResult clan::message_box ( GUIManager *  gui_manager,
std::string  title,
std::string  detail_text,
MessageBoxButtons  buttons,
MessageBoxIcon  icon 
)
void clan::ListView::on_process_message ( std::shared_ptr< GUIMessage > &  msg)

On process message.

Parameters
msg= GUIMessage
bool clan::ListViewItem::operator!= ( ListViewItem other) const
bool clan::ListViewItem::operator== ( ListViewItem other) const
ListViewSelectedItem clan::ListViewSelectedItem::prev ( )

Prev.

Returns
List View Selected Item
ListViewColumnHeader clan::ListViewHeader::remove ( const std::string &  column_id)

Remove.

Parameters
column_id= String Ref
Returns
List View Column Header
void clan::ListViewSelection::remove ( const ListViewItem item)

Remove.

Parameters
item= List View Item
ListViewItem clan::ListViewItem::remove ( )

Removes this item from the item tree.

void clan::ListViewItem::remove_children ( )

Remove all children of this item.

void clan::MenuBar::remove_menu ( int  index)

Remove menu.

Parameters
index= value
void clan::ListViewItem::remove_overlay_icon ( int  icon_index)

Remove overlay icon.

Parameters
icon_index= value
void clan::Tab::remove_page ( int  index)

Remove a page by its index.

void clan::Tab::remove_page_by_id ( int  id)

Remove a page by its ID.

In case of non-unique ID's the first match will be shown. The pointer returned by add_page() will become invalid.

void clan::StatusBar::remove_part ( int  id)

Remove part.

Parameters
id= value
void clan::LineEdit::resize_to_fit ( int  max_width)

Resize the components width so that its whole text becomes visible.

void clan::TextEdit::select_all ( )

Select all.

void clan::LineEdit::select_all ( )

Select all.

void clan::CheckBox::set_3state ( bool  enable)

Set 3state.

Parameters
enable= bool
void clan::PopupMenuItem::set_accelerator_text ( const std::string &  str)

Set accelerator text.

Parameters
str= String Ref
void clan::ListViewColumnHeader::set_alignment ( ListViewColumnHeader::TextAlignment  align)

Set alignment.

Parameters
TextAlignment= List View Column Header
void clan::Label::set_alignment ( Alignment  alignment)

Set alignment.

Parameters
alignment= Alignment
void clan::LineEdit::set_alignment ( Alignment  alignment)

Set alignment.

Parameters
alignment= Alignment
void clan::ListViewColumnHeader::set_caption ( const std::string &  str)

Set caption.

Parameters
str= String Ref
void clan::PopupMenuItem::set_checkable ( bool  checkable)

Set checkable.

Parameters
checkable= bool
void clan::CheckBox::set_checked ( bool  enable)

Set checked.

Parameters
enable= bool
void clan::PopupMenuItem::set_checked ( bool  checked)

Set checked.

Parameters
checked= bool
void clan::PopupMenu::set_class_name ( const std::string &  class_name)

Set class name.

Parameters
class_name= String Ref
void clan::ListViewIconList::set_color ( const Colorf color)

Set color.

Parameters
color= Colorf
void clan::ListViewIconList::set_color_overlay ( const Colorf color)

Set color overlay.

Parameters
color= Colorf
void clan::ListViewColumnData::set_column_id ( const std::string &  column_id)

Set column id.

Parameters
column_id= String Ref
void clan::ListViewColumnHeader::set_column_id ( const std::string &  str)

Set column id.

Parameters
str= String Ref
void clan::ListViewItem::set_column_text ( const std::string &  column_id,
const std::string &  text 
)

Set column text.

Parameters
column_id= String Ref
text= String Ref
void clan::TextEdit::set_cursor_drawing_enabled ( bool  enable)

Set cursor drawing enabled/disabled.

void clan::LineEdit::set_cursor_drawing_enabled ( bool  enable)

Set cursor drawing enabled/disabled.

void clan::TextEdit::set_cursor_pos ( int  pos)

Set cursor pos.

Parameters
pos= value
void clan::LineEdit::set_cursor_pos ( int  pos)

Set cursor pos.

Parameters
pos= value
void clan::LineEdit::set_decimal_character ( const std::string &  decimal_char)

Set decimal character.

Parameters
decimal_char= String Ref
void clan::ListViewHeader::set_display_mode ( ListViewDisplayMode  mode)

Set display mode.

Parameters
mode= List View Display Mode
void clan::ListView::set_display_mode ( ListViewDisplayMode  mode)

Set display mode.

Parameters
mode= List View Display Mode
void clan::ComboBox::set_dropdown_height ( int  height)

Set dropdown height.

Parameters
height= value
void clan::ComboBox::set_dropdown_minimum_width ( int  min_width)

Set dropdown minimum width.

Parameters
min_width= value
void clan::ComboBox::set_editable ( bool  enable = true)

Set editable.

Parameters
enable= bool
void clan::ListViewItem::set_editable ( bool  editable)

Set editable.

Parameters
editable= bool
void clan::PopupMenuItem::set_enabled ( bool  enabled)

Set enabled.

Parameters
enabled= bool
void clan::SaveFileDialog::set_filename ( const std::string &  filename)

Sets a string containing the full path of the file selected.

Parameters
filename= filename
void clan::OpenFileDialog::set_filename ( const std::string &  filename)

Sets a string containing the full path of the file selected.

Parameters
filename= filename
void clan::SaveFileDialog::set_filter_index ( int  filter_index)

Sets a default filter, on a 0-based index.

Parameters
filter_index= filter_index
void clan::OpenFileDialog::set_filter_index ( int  filter_index)

Sets a default filter, on a 0-based index.

Parameters
filter_index= filter_index
void clan::Spin::set_floating_point_mode ( bool  use_floating_point)

Set floating point mode.

Parameters
use_floating_point= bool
void clan::RadioButton::set_group_name ( const std::string &  str)

Set group name.

Parameters
str= String Ref
void clan::Frame::set_header_icon ( const Sprite icon)

Set header icon.

Parameters
icon= Sprite
void clan::Frame::set_header_text ( const std::string &  text)

Set header text.

Parameters
text= String Ref
void clan::ScrollBar::set_horizontal ( )

Set horizontal.

void clan::Slider::set_horizontal ( bool  enable)

Set horizontal.

Parameters
enable= bool
void clan::ListViewIconList::set_icon ( int  index,
const ListViewIcon icon 
)

Set the icon at the specified index.

void clan::ToolBarItem::set_icon ( const Sprite image,
int  frame = 0 
)

Set icon.

Parameters
image= Sprite
frame= value
void clan::PushButton::set_icon ( const Image icon)

Set icon.

Parameters
icon= Image
void clan::PopupMenuItem::set_icon ( const PixelBuffer image)

Set icon.

Parameters
image= Pixel Buffer
void clan::ListViewItem::set_icon ( int  icon_index)

Set icon.

Parameters
icon_index= value
void clan::PushButton::set_icon_position ( IconPosition  pos)

Set icon position.

Parameters
pos= Icon Position
void clan::ToolBarItem::set_id ( int  id)

Set id.

Parameters
id= value
void clan::PopupMenuItem::set_id ( int  id)

Set id.

Parameters
id= value
void clan::ListViewItem::set_id ( int  id)

Set the item id. Defaults to 0 if unset.

void clan::ImageView::set_image ( const Image image)

Set image.

Parameters
image= Sprite
void clan::ImageView::set_image ( const PixelBuffer image)

Set image.

Parameters
image= Pixel Buffer
void clan::CheckBox::set_indeterminated ( )

Set indeterminated.

void clan::BrowseFolderDialog::set_initial_directory ( const std::string &  path)

Sets the initial directory that is displayed.

Parameters
path= path
void clan::SaveFileDialog::set_initial_directory ( const std::string &  path)

Sets the initial directory that is displayed.

Parameters
path= path
void clan::OpenFileDialog::set_initial_directory ( const std::string &  path)

Sets the initial directory that is displayed.

Parameters
path= path
void clan::TextEdit::set_input_mask ( const std::string &  mask)

Use mask to restrict accepted input.

void clan::LineEdit::set_input_mask ( const std::string &  mask)

Use mask to restrict accepted input.

void clan::Tab::set_label ( int  index,
const std::string &  new_label 
)

Set the label of the component specified by index.

void clan::Tab::set_label_by_id ( int  id,
const std::string &  new_label 
)

Set the label of the component specified by index.

void clan::ScrollBar::set_line_step ( int  step)

Set line step.

Parameters
step= value
void clan::Slider::set_lock_to_ticks ( bool  lock)

Set lock to ticks.

Parameters
lock= bool
void clan::TextEdit::set_lowercase ( bool  enable = true)

Set lowercase.

Parameters
enable= bool
void clan::LineEdit::set_lowercase ( bool  enable = true)

Set lowercase.

Parameters
enable= bool
void clan::ProgressBar::set_marquee_animation_speed ( int  milliseconds)

Set marquee animation speed.

Parameters
milliseconds= value
void clan::ProgressBar::set_marquee_box_width ( int  width)

Set marquee box width.

Parameters
width= value
void clan::ProgressBar::set_marquee_mode ( bool  enable)

Set marquee mode.

Parameters
enable= bool
void clan::ProgressBar::set_marquee_step_size ( int  size)

Set marquee step size.

Parameters
size= value
void clan::ScrollBar::set_max ( int  scroll_max)

Set max.

Parameters
scroll_max= value
void clan::ProgressBar::set_max ( int  progress_max)

Set max.

Parameters
progress_max= value
void clan::Slider::set_max ( int  slider_max)

Set max.

Parameters
slider_max= value
void clan::TextEdit::set_max_length ( int  length)

Set max length.

Parameters
length= value
void clan::LineEdit::set_max_length ( int  length)

Set max length.

Parameters
length= value
void clan::PopupMenu::set_maximum_height ( int  height_pixels)

Set maximum height.

Parameters
height_pixels= value
void clan::ScrollBar::set_min ( int  scroll_min)

Set min.

Parameters
scroll_min= value
void clan::ProgressBar::set_min ( int  progress_min)

Set min.

Parameters
progress_min= value
void clan::Slider::set_min ( int  slider_min)

Set min.

Parameters
slider_min= value
void clan::PopupMenu::set_minimum_width ( int  width_pixels)

Set minimum width.

Parameters
width_pixels= value
void clan::OpenFileDialog::set_multi_select ( bool  multiselect)

Sets if multiple files can be selected or not.

Parameters
multiselect= When true, multiple items can be selected.
void clan::ListView::set_multi_select ( bool  value)

When true, multiple items can be selected.

void clan::Spin::set_number_of_decimal_places ( int  decimal_places)

Set number of decimal places.

Parameters
decimal_places= value
void clan::LineEdit::set_numeric_mode ( bool  enable = true,
bool  decimals = false 
)

Set numeric mode.

Parameters
enable= bool
decimals= bool
void clan::ListViewIcon::set_offset ( const Point offset,
ListViewDisplayMode  mode 
)
void clan::ListViewItem::set_open ( bool  open)

Set open.

Parameters
open= bool
void clan::ScrollBar::set_page_step ( int  step)

Set page step.

Parameters
step= value
void clan::Slider::set_page_step ( int  steps)

Set page step.

Parameters
steps= value
void clan::StatusBar::set_part_text ( int  id,
const std::string &  text 
)

Set part text.

Parameters
id= value
text= String Ref
void clan::StatusBar::set_part_text ( int  id,
const Image icon,
const std::string &  text 
)

Set part text.

Parameters
id= value
icon= Image
text= String Ref
void clan::LineEdit::set_password_mode ( bool  enable = true)

Set password mode.

Parameters
enable= bool
void clan::ListViewIcon::set_pixel_buffer ( PixelBuffer pbuf,
ListViewDisplayMode  mode 
)

Set pixel buffer.

Parameters
pbuf= Pixel Buffer
mode= List View Display Mode
void clan::ComboBox::set_popup_menu ( PopupMenu menu)

Set popup menu.

Parameters
menu= Popup Menu
void clan::ProgressBar::set_position ( int  pos)

Set position.

Parameters
pos= value
void clan::ScrollBar::set_position ( int  pos)

Set position.

Parameters
pos= value
void clan::Slider::set_position ( int  pos)

Set position.

Parameters
pos= value
void clan::ToolBarItem::set_pressed ( bool  value)

Set pressed.

Parameters
value= bool
void clan::PushButton::set_pushed ( bool  enable)

Set pushed.

Parameters
enable= bool
void clan::RadioButton::set_radio_id ( int  id)

Set id.

Parameters
id= value
void clan::ProgressBar::set_range ( int  progress_min,
int  progress_max 
)

Set range.

Parameters
progress_min= value
progress_max= value
void clan::Spin::set_ranges ( int  min,
int  max 
)

Set ranges.

Parameters
min= value
max= value
void clan::ScrollBar::set_ranges ( int  scroll_min,
int  scroll_max,
int  line_step,
int  page_step 
)

Set ranges.

Parameters
scroll_min= value
scroll_max= value
line_step= value
page_step= value
void clan::Slider::set_ranges ( int  slider_min,
int  slider_max,
unsigned int  tick_count,
int  page_step 
)

Set ranges.

Parameters
slider_min= value
slider_max= value
tick_count= value
page_step= value
void clan::Spin::set_ranges_float ( float  min,
float  max 
)

Set ranges float.

Parameters
min= value
max= value
void clan::TextEdit::set_read_only ( bool  enable = true)

Set read only.

Parameters
enable= bool
void clan::LineEdit::set_read_only ( bool  enable = true)

Set read only.

Parameters
enable= bool
void clan::ListViewIcon::set_scalable ( bool  value)

Set scalable.

Parameters
value= bool
void clan::ImageView::set_scale ( float  x,
float  y 
)

Set scale.

Parameters
x= value
y= value
void clan::ImageView::set_scale_to_fit ( bool  enable)

Set scale to fit.

void clan::ListView::set_scroll_position ( int  pos)

Set listview scrollbar position.

Parameters
pos= int
void clan::TextEdit::set_select_all_on_focus_gain ( bool  enable)
void clan::LineEdit::set_select_all_on_focus_gain ( bool  enable)
void clan::ListView::set_select_whole_row ( bool  value)

When true, the whole row is drawn selected, as opposed to only the first column.

void clan::RadioButton::set_selected ( bool  selected)

Set selected.

Parameters
selected= bool
void clan::ListView::set_selected ( ListViewItem item,
bool  selected = true 
)

Set selected.

Parameters
item= List View Item
selected= bool
void clan::ListViewIconList::set_selected_color ( const Colorf color)

Set selected color.

Parameters
color= Colorf
void clan::ListViewIconList::set_selected_color_overlay ( const Colorf color)

Set selected color overlay.

Parameters
color= Colorf
void clan::ComboBox::set_selected_item ( int  index)

Set selected item.

Parameters
index= value
void clan::TextEdit::set_selection ( int  pos,
int  length 
)

Set selection.

Parameters
pos= value
length= value
void clan::LineEdit::set_selection ( int  pos,
int  length 
)

Set selection.

Parameters
pos= value
length= value
void clan::PopupMenuItem::set_separator ( bool  separator)

Set separator.

Parameters
separator= bool
void clan::ToolBar::set_single_selection ( bool  value)

Set single selection.

Parameters
value= bool
void clan::ImageView::set_sprite ( const Sprite image)

Set sprite.

Parameters
image= Sprite
void clan::ListViewIcon::set_sprite ( const Sprite sprite,
ListViewDisplayMode  mode 
)

Set sprite.

Parameters
sprite= Sprite
mode= List View Display Mode
void clan::StatusBar::set_status_text ( const std::string &  text)

Set status text.

Parameters
text= String Ref
void clan::Spin::set_step_size ( int  step_size)

Set step size.

Parameters
step_size= value
void clan::ProgressBar::set_step_size ( int  size)

Set step size.

Parameters
size= value
void clan::Spin::set_step_size_float ( float  step_size)

Set step size float.

Parameters
step_size= value
void clan::PopupMenuItem::set_submenu ( PopupMenu submenu)

Set submenu.

Parameters
submenu= Popup Menu
void clan::ListViewColumnData::set_text ( const std::string &  text)

Set text.

Parameters
text= String Ref
void clan::ToolTip::set_text ( const std::string &  text)

Set text.

Parameters
text= String Ref
void clan::CheckBox::set_text ( const std::string &  text)

Set text.

Parameters
text= String Ref
void clan::RadioButton::set_text ( const std::string &  text)

Set text.

Parameters
text= String Ref
void clan::Label::set_text ( const std::string &  text)

Set text.

Parameters
text= String Ref
void clan::ComboBox::set_text ( const std::string &  text)

Set text.

Parameters
text= String Ref
void clan::ToolBarItem::set_text ( const std::string &  text)

Set text.

Parameters
text= String Ref
void clan::PushButton::set_text ( const std::string &  text)

Set text.

Parameters
text= String Ref
void clan::PopupMenuItem::set_text ( const std::string &  text)

Set text.

Parameters
text= String Ref
void clan::TextEdit::set_text ( const std::string &  text)

Set text.

Parameters
text= String Ref
void clan::LineEdit::set_text ( const std::string &  text)

Set text.

Parameters
text= String Ref
void clan::LineEdit::set_text ( int  number)

Set text.

Parameters
number= value
void clan::LineEdit::set_text ( float  number,
int  num_decimal_places = 6 
)

Set text.

Parameters
number= value
num_decimal_places= number of decimal places
void clan::Label::set_text_color ( const Colorf  color)
void clan::Slider::set_tick_count ( int  tick_count)

Set tick count.

Parameters
tick_count= value
void clan::BrowseFolderDialog::set_title ( const std::string &  title)

Sets the text that appears in the title bar.

Parameters
title= title
void clan::SaveFileDialog::set_title ( const std::string &  title)

Sets the text that appears in the title bar.

Parameters
title= title
void clan::OpenFileDialog::set_title ( const std::string &  title)

Sets the text that appears in the title bar.

Parameters
title= title
void clan::PushButton::set_toggle ( bool  enable)

Set toggle.

Parameters
enable= bool
void clan::ToolBarItem::set_toggling ( bool  toggling)

Controls if buttons stay down when pressed.

void clan::TextEdit::set_uppercase ( bool  enable = true)

Set uppercase.

Parameters
enable= bool
void clan::LineEdit::set_uppercase ( bool  enable = true)

Set uppercase.

Parameters
enable= bool
void clan::ListViewItem::set_userdata ( std::shared_ptr< ListViewItemUserData ptr)

Set userdata.

Parameters
ptr= Unknown Shared Ptr
void clan::Spin::set_value ( int  value)

Set value.

Parameters
value= value
void clan::Spin::set_value_float ( float  value)

Set value float.

Parameters
value= value
void clan::ScrollBar::set_vertical ( )

Set vertical.

void clan::Slider::set_vertical ( bool  enable)

Set vertical.

Parameters
enable= bool
void clan::ListViewColumnHeader::set_width ( int  width)

Set width.

Parameters
width= value
bool clan::BrowseFolderDialog::show ( )

Shows the file dialog.

Returns
true if the user clicks the OK button of the dialog that is displayed, false otherwise.
void clan::ToolTip::show ( const Point position)

Show.

Parameters
position= Point
bool clan::SaveFileDialog::show ( )

Shows the file dialog.

Returns
true if the user clicks the OK button of the dialog that is displayed, false otherwise.
bool clan::OpenFileDialog::show ( )

Shows the file dialog.

Returns
true if the user clicks the OK button of the dialog that is displayed, false otherwise.
void clan::ToolTip::show_delayed ( const Point position,
int  delay_time = 750 
)

Show delayed.

Parameters
position= Point
delay_time= value
void clan::ListView::show_detail_icon ( bool  enable = true)

Set if icons are shown in the detail display mode.

void clan::ListView::show_detail_opener ( bool  enable = true)

Set if node opener is shown in the detail display mode.

void clan::Tab::show_page ( int  index)

Show a page by its index.

void clan::Tab::show_page_by_id ( int  id)

Show a page by its ID. In case of non-unique ID's the first match will be shown.

void clan::StatusBar::show_part ( int  id,
bool  show = true 
)

Show part.

Parameters
id= value
show= bool
void clan::StatusBar::show_size_grip ( bool  show = true)

Show size grip.

Parameters
show= bool
void clan::PopupMenu::start ( GUIComponent parent,
const Point pos 
)

Start the popup menu for dialog (not modal)

void clan::ProgressBar::step_position ( )

Step position.

void clan::ListViewSelectedItem::throw_if_null ( ) const

Throw an exception if this object is invalid.

void clan::ListViewColumnHeader::throw_if_null ( ) const

Throw an exception if this object is invalid.

void clan::PopupMenu::throw_if_null ( ) const

Throw an exception if this object is invalid.

void clan::ListViewItem::throw_if_null ( ) const

Throw an exception if this object is invalid.

void clan::ToolBarItem::throw_if_null ( ) const

Throw an exception if this object is invalid.

void clan::PopupMenuItem::throw_if_null ( ) const

Throw an exception if this object is invalid.

Friends

friend class ListView
friend
friend class ListView_Impl
friend
friend class ListView_Impl
friend
friend class ListView_Impl
friend
friend class ListViewHeader
friend
friend class ListViewHeader_Impl
friend
friend class ListViewLayout
friend
friend class ListViewRenderer
friend
friend class ListViewSelection
friend
friend class ListViewSelection
friend
friend class MenuBar
friend
friend class MenuBar_Impl
friend
friend class MenuModalLoop
friend
friend class PopupMenuWindow
friend
friend class RadioButton_Impl
friend
friend class Tab
friend
friend class ToolBar
friend
friend class ToolBar_Impl
friend