A Control Bar is a fully user configurable tool which provides fast access to frequently used operations.

The user can choose between buttons and drawn buttons (let's say icons) and assign to them their own actions (let's say ROOT or C++ commands).

The macro below shows an example of control bar. To execute an item, click with the left mouse button. To see the HELP of a button, click on the right mouse button.

You have access to the last clicked button via the method GetClicked(). For example, bar->GetClicked()->GetName() will return the name of the last clicked button.

{
   // run macro from tutorials directory of ROOT!
   TControlBar bar("vertical");
   bar.AddButton("Help to run demos",".x demoshelp.C",
                 "Explains how to run the demos");
   bar.AddButton("framework",        ".x graphics/framework.C",
                 "An Example of Object Oriented User Interface");
   bar.AddButton("hsimple",          ".x hsimple.C",
                 "An Example Creating Histograms/Ntuples on File");
   bar.AddButton("hsum",             ".x hist/hsum.C",
                 "Filling histograms and some graphics options");
   bar.AddButton("canvas",           ".x graphics/canvas.C",
                 "Canvas and Pad Management");
   bar.AddButton("formula1",         ".x graphics/formula1.C",
                 "Simple Formula and Functions");
   bar.AddButton("fillrandom",       ".x hist/fillrandom.C",
                 "Histograms with Random Numbers from a Function");
   bar.AddButton("fit1",             ".x fit/fit1.C",
                 "A Simple Fitting Example");
   bar.AddButton("draw2dopt",        ".x hist/draw2dopt.C",
                 "Drawing Options for 2D Histograms");
   bar.AddButton("graph",            ".x graphs/graph.C",
                 "Examples of a simple graph");
   bar.AddButton("tornado",          ".x graphics/tornado.C",
                 "Examples of 3-D PolyMarkers");
   bar.AddButton("shapes",           ".x geom/shapes.C",
                 "The Geometry Shapes");
   bar.AddButton("file_layout",      ".x io/file.C",
                 "The ROOT file format");
   bar.AddButton("tree_layout",      ".x tree/tree.C",
                 "The Tree Data Structure");
   bar.AddButton("ntuple1",          ".x tree/ntuple1.C",
                 "Ntuples and Selections");
   bar.AddButton("run benchmarks",   ".x legacy/benchmarks.C",
                 "Runs all the ROOT benchmarks");
   bar.AddButton("rootmarks",        ".x legacy/rootmarks.C",
                 "Prints an estimated ROOTMARKS for your machine");
   bar.AddButton("edit_hsimple",     ".!vi hsimple.C &",
                 "Invokes the text editor on file hsimple.C");
   bar.AddButton("Close Bar",        "bar.Hide()",
                 "Close ControlBar");
   bar.Show();
}

Definition at line 26 of file TControlBar.h.

Public Types
enum	{ kVertical = 1 , kHorizontal = 2 }

Public Types inherited from TControlBarButton
enum	{ kButton = 1 , kDrawnButton , kSeparator }

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

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

enum	EDeprecatedStatusBits { kObjInCanvas = (1ULL << ( 3 )) }

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

Public Member Functions
	TControlBar ()
	Default constructor.

	TControlBar (const char orientation, const char title, Int_t x, Int_t y)
	Normal constructor.

	TControlBar (const char orientation, const char title="")
	Normal constructor.

virtual	~TControlBar ()
	Destructor.

void	AddButton (const char label, const char action, const char hint="", const char type="button")
	Add button.

void	AddButton (TControlBarButton &button)
	Add button.

void	AddButton (TControlBarButton *button)
	Add button.

void	AddControlBar (TControlBar &controlBar)
	Add control bar.

void	AddControlBar (TControlBar *controlBar)
	Add control bar.

void	AddSeparator ()
	Add separator.

TControlBarButton *	GetClicked () const
	Returns a pointer to the last clicked control bar button; null if no button was clicked yet.

TControlBarImp *	GetControlBarImp () const

TList *	GetListOfButtons () const

Int_t	GetNumberOfColumns () const

Int_t	GetNumberOfRows () const

Int_t	GetOrientation () const

void	Hide ()
	Hide control bar.

TClass *	IsA () const override

void	SetButtonState (const char *label, Int_t state=0)
	Sets a state for control bar button 'label'; possible states are 0-kButtonUp, 1-kButtonDown, 2-kButtonEngaged, 3-kButtonDisabled,.

void	SetButtonWidth (UInt_t width)
	Sets the width in pixels for control bar button.

void	SetFont (const char *fontName)
	Sets new font for control bar buttons, e.g.:

void	SetNumberOfColumns (Int_t n)

void	SetNumberOfRows (Int_t n)

