Detailed Description

Enhanced version of ROOT TGListView widget.

Created by KVClassFactory on Wed Apr 9 11:51:38 2008 Author: franklan

Example of use

KVListView takes a list of objects (TObject or derived class) and presents them as a list of items with different data for each object presented in separate columns.
The user specifies the common base-class of the objects to display, the number of columns, and the data to be presented in each column.
The example in the figure shown above (displaying a list of KVDBRun objects) was generated with the following code:

   lvRuns = new KVListView(KVDBRun::Class(), cfRuns, 500, 250); // 'cfRuns' is pointer to parent frame

   lvRuns->SetDataColumns(4);   //set number of columns to 4

   lvRuns->SetDataColumn(0, "Run", "GetNumber");       //by default, the data presented in a column with title "Toto" will be retrieved
   lvRuns->SetDataColumn(1, "Events", "", kTextRight);      //from each object by calling the "GetToto" method of the class given to the KVListView ctor.
   lvRuns->SetDataColumn(2, "Date", "GetDatime");      //in case the "getter" method has a non-standard name, it can be given explicitly.

   lvRuns->GetDataColumn(2)->SetIsDateTime();      //some special treatment is afforded to date/time data. see method doc.
   lvRuns->SetDataColumn(3, "Comments", "", kTextLeft);// specify text alignment for data

   lvRuns->ActivateSortButtons();//when clicking a column header, the list is sorted according to that column's data.
   ...                           //clicking a second time the same column sorts objects in the opposite sense.

To display objects, put them in a TList and call

   lvRuns->Display( pointer_to_TList );

Object selection

Items in the list can be selected using either:

single left click (single object selection),
CTRL+left-click (selection of multiple non-neighbouring objects),
or SHIFT+left-click (selection of multiple & neighbouring objects)
CTRL+a (select all objects in list)

(By default, multiple selection of objects is allowed. Call AllowMultipleSelection(kFALSE) to disable).

When the selection changes, the KVListView emits the

   SelectionChanged()

signal.
The list of the currently selected objects can be retrieved with the method

   GetSelectedObjects()

which returns a TList of the currently selected objects (delete list after use), or

   GetPickOrderedSelectedObjects()

which returns a TList of the currently selected objects IN THE ORDER THEY WERE CLICKED

this list must NOT be deleted by the user.

Double-click action

By default, double-left-clicking an object will execute the

   Browse()

method of the object. This method is defined for all TObjects, it can be overridden in derived classes in order to do something interesting and/or useful.
Alternatively, using method

   SetDoubleClickAction(const char* receiver_class, void* receiver, const char* slot)

you can define a different behaviour when objects are double-clicked using signals & slots.
If you want to deactivate the double-click actions, call

   AllowDoubleClick(kFALSE)

Context menus

By default, context menus are active, which means that right-clicking an object opens its context menu. Call method

   AllowContextMenu(kFALSE)

to deactivate all context menus, or

   AddContextMenuClassException(TClass*)

to activate/deactivate context menus for specific classes, depending on whether context menus are globally activated or not.
See also 'Wrapper classes' below.

Icons

An icon is shown next to each item in the list. This icon is defined (for most ROOT objects e.g. histograms of different types) in the $ROOTSYS/etc/root.mimes file. Other icons can be added in .kvrootrc as in the following example:

   +KaliVeda.GUI.MimeTypes:   TCutG
   KaliVeda.GUI.MimeTypes.TCutG.Icon:   cut_t.xpm

which adds an icon (pair of scissors) for the TCutG class (not defined in root.mimes).
See also 'Wrapper classes' below.

Wrapper classes

For convenience, the objects placed in the list may be of a class which provides a 'wrapper' around the actual object of interest.
In this case, it is possible (if the 'wrapper' inherits from KVBase) to have the icon and the context menu of each object reflect the object of interest, rather than the wrapper.
To do so, call method

   SetUseObjLabelAsRealClass(kTRUE)

