Inheritance diagram for GuiTree:

Public Types
enum	BorderStyle { BORDER_STYLE_3D, BORDER_STYLE_FLAT, BORDER_STYLE_NONE, BORDER_STYLE_COUNT }

Public Types inherited from GuiWidget
enum	Roundness { ROUNDNESS_NONE = 0, ROUNDNESS_TOP_LEFT = 1, ROUNDNESS_TOP_RIGHT = 2, ROUNDNESS_BOTTOM_LEFT = 4, ROUNDNESS_BOTTOM_RIGHT = 8, ROUNDNESS_LEFT = ROUNDNESS_TOP_LEFT \| ROUNDNESS_BOTTOM_LEFT, ROUNDNESS_RIGHT = ROUNDNESS_TOP_RIGHT \| ROUNDNESS_BOTTOM_RIGHT, ROUNDNESS_TOP = ROUNDNESS_TOP_LEFT \| ROUNDNESS_TOP_RIGHT, ROUNDNESS_BOTTOM = ROUNDNESS_BOTTOM_LEFT \| ROUNDNESS_BOTTOM_RIGHT, ROUNDNESS_ALL = ROUNDNESS_TOP \| ROUNDNESS_BOTTOM }

enum	Constraint { CONSTRAINT_LEFT, CONSTRAINT_RIGHT, CONSTRAINT_TOP, CONSTRAINT_BOTTOM, CONSTRAINT_COUNT }

enum	Justify { JUSTIFY_LEFT, JUSTIFY_RIGHT, JUSTIFY_CENTER, JUSTIFY_COUNT }

enum	IconPosition { ICON_POSITION_LEFT, ICON_POSITION_RIGHT, ICON_POSITION_COUNT }

Public Types inherited from EventObject
typedef void(*	EventInfoFunction )(EventObject &, const EventInfo &, void *)
	event callback signature for free functions / static methods.

typedef void(EventObject::*	EventInfoMethod )(EventObject &, const EventInfo &, void *)
	event callback signature for methods.

typedef void(*	EventFunction )(EventObject &, const CoreString &, void *)

typedef void(EventObject::*	EventMethod )(EventObject &, const CoreString &, void *)

Public Member Functions
	GuiTree (GuiWidget &parent, const int &x, const int &y, const int &w, const int &h)

GuiTreeItem &	get_root () const

void	set_connector_column (const unsigned int &index)

const unsigned int &	get_connector_column () const

const unsigned int &	get_column_count () const

void	remove_all_columns ()

unsigned int	add_column (const CoreString &name, const int &width)

unsigned int	insert_column (const CoreString &name, const int &width, const unsigned int &index)

void	remove_column (const unsigned int &index)

int	get_column_width (const unsigned int &index) const

int	get_line_height () const

void	set_line_height (const int &height)

virtual void	refresh ()

virtual void	show () override

virtual void	draw (GuiDc &dc) override
	This is the main drawing method of the widget.

virtual void	set_size (const int &x, const int &y, const int &w, const int &h)

virtual void	resize (const int &x, const int &y, const int &w, const int &h) override

virtual int	process_event (const CoreString &event_id) override
	This method is called whenever an event happens on this widget. Override this to catch and process them.

bool	is_active () const

GuiTreeItem *	get_last_event_item () const

GuiTreeItem *	get_drag_over_item () const

const GMathVec3i &	get_background_color () const

void	set_background_color (const GMathVec3i &color)

void	set_background_color (const int &r, const int &g, const int &b)

void	set_border_style (const BorderStyle &style)

const BorderStyle &	get_border_style () const

const GMathVec3i &	get_border_color () const

void	set_border_color (const GMathVec3i &color)

void	set_border_color (const int &r, const int &g, const int &b)

void	set_shaded_entries (const bool &flag)

bool	is_shaded_entries () const

void	enable_drag_and_drop (const bool &flag, const bool &enable_first=true, const bool &enable_last=true)