void	SetOrientation (const char *o)
	Set control bar orientation.

void	SetOrientation (Int_t o)
	Set control bar orientation.

void	SetTextColor (const char *colorName)
	Sets text color for control bar buttons, e.g.:

void	Show ()
	Show control bar.

void	Streamer (TBuffer &) override
	Stream an object of class TObject.

void	StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)

Public Member Functions inherited from TControlBarButton
	TControlBarButton ()
	Default control bar button ctor.

	TControlBarButton (const char label, const char action="", const char hint="", const char type="button")
	Create control bar button.

virtual	~TControlBarButton ()

virtual void	Action ()
	Execute control bar button command.

virtual const char *	GetAction () const

virtual Int_t	GetType () const

TClass *	IsA () const override

virtual void	SetAction (const char *action)
	Set action to be executed by this button.

virtual void	SetType (const char *type)
	Set button type.

virtual void	SetType (Int_t type)
	Set button type.

void	Streamer (TBuffer &) override
	Stream an object of class TObject.

void	StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)

Public Member Functions inherited from TNamed
	TNamed ()

	TNamed (const char name, const char title)

	TNamed (const TNamed &named)
	TNamed copy ctor.

	TNamed (const TString &name, const TString &title)

virtual	~TNamed ()
	TNamed destructor.

void	Clear (Option_t *option="") override
	Set name and title to empty strings ("").

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

Int_t	Compare (const TObject *obj) const override
	Compare two TNamed objects.

void	Copy (TObject &named) const override
	Copy this to obj.

virtual void	FillBuffer (char *&buffer)
	Encode TNamed into output buffer.

const char *	GetName () const override
	Returns name of object.

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

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

TClass *	IsA () const override

Bool_t	IsSortable () const override

void	ls (Option_t *option="") const override
	List TNamed name and title.

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

void	Print (Option_t *option="") const override
	Print TNamed name and title.

virtual void	SetName (const char *name)
	Set the name of the TNamed.

virtual void	SetNameTitle (const char name, const char title)
	Set all the TNamed parameters (name and title).

virtual void	SetTitle (const char *title="")
	Set the title of the TNamed.

virtual Int_t	Sizeof () const
	Return size of the TNamed part of the TObject.

void	Streamer (TBuffer &) override
	Stream an object of class TObject.

void	StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)

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	Delete (Option_t *option="")
	Delete this object.

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	DrawClass () const
	Draw class inheritance tree of the class to which this object belongs.

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

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

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=nullptr)
	Execute method on this object with the given parameter string, e.g.

virtual void	Execute (TMethod method, TObjArray params, Int_t *error=nullptr)
	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 UInt_t	GetUniqueID () const
	Return the unique object id.

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

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.

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

void	InvertBit (UInt_t f)

Bool_t	IsDestructed () const
	IsDestructed.

virtual Bool_t	IsEqual (const TObject *obj) const
	Default equal comparison (objects are equal if they have the same address in memory).

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

R__ALWAYS_INLINE Bool_t	IsZombie () const

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)

virtual void	SaveAs (const char filename="", Option_t option="") const
	Save this object in the file specified by filename.

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

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	SetDrawOption (Option_t *option="")
	Set drawing option for object.

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

void	StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)

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=nullptr, Int_t option=0, Int_t bufsize=0)
	Write this object to the current directory.

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

Static Public Member Functions
static TClass *	Class ()

static const char *	Class_Name ()

static constexpr Version_t	Class_Version ()

static const char *	DeclFileName ()

Static Public Member Functions inherited from TControlBarButton
static TClass *	Class ()

static const char *	Class_Name ()

static constexpr Version_t	Class_Version ()

static const char *	DeclFileName ()

Static Public Member Functions inherited from TNamed
static TClass *	Class ()

static const char *	Class_Name ()

static constexpr Version_t	Class_Version ()

static const char *	DeclFileName ()

Static Public Member Functions inherited from TObject
static TClass *	Class ()

static const char *	Class_Name ()

static constexpr Version_t	Class_Version ()

static const char *	DeclFileName ()

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.

Protected Attributes
TList *	fButtons {nullptr}
	list of buttons

TControlBarImp *	fControlBarImp {nullptr}
	system specific implementation

Int_t	fNoroc {1}
	number of rows or columns

Int_t	fOrientation {0}
	orientation

Protected Attributes inherited from TControlBarButton
TString	fAction
	action to be executed

Int_t	fType
	button type

Protected Attributes inherited from TNamed
TString	fName

TString	fTitle

Private Member Functions
void	Create () override
	Create control bar.

void	Initialize (Int_t x, Int_t y)
	Initialize control bar.

