#include <RGItemTreeSelector.hh>

Inheritance diagram for RGItemTreeSelector:

Public Types
enum	TreeContextMenu { menuFoldersOpen = 0x00010000, menuFoldersOpenAll = 0x00020000, menuFoldersClose = 0x00030000, menuFoldersCloseAll = 0x00040000, menuMoveTop = 0x00100000, menuMoveUp = 0x00200000, menuMoveDown = 0x00300000, menuMoveBottom = 0x00400000, menuMoveToFolder = 0x00500000, menuMoveToParent = 0x00600000, menuFolderCreate = 0x00700000, menuFolderNewItem = 0x00800000, menuItemEdit = 0x00900000, menuItemDelete = 0x00A00000, menuDummy = 0x00000000 }

Public Member Functions
Sub-widgets functions
virtual TGListTree *	GetListTree () const

virtual TGTextButton *	GetAllButton () const

virtual TGTextButton *	GetNoneButton () const

virtual TGTextButton *	GetInvertButton () const

virtual TGVerticalFrame *	GetSideButtonsFrame () const

virtual TGVerticalFrame *	GetFoldersButtonsFrame () const

virtual TGTextButton *	GetFoldersOpenButton () const

virtual TGTextButton *	GetFoldersCloseButton () const

virtual TGVerticalFrame *	GetMoveButtonsFrame () const

virtual TGTextButton *	GetMoveUpButton () const

virtual TGTextButton *	GetMoveDownButton () const

virtual TGTextButton *	GetMoveTopButton () const

virtual TGTextButton *	GetMoveBottomButton () const

virtual TGTextButton *	GetMoveParentButton () const

virtual TGTextButton *	GetMoveFolderButton () const

virtual TGVerticalFrame *	GetEditButtonsFrame () const

virtual TGTextButton *	GetNewFolderButton () const

virtual TGTextButton *	GetNewItemButton () const

virtual TGTextButton *	GetEditItemButton () const

virtual TGTextButton *	GetDeleteButton () const

virtual TGVerticalFrame *	GetCustomButtonsFrame () const

virtual TGButton *	AddSideButton (const char text, const Int_t id, TGLayoutHints l, const char *tooltip=NULL)

virtual TGButton *	AddSideButton (TGButton but, const Int_t id, TGLayoutHints l)

virtual TGFrame *	AddSideFrame (TGFrame f, TGLayoutHints l=NULL)

virtual TGFrame *	AddBottomFrame (TGFrame f, TGLayoutHints l=NULL)

virtual void	AddMenuItemSeparator ()

virtual void	AddMenuItemEntry (const string &title, Int_t id)

virtual void	AddMenuItemEntry (const string &title, TGPopupMenu *submenu)

virtual void	AddMenuFolderSeparator ()

virtual void	AddMenuFolderEntry (const string &title, Int_t id)

virtual void	AddMenuFolderEntry (const string &title, TGPopupMenu *submenu)

Internal functions (no need to be protected)
virtual void	UpdateItemSelection (GItemTreeBranch *branch=NULL)

virtual void	RecreateTreeDisplay ()

virtual void	RecreateTreeSubDisplay (GItemTreeBranch *branch)

virtual void	UpdateTreeDisplay ()

virtual void	UpdateButtonsState ()

virtual void	UpdateMenuItem (GItemTreeLeaf *leaf)

virtual void	UpdateMenuFolder (GItemTreeBranch *branch)

Tree structure functions
const GItemTreeBranch *	GetTreeRoot () const

void	SetDefaultPicture (const string &pic_name)

GItemTreeBranch *	AddFolder (const string &name)

GItemTreeBranch *	AddFolder (GItemTreeBranch *parent, const string &name)

GItemTreeLeaf *	AddElement (const string &name, void data, const TGPicture pic=NULL)

GItemTreeLeaf *	AddElement (GItemTreeBranch parent, const string &name, void data, const TGPicture *pic=NULL)

GItemTreeBranch *	SetRootNode (GItemTreeBranch *root, bool adopt=false)

