Detailed Description

Extension of TGLVContainer for KVListView widget.

Definition at line 119 of file KVLVContainer.h.

#include <KVLVContainer.h>

Inheritance diagram for KVLVContainer:

Public Member Functions
	KVLVContainer (const TGWindow *p=0, UInt_t w=1, UInt_t h=1, UInt_t options=kSunkenFrame, Pixel_t back=GetDefaultFrameBackground())

	KVLVContainer (TGCanvas *p, UInt_t options=kSunkenFrame, Pixel_t back=GetDefaultFrameBackground())

virtual	~KVLVContainer ()
	Destructor. More...

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)

void	AddContextMenuClassException (TClass *)

void	AddDataColumn (const char *columnName)

void	AddFrame (TGFrame f, TGLayoutHints l=0)
	Add an item to the list. More...

void	AllowBrowse (Bool_t on=kTRUE)

void	AllowContextMenu (Bool_t on=kTRUE)

void	AllowDoubleClick (Bool_t on=kTRUE)

virtual void	Display (const TCollection *=0)

void	DoDoubleClick (TGFrame *, Int_t, Int_t, Int_t)

void	DoubleClickAction (TObject *)

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)
	Find item with fUserData == userData in container. More...

virtual KVLVColumnData *	GetDataColumn (Int_t index) const

TObject *	GetFirstInList ()
	Returns first object in currently displayed list. More...

TObject *	GetLastInList ()
	Returns last object in currently displayed list. More...

TGLVEntry *	GetLastSelectedItem () const

TObject *	GetLastSelectedObject () const

KVList *	GetPickOrderedSelectedObjects () const

TList *	GetSelectedItems ()

TList *	GetSelectedObjects ()

TCollection *	GetUserItems ()

Bool_t	HandleButton (Event_t *event)
	Override TGContainer method in order to set fControlClick flag. More...

Bool_t	IsBeingSorted () const

void	OpenContextMenu (TGFrame *, Int_t, Int_t, Int_t)

virtual void	Refresh ()

virtual void	RemoveAll ()

virtual void	SelectAll ()
	void SetNewColumnName(const char* columnName); More...

virtual void	SetDataColumn (Int_t index, TClass cl, const Char_t name, const Char_t *method="")

virtual void	SetDataColumns (Int_t ncols)

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

void	SetObjClass (TClass *cN)

void	SetUseObjLabelAsRealClass (Bool_t on=kTRUE)

void	Sort (int column)
	Sort objects in container according to contents of given column. More...

Private Member Functions
virtual void	ActivateItemFromSelectAll (TGFrameElement *el)
	Activate item. More...

void	default_init ()

void	DeleteColData ()

virtual void	FillList (const TCollection *=0)

Private Attributes
Bool_t	fAllowContextMenu
	can objects' context menu be opened with right-click ? More...

Bool_t	fAllowDoubleClick
	do something when object double-clicked ? More...

KVLVColumnData **	fColData
	description of column data More...

TContextMenu *	fContextMenu
	used to display popup context menu for items More...

TList *	fContextMenuClassExceptions
	list of classes for which we override value of fAllowContextMenu More...

Bool_t	fControlClick
	set to kTRUE when user ctrl-clicks an item More...

Bool_t	fIsResized
	used to resize columns exactly once More...

Bool_t	fKeepUserItems
	internal use only, do not clear list of user items in RemoveAll() More...

Int_t	fNcols
	number of data columns More...

TClass *	fObjClass

KVList *	fPickOrderedObjects
	list of currently selected objects, in order of selection More...

Bool_t	fSort

KVLVColumnData *	fSortData
	name of column (i.e. type of data) currently used to sort objects More...

Int_t *	fSortDir
	direction of sorting for each column More...

Int_t	fSortType
	current sorting mode of contents (ascending or descending) More...

Bool_t	fUseObjLabelAsRealClass
	if kTRUE, object's classname read from KVBase::GetLabel() (objects must be KVBase-derived!) More...