const bool &	is_drag_and_drop_enabled () const

void	enable_item_delete (const bool &flag)

const bool &	is_item_delete_enabled () const

void	enable_multi_selection (const bool &flag)

const bool &	is_multi_selection_enabled () const

void	destroy_selected_items ()

const CoreVector< GuiTreeItem * > &	get_selection () const

void	set_selection (const CoreVector< GuiTreeItem * > &new_selection, const bool &raise_event=false)

const CoreVector< GuiTreeItem * > &	get_preselection () const

void	set_preselection (const CoreVector< GuiTreeItem * > &new_preselection)

const CoreVector< GuiTreeItem * > &	get_highlighted_items () const

void	highlight_item (GuiTreeItem *item, const bool &value)

virtual void	select_all ()

void	deselect_all (const bool &notify)

void	deselect_all ()

void	show_item (GuiTreeItem *item)

void	select_previous_item (GuiTreeItem *item)

void	select_next_item (GuiTreeItem *item)

GuiTreeItem *	get_first_item ()

GuiTreeItem *	get_last_item (const bool &visible)

void	clear_preselection ()

void	clear_highlighted_items ()

void	remove_all ()

virtual void	on_item_activate (GuiTreeItem *item)

ImageIcon::ImageIconSize	get_icon_size ()

void	set_icon_size (const ImageIcon::ImageIconSize size)

void	preselect_item (GuiTreeItem *item)

Public Member Functions inherited from GuiWidget
	GuiWidget (GuiWidget &parent, const int &x, const int &y, const int &w, const int &h)

	GuiWidget (GuiApp &app, const int &x, const int &y, const int &w, const int &h)

virtual void	load_settings (const ParserGroup &settings)

virtual void	save_settings (ParserGroup &settings)

void	destroy ()

virtual bool	is_shown () const

bool	is_hidden () const

bool	is_recursive_destroyed () const

const bool &	is_destroyed () const

virtual void	hide ()

virtual GuiWidget *	get_parent () const

const GuiWindow *	get_root_window () const

virtual void	set_parent (GuiWidget *parent)

GuiWindow *	get_window () const

const int &	get_width () const

const int &	get_height () const

const int &	get_x () const

const int &	get_y () const

void	set_width (int width)

void	set_height (int height)

virtual const GMathVec2i &	get_size () const

void	set_size (int x, int y, int w, int h)

void	set_position (const int &x, const int &y, bool origin=true)
	sets position , leave size unchanged.

virtual const GMathVec2i &	get_position () const

void	set_mouse_cursor (const Gui::MouseCursorId &cursor)

const Gui::MouseCursorId &	get_mouse_cursor () const

void	set_font (const GuiFont &font)

GuiFont &	get_font () const

const CoreString &	get_tooltip () const

virtual void	set_tooltip (const CoreString &tooltip)

void	force_tooltip ()

virtual bool	is_enabled () const

virtual void	enable ()
	Activate the widget.

virtual void	disable ()
	Deativate the widget.

bool	is_active () const
	Get the active state of the widget, without taking the parents into account.

void	set_enable (bool enable)
	Set the active state of this widget.

virtual GuiColorScheme &	get_color_scheme () const

void	set_color (const GuiColorScheme::Group &group, const GuiColorScheme::Role &role, const unsigned char &r, const unsigned char &g, const unsigned char &b)

void	set_color (const GuiColorScheme::Group &group, const GuiColorScheme::Role &role, const GMathVec3uc &color)

void	get_color (const GuiColorScheme::Group &group, const GuiColorScheme::Role &role, unsigned char &r, unsigned char &g, unsigned char &b) const

const GMathVec3uc &	get_color (const GuiColorScheme::Group &group, const GuiColorScheme::Role &role) const

GMathVec3uc	get_highlighted_color (const GMathVec3uc &, const float &factor=1.2f, const bool &keep_max_gap=true) const