virtual TGListTreeItem *	SelectItem (GItemTreeNode *node)

virtual TGListTreeItem *	SelectItem (TGListTreeItem *elem)

GItemTreeNode *	GetSelected () const

GItemTreeLeaf *	GetSelectedLeaf () const

Buttons / menu related actions
virtual void	OpenSelectedSubFolders ()

virtual void	CloseSelectedSubFolders ()

virtual void	OpenSubFolders (TGListTreeItem *item)

virtual void	CloseSubFolders (TGListTreeItem *item)

virtual void	OpenAllFolders ()

virtual void	CloseAllFolders ()

virtual void	MoveSelectedMoveTop (Bool_t emit=kTRUE)

virtual void	MoveSelectedMoveUp (Bool_t emit=kTRUE)

virtual void	MoveSelectedMoveDown (Bool_t emit=kTRUE)

virtual void	MoveSelectedMoveBottom (Bool_t emit=kTRUE)

virtual void	MoveSelectedToParent (Bool_t emit=kTRUE)

virtual void	MoveSelectedToFolder (Bool_t emit=kTRUE)

virtual void	CreateNewFolder ()

virtual void	CreateSubFolder (GItemTreeBranch *parent)

virtual void	CreateNewItem ()

virtual void	EditSelectedItem ()

virtual void	DeleteSelectedItem ()

virtual void	DeleteItem (GItemTreeLeaf *item, bool update=true)

virtual void	DeleteFolder (GItemTreeBranch *branch, bool update=true)

virtual void	CancelAction (const Bool_t cancel=kTRUE)

virtual Bool_t	GetCancelActionState () const

Slots from sub-widgets
virtual void	SelectAll ()

virtual void	SelectNone ()

virtual void	SelectInvert ()

virtual void	TreeClicked (TGListTreeItem *item, Int_t btn)

virtual void	TreeDoubleClicked (TGListTreeItem *item, Int_t btn)

virtual void	TreeReturnPressed (TGListTreeItem *item)

virtual void	ItemChecked (TObject *obj, Bool_t check)

virtual void	ProcessedEvent (Event_t *event)

virtual void	MenuActivated (Int_t id)

Signals
virtual void	SelectAllClicked ()

virtual void	SelectNoneClicked ()

virtual void	SelectInvertClicked ()

virtual void	SelectionChanged ()

virtual void	MoveUpClicked ()

virtual void	MoveDownClicked ()

virtual void	MoveTopClicked ()

virtual void	MoveBottomClicked ()

virtual void	MoveToParentClicked ()

virtual void	MoveToFolderClicked ()

virtual void	SelectionMoved ()

virtual void	NewFolderClicked ()

virtual void	NewItemClicked ()

virtual void	EditItemClicked ()

virtual void	DeleteClicked ()

virtual void	NewFolderCreated (TGListTreeItem *item)

virtual void	CreateItem (GItemTreeBranch *parent)

virtual void	EditItem (GItemTreeLeaf *item)

virtual void	ItemRemoved (void *data)

virtual void	CustomClicked (Int_t id)

virtual void	CustomMenuActivated (Int_t id)

virtual void	SingleSelected (ULong64_t leaf_ptr)

ROOT related functions
	ClassDef (RGItemTreeSelector, 0)

Protected Attributes
string	default_element_pic
	Default picture name for elements.

UInt_t	tree_w_min
	Tree widget minimum width.

UInt_t	tree_h_min
	Tree widget minimum height.

UInt_t	options
	Widget options.

GItemTreeBranch *	root_node
	Root tree node of GItems.

bool	local_tree
	Indicates if the tree is created internally and should be deleted with the widget.

TGHorizontalFrame *	w_widgets_frame
	Main frame.

TGVerticalFrame *	w_tree_frame
	Tree and side buttons frame.

TGCanvas *	w_tree_canvas
	Canvas holding the tree widget.

TGListTree *	w_tree
	Tree (list-tree) widget.

TGHorizontalFrame *	w_button_frame
	List buttons frame.

TGTextButton *	w_all_button
	All elements selection button.

TGTextButton *	w_none_button
	None elements selection button.

