KVLVEntry Class Reference

Detailed Description

One item/line in a KVListView window.

Created by KVClassFactory on Wed Apr 9 13:55:03 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 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 was generated by the following:

   lvRuns = new KVListView(KVDBRun::Class(), cfRuns, 500, 250); //create list view for KVDBRun objects. 'cfRuns' is pointer to GUI frame containing the list.
   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 );

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)

When the selection changes, the KVListView emits the

SelectionChanged()

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

GetSelectedItems()

, which returns a TList of the currently selected KVLVEntry objects, each one's name corresponds to the value displayed in the first column of the list view.
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.
Right-clicking an object opens the context menu of the object, allowing the usual interaction with objects as in TBrower, TCanvas, etc.

Definition at line 65 of file KVLVEntry.h.

#include <KVLVEntry.h>

Inheritance diagram for KVLVEntry:

Public Member Functions
	KVLVEntry (TObject *obj, const Char_t *objclass, const KVLVContainer *cnt, UInt_t ncols, KVLVColumnData **coldata)
	KVLVEntry (TObject *obj, const KVLVContainer *cnt, UInt_t ncols, KVLVColumnData **coldata)
	Default constructor. More...
virtual	~KVLVEntry ()
virtual void	DrawCopy (Handle_t id, Int_t x, Int_t y)
virtual void	Refresh ()
	Update the object characteristics and ask for redraw. More...
void	SetEditMode (Bool_t edit=kTRUE)

Private Attributes
Pixel_t	fBGColor
	background color of this item More...
Bool_t *	fBoolean
	'IsBoolean' attribute of each column More...
Bool_t	fColoured
	=kTRUE if object has an associated color More...
Bool_t	fDisconnectRefresh
	disconnect object's Modified method from this object's Refresh when deleted More...
Bool_t	fEditMode

Static Private Attributes
static Pixel_t	fgBGColor = 0
	current background color for items More...
static Pixel_t	fgGreyPixel = 0
	light grey color used to distinguish adjacent list items More...

Constructor & Destructor Documentation

KVLVEntry() [1/2]

KVLVEntry::KVLVEntry	(	TObject *	obj,
		const KVLVContainer *	cnt,
		UInt_t	ncols,
		KVLVColumnData **	coldata
	)

Default constructor.

Definition at line 28 of file KVLVEntry.cpp.

KVLVEntry() [2/2]

KVLVEntry::KVLVEntry	(	TObject *	obj,
		const Char_t *	objclass,
		const KVLVContainer *	cnt,
		UInt_t	ncols,
		KVLVColumnData **	coldata
	)

Exactly same as default constructor, but class of object used by TGLVEntry is given separately, not neccessarily the same as obj->ClassName()

Definition at line 107 of file KVLVEntry.cpp.

~KVLVEntry()

KVLVEntry::~KVLVEntry ( )

virtual

Dtor disconnect fUserData object's Modified signal from our Refresh method if connected

Definition at line 158 of file KVLVEntry.cpp.

Member Function Documentation

DrawCopy()

void KVLVEntry::DrawCopy ( Handle_t  id, Int_t  x, Int_t  y  )

virtual

Draw list view item in other window. List view item is placed and layout in the container frame, but is drawn in viewport.

This is a line for line copy of TGLVEntry::DrawCopy from ROOT v5.22/00, but we alternate the background colour between white and light grey, in order to make the list easier to read.

If fColoured=kTRUE (i.e. if entry has a valid GetLVEntryColor method which returns a recognised color), the requested background color is used

Definition at line 206 of file KVLVEntry.cpp.

Refresh()

void KVLVEntry::Refresh ( )

virtual

Update the object characteristics and ask for redraw.

Definition at line 175 of file KVLVEntry.cpp.

SetEditMode()

void KVLVEntry::SetEditMode ( Bool_t  edit = kTRUE )

inline

Definition at line 88 of file KVLVEntry.h.

Member Data Documentation

fBGColor

Pixel_t KVLVEntry::fBGColor

private

background color of this item

Definition at line 73 of file KVLVEntry.h.

fBoolean

Bool_t* KVLVEntry::fBoolean

private

'IsBoolean' attribute of each column

Definition at line 75 of file KVLVEntry.h.

fColoured

Bool_t KVLVEntry::fColoured

private

=kTRUE if object has an associated color

Definition at line 69 of file KVLVEntry.h.

fDisconnectRefresh

Bool_t KVLVEntry::fDisconnectRefresh

private

disconnect object's Modified method from this object's Refresh when deleted

Definition at line 77 of file KVLVEntry.h.

fEditMode

Bool_t KVLVEntry::fEditMode

private

Definition at line 68 of file KVLVEntry.h.

fgBGColor

Pixel_t KVLVEntry::fgBGColor = 0

staticprivate

current background color for items

Definition at line 71 of file KVLVEntry.h.

fgGreyPixel

Pixel_t KVLVEntry::fgGreyPixel = 0

staticprivate

light grey color used to distinguish adjacent list items

Definition at line 72 of file KVLVEntry.h.