bool	is_entered () const

virtual void	set_focus ()

bool	children_has_focus (GuiWidget *widget) const

bool	has_focus () const

void	lose_focus ()

bool	is_focus_receiver () const

void	set_focus_receiver (const bool &receiver)

bool	is_key_receiver () const

void	set_key_receiver (const bool &receiver)

virtual void	redraw ()
	This will ask the widget to be drawn again.

virtual CtxDraw *	get_draw_ctx () const
	Return the drawing context needed by ModuleTool to draw in the widget.

virtual void	widget_update ()
	This method is called just before draw() if set_is_dirty() has been called before.

void	set_is_dirty (const bool &value=true)

bool	get_is_dirty ()
	returns if widget is dirty or not.

void	compute_children_bbox (GMathVec2i &lo, GMathVec2i &hi) const

const CoreVector< GuiWidget * > &	get_children () const

GuiApp &	get_application () const

GuiAction *	register_action (const CoreString &name, GuiAction::Function function, const CoreString &shortcut, const CoreString &tooltip="", void data=0, const GuiImage icon=0)

const CoreVector< GuiAction * > &	get_actions () const

GuiAction *	get_action (const CoreString &name) const

void	get_actions_recursively (CoreVector< GuiAction * > &actions) const

void	remove_action (GuiAction *action, bool delete_it)

void	remove_all_actions ()

void	register_hotkey (const CoreString &shortcut, const CoreString &tooltip)

const CoreVector< Hotkey > &	get_hotkeys () const

void	get_hotkeys_recursively (CoreVector< Hotkey > &hotkeys) const

const int &	get_top_offset () const

const int &	get_bottom_offset () const

const int &	get_left_offset () const

const int &	get_right_offset () const

const Constraint &	get_top_constraint () const

const Constraint &	get_bottom_constraint () const

const Constraint &	get_left_constraint () const

const Constraint &	get_right_constraint () const

virtual void	set_constraints (const Constraint &left, const Constraint &top, const Constraint &right, const Constraint &bottom)

void	set_active_constraints (const bool &active)

virtual const bool &	is_active_constraints () const

void	set_recursive_constraints (const bool &recursive)

virtual const bool &	is_recursive_constraints () const

void	disable_clipping ()

void	enable_clipping ()

void	get_clip_region (int &x, int &y, int &w, int &h) const

virtual void	set_clip_region (const int &x, const int &y, const int &w, const int &h)

const bool &	is_clipping_enabled () const

void	bring_to_front ()

void	enable_tab_navigation (const bool &enable)

const bool &	is_tab_navigation_enabled () const

virtual bool	is_visible () const

virtual void	update_color_scheme (const GuiColorScheme &scheme)

virtual void	paste (const CoreString &clipboard)

bool	initiate_dnd_event (const CoreVector< CoreBaseObject * > &data)
	Initiate Drag'n drop event.

bool	initiate_dnd_event (CoreVector< OfHandle > &data)

bool	initiate_dnd_event (CoreBaseObject *data)
	See initiate_dnd_event.

bool	initiate_dnd_event (OfHandle data)

virtual GuiWidget *	get_next_focus_widget () const

virtual GuiWidget *	get_previous_focus_widget () const

void	give_focus_to_next_widget ()

void	give_focus_to_previous_widget ()

void	get_parent_effective_clip_region (int &x, int &y, int &w, int &h) const

const bool &	is_widget_visible (GuiWidget &child) const

const bool &	is_show_children () const

void	set_show_children (const bool &show_children)

template<class WidgetType >
WidgetType *	get_parent_widget () const
	Return the first occurence of WidgetType* in the widget parent hierarchy, or 0 if not found.

virtual size_t	get_memory_size () const override

Public Member Functions inherited from EventObject
	EventObject ()
	Constructor.

	EventObject (const EventObject &src)
	Copy Constructor.

virtual	~EventObject () override
	Destructor.

