A listbox is a box, possibly with scrollbar, containing entries.

Currently entries are simple text strings (TGTextLBEntry). A TGListBox looks a lot like a TGCanvas. It has a TGViewPort containing a TGLBContainer which contains the entries and it also has a vertical scrollbar which becomes visible if there are more items than fit in the visible part of the container.

The TGListBox is user callable. The other classes are service classes of the listbox.

A listbox contains a container frame which is viewed through a viewport. If the container is larger than the viewport than a vertical scrollbar is added.

Selecting an item in the listbox will generate the event:

kC_COMMAND, kCM_LISTBOX, listbox id, item id.

Definition at line 221 of file TGListBox.h.

Public Member Functions
	TGListBox (const TGWindow *p=nullptr, Int_t id=-1, UInt_t options=kSunkenFrame\|kDoubleBorder, Pixel_t back=GetWhitePixel())
	Create a listbox.

virtual	~TGListBox ()
	Delete a listbox widget.

virtual void	AddEntry (const char *s, Int_t id)
	Add entry with specified string and id to listbox.

virtual void	AddEntry (TGLBEntry lbe, TGLayoutHints lhints)
	Add specified TGLBEntry and TGLayoutHints to listbox.

virtual void	AddEntry (TGString *s, Int_t id)
	Add entry with specified string and id to listbox.

virtual void	AddEntrySort (const char *s, Int_t id)
	Add entry with specified string and id to listbox sorted by increasing id.

virtual void	AddEntrySort (TGLBEntry lbe, TGLayoutHints lhints)
	Add specified TGLBEntry and TGLayoutHints to listbox sorted by increasing id.

virtual void	AddEntrySort (TGString *s, Int_t id)
	Add entry with specified string and id to listbox sorted by increasing id.

virtual void	ChangeBackground (Pixel_t back)
	Change background to all entries.

virtual void	DoubleClicked (const char *txt)

virtual void	DoubleClicked (Int_t id)

virtual void	DoubleClicked (Int_t widgetId, Int_t id)
	Emit DoubleClicked signal with list box id and entry id.

virtual void	DrawBorder ()
	Draw borders of the list box widget.

virtual TGLBEntry *	FindEntry (const char *s) const
	Find entry by name.

virtual TGFrame *	GetContainer () const

virtual TGDimension	GetDefaultSize () const
	Return default size of listbox widget.

virtual TGLBEntry *	GetEntry (Int_t id) const
	Returns list box entry with specified id.

UInt_t	GetItemVsize () const

virtual Bool_t	GetMultipleSelections () const

virtual Int_t	GetNumberOfEntries () const

virtual TGScrollBar *	GetScrollBar () const

virtual Int_t	GetSelected () const
	Return id of selected listbox item.

virtual void	GetSelectedEntries (TList *selected)
	Adds all selected entries (TGLBEntry) of the list box into the list selected.

virtual TGLBEntry *	GetSelectedEntry () const

virtual Bool_t	GetSelection (Int_t id)

virtual TGViewPort *	GetViewPort () const

virtual TGVScrollBar *	GetVScrollbar () const

virtual void	InsertEntry (const char *s, Int_t id, Int_t afterID)
	Insert entry with specified string and id behind the entry with afterID.

virtual void	InsertEntry (TGLBEntry lbe, TGLayoutHints lhints, Int_t afterID)
	Insert the specified TGLBEntry and layout hints behind afterID.

virtual void	InsertEntry (TGString *s, Int_t id, Int_t afterID)
	Insert entry with specified string and id behind the entry with afterID.

virtual void	IntegralHeight (Bool_t mode)

virtual void	Layout ()
	Layout the listbox components.

virtual void	MoveResize (Int_t x, Int_t y, UInt_t w, UInt_t h)
	Move and resize the listbox widget.

virtual void	NewEntry (const char *s="Entry")
	method used to add entry via context menu

virtual Bool_t	ProcessMessage (Longptr_t msg, Longptr_t parm1, Longptr_t parm2)
	Process messages generated by the listbox container and forward messages to the listbox message handling window.

virtual void	RemoveAll ()
	Remove all entries.

virtual void	RemoveEntries (Int_t from_ID, Int_t to_ID)
	Remove a range of entries defined by from_ID and to_ID.

virtual void	RemoveEntry (Int_t id=-1)
	remove entry with id.

virtual void	Resize (TGDimension size)
	Resize the frame.

virtual void	Resize (UInt_t w, UInt_t h)
	Resize the listbox widget.

virtual void	SavePrimitive (std::ostream &out, Option_t *option="")
	Save a list box widget as a C++ statement(s) on output stream out.

virtual TGLBEntry *	Select (Int_t id, Bool_t sel=kTRUE)

virtual void	Selected (const char *txt)

virtual void	Selected (Int_t id)

virtual void	Selected (Int_t widgetId, Int_t id)
	Emit Selected signal with list box id and entry id.

virtual void	SelectionChanged ()

virtual void	SetLayoutManager (TGLayoutManager *)
	Set the layout manager for the composite frame.

virtual void	SetMultipleSelections (Bool_t multi=kTRUE)

virtual void	SetTopEntry (Int_t id=-1)
	Scroll the entry with id to the top of the listbox.

virtual void	SortByName (Bool_t ascend=kTRUE)
	Sort entries by name.

Public Member Functions inherited from TGCompositeFrame
	TGCompositeFrame (const TGWindow *p=nullptr, UInt_t w=1, UInt_t h=1, UInt_t options=0, Pixel_t back=GetDefaultFrameBackground())
	Create a composite frame.

	TGCompositeFrame (TGClient c, Window_t id, const TGWindow parent=nullptr)
	Create a frame using an externally created window.

virtual	~TGCompositeFrame ()
	Delete a composite frame.

virtual void	AddFrame (TGFrame f, TGLayoutHints l=0)
	Add frame to the composite frame using the specified layout hints.

virtual void	ChangeOptions (UInt_t options)
	Change composite frame options. Options is an OR of the EFrameTypes.

virtual void	ChangeSubframesBackground (Pixel_t back)
	Change background color for this frame and all subframes.

