Logo ROOT   6.21/01
Reference Guide
TControlBar Class Reference

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.

{
gROOT->Reset("a");
TControlBar bar("vertical");
bar.AddButton("Help to run demos",".x demoshelp.C",
"Explains how to run the demos");
bar.AddButton("framework", ".x 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 hsum.C",
"Filling histograms and some graphics options");
bar.AddButton("canvas", ".x canvas.C",
"Canvas and Pad Management");
bar.AddButton("formula1", ".x formula1.C",
"Simple Formula and Functions");
bar.AddButton("fillrandom", ".x fillrandom.C",
"Histograms with Random Numbers from a Function");
bar.AddButton("fit1", ".x fit1.C",
"A Simple Fitting Example");
bar.AddButton("h1draw", ".x h1draw.C",
"Drawing Options for 1D Histograms");
bar.AddButton("graph", ".x graph.C",
"Examples of a simple graph");
bar.AddButton("tornado", ".x tornado.C",
"Examples of 3-D PolyMarkers");
bar.AddButton("shapes", ".x shapes.C",
"The Geometry Shapes");
bar.AddButton("atlasna49", ".x atlasna49.C",
"Creating and Viewing Geometries");
bar.AddButton("file_layout", ".x file.C",
"The ROOT file format");
bar.AddButton("tree_layout", ".x tree.C",
"The Tree Data Structure");
bar.AddButton("ntuple1", ".x ntuple1.C",
"Ntuples and Selections");
bar.AddButton("run benchmarks", ".x benchmarks.C",
"Runs all the ROOT benchmarks");
bar.AddButton("rootmarks", ".x rootmarks.C",
"Prints an estimated ROOTMARKS for your machine");
bar.AddButton("edit_hsimple", ".!ved hsimple.C &",
"Invokes the text editor on file hsimple.C");
bar.AddButton("Close Bar", "gROOT.Reset(\"a\")",
"Close ControlBar");
bar.Show();
gROOT->SaveContext();
}
gpad_controlbar.png

Definition at line 22 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 = 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)
}
 

Public Member Functions

 TControlBar ()
 Default constructor. More...
 
 TControlBar (const char *orientation, const char *title="")
 Normal constructor. More...
 
 TControlBar (const char *orientation, const char *title, Int_t x, Int_t y)
 Normal constructor. More...
 
virtual ~TControlBar ()
 Destructor. More...
 
void AddButton (TControlBarButton *button)
 Add button. More...
 
void AddButton (TControlBarButton &button)
 Add button. More...
 
void AddButton (const char *label, const char *action, const char *hint="", const char *type="button")
 Add button. More...
 
void AddControlBar (TControlBar *controlBar)
 Add control bar. More...
 
void AddControlBar (TControlBar &controlBar)
 Add control bar. More...
 
void AddSeparator ()
 Add separator. More...
 
TControlBarButtonGetClicked () const
 Returns a pointer to the last clicked control bar button; null if no button was clicked yet. More...
 
TControlBarImpGetControlBarImp () const
 
TListGetListOfButtons () const
 
Int_t GetNumberOfColumns () const
 
Int_t GetNumberOfRows () const
 
Int_t GetOrientation () const
 
void Hide ()
 Hide control bar. More...
 
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,. More...
 
void SetButtonWidth (UInt_t width)
 Sets the width in pixels for control bar button. More...
 
void SetFont (const char *fontName)
 Sets new font for control bar buttons, e.g. More...
 
void SetNumberOfColumns (Int_t n)
 
void SetNumberOfRows (Int_t n)
 
void SetOrientation (const char *o)
 Set control bar orientation. More...
 
void SetOrientation (Int_t o)
 Set control bar orientation. More...
 
void SetTextColor (const char *colorName)
 Sets text color for control bar buttons, e.g. More...
 
void Show ()
 Show control bar. More...
 
- Public Member Functions inherited from TControlBarButton
 TControlBarButton ()
 Default control bar button ctor. More...
 
 TControlBarButton (const char *label, const char *action="", const char *hint="", const char *type="button")
 Create control bar button. More...
 
virtual ~TControlBarButton ()
 
virtual void Action ()
 Execute control bar button command. More...
 
virtual const char * GetAction () const
 
virtual Int_t GetType () const
 
virtual void SetAction (const char *action)
 Set action to be executed by this button. More...
 