void	connect (EventObject &sender, const CoreString &event_id, EventInfoMethod event_cb, void *data=0)
	Connects this to an object to listen to a specific event.

void	connect (EventObject &sender, EventInfoMethod event_cb, void *data=0)
	Connects this to an object to listen any of its events.

bool	disconnect (EventObject &sender, const CoreString &event_id, EventInfoMethod event_cb, void *data=0)

bool	disconnect_all (EventObject &sender)
	Disconnects from all objects sender was listening on.

void	disconnect_all ()
	Disconnects from all objects we were listening on.

void	remove_all_connection ()
	Disconnects object from other objects it is listening to, and also disconnects all objects listening to it.

void	raise_event (const CoreString &event_id) const
	sends an event

void	raise_event (const EventInfo &event_info) const
	sends an event

bool	is_connected (EventObject &sender, const CoreString &event_id, void *data)

void	set_mute (const bool &mute)
	Asks for object muting. This will increase or decrease the muting counter. Unmuting may not be immediat since it will happen only when counter reaches 0.

bool	is_mute () const
	Returns if object is muted.

CoreArray< EventObject * >	get_senders () const

unsigned int	get_sender_count () const

unsigned int	get_receiver_count () const

void	connect (EventObject &sender, const CoreString &event_id, EventMethod event_cb, void *data=0)
	Connects this to an object to listen to a specific event.

void	connect (EventObject &sender, EventMethod event_cb, void *data=0)
	Connects this to an object to listen any of its events.

bool	disconnect (EventObject &sender, const CoreString &event_id, EventMethod event_cb, void *data=0)
	Disconnects this from an object for a specific event.

Public Member Functions inherited from CoreCustomData
	CoreCustomData (const CoreCustomData &src)

void	add_custom_data (void *key, const bool &data)

void	add_custom_data (void *key, const int &data)

void	add_custom_data (void *key, const unsigned int &data)

void	add_custom_data (void key, const char data)

void	add_custom_data (void *key, const CoreString &data)

void	add_custom_data (void *key, const double &data)

void	add_custom_data (void key, void data)

void	remove_custom_data (void *key)

void	remove_all_custom_data ()

void	set_custom_data (void *key, const bool &data)

void	set_custom_data (void *key, const int &data)

void	set_custom_data (void *key, const unsigned int &data)

void	set_custom_data (void *key, const double &data)

void	set_custom_data (void key, const char data)

void	set_custom_data (void *key, const CoreString &data)

void	set_custom_data (void key, void data)

void	get_custom_data (void *key, bool &data) const

void	get_custom_data (void *key, int &data) const

void	get_custom_data (void *key, unsigned int &data) const

void	get_custom_data (void *key, double &data) const

void	get_custom_data (void *key, CoreString &data) const

void	get_custom_data (void key, void &data) const

Public Member Functions inherited from CoreBaseObject
bool	is_kindof (const CoreBaseObject &object) const

CoreString	get_class_info_name () const

const unsigned long &	get_class_info_id () const

virtual bool	is_kindof (const CoreClassInfo &cinfo) const

virtual const CoreClassInfo &	get_class_info () const

template<class T >
T *	cast ()

template<class T >
const T *	cast () const

Public Member Functions inherited from CoreBaseType
bool	is_kindof (const CoreClassInfo &cinfo) const

Static Public Member Functions
static void	scroll_while_drag (void *data)

Static Public Member Functions inherited from GuiWidget
static CoreString	open_file (GuiApp &app, const CoreString &directory="", const CoreString &title="Open file", const CoreString &filter="")

static CoreArray< CoreString >	open_files (GuiApp &app, const CoreString &directory="", const CoreString &title="Open files", const CoreString &filter="")

static CoreString	open_folder (GuiApp &app, const CoreString &directory="", const CoreString &title="Choose folder")