TGTextButton *	w_invert_button
	Invert selection button.

TGVerticalFrame *	w_side_frame
	Side buttons frame.

TGVerticalFrame *	w_folder_buttons_frame
	Frame for folder buttons.

TGTextButton *	w_open_all_button
	Open all folders button.

TGTextButton *	w_close_all_button
	Close all folders button.

TGVerticalFrame *	w_move_buttons_frame
	Frame for move buttons.

TGTextButton *	w_move_up_button
	In-folder selected item move button.

TGTextButton *	w_move_down_button
	In-folder selected item move button.

TGTextButton *	w_move_top_button
	In-folder selected item move button.

TGTextButton *	w_move_bottom_button
	In-folder selected item move button.

TGTextButton *	w_move_parent_button
	Button to move selected item to its parent folder.

TGTextButton *	w_move_folder_button
	Button to move selected item to another folder.

TGVerticalFrame *	w_edit_buttons_frame
	Frame for edit buttons.

TGTextButton *	w_new_folder_button
	New folder creation button.

TGTextButton *	w_new_item_button
	New element definition button.

TGTextButton *	w_edit_item_button
	Edit element button.

TGTextButton *	w_delete_button
	Delete button.

TGVerticalFrame *	w_custom_buttons_frame
	Frame for additional buttons.

TGPopupMenu *	w_menu_item
	Define the context menu for item selected.

TGPopupMenu *	w_menu_folder
	Define the context menu for folder selected.

TGListTreeItem *	prev_selected
	Previously selected item.

Bool_t	cancel_action
	Flag for cancellation of default requested action.

Private Member Functions
	GObject (RGItemTreeSelector)

Constructors, affectation, destructor
	RGItemTreeSelector (TGWindow p, const char label=NULL, const UInt_t opts=0, const UInt_t w_min=160, const UInt_t h_min=200)

virtual	~RGItemTreeSelector ()

	RGItemTreeSelector (const RGItemTreeSelector &original)

Widget functions
Bool_t	MultipleSelection () const

virtual void	MapSubwindows ()

virtual void	RefreshTreeView ()

virtual void	Construct ()

Detailed Description

This class defines a widget containing a tree of items for selection of elements. The elements are pointers on user objects, referred to by GItem objects.

In case of a single selection widget, no check-box is associated to the items in the tree view.

Objects in the tree are referred to using RGItem objects to refer to to them (RGItem is the class for the tree structure template). The user data of the tree nodes is used for the connection between the tree structure nodes and the tree view elements.

When selecting or unselecting a folder, all elements in that folder are selected or unselected.

The widget also provides also options for pre-defined actions (see option flags defined in RGItemTreeSelectorOptions) from buttons and context menu for tree elements. For these actions, a signal is emitted before the corresponding action is performed, so that, depending on the context, the calling object (embbeding the RGItemTreeSelector) can cancel the predefined action in a slot if it calls the CancelAction() function.

The optional button actions are

a set of move buttons to move elements up and down in their own folder
a set of move buttons (new folder creation, new item creation, selected item edit or delete)
buttons to open / close all folders (these actions do not check the action cancellation, since they do not alter the tree structure)

The optional context menus can be defined for folder elements or for item elements of the tree structure. The optional menu actions are:

menus to open / close all sub-folders
menus to move current element one level up (to parent folder) in the tree structure

Adding custum buttons and menus

If the rgITSCustomButtons option is selected, a frame is added in the side buttons area to add extra user buttons. It is possible to add buttons in this frame with the AddSideButton functions. Such buttons will then emit the CustomClicked signal.

If the context menus have been defined for items and/or for folders, it is possible to add entries to these menus, with the AddMenuItemEntry and the AddMenuFolderEntry functions. Note that item and folder menus share the same processing function (MenuActivated) and signal (CustomMenuActivated), and entries identifiers should then be different for items and folders menus. Nevertheless, this does not need to the case if a menu may be defined for both items and folders (but the entry has to be defined explicitely for both). For custom menu entries identifiers, use values below 65536, since values above are used for predefined menus.