and have the wrapper class' GetLabel() and GetObject() methods return the class name and address of the wrapped object.

Definition at line 146 of file KVListView.h.

#include <KVListView.h>

Inheritance diagram for KVListView:

[legend]

Public Member Functions
	KVListView (TClass obj_class, const TGWindow p, UInt_t w, UInt_t h, UInt_t options=kSunkenFrame\|kDoubleBorder, Pixel_t back=GetDefaultFrameBackground())

virtual	~KVListView ()

void	ActivateItemsWithColumnData (const Char_t *colname, KVNumberList data, Bool_t activate=kTRUE)

void	ActivateItemWithColumnData (const Char_t colname, const Char_t data, Bool_t activate=kTRUE)

void	ActivateItemWithColumnData (const Char_t *colname, Double_t data, Bool_t activate=kTRUE)

void	ActivateItemWithColumnData (const Char_t *colname, Long_t data, Bool_t activate=kTRUE)

void	ActivateItemWithData (void *userData, Bool_t activate=kTRUE)

virtual void	ActivateSortButtons ()

void	AddContextMenuClassException (TClass *)

void	AllowBrowse (Bool_t on=kTRUE)

void	AllowContextMenu (Bool_t on=kTRUE)

void	AllowDoubleClick (Bool_t on=kTRUE)

void	AllowMultipleSelection (Bool_t yes=kTRUE)

virtual void	Display (const TCollection *l)

TGLVEntry *	FindItemWithColumnData (const Char_t colname, const Char_t data)

TGLVEntry *	FindItemWithColumnData (const Char_t *colname, Double_t data)

TGLVEntry *	FindItemWithColumnData (const Char_t *colname, Long_t data)

TGLVEntry *	FindItemWithData (void *userData)

virtual Int_t	GetColumnNumber (const Char_t *colname)

virtual KVLVColumnData *	GetDataColumn (Int_t index) const

TObject *	GetFirstInList () const

TObject *	GetLastInList () const

TGLVEntry *	GetLastSelectedItem () const

TObject *	GetLastSelectedObject () const

Bool_t	GetMultipleSelection () const

TClass *	GetObjClass () const

KVList *	GetPickOrderedSelectedObjects () const

TList *	GetSelectedItems () const

TList *	GetSelectedObjects () const

TCollection *	GetUserItems ()

virtual Bool_t	ProcessMessage (Long_t msg, Long_t parm1, Long_t parm2)
	Handle messages generated by the list view container. More...

virtual void	RemoveAll ()

virtual void	SelectAll ()

virtual void	SetDataColumn (Int_t index, const Char_t name, const Char_t method="", Int_t mode=kTextCenterX)

virtual void	SetDataColumns (Int_t ncolumns)

virtual void	SetDefaultColumnWidth (TGVFileSplitter *splitter)

void	SetDoubleClickAction (const char receiver_class, void receiver, const char *slot)

virtual void	SetMaxColumnSize (UInt_t width)

void	SetObjClass (TClass *cl)

void	SetUseObjLabelAsRealClass (Bool_t yes=kTRUE)

virtual void	Sort (Int_t column)

virtual void	UnSelectAll ()

Private Attributes
TContextMenu *	fContextMenu

UInt_t	fMaxColumnSize
	maximum width of columns More...

TClass *	fObjClass
	class of objects in list More...

int	nselected
	number of selected items More...

Constructor & Destructor Documentation

◆ KVListView()

KVListView::KVListView	(	TClass *	obj_class,
		const TGWindow *	p,
		UInt_t	w,
		UInt_t	h,
		UInt_t	options = `kSunkenFrame \| kDoubleBorder`,
		Pixel_t	back = `GetDefaultFrameBackground()`
	)

Create list view widget for objects of class obj_class. A KVLVContainer object is also created and set as the container in use. The view mode is set to kLVDetails (only one possible, no icons) Scrolling increments are set to 1 (vertical) & 19 (horizontal)