Bool_t	fUserDoubleClickAction
	user-defined double-click action instead of Browse() method More...

KVList *	fUserItems
	list of currently displayed items, used by Refresh() More...

Friends
class	KVLVEntry

class	KVLVFrameElement

Constructor & Destructor Documentation

◆ KVLVContainer() [1/2]

KVLVContainer::KVLVContainer	(	const TGWindow *	p = `0`,
		UInt_t	w = `1`,
		UInt_t	h = `1`,
		UInt_t	options = `kSunkenFrame`,
		Pixel_t	back = `GetDefaultFrameBackground()`
	)

Definition at line 306 of file KVLVContainer.cpp.

◆ KVLVContainer() [2/2]

KVLVContainer::KVLVContainer	(	TGCanvas *	p,
		UInt_t	options = `kSunkenFrame`,
		Pixel_t	back = `GetDefaultFrameBackground()`
	)

Definition at line 316 of file KVLVContainer.cpp.

◆ ~KVLVContainer()

KVLVContainer::~KVLVContainer ( )

virtual

Destructor.

Definition at line 375 of file KVLVContainer.cpp.

Member Function Documentation

◆ ActivateItemFromSelectAll()

void KVLVContainer::ActivateItemFromSelectAll ( TGFrameElement * el )

privatevirtual

Activate item.

Definition at line 1130 of file KVLVContainer.cpp.

◆ ActivateItemsWithColumnData()

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

Definition at line 752 of file KVLVContainer.cpp.

◆ ActivateItemWithColumnData() [1/3]

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

Definition at line 704 of file KVLVContainer.cpp.

◆ ActivateItemWithColumnData() [2/3]

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

Definition at line 783 of file KVLVContainer.cpp.

◆ ActivateItemWithColumnData() [3/3]

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

Definition at line 728 of file KVLVContainer.cpp.

◆ ActivateItemWithData()

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

Find item with fUserData == userData in container and make it active (inactive if activate=kFALSE).

Definition at line 621 of file KVLVContainer.cpp.

◆ AddContextMenuClassException()

void KVLVContainer::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 1003 of file KVLVContainer.cpp.

◆ AddDataColumn()

void KVLVContainer::AddDataColumn ( const char * columnName )

Definition at line 1084 of file KVLVContainer.cpp.

◆ AddFrame()

void KVLVContainer::AddFrame	(	TGFrame *	f,
		TGLayoutHints *	l = `0`
	)

Add an item to the list.

Definition at line 435 of file KVLVContainer.cpp.

◆ AllowBrowse()

void KVLVContainer::AllowBrowse ( Bool_t on = kTRUE )

inline

Deprecated: use AllowDoubleClick

Definition at line 222 of file KVLVContainer.h.

◆ AllowContextMenu()

void KVLVContainer::AllowContextMenu ( Bool_t on = kTRUE )

inline

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

Definition at line 216 of file KVLVContainer.h.

◆ AllowDoubleClick()

void KVLVContainer::AllowDoubleClick ( Bool_t on = kTRUE )

inline

Call with on=kFALSE to disable reactivity of objects to mouse double-click

Definition at line 227 of file KVLVContainer.h.

◆ default_init()

void KVLVContainer::default_init ( )

private

Default initialisation of list view container Multiple selection is enabled The parent list view widget handles messages generated by container. By default, we allow objects' context menu to be opened with right-click, and objects' Browse() method to be executed by double-clicking. This can be modified using AllowContextMenu(kFALSE) and AllowDoubleClick(kFALSE).

Definition at line 332 of file KVLVContainer.cpp.

◆ DeleteColData()

void KVLVContainer::DeleteColData ( )

private

Definition at line 394 of file KVLVContainer.cpp.

◆ Display()

void KVLVContainer::Display ( const TCollection * list_of_objects = 0 )

virtual

Display the list of objects in the container. If the list is very long (> KVListView.MaxListLength) we pop up a dialog box to ask if all items should be displayed which can take quite a long time

Definition at line 458 of file KVLVContainer.cpp.