Note

the user data of the TGListTreeItem elements of the tree view contain the pointer to the GItemTreeNote nodes of the tree structure
the user data of the nodes contain the pointer to the the TGListTreeItem elements
the user data of the RGItem (for tree leaves) is supposed to point on the program objects.

Options defined in the RGItemTreeSelectorOptions enumeration

Label options (related to TGGroupFrame base class)
- rgITSLabelCenterAligned: label is centered (default)
- rgITSLabelLeftAligned: label at left position
- rgITSLabelRightAligned: label at right position
- rgITSLabelAboveList: label is located above the list (default)
- rgITSLabelBelowList: label is located below the list
Side buttons position options
- rgITSSideButtonsRight: side buttons on the right side (default)
- rgITSSideButtonsLeft: side buttons on the left side
- rgITSSideButtonsCenter: side buttons vertically centered (default)
- rgITSSideButtonsUp: side buttons vertically placed up
- rgITSSideButtonsUpRight: side buttons placed up and right
- rgITSSideButtonsUpLeft: side buttons placed up and left
- rgITSSideButtonsDown: side buttons vertically placed down
- rgITSSideButtonsDownRight: side buttons placed down and right
- rgITSSideButtonsDownLeft: side buttons placed down and left
Side buttons actions options
- rgITSFolderButtons: include buttons for open / close of all folders
- rgITSMoveButtons: include default move buttons (move up, down, top, bottom)
- rgITSEditButtons: include default edition buttons (new folder, new item, edit and delete)
- rgITSCustomButtons: custom side buttons will be added (for derived classes)
Context menu options
- rgITSMenuItem: create the context menu for items (empty menu)
- rgITSMenuItemMove: define items context menu entries to move element top or to another folder
- rgITSMenuItemEdit: define items context menu entries to edit elements
- rgITSMenuFolder: create the context menu for folders (empty menu)
- rgITSMenuFolderOpen: define folders context menu entries for open / close of all folders (same as corresponding buttons)
- rgITSMenuFolderEdit: define folders context menu entries create a new sub-folder
- rgITSMenuFolderMove: define folders context menu entries to move element top or to another folder
- rgITSMenuDefault: create all predefined entries for context menus
Tree structure and selection options
- rgITSSingleSelection: single selection only (default)
- rgITSMultipleSelection: multiple selection
- rgITSAutoCreateFolder: automatically create folders if needed when adding elements

Tree structure organisation

Member Enumeration Documentation

enum RGItemTreeSelector::TreeContextMenu

Values associated to default context menus. If a menu is defined for both folders and items, the menu identification value is the same.

Constructor & Destructor Documentation

RGItemTreeSelector::RGItemTreeSelector	(	TGWindow *	p,
		const char *	label = `NULL`,
		const UInt_t	opts = `0`,
		const UInt_t	w_min = `160`,
		const UInt_t	h_min = `200`
	)

Constructor.

Parameters

p	parent widget
label	list label
opts	options
w_min	minimum width of list widget
h_min	minimum height of list widget

References cancel_action, Construct(), default_element_pic, local_tree, options, prev_selected, RG_ITL_DEFAULT_TREE_PICT, root_node, tree_h_min, tree_w_min, w_all_button, w_button_frame, w_close_all_button, w_custom_buttons_frame, w_delete_button, w_edit_buttons_frame, w_edit_item_button, w_folder_buttons_frame, w_invert_button, w_menu_folder, w_menu_item, w_move_bottom_button, w_move_buttons_frame, w_move_down_button, w_move_folder_button, w_move_parent_button, w_move_top_button, w_move_up_button, w_new_folder_button, w_new_item_button, w_none_button, w_open_all_button, w_side_frame, w_tree, w_tree_canvas, w_tree_frame, and w_widgets_frame.

RGItemTreeSelector::RGItemTreeSelector ( const RGItemTreeSelector & original )

protected

Copy constructor, not implemented.

Parameters

original object to copy

RGItemTreeSelector::~RGItemTreeSelector ( )

virtual

Destructor.