Definition at line 24 of file KVListView.cpp.

◆ ~KVListView()

virtual KVListView::~KVListView ( )

inlinevirtual

Definition at line 157 of file KVListView.h.

Member Function Documentation

◆ ActivateItemsWithColumnData()

void KVListView::ActivateItemsWithColumnData	(	const Char_t *	colname,
		KVNumberList	data,
		Bool_t	activate = `kTRUE`
	)

inline

Definition at line 227 of file KVListView.h.

◆ ActivateItemWithColumnData() [1/3]

void KVListView::ActivateItemWithColumnData	(	const Char_t *	colname,
		const Char_t *	data,
		Bool_t	activate = `kTRUE`
	)

inline

Definition at line 215 of file KVListView.h.

◆ ActivateItemWithColumnData() [2/3]

void KVListView::ActivateItemWithColumnData	(	const Char_t *	colname,
		Double_t	data,
		Bool_t	activate = `kTRUE`
	)

inline

Definition at line 223 of file KVListView.h.

◆ ActivateItemWithColumnData() [3/3]

void KVListView::ActivateItemWithColumnData	(	const Char_t *	colname,
		Long_t	data,
		Bool_t	activate = `kTRUE`
	)

inline

Definition at line 219 of file KVListView.h.

◆ ActivateItemWithData()

void KVListView::ActivateItemWithData	(	void *	userData,
		Bool_t	activate = `kTRUE`
	)

inline

Definition at line 199 of file KVListView.h.

◆ ActivateSortButtons()

void KVListView::ActivateSortButtons ( )

virtual

Connects the column header buttons (if defined) to the container's Sort(const Char_t*) method. Each button, when pressed, sends a "Clicked" signal which activates "Sort" with the name of the button/column as argument.

Definition at line 72 of file KVListView.cpp.

◆ AddContextMenuClassException()

void KVListView::AddContextMenuClassException ( TClass * cl )

The global context menu status (allowed or not allowed) is set by AllowContextMenu(). If required, this can be overridden for specific classes by calling this method for each required class. In this case, any objects in the list of precisely this class (not derived classes) will have the opposite behaviour to that defined by AllowContextMenu(), i.e. if context menus are globally disabled, this method defines the classes for which a context menu is authorised, and vice-versa.

Definition at line 235 of file KVListView.cpp.

◆ AllowBrowse()

void KVListView::AllowBrowse ( Bool_t on = kTRUE )

inline

Deprecated: use AllowDoubleClick()

Definition at line 278 of file KVListView.h.

◆ AllowContextMenu()

void KVListView::AllowContextMenu ( Bool_t on = kTRUE )

inline

Call with on=kFALSE to disable objects' context menus opening with mouse right-click

Definition at line 283 of file KVListView.h.

◆ AllowDoubleClick()

void KVListView::AllowDoubleClick ( Bool_t on = kTRUE )

inline

Call with on=kFALSE to disable objects' Browse() method being called with mouse double-click

Definition at line 272 of file KVListView.h.

◆ AllowMultipleSelection()

void KVListView::AllowMultipleSelection ( Bool_t yes = kTRUE )

inline

Definition at line 291 of file KVListView.h.

◆ Display()

virtual void KVListView::Display ( const TCollection * l )

inlinevirtual

Definition at line 173 of file KVListView.h.

◆ FindItemWithColumnData() [1/3]

TGLVEntry* KVListView::FindItemWithColumnData	(	const Char_t *	colname,
		const Char_t *	data
	)

inline

Definition at line 203 of file KVListView.h.

◆ FindItemWithColumnData() [2/3]

TGLVEntry* KVListView::FindItemWithColumnData	(	const Char_t *	colname,
		Double_t	data
	)

inline

Definition at line 211 of file KVListView.h.

◆ FindItemWithColumnData() [3/3]

TGLVEntry* KVListView::FindItemWithColumnData	(	const Char_t *	colname,
		Long_t	data
	)