Friends
class	TControlBarImp

Additional Inherited Members
Protected Types inherited from TObject
enum	{ kOnlyPrepStep = (1ULL << ( 3 )) }

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 ()

#include <TControlBar.h>

Inheritance diagram for TControlBar:

[legend]

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Enumerator
kVertical
kHorizontal

Definition at line 42 of file TControlBar.h.

Constructor & Destructor Documentation

◆ TControlBar() [1/3]

TControlBar::TControlBar ( )

Default constructor.

Definition at line 90 of file TControlBar.cxx.

◆ TControlBar() [2/3]

TControlBar::TControlBar	(	const char *	orientation,
		const char *	title = `""`
	)

Normal constructor.

Definition at line 97 of file TControlBar.cxx.

◆ TControlBar() [3/3]

TControlBar::TControlBar	(	const char *	orientation,
		const char *	title,
		Int_t	x,
		Int_t	y
	)

Normal constructor.

Definition at line 107 of file TControlBar.cxx.

◆ ~TControlBar()

TControlBar::~TControlBar ( )

virtual

Destructor.

Definition at line 119 of file TControlBar.cxx.

Member Function Documentation

◆ AddButton() [1/3]

void TControlBar::AddButton	(	const char *	label,
		const char *	action,
		const char *	hint = `""`,
		const char *	type = `"button"`
	)

Add button.

Definition at line 150 of file TControlBar.cxx.

◆ AddButton() [2/3]

void TControlBar::AddButton ( TControlBarButton & button )

Add button.

Definition at line 133 of file TControlBar.cxx.

◆ AddButton() [3/3]

void TControlBar::AddButton ( TControlBarButton * button )

Add button.

Definition at line 141 of file TControlBar.cxx.

◆ AddControlBar() [1/2]

void TControlBar::AddControlBar ( TControlBar & controlBar )

Add control bar.

Definition at line 159 of file TControlBar.cxx.

◆ AddControlBar() [2/2]

void TControlBar::AddControlBar ( TControlBar * controlBar )

Add control bar.

Definition at line 167 of file TControlBar.cxx.

◆ AddSeparator()

void TControlBar::AddSeparator ( )

Add separator.

Definition at line 176 of file TControlBar.cxx.

◆ Class()

static TClass * TControlBar::Class ( )

static

Returns: TClass describing this class

◆ Class_Name()

static const char * TControlBar::Class_Name ( )

static

Returns: Name of this class

◆ Class_Version()

static constexpr Version_t TControlBar::Class_Version ( )

inlinestaticconstexpr

Returns: Version of this class

Definition at line 72 of file TControlBar.h.

◆ Create()

void TControlBar::Create ( )

overrideprivatevirtual

Create control bar.

Reimplemented from TControlBarButton.

Definition at line 183 of file TControlBar.cxx.

◆ DeclFileName()

static const char * TControlBar::DeclFileName ( )

inlinestatic

Returns: Name of the file containing the class declaration

Definition at line 72 of file TControlBar.h.

◆ GetClicked()

TControlBarButton * TControlBar::GetClicked ( ) const

Returns a pointer to the last clicked control bar button; null if no button was clicked yet.

Definition at line 327 of file TControlBar.cxx.

◆ GetControlBarImp()

TControlBarImp * TControlBar::GetControlBarImp ( ) const

inline

Definition at line 56 of file TControlBar.h.

◆ GetListOfButtons()

TList * TControlBar::GetListOfButtons ( ) const

inline

Definition at line 57 of file TControlBar.h.

◆ GetNumberOfColumns()

Int_t TControlBar::GetNumberOfColumns ( ) const

inline

Definition at line 58 of file TControlBar.h.

◆ GetNumberOfRows()

Int_t TControlBar::GetNumberOfRows ( ) const

inline

Definition at line 59 of file TControlBar.h.

◆ GetOrientation()

Int_t TControlBar::GetOrientation ( ) const

inline

Definition at line 60 of file TControlBar.h.

◆ Hide()

void TControlBar::Hide ( )

Hide control bar.

Definition at line 193 of file TControlBar.cxx.

◆ Initialize()

void TControlBar::Initialize	(	Int_t	x,
		Int_t	y
	)

private

Initialize control bar.

Definition at line 203 of file TControlBar.cxx.

◆ IsA()

TClass * TControlBar::IsA ( ) const

inlineoverridevirtual

Returns: TClass describing current object

Reimplemented from TObject.

Definition at line 72 of file TControlBar.h.

◆ SetButtonState()

void TControlBar::SetButtonState	(	const char *	label,
		Int_t	state = `0`
	)