References local_tree, root_node, w_menu_folder, and w_menu_item.

Member Function Documentation

RGItemTreeSelector::GObject ( RGItemTreeSelector )

private

Macro from GCpp library that defines the following functions:

ClassName(): return the real class name of the object
StaticClassName(): return the used class name of the object (that may be a base class of the real object).
IsInstanceOf<T>(): return true if the current object is an instance of the template class name argument
Clone(): return an allocated copy of the object.

TGListTree * RGItemTreeSelector::GetListTree ( ) const

inlinevirtual

Get TGListBox widget pointer.

References w_tree.

TGTextButton * RGItemTreeSelector::GetAllButton ( ) const

inlinevirtual

Get "All" button pointer.

References w_all_button.

TGTextButton * RGItemTreeSelector::GetNoneButton ( ) const

inlinevirtual

Get "None" button pointer.

References w_none_button.

TGTextButton * RGItemTreeSelector::GetInvertButton ( ) const

inlinevirtual

Get "Invert" button pointer.

References w_invert_button.

TGVerticalFrame * RGItemTreeSelector::GetSideButtonsFrame ( ) const

inlinevirtual

Get pointer to move buttons frame.

References w_side_frame.

TGVerticalFrame * RGItemTreeSelector::GetFoldersButtonsFrame ( ) const

inlinevirtual

Get pointer to "folders" side buttons frame.

References w_folder_buttons_frame.

TGTextButton * RGItemTreeSelector::GetFoldersOpenButton ( ) const

inlinevirtual

Get "Open all folders" button pointer.

References w_open_all_button.

TGTextButton * RGItemTreeSelector::GetFoldersCloseButton ( ) const

inlinevirtual

Get "Close all folders" button pointer.

References w_close_all_button.

TGVerticalFrame * RGItemTreeSelector::GetMoveButtonsFrame ( ) const

inlinevirtual

Get pointer to "move" side buttons frame.

References w_move_buttons_frame.

TGTextButton * RGItemTreeSelector::GetMoveUpButton ( ) const

inlinevirtual

Get "Move up" button pointer.

References w_move_up_button.

TGTextButton * RGItemTreeSelector::GetMoveDownButton ( ) const

inlinevirtual

Get "Move down" button pointer.

References w_move_down_button.

TGTextButton * RGItemTreeSelector::GetMoveTopButton ( ) const

inlinevirtual

Get "Move top" button pointer.

References w_move_top_button.

TGTextButton * RGItemTreeSelector::GetMoveBottomButton ( ) const

inlinevirtual

Get "Move bottom" button pointer.

References w_move_bottom_button.

TGTextButton * RGItemTreeSelector::GetMoveParentButton ( ) const

inlinevirtual

Get "Move to parent" button pointer.

References w_move_parent_button.

TGTextButton * RGItemTreeSelector::GetMoveFolderButton ( ) const

inlinevirtual

Get "Move to another folder" button pointer.

References w_move_folder_button.

TGVerticalFrame * RGItemTreeSelector::GetEditButtonsFrame ( ) const

inlinevirtual

Get pointer to "edit" side buttons frame.

References w_edit_buttons_frame.

TGTextButton * RGItemTreeSelector::GetNewFolderButton ( ) const

inlinevirtual

Get "New folder" button pointer.

References w_new_folder_button.

TGTextButton * RGItemTreeSelector::GetNewItemButton ( ) const

inlinevirtual

Get "New item" button pointer.

References w_new_item_button.

TGTextButton * RGItemTreeSelector::GetEditItemButton ( ) const

inlinevirtual

Get "Edit item" button pointer.

References w_edit_item_button.

TGTextButton * RGItemTreeSelector::GetDeleteButton ( ) const

inlinevirtual

Get "Delete" button pointer.

References w_delete_button.

TGVerticalFrame * RGItemTreeSelector::GetCustomButtonsFrame ( ) const

inlinevirtual

Get pointer to "custom" side buttons frame.

References w_custom_buttons_frame.

TGButton * RGItemTreeSelector::AddSideButton	(	const char *	text,
		const Int_t	id,
		TGLayoutHints *	l,
		const char *	tooltip = `NULL`
	)