virtual void SetType (const char *type)
 Set button type. More...
 
virtual void SetType (Int_t type)
 Set button type. More...
 
- Public Member Functions inherited from TNamed
 TNamed ()
 
 TNamed (const char *name, const char *title)
 
 TNamed (const TString &name, const TString &title)
 
 TNamed (const TNamed &named)
 TNamed copy ctor. More...
 
virtual ~TNamed ()
 TNamed destructor. More...
 
virtual void Clear (Option_t *option="")
 Set name and title to empty strings (""). More...
 
virtual TObjectClone (const char *newname="") const
 Make a clone of an object using the Streamer facility. More...
 
virtual Int_t Compare (const TObject *obj) const
 Compare two TNamed objects. More...
 
virtual void Copy (TObject &named) const
 Copy this to obj. More...
 
virtual void FillBuffer (char *&buffer)
 Encode TNamed into output buffer. More...
 
virtual const char * GetName () const
 Returns name of object. More...
 
virtual const char * GetTitle () const
 Returns title of object. More...
 
virtual ULong_t Hash () const
 Return hash value for this object. More...
 
virtual Bool_t IsSortable () const
 
virtual void ls (Option_t *option="") const
 List TNamed name and title. More...
 
TNamedoperator= (const TNamed &rhs)
 TNamed assignment operator. More...
 
virtual void Print (Option_t *option="") const
 Print TNamed name and title. More...
 
virtual void SetName (const char *name)
 Set the name of the TNamed. More...
 
virtual void SetNameTitle (const char *name, const char *title)
 Set all the TNamed parameters (name and title). More...
 
virtual void SetTitle (const char *title="")
 Set the title of the TNamed. More...
 
virtual Int_t Sizeof () const
 Return size of the TNamed part of the TObject. More...
 
- Public Member Functions inherited from TObject
 TObject ()
 TObject constructor. More...
 
 TObject (const TObject &object)
 TObject copy ctor. More...
 
virtual ~TObject ()
 TObject destructor. More...
 
void AbstractMethod (const char *method) const
 Use this method to implement an "abstract" method that you don't want to leave purely abstract. More...
 
virtual void AppendPad (Option_t *option="")
 Append graphics object to current pad. More...
 
virtual void Browse (TBrowser *b)
 Browse object. May be overridden for another default action. More...
 
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. More...
 
virtual const char * ClassName () const
 Returns name of class to which the object belongs. More...
 
virtual void Delete (Option_t *option="")
 Delete this object. More...
 
virtual Int_t DistancetoPrimitive (Int_t px, Int_t py)
 Computes distance from point (px,py) to the object. More...
 
virtual void Draw (Option_t *option="")
 Default Draw method for all objects. More...
 
virtual void DrawClass () const
 Draw class inheritance tree of the class to which this object belongs. More...
 
virtual TObjectDrawClone (Option_t *option="") const
 Draw a clone of this object in the current selected pad for instance with: gROOT->SetSelectedPad(gPad). More...
 
virtual void Dump () const
 Dump contents of object on stdout. More...
 
virtual void Error (const char *method, const char *msgfmt,...) const
 Issue error message. More...
 
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. More...
 
virtual void Execute (TMethod *method, TObjArray *params, Int_t *error=0)
 Execute method on this object with parameters stored in the TObjArray. More...
 
virtual void ExecuteEvent (Int_t event, Int_t px, Int_t py)
 Execute action corresponding to an event at (px,py). More...
 
virtual void Fatal (const char *method, const char *msgfmt,...) const
 Issue fatal error message. More...
 
virtual TObjectFindObject (const char *name) const
 Must be redefined in derived classes. More...
 
virtual TObjectFindObject (const TObject *obj) const
 Must be redefined in derived classes. More...
 
virtual Option_tGetDrawOption () const
 Get option used by the graphics system to draw this object. More...
 
virtual const char * GetIconName () const
 Returns mime type name of object. More...
 
virtual char * GetObjectInfo (Int_t px, Int_t py) const
 Returns string containing info about the object at position (px,py). More...
 
virtual Option_tGetOption () const
 
virtual UInt_t GetUniqueID () const
 Return the unique object id. More...
 
virtual Bool_t HandleTimer (TTimer *timer)
 Execute action in response of a timer timing out. More...
 
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. More...
 