virtual void	Cleanup ()
	Cleanup and delete all objects contained in this composite frame.

virtual TGFrameElement *	FindFrameElement (TGFrame *f) const
	Find frame-element holding frame f.

virtual UInt_t	GetDefaultHeight () const

virtual UInt_t	GetDefaultWidth () const

virtual TGFrame *	GetFrameFromPoint (Int_t x, Int_t y)
	Get frame located at specified point.

virtual TGLayoutManager *	GetLayoutManager () const

virtual TList *	GetList () const

Int_t	GetState (TGFrame *f) const
	Get state of sub frame.

virtual Bool_t	HandleButton (Event_t *)

virtual Bool_t	HandleCrossing (Event_t *)

virtual Bool_t	HandleDoubleClick (Event_t *)

virtual Bool_t	HandleDragDrop (TGFrame frame, Int_t x, Int_t y, TGLayoutHints lo)
	Handle drop event.

virtual Bool_t	HandleDragEnter (TGFrame *)
	Handle drag enter event.

virtual Bool_t	HandleDragLeave (TGFrame *)
	Handle drag leave event.

virtual Bool_t	HandleDragMotion (TGFrame *)
	Handle drag motion event.

virtual Bool_t	HandleFocusChange (Event_t *)

virtual Bool_t	HandleKey (Event_t *)

virtual Bool_t	HandleMotion (Event_t *)

virtual Bool_t	HandleSelection (Event_t *)

virtual void	HideFrame (TGFrame *f)
	Hide sub frame.

Bool_t	IsArranged (TGFrame *f) const
	Get state of sub frame.

Bool_t	IsArranged (TGFrameElement *ptr) const

Bool_t	IsComposite () const

virtual Bool_t	IsEditable () const
	Return kTRUE if frame is being edited.

virtual Bool_t	IsLayoutBroken () const

virtual Bool_t	IsMapSubwindows () const

Bool_t	IsVisible (TGFrame *f) const
	Get state of sub frame.

Bool_t	IsVisible (TGFrameElement *ptr) const

virtual void	MapSubwindows ()
	Map all sub windows that are part of the composite frame.

virtual Int_t	MustCleanup () const

virtual void	Print (Option_t *option="") const
	Print all frames in this composite frame.

virtual void	RemoveFrame (TGFrame *f)
	Remove frame from composite frame.

virtual void	SavePrimitiveSubframes (std::ostream &out, Option_t *option="")
	Auxiliary protected method used to save subframes.

virtual void	SetCleanup (Int_t mode=kLocalCleanup)
	Turn on automatic cleanup of child frames in dtor.

virtual void	SetEditable (Bool_t on=kTRUE)
	Switch ON/OFF edit mode.

virtual void	SetEditDisabled (UInt_t on=1)
	Set edit disable flag for this frame and subframes.

virtual void	SetLayoutBroken (Bool_t on=kTRUE)
	Set broken layout. No Layout method is called.

virtual void	SetMapSubwindows (Bool_t on)

virtual void	ShowFrame (TGFrame *f)
	Show sub frame.

virtual Bool_t	TranslateCoordinates (TGFrame *child, Int_t x, Int_t y, Int_t &fx, Int_t &fy)
	Translate coordinates to child frame.

Public Member Functions inherited from TGFrame
	TGFrame (const TGWindow *p=nullptr, UInt_t w=1, UInt_t h=1, UInt_t options=0, Pixel_t back=GetDefaultFrameBackground())
	Create a TGFrame object. Options is an OR of the EFrameTypes.

	TGFrame (TGClient c, Window_t id, const TGWindow parent=nullptr)
	Create a frame using an externally created window.

virtual	~TGFrame ()
	Destructor.

virtual void	Activate (Bool_t)

void	AddInput (UInt_t emask)
	Add events specified in the emask to the events the frame should handle.

Bool_t	Contains (Int_t x, Int_t y) const

virtual void	Delete (Option_t *="")
	Delete this object.

virtual void	DeleteWindow ()
	Delete window.

virtual void	DrawClass () const
	Draw class inheritance tree of the class to which this object belongs.

virtual TObject *	DrawClone (Option_t *="") const
	Draw a clone of this object in the current selected pad for instance with: `gROOT->SetSelectedPad(gPad)`.

virtual void	DrawCopy (Handle_t, Int_t, Int_t)

virtual void	Dump () const
	Dump contents of object on stdout.

virtual Pixel_t	GetBackground () const

Int_t	GetBorderWidth () const

virtual TDNDData *	GetDNDData (Atom_t)

virtual Int_t	GetDragType () const
	Returns drag source type.

virtual Int_t	GetDropType () const
	Returns drop target type.

UInt_t	GetEventMask () const

virtual Pixel_t	GetForeground () const
	Return frame foreground color.

TGFrameElement *	GetFrameElement () const

UInt_t	GetHeight () const

UInt_t	GetMaxHeight () const

UInt_t	GetMaxWidth () const

UInt_t	GetMinHeight () const

UInt_t	GetMinWidth () const

virtual UInt_t	GetOptions () const

TGDimension	GetSize () const

UInt_t	GetWidth () const

Int_t	GetX () const

Int_t	GetY () const

virtual Bool_t	HandleClientMessage (Event_t *event)
	Handle a client message.

virtual Bool_t	HandleColormapChange (Event_t *)

virtual Bool_t	HandleConfigureNotify (Event_t *event)
	This event is generated when the frame is resized.

virtual Bool_t	HandleDNDDrop (TDNDData *)

virtual Atom_t	HandleDNDEnter (Atom_t *)

virtual Bool_t	HandleDNDFinished ()

virtual Bool_t	HandleDNDLeave ()

virtual Atom_t	HandleDNDPosition (Int_t, Int_t, Atom_t, Int_t, Int_t)

virtual Bool_t	HandleEvent (Event_t *event)
	Handle all frame events.

virtual Bool_t	HandleSelectionClear (Event_t *)

virtual Bool_t	HandleSelectionRequest (Event_t *)

virtual void	Inspect () const
	Dump contents of this object in a graphics canvas.

virtual Bool_t	IsActive () const