◆ DoDoubleClick()

void KVLVContainer::DoDoubleClick	(	TGFrame *	f,
		Int_t	but,
		Int_t	,
		Int_t
	)

Perform 'default' action when user double-left-clicks an object in the list. By default, this calls the Browse(TBrowser*) method of the object (defined for TObject, overridden in child classes). If SetDoubleClickAction() was called, the DoubleClickAction(TObject*) signal will be emitted with the address of the selected object. Calling AllowDoubleClick(kFALSE) will disable this.

Definition at line 882 of file KVLVContainer.cpp.

◆ DoubleClickAction()

void KVLVContainer::DoubleClickAction ( TObject * obj )

Definition at line 1049 of file KVLVContainer.cpp.

◆ FillList()

void KVLVContainer::FillList ( const TCollection * l = 0 )

privatevirtual

Fill list from list Pointers to objects are stored in internal list fUserItems for Refresh()

Definition at line 539 of file KVLVContainer.cpp.

◆ FindItemWithColumnData() [1/3]

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

Definition at line 644 of file KVLVContainer.cpp.

◆ FindItemWithColumnData() [2/3]

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

Definition at line 684 of file KVLVContainer.cpp.

◆ FindItemWithColumnData() [3/3]

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

Definition at line 664 of file KVLVContainer.cpp.

◆ FindItemWithData()

TGLVEntry * KVLVContainer::FindItemWithData ( void * userData )

Find item with fUserData == userData in container.

Definition at line 598 of file KVLVContainer.cpp.

◆ GetDataColumn()

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

inlinevirtual

Definition at line 169 of file KVLVContainer.h.

◆ GetFirstInList()

TObject * KVLVContainer::GetFirstInList ( )

Returns first object in currently displayed list.

Definition at line 909 of file KVLVContainer.cpp.

◆ GetLastInList()

TObject * KVLVContainer::GetLastInList ( )

Returns last object in currently displayed list.

Definition at line 929 of file KVLVContainer.cpp.

◆ GetLastSelectedItem()

TGLVEntry* KVLVContainer::GetLastSelectedItem ( ) const

inline

Returns last clicked item in list

Definition at line 192 of file KVLVContainer.h.

◆ GetLastSelectedObject()

TObject* KVLVContainer::GetLastSelectedObject ( ) const

inline

Returns object corresponding to last clicked item in list

Definition at line 187 of file KVLVContainer.h.

◆ GetPickOrderedSelectedObjects()

KVList* KVLVContainer::GetPickOrderedSelectedObjects ( ) const

inline

Returns list of currently selected objects, in the order they were picked. Do NOT delete this list - it belongs to KVLVContainer.

Definition at line 201 of file KVLVContainer.h.

◆ GetSelectedItems()

TList * KVLVContainer::GetSelectedItems ( )

Create and fill list with all currently selected items (KVLVEntry objects) USER MUST DELETE TLIST AFTER USE!!!

Definition at line 950 of file KVLVContainer.cpp.

◆ GetSelectedObjects()

TList * KVLVContainer::GetSelectedObjects ( )

Create and fill list with all currently selected objects (derived from TObject) USER MUST DELETE TLIST AFTER USE!!!

Definition at line 975 of file KVLVContainer.cpp.

◆ GetUserItems()

TCollection* KVLVContainer::GetUserItems ( )

inline

return list of all objects in list (regardless of selection)

Definition at line 207 of file KVLVContainer.h.

◆ HandleButton()

Bool_t KVLVContainer::HandleButton ( Event_t * event )

Override TGContainer method in order to set fControlClick flag.

Definition at line 1059 of file KVLVContainer.cpp.

◆ IsBeingSorted()

Bool_t KVLVContainer::IsBeingSorted ( ) const

inline

Definition at line 212 of file KVLVContainer.h.

◆ OpenContextMenu()

void KVLVContainer::OpenContextMenu	(	TGFrame *	f,
		Int_t	but,
		Int_t	x,
		Int_t	y
	)