virtual void Info (const char *method, const char *msgfmt,...) const
 Issue info message. More...
 
virtual Bool_t InheritsFrom (const char *classname) const
 Returns kTRUE if object inherits from class "classname". More...
 
virtual Bool_t InheritsFrom (const TClass *cl) const
 Returns kTRUE if object inherits from TClass cl. More...
 
virtual void Inspect () const
 Dump contents of this object in a graphics canvas. More...
 
void InvertBit (UInt_t f)
 
virtual Bool_t IsEqual (const TObject *obj) const
 Default equal comparison (objects are equal if they have the same address in memory). More...
 
virtual Bool_t IsFolder () const
 Returns kTRUE in case object contains browsable objects (like containers or lists of other objects). More...
 
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). More...
 
virtual Bool_t Notify ()
 This method must be overridden to handle object notification. More...
 
void Obsolete (const char *method, const char *asOfVers, const char *removedFromVers) const
 Use this method to declare a method obsolete. More...
 
void operator delete (void *ptr)
 Operator delete. More...
 
void operator delete[] (void *ptr)
 Operator delete []. More...
 
voidoperator new (size_t sz)
 
voidoperator new (size_t sz, void *vp)
 
voidoperator new[] (size_t sz)
 
voidoperator new[] (size_t sz, void *vp)
 
TObjectoperator= (const TObject &rhs)
 TObject assignment operator. More...
 
virtual void Paint (Option_t *option="")
 This method must be overridden if a class wants to paint itself. More...
 
virtual void Pop ()
 Pop on object drawn in a pad to the top of the display list. More...
 
virtual Int_t Read (const char *name)
 Read contents of object with specified name from the current directory. More...
 
virtual void RecursiveRemove (TObject *obj)
 Recursively remove this object from a list. More...
 
void ResetBit (UInt_t f)
 
virtual void SaveAs (const char *filename="", Option_t *option="") const
 Save this object in the file specified by filename. More...
 
virtual void SavePrimitive (std::ostream &out, Option_t *option="")
 Save a primitive as a C++ statement(s) on output stream "out". More...
 
void SetBit (UInt_t f, Bool_t set)
 Set or unset the user status bits as specified in f. More...
 
void SetBit (UInt_t f)
 
virtual void SetDrawOption (Option_t *option="")
 Set drawing option for object. More...
 
virtual void SetUniqueID (UInt_t uid)
 Set the unique object id. More...
 
virtual void SysError (const char *method, const char *msgfmt,...) const
 Issue system error message. More...
 
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. More...
 
virtual void Warning (const char *method, const char *msgfmt,...) const
 Issue warning message. More...
 
virtual Int_t Write (const char *name=0, Int_t option=0, Int_t bufsize=0)
 Write this object to the current directory. More...
 
virtual Int_t Write (const char *name=0, Int_t option=0, Int_t bufsize=0) const
 Write this object to the current directory. More...
 

Protected Attributes

TListfButtons
 list of buttons More...
 
TControlBarImpfControlBarImp
 system specific implementation More...
 
Int_t fNoroc
 number of rows or columns More...
 
Int_t fOrientation
 orientation More...
 
- Protected Attributes inherited from TControlBarButton
TString fAction
 action to be executed More...
 
Int_t fType
 button type More...
 
- Protected Attributes inherited from TNamed
TString fName
 
TString fTitle
 

Private Member Functions

virtual void Create ()
 Create control bar. More...
 
void Initialize (Int_t x, Int_t y)
 Initialize control bar. More...
 

Friends

class TControlBarImp
 

Additional Inherited Members

- Static Public Member Functions inherited from TObject
static Long_t GetDtorOnly ()
 Return destructor only flag. More...
 
static Bool_t GetObjectStat ()
 Get status of object stat flag. More...
 
static void SetDtorOnly (void *obj)
 Set destructor only flag. More...
 
static void SetObjectStat (Bool_t stat)
 Turn on/off tracking of objects in the TObjectTable. More...
 
- 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). More...
 
void MakeZombie ()
 

#include <TControlBar.h>

Inheritance diagram for TControlBar:
[legend]

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
Enumerator
kVertical 
kHorizontal 

Definition at line 38 of file TControlBar.h.

Constructor & Destructor Documentation

◆ TControlBar() [1/3]

TControlBar::TControlBar ( )