virtual

Add a button to side buttons. The button emits a signal CustomClicked(Int_t id).

Parameters

text	button text
id	button identification number
l	frame layout
tooltip	information message

TGButton * RGItemTreeSelector::AddSideButton	(	TGButton *	but,
		const Int_t	id,
		TGLayoutHints *	l
	)

virtual

Add a button to side buttons. The button emits a signal CustomClicked(Int_t id).

Parameters

but	button pointer
id	button identification number
l	frame layout

References MapSubwindows(), and w_custom_buttons_frame.

TGFrame * RGItemTreeSelector::AddSideFrame	(	TGFrame *	f,
		TGLayoutHints *	l = `NULL`
	)

virtual

Add a frame to side panel (buttons list).

Parameters

f	frame pointer
l	frame layout

References MapSubwindows(), and w_side_frame.

TGFrame * RGItemTreeSelector::AddBottomFrame	(	TGFrame *	f,
		TGLayoutHints *	l = `NULL`
	)

virtual

Add a frame below selection list.

Parameters

f	frame pointer
l	frame layout

References MapSubwindows().

void RGItemTreeSelector::AddMenuItemSeparator ( )

virtual

Add a new separator to the items context menu.

References w_menu_item.

void RGItemTreeSelector::AddMenuItemEntry	(	const string &	title,
		Int_t	id
	)

virtual

Add a new menu entry to the items context menu.

Parameters

title	menu title
id	associated identifier

References w_menu_item.

void RGItemTreeSelector::AddMenuItemEntry	(	const string &	title,
		TGPopupMenu *	submenu
	)

virtual

Add a new sub-menu to the items context menu.

Parameters

title	menu title
submenu	popup menu to be added

References w_menu_item.

void RGItemTreeSelector::AddMenuFolderSeparator ( )

virtual

Add a new separator to the folders context menu.

References w_menu_folder.

void RGItemTreeSelector::AddMenuFolderEntry	(	const string &	title,
		Int_t	id
	)

virtual

Add a new menu entry to the folders context menu.

Parameters

title	menu title
id	associated identifier

References w_menu_folder.

void RGItemTreeSelector::AddMenuFolderEntry	(	const string &	title,
		TGPopupMenu *	submenu
	)

virtual

Add a new sub-menu to the folders context menu.

Parameters

title	menu title
submenu	popup menu to be added

References w_menu_folder.

Bool_t RGItemTreeSelector::MultipleSelection ( ) const

inline

Return true if multiple selection option is set.

References options.

Referenced by AddElement(), AddFolder(), Construct(), RecreateTreeSubDisplay(), SelectAll(), SelectInvert(), SelectNone(), TreeDoubleClicked(), TreeReturnPressed(), UpdateItemSelection(), and UpdateTreeDisplay().

void RGItemTreeSelector::Construct ( )

protectedvirtual

Function called by constructor to setup the sub-widgets.

References RDico::its_all, RDico::its_all_tip, RDico::its_close_all, RDico::its_close_all_tip, RDico::its_delete, RDico::its_delete_tip, RDico::its_edit_item, RDico::its_edit_item_tip, RDico::its_folder_close, RDico::its_folder_open, RDico::its_invert, RDico::its_invert_tip, RDico::its_move_bottom, RDico::its_move_bottom_tip, RDico::its_move_down, RDico::its_move_down_tip, RDico::its_move_folder, RDico::its_move_folder_tip, RDico::its_move_parent, RDico::its_move_parent_tip, RDico::its_move_top, RDico::its_move_top_tip, RDico::its_move_up, RDico::its_move_up_tip, RDico::its_new_folder, RDico::its_new_folder_tip, RDico::its_new_item, RDico::its_new_item_tip, RDico::its_none, RDico::its_none_tip, RDico::its_open_all, RDico::its_open_all_tip, MultipleSelection(), options, rDico, tree_h_min, tree_w_min, w_all_button, w_button_frame, w_close_all_button, w_custom_buttons_frame, w_delete_button, w_edit_buttons_frame, w_edit_item_button, w_folder_buttons_frame, w_invert_button, w_menu_folder, w_menu_item, w_move_bottom_button, w_move_buttons_frame, w_move_down_button, w_move_folder_button, w_move_parent_button, w_move_top_button, w_move_up_button, w_new_folder_button, w_new_item_button, w_none_button, w_open_all_button, w_side_frame, w_tree, w_tree_canvas, w_tree_frame, and w_widgets_frame.