Open context menu when user right-clicks an object in the list. Calling AllowContextMenu(kFALSE) will disable this. We also fill the list fPickOrderedObjects with the selected objects in the order of clicking

if fUseObjLabelAsRealClass=kTRUE (and if objects inherit from KVBase) then the context menu opened will be that of the class given by KVBase::GetLabel. The object's KVBase::GetObject() method must return the real object to use.

Definition at line 816 of file KVLVContainer.cpp.

◆ Refresh()

void KVLVContainer::Refresh ( )

virtual

Redisplay the list of objects in the container. This can be used to refresh the contents of the window.

Definition at line 508 of file KVLVContainer.cpp.

◆ RemoveAll()

void KVLVContainer::RemoveAll ( )

virtual

When the graphical list is emptied we need to empty the list of user objects also.

Definition at line 523 of file KVLVContainer.cpp.

◆ SelectAll()

void KVLVContainer::SelectAll ( void )

virtual

void SetNewColumnName(const char* columnName);

Override method in TGContainer If multiple selection is not enabled, do nothing

Definition at line 1097 of file KVLVContainer.cpp.

◆ SetDataColumn()

void KVLVContainer::SetDataColumn	(	Int_t	index,
		TClass *	cl,
		const Char_t *	name,
		const Char_t *	method = `""`
	)

virtual

Definition at line 587 of file KVLVContainer.cpp.

◆ SetDataColumns()

void KVLVContainer::SetDataColumns ( Int_t ncols )

virtual

Definition at line 569 of file KVLVContainer.cpp.

◆ SetDoubleClickAction()

void KVLVContainer::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 1030 of file KVLVContainer.cpp.

◆ SetObjClass()

void KVLVContainer::SetObjClass ( TClass * cN )

inline

Definition at line 237 of file KVLVContainer.h.

◆ SetUseObjLabelAsRealClass()

void KVLVContainer::SetUseObjLabelAsRealClass ( Bool_t on = kTRUE )

inline

Definition at line 245 of file KVLVContainer.h.

◆ Sort()

void KVLVContainer::Sort ( int column )

Sort objects in container according to contents of given column.

Definition at line 411 of file KVLVContainer.cpp.

Friends And Related Function Documentation

◆ KVLVEntry

friend class KVLVEntry

friend

Definition at line 122 of file KVLVContainer.h.

◆ KVLVFrameElement

friend class KVLVFrameElement

friend

Definition at line 121 of file KVLVContainer.h.

Member Data Documentation

◆ fAllowContextMenu

Bool_t KVLVContainer::fAllowContextMenu

private

can objects' context menu be opened with right-click ?

Definition at line 127 of file KVLVContainer.h.

◆ fAllowDoubleClick

Bool_t KVLVContainer::fAllowDoubleClick

private

do something when object double-clicked ?

Definition at line 129 of file KVLVContainer.h.

◆ fColData

KVLVColumnData** KVLVContainer::fColData

private

description of column data

Definition at line 136 of file KVLVContainer.h.

◆ fContextMenu

TContextMenu* KVLVContainer::fContextMenu

private

used to display popup context menu for items

Definition at line 141 of file KVLVContainer.h.

◆ fContextMenuClassExceptions

TList* KVLVContainer::fContextMenuClassExceptions

private

list of classes for which we override value of fAllowContextMenu

Definition at line 128 of file KVLVContainer.h.

◆ fControlClick

Bool_t KVLVContainer::fControlClick

private

set to kTRUE when user ctrl-clicks an item

Definition at line 131 of file KVLVContainer.h.

◆ fIsResized

Bool_t KVLVContainer::fIsResized

private

used to resize columns exactly once

Definition at line 124 of file KVLVContainer.h.

◆ fKeepUserItems

Bool_t KVLVContainer::fKeepUserItems

private

internal use only, do not clear list of user items in RemoveAll()

Definition at line 133 of file KVLVContainer.h.

◆ fNcols

Int_t KVLVContainer::fNcols

private

number of data columns