inline

Definition at line 207 of file KVListView.h.

◆ FindItemWithData()

TGLVEntry* KVListView::FindItemWithData ( void * userData )

inline

Definition at line 195 of file KVListView.h.

◆ GetColumnNumber()

Int_t KVListView::GetColumnNumber ( const Char_t * colname )

virtual

Returns index of data column from its name. Return -1 if not found.

Definition at line 124 of file KVListView.cpp.

◆ GetDataColumn()

virtual KVLVColumnData* KVListView::GetDataColumn ( Int_t index ) const

inlinevirtual

Definition at line 168 of file KVListView.h.

◆ GetFirstInList()

TObject* KVListView::GetFirstInList ( ) const

inline

return first object in currently displayed list

Definition at line 262 of file KVListView.h.

◆ GetLastInList()

TObject* KVListView::GetLastInList ( ) const

inline

return last object in currently displayed list

Definition at line 267 of file KVListView.h.

◆ GetLastSelectedItem()

TGLVEntry* KVListView::GetLastSelectedItem ( ) const

inline

Definition at line 235 of file KVListView.h.

◆ GetLastSelectedObject()

TObject* KVListView::GetLastSelectedObject ( ) const

inline

Definition at line 231 of file KVListView.h.

◆ GetMultipleSelection()

Bool_t KVListView::GetMultipleSelection ( ) const

inline

Definition at line 295 of file KVListView.h.

◆ GetObjClass()

TClass* KVListView::GetObjClass ( ) const

inline

Definition at line 302 of file KVListView.h.

◆ GetPickOrderedSelectedObjects()

KVList* KVListView::GetPickOrderedSelectedObjects ( ) const

inline

list of selected objects (derived from TObject) in the order they were picked DO NOT DELETE!!!

Definition at line 251 of file KVListView.h.

◆ GetSelectedItems()

TList* KVListView::GetSelectedItems ( ) const

inline

list of selected KVLVEntry objects DELETE AFTER USE !!!

Definition at line 239 of file KVListView.h.

◆ GetSelectedObjects()

TList* KVListView::GetSelectedObjects ( ) const

inline

list of selected objects (derived from TObject) DELETE AFTER USE !!!

Definition at line 245 of file KVListView.h.

◆ GetUserItems()

TCollection* KVListView::GetUserItems ( )

inline

return list of all objects (selected or unselected) in list view

Definition at line 257 of file KVListView.h.

◆ ProcessMessage()

Bool_t KVListView::ProcessMessage	(	Long_t	msg,
		Long_t	parm1,
		Long_t	parm2
	)

virtual

Handle messages generated by the list view container.

Definition at line 47 of file KVListView.cpp.

◆ RemoveAll()

virtual void KVListView::RemoveAll ( )

inlinevirtual

Definition at line 190 of file KVListView.h.

◆ SelectAll()

virtual void KVListView::SelectAll ( void )

inlinevirtual

Definition at line 182 of file KVListView.h.

◆ SetDataColumn()

void KVListView::SetDataColumn	(	Int_t	index,
		const Char_t *	name,
		const Char_t *	method = `""`,
		Int_t	mode = `kTextCenterX`
	)

virtual

Define column with index = 0, 1, ... name = name of column (shown in column header button) method = method to call to fill column with data (by default, "Getname") mode = text alignment for data in column (kTextCenterX [default], kTextLeft, kTextRight) column header name is always center aligned

Definition at line 106 of file KVListView.cpp.

◆ SetDataColumns()

void KVListView::SetDataColumns ( Int_t ncolumns )

virtual

Definition at line 91 of file KVListView.cpp.

◆ SetDefaultColumnWidth()

void KVListView::SetDefaultColumnWidth ( TGVFileSplitter * splitter )

virtual

Set default column width of the columns headers. Limit minimum size of a column to total width / number of columns If only one column it will span the whole viewport

Definition at line 145 of file KVListView.cpp.