Referenced by RGItemTreeSelector().

void RGItemTreeSelector::MapSubwindows ( )

virtual

Overload of TGFrame function.

References tree_h_min, tree_w_min, UpdateButtonsState(), UpdateTreeDisplay(), w_menu_folder, w_menu_item, and w_tree.

Referenced by AddBottomFrame(), AddSideButton(), and AddSideFrame().

void RGItemTreeSelector::RefreshTreeView ( )

virtual

Refresh the display of the tree view.

References w_tree.

Referenced by CloseAllFolders(), OpenAllFolders(), SelectInvert(), TreeDoubleClicked(), and UpdateTreeDisplay().

void RGItemTreeSelector::UpdateItemSelection ( GItemTreeBranch * branch = NULL )

virtual

Function that updates the tree structure selection from the tree-list widget.

Parameters

branch sub-tree structure to update (root if NULL)

References MultipleSelection(), and root_node.

Referenced by ItemChecked().

void RGItemTreeSelector::RecreateTreeDisplay ( )

virtual

Function that clears the tree view widget and recreates it from scratch from the items tree structure.

References RecreateTreeSubDisplay(), root_node, UpdateTreeDisplay(), and w_tree.

Referenced by RGTreeRequester::Construct(), CreateSubFolder(), DeleteFolder(), DeleteItem(), MoveSelectedMoveBottom(), MoveSelectedMoveDown(), MoveSelectedMoveTop(), MoveSelectedMoveUp(), MoveSelectedToFolder(), MoveSelectedToParent(), and SetRootNode().

void RGItemTreeSelector::RecreateTreeSubDisplay ( GItemTreeBranch * branch )

virtual

Function that recreates the tree view elements for the children of the branch given as argument.

Parameters

branch tree structure branch for which the children tree view elements have to be recreated

References default_element_pic, RGItem::GetIcon(), MultipleSelection(), and w_tree.

Referenced by RecreateTreeDisplay().

void RGItemTreeSelector::UpdateTreeDisplay ( )

virtual

Function that updates the tree-list widget from the content of the tree structure.

References MultipleSelection(), RefreshTreeView(), root_node, and w_tree.

Referenced by MapSubwindows(), RecreateTreeDisplay(), SelectAll(), SelectInvert(), SelectNone(), and TreeDoubleClicked().

void RGItemTreeSelector::UpdateButtonsState ( )

virtual

Update the buttons activation status according to checked items and selection.

References w_delete_button, w_edit_item_button, w_move_bottom_button, w_move_down_button, w_move_folder_button, w_move_parent_button, w_move_top_button, w_move_up_button, w_new_folder_button, w_new_item_button, and w_tree.

Referenced by MapSubwindows(), MoveSelectedMoveBottom(), MoveSelectedMoveDown(), MoveSelectedMoveTop(), MoveSelectedMoveUp(), MoveSelectedToFolder(), MoveSelectedToParent(), SelectionChanged(), and TreeClicked().

void RGItemTreeSelector::UpdateMenuItem ( GItemTreeLeaf * leaf )

virtual

Update the context menu for items, according to argument leaf.

Parameters

leaf	selected leaf

References w_menu_item.

Referenced by ProcessedEvent().

void RGItemTreeSelector::UpdateMenuFolder ( GItemTreeBranch * branch )

virtual

Update the context menu for folders, according to argument branch.

Parameters

branch selected branch

References w_menu_folder, and w_menu_item.

Referenced by ProcessedEvent().

const GItemTreeBranch * RGItemTreeSelector::GetTreeRoot ( ) const

inline