Definition at line 140 of file KVLVContainer.h.

◆ fObjClass

TClass* KVLVContainer::fObjClass

private

Definition at line 145 of file KVLVContainer.h.

◆ fPickOrderedObjects

KVList* KVLVContainer::fPickOrderedObjects

private

list of currently selected objects, in order of selection

Definition at line 143 of file KVLVContainer.h.

◆ fSort

Bool_t KVLVContainer::fSort

private

Definition at line 125 of file KVLVContainer.h.

◆ fSortData

KVLVColumnData* KVLVContainer::fSortData

private

name of column (i.e. type of data) currently used to sort objects

Definition at line 138 of file KVLVContainer.h.

◆ fSortDir

Int_t* KVLVContainer::fSortDir

private

direction of sorting for each column

Definition at line 139 of file KVLVContainer.h.

◆ fSortType

Int_t KVLVContainer::fSortType

private

current sorting mode of contents (ascending or descending)

Definition at line 137 of file KVLVContainer.h.

◆ fUseObjLabelAsRealClass

Bool_t KVLVContainer::fUseObjLabelAsRealClass

private

if kTRUE, object's classname read from KVBase::GetLabel() (objects must be KVBase-derived!)

Definition at line 147 of file KVLVContainer.h.

◆ fUserDoubleClickAction

Bool_t KVLVContainer::fUserDoubleClickAction

private

user-defined double-click action instead of Browse() method

Definition at line 130 of file KVLVContainer.h.

◆ fUserItems

KVList* KVLVContainer::fUserItems

private

list of currently displayed items, used by Refresh()

Definition at line 142 of file KVLVContainer.h.

Detailed Description

Public Member Functions

Private Member Functions

Private Attributes

Friends

Constructor & Destructor Documentation

◆ KVLVContainer() [1/2]

◆ KVLVContainer() [2/2]

◆ ~KVLVContainer()

Member Function Documentation

◆ ActivateItemFromSelectAll()

◆ ActivateItemsWithColumnData()

◆ ActivateItemWithColumnData() [1/3]

◆ ActivateItemWithColumnData() [2/3]

◆ ActivateItemWithColumnData() [3/3]

◆ ActivateItemWithData()

◆ AddContextMenuClassException()

◆ AddDataColumn()

◆ AddFrame()

◆ AllowBrowse()

◆ AllowContextMenu()

◆ AllowDoubleClick()

◆ default_init()

◆ DeleteColData()

◆ Display()

◆ DoDoubleClick()

◆ DoubleClickAction()

◆ FillList()

◆ FindItemWithColumnData() [1/3]

◆ FindItemWithColumnData() [2/3]

◆ FindItemWithColumnData() [3/3]

◆ FindItemWithData()

◆ GetDataColumn()

◆ GetFirstInList()

◆ GetLastInList()

◆ GetLastSelectedItem()

◆ GetLastSelectedObject()

◆ GetPickOrderedSelectedObjects()

◆ GetSelectedItems()

◆ GetSelectedObjects()

◆ GetUserItems()

◆ HandleButton()

◆ IsBeingSorted()

◆ OpenContextMenu()

◆ Refresh()

◆ RemoveAll()

◆ SelectAll()

◆ SetDataColumn()

◆ SetDataColumns()

◆ SetDoubleClickAction()

◆ SetObjClass()

◆ SetUseObjLabelAsRealClass()

◆ Sort()

Friends And Related Function Documentation

◆ KVLVEntry

◆ KVLVFrameElement

Member Data Documentation

◆ fAllowContextMenu

◆ fAllowDoubleClick

◆ fColData

◆ fContextMenu

◆ fContextMenuClassExceptions

◆ fControlClick

◆ fIsResized

◆ fKeepUserItems

◆ fNcols

◆ fObjClass

◆ fPickOrderedObjects

◆ fSort

◆ fSortData

◆ fSortDir

◆ fSortType

◆ fUseObjLabelAsRealClass

◆ fUserDoubleClickAction

◆ fUserItems