static CoreString	save_file (GuiApp &app, const CoreString &directory="", const CoreString &title="Save file", const CoreString &filter="", int *filter_selected=0)

static CoreVector< OfItemHandle >	pick_objects (GuiApp &app, const CoreVector< OfItemHandle > &current_selection, const CoreVector< OfClass * > &filter_classes, OfContext context=0, const CoreVector< OfItem > &hidden_items=CoreVector< OfItem * >(), const bool &enable_multi_selection=false)

static CoreVector< OfItemHandle >	pick_objects (GuiApp &app, const CoreVector< OfClass * > &filter_classes, OfContext *context=0, const bool &enable_multi_selection=false)

static const char *	get_roundness_name (const Roundness &roundness)

static const char *	get_constraint_name (const Constraint &constraint)

static const char *	get_justify_name (const Justify &justification)

static const char *	get_icon_position_name (const IconPosition &position)

static GuiWidget *	get_focused_widget ()

static GuiWidget *	get_last_focused_widget ()

static GuiWidget *	get_last_event_widget ()

static void	intersect_box (const int &x1, const int &y1, const int &w1, const int &h1, const int &x2, const int &y2, const int &w2, const int &h2, int &x, int &y, int &w, int &h)

static bool	intersect_box (const int &x1, const int &y1, const int &w1, const int &h1, const int &x2, const int &y2, const int &w2, const int &h2)

static void	on_dnd_timeout (void *data)

static const CoreVector < CoreBaseObject * > &	get_dnd_event_data ()
	Return the data associated with the current Drag'n drop. The data is only valid if a widget is currently calling initiate_dnd_event, otherwise it is empty.

static GuiWidget *	get_dnd_widget ()
	Return the GuiWidget that initiated the Drag'n drop. Null otherwise.

static GuiWidget *	get_dnd_accepting_widget ()
	Return the GuiWidget that accepts the Drag'n drop. Null otherwise.

Static Public Member Functions inherited from EventObject
static void	connect (EventObject &sender, const CoreString &event_id, EventObject &receiver, EventInfoMethod event_cb, void *data=0)
	Static version of the above function.

static void	connect (EventObject &sender, EventObject &receiver, EventInfoMethod event_cb, void *data=0)
	Static version of the above function.

static void	connect (EventObject &sender, const CoreString &event_id, EventInfoFunction event_cb, void *data=0)
	Connects to an object to listen to a specific event.

static void	connect (EventObject &sender, EventInfoFunction event_cb, void *data=0)
	Connects to an object to listen any of its events.

static bool	disconnect (EventObject &sender, const CoreString &event_id, EventInfoFunction event_cb, void *data=0)

static void	raise_event (EventObject &sender, const CoreString &event_id)
	Sends an event.

static void	raise_event (EventObject &sender, const EventInfo &event_info)
	Sends an event.

static void	connect (EventObject &sender, const CoreString &event_id, EventFunction event_cb, void *data=0)
	Connects to an object to listen to a specific event.

static void	connect (EventObject &sender, EventFunction event_cb, void *data=0)
	Connects to an object to listen any of its events.

static void	connect (EventObject &sender, const CoreString &event_id, EventObject &receiver, EventMethod event_cb, void *data=0)
	Static version of the above function.

static void	connect (EventObject &sender, EventObject &receiver, EventMethod event_cb, void *data=0)
	Static version of the above function.

static bool	disconnect (EventObject &sender, const CoreString &event_id, EventFunction event_cb, void *data=0)
	Disconnects this from an object for a specific event.

Static Public Member Functions inherited from CoreCustomData
static void *	get_custom_data_key (const CoreString &key)

Static Public Member Functions inherited from CoreBaseObject
static const CoreClassInfo &	class_info ()

template<class T >
static T *	cast (CoreBaseObject *object)

template<class T >
static const T *	cast (const CoreBaseObject *object)

Static Public Member Functions inherited from CoreBaseType
static const CoreClassInfo &	class_info ()
	Get the type descriptor of this instance.