◆ SetDoubleClickAction()

void KVListView::SetDoubleClickAction	(	const char *	receiver_class,
		void *	receiver,
		const char *	slot
	)

Overrides the default 'double-click' action. By default, double-clicking on an object in the list will call the Browse(TBrowser*) method of the selected object. Use this method to override this behaviour. When an object is double-clicked the method 'slot' of the object 'receiver' of class 'receiver_class' will be called. The method in question must have the signature receiver_class::slot(TObject*) The address of the selected (T)object is passed as argument.

Definition at line 210 of file KVListView.cpp.

◆ SetMaxColumnSize()

virtual void KVListView::SetMaxColumnSize ( UInt_t width )

inlinevirtual

Definition at line 161 of file KVListView.h.

◆ SetObjClass()

void KVListView::SetObjClass ( TClass * cl )

inline

Definition at line 306 of file KVListView.h.

◆ SetUseObjLabelAsRealClass()

void KVListView::SetUseObjLabelAsRealClass ( Bool_t yes = kTRUE )

If list contains KVBase-derived objects, calling this method with yes=kTRUE will cause the string returned by the objects' KVBase::GetLabel() method to be used as the class name of the object

Definition at line 189 of file KVListView.cpp.

◆ Sort()

virtual void KVListView::Sort ( Int_t column )

inlinevirtual

Sort list according to data in given column (=0, 1, ...)

Definition at line 177 of file KVListView.h.

◆ UnSelectAll()

virtual void KVListView::UnSelectAll ( )

inlinevirtual

Definition at line 186 of file KVListView.h.

Member Data Documentation

◆ fContextMenu

TContextMenu* KVListView::fContextMenu

private

Definition at line 151 of file KVListView.h.

◆ fMaxColumnSize

UInt_t KVListView::fMaxColumnSize

private

maximum width of columns

Definition at line 150 of file KVListView.h.

◆ fObjClass

TClass* KVListView::fObjClass

private

class of objects in list

Definition at line 149 of file KVListView.h.

◆ nselected

int KVListView::nselected

private

number of selected items

Definition at line 148 of file KVListView.h.

Detailed Description

Example of use

Object selection

Double-click action

Context menus

Icons

Wrapper classes

Public Member Functions

Private Attributes

Constructor & Destructor Documentation

◆ KVListView()

◆ ~KVListView()

Member Function Documentation

◆ ActivateItemsWithColumnData()

◆ ActivateItemWithColumnData() [1/3]

◆ ActivateItemWithColumnData() [2/3]

◆ ActivateItemWithColumnData() [3/3]

◆ ActivateItemWithData()

◆ ActivateSortButtons()

◆ AddContextMenuClassException()

◆ AllowBrowse()

◆ AllowContextMenu()

◆ AllowDoubleClick()

◆ AllowMultipleSelection()

◆ Display()

◆ FindItemWithColumnData() [1/3]

◆ FindItemWithColumnData() [2/3]

◆ FindItemWithColumnData() [3/3]

◆ FindItemWithData()

◆ GetColumnNumber()

◆ GetDataColumn()

◆ GetFirstInList()

◆ GetLastInList()

◆ GetLastSelectedItem()

◆ GetLastSelectedObject()

◆ GetMultipleSelection()

◆ GetObjClass()

◆ GetPickOrderedSelectedObjects()

◆ GetSelectedItems()

◆ GetSelectedObjects()

◆ GetUserItems()

◆ ProcessMessage()

◆ RemoveAll()

◆ SelectAll()

◆ SetDataColumn()

◆ SetDataColumns()

◆ SetDefaultColumnWidth()

◆ SetDoubleClickAction()

◆ SetMaxColumnSize()

◆ SetObjClass()

◆ SetUseObjLabelAsRealClass()

◆ Sort()

◆ UnSelectAll()

Member Data Documentation

◆ fContextMenu

◆ fMaxColumnSize

◆ fObjClass

◆ nselected