Sets a state for control bar button 'label'; possible states are 0-kButtonUp, 1-kButtonDown, 2-kButtonEngaged, 3-kButtonDisabled,.

e.g.:

root > .x tutorials/demos.C

to disable the button 'first' do:

root > bar->SetButtonState("first", 3)

to enable the button 'first' do:

root > bar->SetButtonState("first", 0)

Definition at line 264 of file TControlBar.cxx.

◆ SetButtonWidth()

void TControlBar::SetButtonWidth ( UInt_t width )

Sets the width in pixels for control bar button.

Definition at line 277 of file TControlBar.cxx.

◆ SetFont()

void TControlBar::SetFont ( const char * fontName )

Sets new font for control bar buttons, e.g.:

root > .x tutorials/demos.C

root > bar->SetFont("-adobe-helvetica-bold-r-*-*-24-*-*-*-*-*-iso8859-1")

Definition at line 230 of file TControlBar.cxx.

◆ SetNumberOfColumns()

void TControlBar::SetNumberOfColumns ( Int_t n )

inline

Definition at line 65 of file TControlBar.h.

◆ SetNumberOfRows()

void TControlBar::SetNumberOfRows ( Int_t n )

inline

Definition at line 66 of file TControlBar.h.

◆ SetOrientation() [1/2]

void TControlBar::SetOrientation ( const char * o )

Set control bar orientation.

Definition at line 285 of file TControlBar.cxx.

◆ SetOrientation() [2/2]

void TControlBar::SetOrientation ( Int_t o )

Set control bar orientation.

Definition at line 303 of file TControlBar.cxx.

◆ SetTextColor()

void TControlBar::SetTextColor ( const char * colorName )

Sets text color for control bar buttons, e.g.:

root > .x tutorials/demos.C

root > bar->SetTextColor("red")

Definition at line 242 of file TControlBar.cxx.

◆ Show()

void TControlBar::Show ( )

Show control bar.

Definition at line 317 of file TControlBar.cxx.

◆ Streamer()

void TControlBar::Streamer ( TBuffer & R__b )

overridevirtual

Stream an object of class TObject.

Reimplemented from TObject.

◆ StreamerNVirtual()

void TControlBar::StreamerNVirtual ( TBuffer & ClassDef_StreamerNVirtual_b )

inline

Definition at line 72 of file TControlBar.h.

Friends And Related Symbol Documentation

◆ TControlBarImp

friend class TControlBarImp

friend

Definition at line 28 of file TControlBar.h.

Member Data Documentation

◆ fButtons

TList* TControlBar::fButtons {nullptr}

protected

list of buttons

Definition at line 38 of file TControlBar.h.

◆ fControlBarImp

TControlBarImp* TControlBar::fControlBarImp {nullptr}

protected

system specific implementation

Definition at line 36 of file TControlBar.h.

◆ fNoroc

Int_t TControlBar::fNoroc {1}

protected

number of rows or columns

Definition at line 39 of file TControlBar.h.

◆ fOrientation

Int_t TControlBar::fOrientation {0}

protected

orientation

Definition at line 37 of file TControlBar.h.

Libraries for TControlBar:

[legend]

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

graf2d/gpad/inc/TControlBar.h
graf2d/gpad/src/TControlBar.cxx

Public Types

Public Member Functions

Static Public Member Functions

Protected Attributes

Private Member Functions

Friends

Additional Inherited Members

Member Enumeration Documentation

◆ anonymous enum

Constructor & Destructor Documentation

◆ TControlBar() [1/3]

◆ TControlBar() [2/3]

◆ TControlBar() [3/3]

◆ ~TControlBar()

Member Function Documentation

◆ AddButton() [1/3]

◆ AddButton() [2/3]

◆ AddButton() [3/3]

◆ AddControlBar() [1/2]

◆ AddControlBar() [2/2]

◆ AddSeparator()

◆ Class()

◆ Class_Name()

◆ Class_Version()

◆ Create()

◆ DeclFileName()

◆ GetClicked()

◆ GetControlBarImp()

◆ GetListOfButtons()

◆ GetNumberOfColumns()

◆ GetNumberOfRows()

◆ GetOrientation()

◆ Hide()

◆ Initialize()

◆ IsA()

◆ SetButtonState()

◆ SetButtonWidth()

◆ SetFont()

◆ SetNumberOfColumns()

◆ SetNumberOfRows()

◆ SetOrientation() [1/2]

◆ SetOrientation() [2/2]

◆ SetTextColor()

◆ Show()

◆ Streamer()

◆ StreamerNVirtual()

Friends And Related Symbol Documentation

◆ TControlBarImp

Member Data Documentation

◆ fButtons

◆ fControlBarImp

◆ fNoroc

◆ fOrientation