Protected Member Functions
virtual int	on_delete ()

virtual void	on_item_expand (GuiTreeItem *item)

virtual void	on_item_collapse (GuiTreeItem *item)

virtual void	on_item_deselect (GuiTreeItem *item)

virtual void	on_selection_changed ()

virtual void	on_selection_drag ()

virtual void	on_selection_drop (GuiTreeItem *over)

virtual void	on_deselect_all ()

virtual void	on_item_rename (GuiTreeItem *item)

virtual void	on_remove_selection ()

virtual int	on_navigate_up ()

virtual int	on_navigate_down ()

virtual int	on_navigate_left ()

virtual int	on_navigate_right ()

void	deselect_item (GuiTreeItem *item)

void	set_is_disable_selection_issuer (const bool &value)

const bool &	get_is_disable_selection_issuer () const

Protected Member Functions inherited from GuiWidget
virtual GuiDc &	get_dc ()

	GuiWidget (CreateWidget create_widget, GuiWidget &parent, const int &x, const int &y, const int &w, const int &h)

	GuiWidget (CreateWidget create_widget, GuiApp &app, const int &x, const int &y, const int &w, const int &h)

virtual void	widget_redraw ()

virtual Fl_Widget *	get_widget () const

virtual Fl_Group *	get_group () const

void	clear_all_children ()

void	damage (const unsigned char &mask)

const bool	is_damaged (const unsigned char &mask) const

const unsigned char	get_damage () const

void	create_delayed_parenting (Fl_Group *group) const

void	recompute_constraints ()

virtual void	push_clip (const int &x, const int &y, const int &w, const int &h)

virtual void	pop_clip ()

void	get_text_size (const CoreString &text, int &w, int &h) const

void	get_text_size (const char *text, int &w, int &h) const

virtual void	on_add_child (GuiWidget *child)

virtual void	on_remove_child (GuiWidget *child)

virtual void	apply_constraints (const int &px, const int &py, const int &pw, const int &ph)

void	apply_children_constraints (const int &px, const int &py, const int &pw, const int &ph) const

void	apply_constraints (GuiWidget &child, const int &px, const int &py, const int &pw, const int &ph) const

virtual void	apply_clipping ()

void	apply_children_clipping ()

void	capture_events (const bool &value)

virtual bool	process_actions ()

Friends
class	GuiTreeItem

class	GuiTreeVisible

Additional Inherited Members
Protected Types inherited from GuiWidget
typedef void(*	CreateWidget )(void *inst)

Protected Attributes inherited from GuiWidget
Fl_Widget *	m_widget

Fl_Window *	m_window

Fl_Group *	m_group

GuiApp &	m_application

int	m_child_index

Constraint	m_top_constraint

Constraint	m_bottom_constraint

Constraint	m_left_constraint

Constraint	m_right_constraint

int	m_top_offset

int	m_bottom_offset

int	m_left_offset

int	m_right_offset

int	m_clip_x

int	m_clip_y

int	m_clip_w

int	m_clip_h

int	m_eff_clip_x

int	m_eff_clip_y

int	m_eff_clip_w

int	m_eff_clip_h

GMathVec2i	m_size

GMathVec2i	m_position

GuiColorScheme *	m_color_scheme

GuiDc *	m_dc

Member Function Documentation

void GuiTree::draw ( GuiDc & dc )

overridevirtual

This is the main drawing method of the widget.

Parameters

dc	The drawing context used to draw stuff.

Reimplemented from GuiWidget.

int GuiTree::process_event ( const CoreString & event_id )

overridevirtual

This method is called whenever an event happens on this widget. Override this to catch and process them.

Parameters

event_id The event name.

Returns: 1 if the event was consumed, 0 otherwise (to let the other widgets catch it)

Reimplemented from GuiWidget.

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Friends

Additional Inherited Members

Member Function Documentation