Bool_t	IsDNDSource () const

Bool_t	IsDNDTarget () const

virtual void	MapRaised ()
	map raised

virtual void	MapWindow ()
	map window

virtual void	Move (Int_t x, Int_t y)
	Move frame.

virtual void	ProcessedConfigure (Event_t *event)

virtual void	ProcessedEvent (Event_t *event)

virtual void	ReallyDelete ()

void	RemoveInput (UInt_t emask)
	Remove events specified in emask from the events the frame should handle.

virtual void	ReparentWindow (const TGWindow *p, Int_t x=0, Int_t y=0)
	Reparent window, make p the new parent and position the window at position (x,y) in new parent.

void	SaveUserColor (std::ostream &out, Option_t *)
	Save a user color in a C++ macro file - used in SavePrimitive().

virtual void	SendMessage (const TGWindow *w, Longptr_t msg, Longptr_t parm1, Longptr_t parm2)
	Send message (i.e.

virtual void	SetBackgroundColor (Pixel_t back)
	Set background color (override from TGWindow base class).

void	SetDNDSource (Bool_t onoff)

void	SetDNDTarget (Bool_t onoff)

virtual void	SetDragType (Int_t type)
	SetDragType.

virtual void	SetDrawOption (Option_t *="")
	Set drawing option for object.

virtual void	SetDropType (Int_t type)
	SetDropType.

virtual void	SetForegroundColor (Pixel_t)

void	SetFrameElement (TGFrameElement *fe)

virtual void	SetHeight (UInt_t h)

virtual void	SetMaxHeight (UInt_t h)

virtual void	SetMaxWidth (UInt_t w)

virtual void	SetMinHeight (UInt_t h)

virtual void	SetMinWidth (UInt_t w)

virtual void	SetSize (const TGDimension &s)

virtual void	SetWidth (UInt_t w)

virtual void	SetX (Int_t x)

virtual void	SetY (Int_t y)

virtual void	UnmapWindow ()
	unmap window

Public Member Functions inherited from TGWindow
	TGWindow (const TGWindow p=0, Int_t x=0, Int_t y=0, UInt_t w=0, UInt_t h=0, UInt_t border=0, Int_t depth=0, UInt_t clss=0, void visual=0, SetWindowAttributes_t *attr=0, UInt_t wtype=0)
	Create a new window.

	TGWindow (TGClient c, Window_t id, const TGWindow parent=0)
	Create a copy of a window.

virtual	~TGWindow ()
	Window destructor. Unregisters the window.

virtual void	DestroySubwindows ()
	destroy sub windows

virtual void	DestroyWindow ()
	destroy window

virtual UInt_t	GetEditDisabled () const

virtual const TGWindow *	GetMainFrame () const
	Returns top level main frame.

virtual const char *	GetName () const
	Return unique name, used in SavePrimitive methods.

const TGWindow *	GetParent () const

virtual Bool_t	HandleExpose (Event_t *event)

virtual Bool_t	HandleIdleEvent (TGIdleHandler *)

virtual Bool_t	HandleTimer (TTimer *)
	Execute action in response of a timer timing out.

virtual void	IconifyWindow ()
	iconify window

virtual Bool_t	IsMapped ()
	Returns kTRUE if window is mapped on screen, kFALSE otherwise.

virtual void	LowerWindow ()
	lower window

virtual void	RaiseWindow ()
	raise window

virtual void	RequestFocus ()
	request focus

virtual void	SetBackgroundPixmap (Pixmap_t pixmap)
	set background pixmap

virtual void	SetName (const char *name)

virtual void	SetWindowName (const char *name=0)
	Set window name.

Public Member Functions inherited from TGObject
	TGObject ()

	TGObject (const TGObject &tgo)

virtual	~TGObject ()
	TGObject destructor.

TGClient *	GetClient () const

Handle_t	GetId () const

ULong_t	Hash () const
	Return hash value for this object.

Bool_t	IsEqual (const TObject *obj) const
	Equal comparison (TGObjects are equal if they have the same window identifier).

virtual void	SaveAs (const char filename="", Option_t option="") const
	Write this TGObject to a file using TImage, if filename's extension signals a valid TImage::EImageFileType, as defined by TImage::GetImageFileTypeFromFilename().

Public Member Functions inherited from TObject
	TObject ()
	TObject constructor.

	TObject (const TObject &object)
	TObject copy ctor.

virtual	~TObject ()
	TObject destructor.

void	AbstractMethod (const char *method) const
	Use this method to implement an "abstract" method that you don't want to leave purely abstract.

virtual void	AppendPad (Option_t *option="")
	Append graphics object to current pad.

virtual void	Browse (TBrowser *b)
	Browse object. May be overridden for another default action.

ULong_t	CheckedHash ()
	Check and record whether this class has a consistent Hash/RecursiveRemove setup (*) and then return the regular Hash value for this object.

virtual const char *	ClassName () const
	Returns name of class to which the object belongs.

virtual void	Clear (Option_t *="")

virtual TObject *	Clone (const char *newname="") const
	Make a clone of an object using the Streamer facility.

virtual Int_t	Compare (const TObject *obj) const
	Compare abstract method.

virtual void	Copy (TObject &object) const
	Copy this to obj.

virtual Int_t	DistancetoPrimitive (Int_t px, Int_t py)
	Computes distance from point (px,py) to the object.

virtual void	Draw (Option_t *option="")
	Default Draw method for all objects.

virtual void	Error (const char method, const char msgfmt,...) const
	Issue error message.

virtual void	Execute (const char method, const char params, Int_t *error=0)
	Execute method on this object with the given parameter string, e.g.

virtual void	Execute (TMethod method, TObjArray params, Int_t *error=0)
	Execute method on this object with parameters stored in the TObjArray.

virtual void	ExecuteEvent (Int_t event, Int_t px, Int_t py)
	Execute action corresponding to an event at (px,py).

virtual void	Fatal (const char method, const char msgfmt,...) const
	Issue fatal error message.

virtual TObject *	FindObject (const char *name) const
	Must be redefined in derived classes.

virtual TObject *	FindObject (const TObject *obj) const
	Must be redefined in derived classes.

virtual Option_t *	GetDrawOption () const
	Get option used by the graphics system to draw this object.

virtual const char *	GetIconName () const
	Returns mime type name of object.

virtual char *	GetObjectInfo (Int_t px, Int_t py) const
	Returns string containing info about the object at position (px,py).

virtual Option_t *	GetOption () const

virtual const char *	GetTitle () const
	Returns title of object.

virtual UInt_t	GetUniqueID () const
	Return the unique object id.

Bool_t	HasInconsistentHash () const
	Return true is the type of this object is known to have an inconsistent setup for Hash and RecursiveRemove (i.e.

virtual void	Info (const char method, const char msgfmt,...) const
	Issue info message.

virtual Bool_t	InheritsFrom (const char *classname) const
	Returns kTRUE if object inherits from class "classname".

virtual Bool_t	InheritsFrom (const TClass *cl) const
	Returns kTRUE if object inherits from TClass cl.

void	InvertBit (UInt_t f)

Bool_t	IsDestructed () const
	IsDestructed.

virtual Bool_t	IsFolder () const
	Returns kTRUE in case object contains browsable objects (like containers or lists of other objects).

R__ALWAYS_INLINE Bool_t	IsOnHeap () const

virtual Bool_t	IsSortable () const

R__ALWAYS_INLINE Bool_t	IsZombie () const

virtual void	ls (Option_t *option="") const
	The ls function lists the contents of a class on stdout.

void	MayNotUse (const char *method) const
	Use this method to signal that a method (defined in a base class) may not be called in a derived class (in principle against good design since a child class should not provide less functionality than its parent, however, sometimes it is necessary).

virtual Bool_t	Notify ()
	This method must be overridden to handle object notification.

void	Obsolete (const char method, const char asOfVers, const char *removedFromVers) const
	Use this method to declare a method obsolete.

void	operator delete (void *ptr)
	Operator delete.

void	operator delete[] (void *ptr)
	Operator delete [].

void *	operator new (size_t sz)

void *	operator new (size_t sz, void *vp)

void *	operator new[] (size_t sz)

void *	operator new[] (size_t sz, void *vp)

TObject &	operator= (const TObject &rhs)
	TObject assignment operator.

virtual void	Paint (Option_t *option="")
	This method must be overridden if a class wants to paint itself.

virtual void	Pop ()
	Pop on object drawn in a pad to the top of the display list.

virtual Int_t	Read (const char *name)
	Read contents of object with specified name from the current directory.

virtual void	RecursiveRemove (TObject *obj)
	Recursively remove this object from a list.

void	ResetBit (UInt_t f)

void	SetBit (UInt_t f)

void	SetBit (UInt_t f, Bool_t set)
	Set or unset the user status bits as specified in f.

virtual void	SetUniqueID (UInt_t uid)
	Set the unique object id.

virtual void	SysError (const char method, const char msgfmt,...) const
	Issue system error message.

R__ALWAYS_INLINE Bool_t	TestBit (UInt_t f) const

Int_t	TestBits (UInt_t f) const

virtual void	UseCurrentStyle ()
	Set current style settings in this object This function is called when either TCanvas::UseCurrentStyle or TROOT::ForceStyle have been invoked.

virtual void	Warning (const char method, const char msgfmt,...) const
	Issue warning message.

virtual Int_t	Write (const char *name=0, Int_t option=0, Int_t bufsize=0)
	Write this object to the current directory.

virtual Int_t	Write (const char *name=0, Int_t option=0, Int_t bufsize=0) const
	Write this object to the current directory.

Public Member Functions inherited from TQObject
	TQObject ()
	TQObject Constructor.

virtual	~TQObject ()
	TQObject Destructor.

Bool_t	AreSignalsBlocked () const

Bool_t	BlockSignals (Bool_t b)

virtual void	ChangedBy (const char *method)

void	CollectClassSignalLists (TList &list, TClass *cls)
	Collect class signal lists from class cls and all its base-classes.

Bool_t	Connect (const char signal, const char receiver_class, void receiver, const char slot)
	Non-static method is used to connect from the signal of this object to the receiver slot.

virtual void	Connected (const char *)

virtual void	Destroyed ()

Bool_t	Disconnect (const char signal=0, void receiver=0, const char *slot=0)
	Disconnects signal of this object from slot of receiver.

virtual void	Disconnected (const char *)

void	Emit (const char *signal)
	Activate signal without args.

template<typename T >
void	Emit (const char *signal, const T &arg)
	Activate signal with single parameter.

template<typename... T>
void	EmitVA (const char *signal_name, Int_t, const T &... params)
	Emit a signal with a varying number of arguments.

TList *	GetListOfClassSignals () const
	Returns pointer to list of signals of this class.

TList *	GetListOfConnections () const

TList *	GetListOfSignals () const

virtual Bool_t	HasConnection (const char *signal_name) const
	Return true if there is any object connected to this signal.

virtual void	HighPriority (const char signal_name, const char slot_name=0)

virtual void	LowPriority (const char signal_name, const char slot_name=0)

virtual void	Message (const char *msg)

virtual Int_t	NumberOfConnections () const
	Return number of connections for this object.

virtual Int_t	NumberOfSignals () const
	Return number of signals for this object.

Public Member Functions inherited from TGWidget
	TGWidget ()

	TGWidget (Int_t id)

virtual	~TGWidget ()

virtual void	Associate (const TGWindow *w)

const char *	GetCommand () const

Bool_t	HasFocus () const

Bool_t	IsEnabled () const

virtual void	SetCommand (const char *command)

Bool_t	WantFocus () const

Int_t	WidgetId () const

Protected Member Functions
virtual void	InitListBox ()
	Initiate the internal classes of a list box.

void	SetContainer (TGFrame *f)

Protected Member Functions inherited from TGFrame
virtual void	DoRedraw ()
	Redraw the frame.

virtual void	Draw3dRectangle (UInt_t type, Int_t x, Int_t y, UInt_t w, UInt_t h)
	Draw 3D rectangle on the frame border.

TString	GetOptionString () const
	Returns a frame option string - used in SavePrimitive().

const TGResourcePool *	GetResourcePool () const

virtual void *	GetSender ()

virtual void	StartGuiBuilding (Bool_t on=kTRUE)
	Go into GUI building mode.

Protected Member Functions inherited from TGWindow
	TGWindow (const TGWindow &tgw)

	TGWindow (Window_t id)

TGWindow &	operator= (const TGWindow &tgw)

Protected Member Functions inherited from TGObject
TGObject &	operator= (const TGObject &tgo)

Protected Member Functions inherited from TObject
virtual void	DoError (int level, const char location, const char fmt, va_list va) const
	Interface to ErrorHandler (protected).

void	MakeZombie ()

Protected Member Functions inherited from TQObject
virtual const char *	GetSenderClassName () const

Protected Member Functions inherited from TGWidget
	TGWidget (const TGWidget &tgw)

Int_t	ClearFlags (Int_t flags)

TGWidget &	operator= (const TGWidget &tgw)

Int_t	SetFlags (Int_t flags)

Protected Attributes
Bool_t	fIntegralHeight
	true if height should be multiple of fItemVsize

UInt_t	fItemVsize
	maximum height of single entry

TGLBContainer *	fLbc
	listbox container

TGViewPort *	fVport
	listbox viewport (see TGCanvas.h)

TGVScrollBar *	fVScrollbar
	vertical scrollbar

Protected Attributes inherited from TGCompositeFrame
Bool_t	fLayoutBroken
	no layout manager is used

TGLayoutManager *	fLayoutManager
	layout manager

TList *	fList
	container of frame elements

Bool_t	fMapSubwindows
	kTRUE - map subwindows

Int_t	fMustCleanup
	cleanup mode (see EFrameCleanup)

Protected Attributes inherited from TGFrame
Pixel_t	fBackground
	frame background color

Int_t	fBorderWidth
	frame border width

Int_t	fDNDState
	EDNDFlags.

UInt_t	fEventMask
	currently active event mask

TGFrameElement *	fFE
	pointer to frame element

UInt_t	fHeight
	frame height

UInt_t	fMaxHeight
	maximal frame height

UInt_t	fMaxWidth
	maximal frame width

UInt_t	fMinHeight
	minimal frame height

UInt_t	fMinWidth
	minimal frame width

UInt_t	fOptions
	frame options

UInt_t	fWidth
	frame width

Int_t	fX
	frame x position

Int_t	fY
	frame y position

Protected Attributes inherited from TGWindow
UInt_t	fEditDisabled
	flags used for "guibuilding"

TString	fName
	name of the window used in SavePrimitive()

Bool_t	fNeedRedraw
	kTRUE if window needs to be redrawn

const TGWindow *	fParent
	Parent window.

Protected Attributes inherited from TGObject
TGClient *	fClient
	Connection to display server.

Handle_t	fId
	X11/Win32 Window identifier.

Protected Attributes inherited from TQObject
TList *	fListOfConnections
	list of signals from this object

TList *	fListOfSignals

Bool_t	fSignalsBlocked
	list of connections to this object

Protected Attributes inherited from TGWidget
TString	fCommand
	command to be executed

const TGWindow *	fMsgWindow
	window which handles widget events

Int_t	fWidgetFlags
	widget status flags (OR of EWidgetStatus)

Int_t	fWidgetId
	the widget id (used for event processing)

Private Member Functions
	TGListBox (const TGListBox &)=delete

TGListBox	operator= (const TGListBox &)=delete

Additional Inherited Members
Public Types inherited from TGWindow
enum	EEditMode { kEditEnable = 0 , kEditDisable = BIT(0) , kEditDisableEvents = BIT(1) , kEditDisableGrab = BIT(2) , kEditDisableLayout = BIT(3) , kEditDisableResize = BIT(4) , kEditDisableHeight = BIT(5) , kEditDisableWidth = BIT(6) , kEditDisableBtnEnable = BIT(7) , kEditDisableKeyEnable = BIT(8) }

enum	EStatusBits { kIsHtmlView = BIT(14) }

Public Types inherited from TObject
enum	{ kIsOnHeap = 0x01000000 , kNotDeleted = 0x02000000 , kZombie = 0x04000000 , kInconsistent = 0x08000000 , kBitMask = 0x00ffffff }

enum	{ kSingleKey = BIT(0) , kOverwrite = BIT(1) , kWriteDelete = BIT(2) }

enum	EDeprecatedStatusBits { kObjInCanvas = BIT(3) }

enum	EStatusBits { kCanDelete = BIT(0) , kMustCleanup = BIT(3) , kIsReferenced = BIT(4) , kHasUUID = BIT(5) , kCannotPick = BIT(6) , kNoContextMenu = BIT(8) , kInvalidObject = BIT(13) }

Static Public Member Functions inherited from TGFrame
static const TGGC &	GetBckgndGC ()
	Get background color graphics context.

static const TGGC &	GetBlackGC ()
	Get black graphics context.

static Pixel_t	GetBlackPixel ()
	Get black pixel value.

static Pixel_t	GetDefaultFrameBackground ()
	Get default frame background.

static Pixel_t	GetDefaultSelectedBackground ()
	Get default selected frame background.

static const TGGC &	GetHilightGC ()
	Get highlight color graphics context.

static const TGGC &	GetShadowGC ()
	Get shadow color graphics context.

static const TGGC &	GetWhiteGC ()
	Get white graphics context.

static Pixel_t	GetWhitePixel ()
	Get white pixel value.

Static Public Member Functions inherited from TGWindow
static Int_t	GetCounter ()
	Return global window counter (total number of created windows).

Static Public Member Functions inherited from TObject
static Longptr_t	GetDtorOnly ()
	Return destructor only flag.

static Bool_t	GetObjectStat ()
	Get status of object stat flag.

static void	SetDtorOnly (void *obj)
	Set destructor only flag.

static void	SetObjectStat (Bool_t stat)
	Turn on/off tracking of objects in the TObjectTable.

Static Public Member Functions inherited from TQObject
static Bool_t	AreAllSignalsBlocked ()
	Returns true if all signals are blocked.

static Bool_t	BlockAllSignals (Bool_t b)
	Block or unblock all signals. Returns the previous block status.

static Bool_t	Connect (const char sender_class, const char signal, const char receiver_class, void receiver, const char *slot)
	This method allows to make a connection from any object of the same class to a single slot.

static Bool_t	Connect (TQObject sender, const char signal, const char receiver_class, void receiver, const char *slot)
	Create connection between sender and receiver.

static Bool_t	Disconnect (const char class_name, const char signal, void receiver=0, const char slot=0)
	Disconnects "class signal".

static Bool_t	Disconnect (TQObject sender, const char signal=0, void receiver=0, const char slot=0)
	Disconnects signal in object sender from slot_method in object receiver.

Protected Types inherited from TGFrame
enum	{ kDeleteWindowCalled = BIT(15) }

Protected Types inherited from TObject
enum	{ kOnlyPrepStep = BIT(3) }

Static Protected Member Functions inherited from TGFrame
static Time_t	GetLastClick ()
	Get time of last mouse click.

Static Protected Member Functions inherited from TQObject
static Int_t	CheckConnectArgs (TQObject sender, TClass sender_class, const char signal, TClass receiver_class, const char *slot)
	Checking of consistency of sender/receiver methods/arguments.

static TString	CompressName (const char *method_name)
	Removes "const" words and blanks from full (with prototype) method name and resolve any typedefs in the method signature.

static Bool_t	ConnectToClass (const char sender_class, const char signal, TClass receiver_class, void receiver, const char *slot)
	This method allows to make connection from any object of the same class to the receiver object.

static Bool_t	ConnectToClass (TQObject sender, const char signal, TClass receiver_class, void receiver, const char *slot)
	Create connection between sender and receiver.

Static Protected Attributes inherited from TGCompositeFrame
static TGLayoutHints *	fgDefaultHints = nullptr

Static Protected Attributes inherited from TGFrame
static const TGGC *	fgBckgndGC = nullptr

static const TGGC *	fgBlackGC = nullptr

static Pixel_t	fgBlackPixel = 0

static Window_t	fgDbw = 0

static Int_t	fgDbx = 0

static Int_t	fgDby = 0

static Pixel_t	fgDefaultFrameBackground = 0

static Pixel_t	fgDefaultSelectedBackground = 0

static const TGGC *	fgHilightGC = nullptr

static Bool_t	fgInit = kFALSE

static UInt_t	fgLastButton = 0

static Time_t	fgLastClick = 0

static const TGGC *	fgShadowGC = nullptr

static UInt_t	fgUserColor = 0

static const TGGC *	fgWhiteGC = nullptr

static Pixel_t	fgWhitePixel = 0

Static Protected Attributes inherited from TGWindow
static Int_t	fgCounter = 0
	counter of created windows in SavePrimitive

Static Protected Attributes inherited from TQObject
static Bool_t	fgAllSignalsBlocked = kFALSE
	flag used for suppression of signals

#include <TGListBox.h>

Inheritance diagram for TGListBox:

[legend]

Constructor & Destructor Documentation

◆ TGListBox() [1/2]

TGListBox::TGListBox ( const TGListBox & )

privatedelete

◆ TGListBox() [2/2]

TGListBox::TGListBox	(	const TGWindow *	p = `nullptr`,
		Int_t	id = `-1`,
		UInt_t	options = `kSunkenFrame \| kDoubleBorder`,
		Pixel_t	back = `GetWhitePixel()`
	)

Create a listbox.

Definition at line 1115 of file TGListBox.cxx.

◆ ~TGListBox()

TGListBox::~TGListBox ( )

virtual

Delete a listbox widget.

Definition at line 1131 of file TGListBox.cxx.

Member Function Documentation

◆ AddEntry() [1/3]

void TGListBox::AddEntry	(	const char *	s,
		Int_t	id
	)

virtual

Add entry with specified string and id to listbox.

The id will be used in the event processing routine when the item is selected.

Definition at line 1218 of file TGListBox.cxx.

◆ AddEntry() [2/3]

void TGListBox::AddEntry	(	TGLBEntry *	lbe,
		TGLayoutHints *	lhints
	)

virtual

Add specified TGLBEntry and TGLayoutHints to listbox.

The entry and layout will be adopted and later deleted by the listbox.

Definition at line 1227 of file TGListBox.cxx.

◆ AddEntry() [3/3]

void TGListBox::AddEntry	(	TGString *	s,
		Int_t	id
	)

virtual

Add entry with specified string and id to listbox.

The id will be used in the event processing routine when the item is selected. The string will be adopted by the listbox.

Definition at line 1203 of file TGListBox.cxx.

◆ AddEntrySort() [1/3]

void TGListBox::AddEntrySort	(	const char *	s,
		Int_t	id
	)

virtual

Add entry with specified string and id to listbox sorted by increasing id.

This sorting works properly only if EntrySort functions are used to add entries without mixing them with other add or insert functions. The id will be used in the event processing routine when the item is selected.

Definition at line 1257 of file TGListBox.cxx.

◆ AddEntrySort() [2/3]

void TGListBox::AddEntrySort	(	TGLBEntry *	lbe,
		TGLayoutHints *	lhints
	)

virtual

Add specified TGLBEntry and TGLayoutHints to listbox sorted by increasing id.

This sorting works properly only if EntrySort functions are used to add entries without mixing them with other add or insert functions. The entry and layout will be adopted and later deleted by the listbox.

Definition at line 1268 of file TGListBox.cxx.

◆ AddEntrySort() [3/3]

void TGListBox::AddEntrySort	(	TGString *	s,
		Int_t	id
	)

virtual

Add entry with specified string and id to listbox sorted by increasing id.

This sorting works properly only if EntrySort functions are used to add entries without mixing them with other add or insert functions. The id will be used in the event processing routine when the item is selected. The string will be adopted by the listbox.

Definition at line 1240 of file TGListBox.cxx.

◆ ChangeBackground()

void TGListBox::ChangeBackground ( Pixel_t back )

virtual

Change background to all entries.

Reimplemented from TGFrame.

Definition at line 1533 of file TGListBox.cxx.

◆ DoubleClicked() [1/3]

virtual void TGListBox::DoubleClicked ( const char * txt )

inlinevirtual

Definition at line 299 of file TGListBox.h.

◆ DoubleClicked() [2/3]

virtual void TGListBox::DoubleClicked ( Int_t id )

inlinevirtual

Definition at line 298 of file TGListBox.h.

◆ DoubleClicked() [3/3]

void TGListBox::DoubleClicked	(	Int_t	widgetId,
		Int_t	id
	)

virtual

Emit DoubleClicked signal with list box id and entry id.

Definition at line 1622 of file TGListBox.cxx.

◆ DrawBorder()

void TGListBox::DrawBorder ( )

virtual

Draw borders of the list box widget.

Reimplemented from TGFrame.

Definition at line 1176 of file TGListBox.cxx.

◆ FindEntry()

TGLBEntry * TGListBox::FindEntry ( const char * s ) const

virtual

Find entry by name.

Definition at line 1635 of file TGListBox.cxx.

◆ GetContainer()

virtual TGFrame * TGListBox::GetContainer ( ) const

inlinevirtual

Definition at line 267 of file TGListBox.h.

◆ GetDefaultSize()

TGDimension TGListBox::GetDefaultSize ( ) const

virtual

Return default size of listbox widget.

Reimplemented from TGCompositeFrame.

Definition at line 1436 of file TGListBox.cxx.

◆ GetEntry()

TGLBEntry * TGListBox::GetEntry ( Int_t id ) const

virtual

Returns list box entry with specified id.

Definition at line 1372 of file TGListBox.cxx.

◆ GetItemVsize()

UInt_t TGListBox::GetItemVsize ( ) const

inline

Definition at line 290 of file TGListBox.h.

◆ GetMultipleSelections()

virtual Bool_t TGListBox::GetMultipleSelections ( ) const

inlinevirtual

Definition at line 261 of file TGListBox.h.

◆ GetNumberOfEntries()

virtual Int_t TGListBox::GetNumberOfEntries ( ) const

inlinevirtual

Definition at line 263 of file TGListBox.h.

◆ GetScrollBar()

virtual TGScrollBar * TGListBox::GetScrollBar ( ) const

inlinevirtual

Definition at line 269 of file TGListBox.h.

◆ GetSelected()

Int_t TGListBox::GetSelected ( ) const

virtual

Return id of selected listbox item.

Definition at line 1515 of file TGListBox.cxx.

◆ GetSelectedEntries()

void TGListBox::GetSelectedEntries ( TList * selected )

virtual

Adds all selected entries (TGLBEntry) of the list box into the list selected.

Definition at line 1525 of file TGListBox.cxx.

◆ GetSelectedEntry()

virtual TGLBEntry * TGListBox::GetSelectedEntry ( ) const

inlinevirtual

Definition at line 288 of file TGListBox.h.

◆ GetSelection()

virtual Bool_t TGListBox::GetSelection ( Int_t id )

inlinevirtual

Definition at line 287 of file TGListBox.h.

◆ GetViewPort()

virtual TGViewPort * TGListBox::GetViewPort ( ) const

inlinevirtual

Definition at line 268 of file TGListBox.h.

◆ GetVScrollbar()

virtual TGVScrollBar * TGListBox::GetVScrollbar ( ) const

inlinevirtual

Definition at line 270 of file TGListBox.h.

◆ InitListBox()

void TGListBox::InitListBox ( )

protectedvirtual

Initiate the internal classes of a list box.

Definition at line 1143 of file TGListBox.cxx.

◆ InsertEntry() [1/3]

void TGListBox::InsertEntry	(	const char *	s,
		Int_t	id,
		Int_t	afterID
	)

virtual

Insert entry with specified string and id behind the entry with afterID.

Definition at line 1292 of file TGListBox.cxx.

◆ InsertEntry() [2/3]

void TGListBox::InsertEntry	(	TGLBEntry *	lbe,
		TGLayoutHints *	lhints,
		Int_t	afterID
	)

virtual

Insert the specified TGLBEntry and layout hints behind afterID.

The entry and layout will be adopted and later deleted by the listbox.

Definition at line 1363 of file TGListBox.cxx.

◆ InsertEntry() [3/3]

void TGListBox::InsertEntry	(	TGString *	s,
		Int_t	id,
		Int_t	afterID
	)

virtual

Insert entry with specified string and id behind the entry with afterID.

The string will be adopted and later deleted by the listbox.

Definition at line 1278 of file TGListBox.cxx.

◆ IntegralHeight()

virtual void TGListBox::IntegralHeight ( Bool_t mode )

inlinevirtual

Definition at line 279 of file TGListBox.h.

◆ Layout()

void TGListBox::Layout ( )

virtual

Layout the listbox components.

Reimplemented from TGCompositeFrame.

Definition at line 1452 of file TGListBox.cxx.

◆ MoveResize()

void TGListBox::MoveResize	(	Int_t	x,
		Int_t	y,
		UInt_t	w,
		UInt_t	h
	)

virtual

Move and resize the listbox widget.

Reimplemented from TGFrame.

Definition at line 1424 of file TGListBox.cxx.

◆ NewEntry()

void TGListBox::NewEntry ( const char * s = "Entry" )

virtual

method used to add entry via context menu

Definition at line 1300 of file TGListBox.cxx.

◆ operator=()

TGListBox TGListBox::operator= ( const TGListBox & )

privatedelete

◆ ProcessMessage()

Bool_t TGListBox::ProcessMessage	(	Longptr_t	msg,
		Longptr_t	parm1,
		Longptr_t	parm2
	)

virtual

Process messages generated by the listbox container and forward messages to the listbox message handling window.

Reimplemented from TGCompositeFrame.

Definition at line 1551 of file TGListBox.cxx.

◆ RemoveAll()

void TGListBox::RemoveAll ( )

virtual

Remove all entries.

Reimplemented from TGCompositeFrame.

Definition at line 1344 of file TGListBox.cxx.

◆ RemoveEntries()

void TGListBox::RemoveEntries	(	Int_t	from_ID,
		Int_t	to_ID
	)

virtual

Remove a range of entries defined by from_ID and to_ID.

Definition at line 1353 of file TGListBox.cxx.

◆ RemoveEntry()

void TGListBox::RemoveEntry ( Int_t id = -1 )

virtual

remove entry with id.

If id = -1 - the selected entry/entries is/are removed.

Definition at line 1318 of file TGListBox.cxx.

◆ Resize() [1/2]

virtual void TGListBox::Resize ( TGDimension size )

inlinevirtual

Resize the frame.

Reimplemented from TGFrame.

Definition at line 274 of file TGListBox.h.

◆ Resize() [2/2]

void TGListBox::Resize	(	UInt_t	w,
		UInt_t	h
	)

virtual

Resize the listbox widget.

If fIntegralHeight is true make the height an integral number of the maximum height of a single entry.

Reimplemented from TGFrame.

Definition at line 1411 of file TGListBox.cxx.

◆ SavePrimitive()

void TGListBox::SavePrimitive	(	std::ostream &	out,
		Option_t *	option = `""`
	)

virtual

Save a list box widget as a C++ statement(s) on output stream out.

Reimplemented from TGCompositeFrame.

Definition at line 1650 of file TGListBox.cxx.

◆ Select()

virtual TGLBEntry * TGListBox::Select	(	Int_t	id,
		Bool_t	sel = `kTRUE`
	)

inlinevirtual

Definition at line 284 of file TGListBox.h.

◆ Selected() [1/3]

virtual void TGListBox::Selected ( const char * txt )

inlinevirtual

Definition at line 296 of file TGListBox.h.

◆ Selected() [2/3]

virtual void TGListBox::Selected ( Int_t id )

inlinevirtual

Definition at line 295 of file TGListBox.h.

◆ Selected() [3/3]

void TGListBox::Selected	(	Int_t	widgetId,
		Int_t	id
	)

virtual

Emit Selected signal with list box id and entry id.

Definition at line 1609 of file TGListBox.cxx.

◆ SelectionChanged()

virtual void TGListBox::SelectionChanged ( )

inlinevirtual

Definition at line 300 of file TGListBox.h.

◆ SetContainer()

void TGListBox::SetContainer ( TGFrame * f )

inlineprotected

Definition at line 234 of file TGListBox.h.

◆ SetLayoutManager()

virtual void TGListBox::SetLayoutManager ( TGLayoutManager * l )

inlinevirtual

Set the layout manager for the composite frame.

The layout manager is adopted by the frame and will be deleted by the frame.

Reimplemented from TGCompositeFrame.

Definition at line 277 of file TGListBox.h.

◆ SetMultipleSelections()

virtual void TGListBox::SetMultipleSelections ( Bool_t multi = kTRUE )

inlinevirtual

Definition at line 259 of file TGListBox.h.

◆ SetTopEntry()

void TGListBox::SetTopEntry ( Int_t id = -1 )

virtual

Scroll the entry with id to the top of the listbox.

Definition at line 1387 of file TGListBox.cxx.

◆ SortByName()

void TGListBox::SortByName ( Bool_t ascend = kTRUE )

virtual

Sort entries by name.

Definition at line 1505 of file TGListBox.cxx.

Member Data Documentation

◆ fIntegralHeight

Bool_t TGListBox::fIntegralHeight

protected

true if height should be multiple of fItemVsize

Definition at line 229 of file TGListBox.h.

◆ fItemVsize

UInt_t TGListBox::fItemVsize

protected

maximum height of single entry

Definition at line 228 of file TGListBox.h.

◆ fLbc

TGLBContainer* TGListBox::fLbc

protected

listbox container

Definition at line 230 of file TGListBox.h.

◆ fVport

TGViewPort* TGListBox::fVport

protected

listbox viewport (see TGCanvas.h)

Definition at line 231 of file TGListBox.h.

◆ fVScrollbar

TGVScrollBar* TGListBox::fVScrollbar

protected

vertical scrollbar

Definition at line 232 of file TGListBox.h.

Libraries for TGListBox:

[legend]

The documentation for this class was generated from the following files:

gui/gui/inc/TGListBox.h
gui/gui/src/TGListBox.cxx

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

◆ TGListBox() [1/2]

◆ TGListBox() [2/2]

◆ ~TGListBox()

Member Function Documentation

◆ AddEntry() [1/3]

◆ AddEntry() [2/3]

◆ AddEntry() [3/3]

◆ AddEntrySort() [1/3]

◆ AddEntrySort() [2/3]

◆ AddEntrySort() [3/3]

◆ ChangeBackground()

◆ DoubleClicked() [1/3]

◆ DoubleClicked() [2/3]

◆ DoubleClicked() [3/3]

◆ DrawBorder()

◆ FindEntry()

◆ GetContainer()

◆ GetDefaultSize()

◆ GetEntry()

◆ GetItemVsize()

◆ GetMultipleSelections()

◆ GetNumberOfEntries()

◆ GetScrollBar()

◆ GetSelected()

◆ GetSelectedEntries()

◆ GetSelectedEntry()

◆ GetSelection()

◆ GetViewPort()

◆ GetVScrollbar()

◆ InitListBox()

◆ InsertEntry() [1/3]

◆ InsertEntry() [2/3]

◆ InsertEntry() [3/3]

◆ IntegralHeight()

◆ Layout()

◆ MoveResize()

◆ NewEntry()

◆ operator=()

◆ ProcessMessage()

◆ RemoveAll()

◆ RemoveEntries()

◆ RemoveEntry()

◆ Resize() [1/2]

◆ Resize() [2/2]

◆ SavePrimitive()

◆ Select()

◆ Selected() [1/3]

◆ Selected() [2/3]

◆ Selected() [3/3]

◆ SelectionChanged()

◆ SetContainer()

◆ SetLayoutManager()

◆ SetMultipleSelections()

◆ SetTopEntry()

◆ SortByName()

Member Data Documentation

◆ fIntegralHeight

◆ fItemVsize

◆ fLbc

◆ fVport

◆ fVScrollbar