Default constructor.

Definition at line 91 of file TControlBar.cxx.

◆ TControlBar() [2/3]

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

Normal constructor.

Definition at line 102 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 112 of file TControlBar.cxx.

◆ ~TControlBar()

TControlBar::~TControlBar ( )
virtual

Destructor.

Definition at line 124 of file TControlBar.cxx.

Member Function Documentation

◆ AddButton() [1/3]

void TControlBar::AddButton ( TControlBarButton button)

Add button.

Definition at line 146 of file TControlBar.cxx.

◆ AddButton() [2/3]

void TControlBar::AddButton ( TControlBarButton button)

Add button.

Definition at line 138 of file TControlBar.cxx.

◆ AddButton() [3/3]

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

Add button.

Definition at line 155 of file TControlBar.cxx.

◆ AddControlBar() [1/2]

void TControlBar::AddControlBar ( TControlBar controlBar)

Add control bar.

Definition at line 172 of file TControlBar.cxx.

◆ AddControlBar() [2/2]

void TControlBar::AddControlBar ( TControlBar controlBar)

Add control bar.

Definition at line 164 of file TControlBar.cxx.

◆ AddSeparator()

void TControlBar::AddSeparator ( )

Add separator.

Definition at line 181 of file TControlBar.cxx.

◆ Create()

void TControlBar::Create ( )
privatevirtual

Create control bar.

Reimplemented from TControlBarButton.

Definition at line 188 of file TControlBar.cxx.

◆ 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 330 of file TControlBar.cxx.

◆ GetControlBarImp()

TControlBarImp* TControlBar::GetControlBarImp ( ) const
inline

Definition at line 52 of file TControlBar.h.

◆ GetListOfButtons()

TList* TControlBar::GetListOfButtons ( ) const
inline

Definition at line 53 of file TControlBar.h.

◆ GetNumberOfColumns()

Int_t TControlBar::GetNumberOfColumns ( ) const
inline

Definition at line 54 of file TControlBar.h.

◆ GetNumberOfRows()

Int_t TControlBar::GetNumberOfRows ( ) const
inline

Definition at line 55 of file TControlBar.h.

◆ GetOrientation()

Int_t TControlBar::GetOrientation ( ) const
inline

Definition at line 56 of file TControlBar.h.

◆ Hide()

void TControlBar::Hide ( )

Hide control bar.

Definition at line 198 of file TControlBar.cxx.

◆ Initialize()

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

Initialize control bar.

Definition at line 208 of file TControlBar.cxx.

◆ 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 267 of file TControlBar.cxx.

◆ SetButtonWidth()

void TControlBar::SetButtonWidth ( UInt_t  width)

Sets the width in pixels for control bar button.

Definition at line 280 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 233 of file TControlBar.cxx.

◆ SetNumberOfColumns()

void TControlBar::SetNumberOfColumns ( Int_t  n)
inline

Definition at line 61 of file TControlBar.h.

◆ SetNumberOfRows()

void TControlBar::SetNumberOfRows ( Int_t  n)
inline

Definition at line 62 of file TControlBar.h.

◆ SetOrientation() [1/2]

void TControlBar::SetOrientation ( const char *  o)

Set control bar orientation.

Definition at line 288 of file TControlBar.cxx.

◆ SetOrientation() [2/2]

void TControlBar::SetOrientation ( Int_t  o)

Set control bar orientation.

Definition at line 306 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 245 of file TControlBar.cxx.

◆ Show()

void TControlBar::Show ( )

Show control bar.

Definition at line 320 of file TControlBar.cxx.

Friends And Related Function Documentation

◆ TControlBarImp

friend class TControlBarImp
friend

Definition at line 24 of file TControlBar.h.

Member Data Documentation

◆ fButtons

TList* TControlBar::fButtons
protected

list of buttons

Definition at line 34 of file TControlBar.h.

◆ fControlBarImp

TControlBarImp* TControlBar::fControlBarImp
protected

system specific implementation

Definition at line 32 of file TControlBar.h.

◆ fNoroc

Int_t TControlBar::fNoroc
protected

number of rows or columns

Definition at line 35 of file TControlBar.h.

◆ fOrientation

Int_t TControlBar::fOrientation
protected

orientation

Definition at line 33 of file TControlBar.h.

Libraries for TControlBar:
[legend]

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