Return the pointer to the tree root node.

References root_node.

void RGItemTreeSelector::SetDefaultPicture ( const string & pic_name )

Modify the default picture name for tree view elements.

Parameters

pic_name picture name

References default_element_pic, and RG_ITL_DEFAULT_TREE_PICT.

GItemTreeBranch * RGItemTreeSelector::AddFolder ( const string & name )

Add a new folder in the tree structure.

Parameters

name	folder name

References options, and root_node.

Referenced by AddElement(), and CreateSubFolder().

GItemTreeBranch * RGItemTreeSelector::AddFolder	(	GItemTreeBranch *	parent,
		const string &	name
	)

Add a new folder in the tree structure. Since the parent folder is given explicitely, the item name should not contain any subfolder.

Parameters

parent	parent folder in the tree structure
name	folder name

References MultipleSelection(), root_node, and w_tree.

GItemTreeLeaf * RGItemTreeSelector::AddElement	(	const string &	name,
		void *	data,
		const TGPicture *	pic = `NULL`
	)

Add a new element in the tree structure. The name is given relatively to the tree structure root, and may contain the sub-folder where the element should be placed.

Parameters

name	element name
data	pointer to the object referred by the element
pic	pointer to the picture for the element

References AddFolder(), options, and root_node.

GItemTreeLeaf * RGItemTreeSelector::AddElement	(	GItemTreeBranch *	parent,
		const string &	name,
		void *	data,
		const TGPicture *	pic = `NULL`
	)

Add a new element in the tree structure. Since the parent folder is given explicitely, the item name should not contain any subfolder.

Parameters

parent	parent folder in the tree structure
name	element name
data	pointer to the object referred by the element
pic	pointer to the picture for the element

References default_element_pic, MultipleSelection(), root_node, and w_tree.

GItemTreeBranch * RGItemTreeSelector::SetRootNode	(	GItemTreeBranch *	root,
		bool	adopt = `false`
	)

Define the item tree from arguments. This function completely removes the current tree if it is defined: if it is defined locally (adopted), the tree structure is deleted, without any signal emission.

Parameters

root	new tree root (main branch)
adopt	whether the tree is defined locally and will be deleted by the widget

References local_tree, RecreateTreeDisplay(), and root_node.

Referenced by RGTreeRequester::Construct().

TGListTreeItem * RGItemTreeSelector::SelectItem ( GItemTreeNode * node )

virtual

Set the argument node as selected item in the tree.

Parameters

node	tree structure node to set as selected

Referenced by CreateSubFolder(), MoveSelectedMoveBottom(), MoveSelectedMoveDown(), MoveSelectedMoveTop(), MoveSelectedMoveUp(), MoveSelectedToFolder(), MoveSelectedToParent(), TreeDoubleClicked(), and TreeReturnPressed().

TGListTreeItem * RGItemTreeSelector::SelectItem ( TGListTreeItem * elem )

virtual

Set the argument element as selected item in the tree.

Parameters

elem	tree view element to set as selected

References prev_selected, and w_tree.

GItemTreeNode * RGItemTreeSelector::GetSelected ( ) const

Return a pointer to the currently selected (highlighted) node, or NULL if no element (item or folder) is selected.

References w_tree.

Referenced by GetSelectedLeaf(), and RGTreeRequester::ProcessButton().

GItemTreeLeaf * RGItemTreeSelector::GetSelectedLeaf ( ) const

Return a pointer to the currently selected (highlighted) item, or NULL if no item is selected or if a folder is selected.

References GetSelected().

Referenced by RGTreeRequester::ProcessButton().

void RGItemTreeSelector::OpenSelectedSubFolders ( )

virtual

Open currently selected folder and all its sub-folders.

item	pointer to the tree leaf
update	indicates whether the tree display should be updated

branch	pointer to the tree branch
update	indicates whether the tree display should be updated

obj	user data object (in fact, a GItemTreeNode pointer)
check	check state of the item

Public Types

Public Member Functions

Protected Attributes

Private Member Functions

Constructors, affectation, destructor

Widget functions

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation