Logo ROOT   6.12/07
Reference Guide
TButton.cxx
Go to the documentation of this file.
1 // @(#)root/gpad:$Id$
2 // Author: Rene Brun 01/07/96
3 
4 /*************************************************************************
5  * Copyright (C) 1995-2000, Rene Brun and Fons Rademakers. *
6  * All rights reserved. *
7  * *
8  * For the licensing terms see $ROOTSYS/LICENSE. *
9  * For the list of contributors see $ROOTSYS/README/CREDITS. *
10  *************************************************************************/
11 
12 #include "Riostream.h"
13 #include "TROOT.h"
14 #include "TButton.h"
15 #include "TCanvas.h"
16 #include "TLatex.h"
17 
18 #include <string.h>
19 
21 
22 
23 /** \class TButton
24 \ingroup gpad
25 
26 A TButton object is a user interface object.
27 
28 A TButton has a name and an associated action.
29 When the button is clicked with the left mouse button, the corresponding
30 action is executed.
31 
32 A TButton can be created by direct invocation of the constructors
33 or via the graphics editor.
34 
35 The action can be set via TButton::SetMethod.
36 The action can be any command. Examples of actions:
37  - "34+78" When the button is clicked, the result of addition is printed.
38  - ".x macro.C" . Clicking the button executes the macro macro.C
39 The action can be modified at any time via TButton::SetMethod.
40 
41 To modify the layout/size/contents of one or several buttons
42 in a canvas, you must set the canvas editable via TCanvas::SetEditable.
43 By default a TCanvas is editable.
44 By default a TDialogCanvas is not editable.
45 TButtons are in general placed in a TDialogCanvas.
46 
47 A TButton being a TPad, one can draw graphics primitives in it
48 when the TCanvas/TDialogCanvas is editable.
49 
50 Example of a macro creating a dialog canvas with buttons:
51 ~~~ {.cpp}
52 void but() {
53 // example of a dialog canvas with a few buttons
54 
55  TDialogCanvas *dialog = new TDialogCanvas("dialog","",200,300);
56 
57 // Create first button. Clicking on this button will execute 34+56
58  TButton *but1 = new TButton("button1","34+56",.05,.8,.45,.88);
59  but1->Draw();
60 
61 // Create second button. Clicking on this button will create a new canvas
62  TButton *but2 = new TButton("canvas","c2 = new TCanvas(\"c2\")",.55,.8,.95,.88);
63  but2->Draw();
64 
65 // Create third button. Clicking on this button will invoke the browser
66  but3 = new TButton("Browser","br = new TBrowser(\"br\")",0.25,0.54,0.75,0.64);
67  but3->SetFillColor(42);
68  but3->Draw();
69 
70 // Create last button with no name. Instead a graph is draw inside the button
71 // Clicking on this button will invoke the macro $ROOTSYS/tutorials/graphs/graph.C
72  button = new TButton("",".x tutorials/graphs/graph.C",0.15,0.15,0.85,0.38);
73  button->SetFillColor(42);
74  button->Draw();
75  button->SetEditable(kTRUE);
76  button->cd();
77 
78  Double_t x[8] = {0.08,0.21,0.34,0.48,0.61,0.7,0.81,0.92};
79  Double_t y[8] = {0.2,0.65,0.4,0.34,0.24,0.43,0.75,0.52};
80  TGraph *graph = new TGraph(8,x,y);
81  graph->SetMarkerColor(4);
82  graph->SetMarkerStyle(21);
83  graph->Draw("lp");
84 
85  dialog->cd();
86 }
87 ~~~
88 Executing the macro above produces the following dialog canvas:
89 
90 \image html gpad_dialogbuttons.png
91 */
92 
93 ////////////////////////////////////////////////////////////////////////////////
94 /// Button default constructor.
95 
97 {
98  fFraming = 0;
99  fMethod = "";
100  fLogx = kFALSE;
101  fLogy = kFALSE;
103  fFocused = 0;
104 }
105 
106 ////////////////////////////////////////////////////////////////////////////////
107 /// Button normal constructor.
108 ///
109 /// Note that the button coordinates x1,y1,x2,y2 are always in the range [0,1]
110 
111 TButton::TButton(const char *title, const char *method, Double_t x1, Double_t y1,Double_t x2, Double_t y2)
112  :TPad("button",title,x1,y1,x2,y2,18,2,1), TAttText(22,0,1,61,0.65)
113 {
114  fFraming=0;
116  fModified = kTRUE;
117  fMethod = method;
118  if (strlen(title)) {
119  TLatex *text = new TLatex(0.5*(fX1+fX2),0.5*(fY1+fY2),title);
120  fPrimitives->Add(text);
121  }
122  fLogx = kFALSE;
123  fLogy = kFALSE;
125  fFocused = 0;
126 }
127 
128 ////////////////////////////////////////////////////////////////////////////////
129 /// Button default destructor.
130 
132 {
134 }
135 
136 ////////////////////////////////////////////////////////////////////////////////
137 /// Draw this button with its current attributes.
138 
139 void TButton::Draw(Option_t *option)
140 {
141  if (fCanvas) AppendPad(option);
142 }
143 
144 ////////////////////////////////////////////////////////////////////////////////
145 /// Execute action corresponding to one event.
146 ///
147 /// This member function is called when a Button object is clicked.
148 
150 {
151  //check case where pressing a button deletes itself
152  if (!TestBit(kNotDeleted)) return;
153 
154  if (IsEditable()) {
155  TPad::ExecuteEvent(event,px,py);
156  return;
157  }
158 
159  TPad *cdpad = (TPad*)gROOT->GetSelectedPad();
160  HideToolTip(event);
161 
162  switch (event) {
163 
164  case kMouseEnter:
165  TPad::ExecuteEvent(event,px,py);
166  break;
167 
168  case kButton1Down:
169  SetBorderMode(-1);
170  fFocused=1;
171  Modified();
172  Update();
173  break;
174 
175  case kMouseMotion:
176 
177  break;
178 
179  case kButton1Motion:
180  if (px<XtoAbsPixel(1) && px>XtoAbsPixel(0) &&
181  py<YtoAbsPixel(0) && py>YtoAbsPixel(1)) {
182  if (!fFocused) {
183  SetBorderMode(-1);
184  fFocused=1;
185  Modified();
186  GetCanvas()->Modified();
187  Update();
188  }
189  } else if (fFocused) {
190  SetBorderMode(1);
191  fFocused=0;
192  Modified();
193  GetCanvas()->Modified();
194  Update();
195  }
196  break;
197 
198  case kButton1Up:
199  SetCursor(kWatch);
200  if (fFocused) {
201  if (cdpad) cdpad->cd();
202  gROOT->ProcessLine(GetMethod());
203  }
204  //check case where pressing a button deletes itself
205  if (!TestBit(kNotDeleted)) return;
206  SetBorderMode(1);
207  Modified();
208  Update();
209  SetCursor(kCross);
210  break;
211  }
212 }
213 
214 ////////////////////////////////////////////////////////////////////////////////
215 /// Paint this button with its current attributes.
216 
218 {
219  if (!fCanvas) return;
220  if (!fPrimitives) fPrimitives = new TList();
221  TObject *obj = GetListOfPrimitives()->First();
222  if (obj && obj->InheritsFrom(TText::Class())) {
223  TLatex *text = (TLatex*)obj;
224  text->SetTitle(GetTitle());
225  text->SetTextSize(GetTextSize());
226  text->SetTextFont(GetTextFont());
227  text->SetTextAlign(GetTextAlign());
228  text->SetTextColor(GetTextColor());
229  text->SetTextAngle(GetTextAngle());
230  }
231  SetLogx(0);
232  SetLogy(0);
233  TPad::Paint(option); //only called for Postscript print
234 }
235 
236 ////////////////////////////////////////////////////////////////////////////////
237 /// Paint is modified.
238 
240 {
241  if (!fCanvas) return;
242  if (!fPrimitives) fPrimitives = new TList();
243  TObject *obj = GetListOfPrimitives()->First();
244  if (obj && obj->InheritsFrom(TText::Class())) {
245  TLatex *text = (TLatex*)obj;
246  text->SetTitle(GetTitle());
247  text->SetTextSize(GetTextSize());
248  text->SetTextFont(GetTextFont());
249  text->SetTextAlign(GetTextAlign());
250  text->SetTextColor(GetTextColor());
251  text->SetTextAngle(GetTextAngle());
252  }
253  SetLogx(0);
254  SetLogy(0);
256 }
257 
258 ////////////////////////////////////////////////////////////////////////////////
259 /// Set world coordinate system for the pad.
260 
262 {
263  TPad::Range(x1,y1,x2,y2);
264 }
265 
266 ////////////////////////////////////////////////////////////////////////////////
267 /// Save primitive as a C++ statement(s) on output stream out
268 
269 void TButton::SavePrimitive(std::ostream &out, Option_t * /*= ""*/)
270 {
271  TPad *padsav = (TPad*)gPad;
272  char quote = '"';
273  if (gROOT->ClassSaved(TButton::Class())) {
274  out<<" ";
275  } else {
276  out<<" TButton *";
277  }
278  char *cm = (char*)GetMethod();
279  Int_t nch = strlen(cm);
280  char *cmethod = new char[nch+10];
281  Int_t i = 0;
282  while(*cm) {
283  if (*cm == '"') {
284  cmethod[i] = '\\';
285  i++;
286  }
287  cmethod[i] = *cm;
288  i++;
289  cm++;
290  }
291  cmethod[i] = 0;
292  out<<"button = new TButton("<<quote<<GetTitle()
293  <<quote<<","<<quote<<cmethod<<quote
294  <<","<<fXlowNDC
295  <<","<<fYlowNDC
296  <<","<<fXlowNDC+fWNDC
297  <<","<<fYlowNDC+fHNDC
298  <<");"<<std::endl;
299  delete [] cmethod;
300 
301  SaveFillAttributes(out,"button",0,1001);
302  SaveLineAttributes(out,"button",1,1,1);
303  SaveTextAttributes(out,"button",22,0,1,61,.65);
304 
305  if (GetBorderSize() != 2) {
306  out<<" button->SetBorderSize("<<GetBorderSize()<<");"<<std::endl;
307  }
308  if (GetBorderMode() != 1) {
309  out<<" button->SetBorderMode("<<GetBorderMode()<<");"<<std::endl;
310  }
311 
312  if (GetFraming()) out<<"button->SetFraming();"<<std::endl;
313  if (IsEditable()) out<<"button->SetEditable(kTRUE);"<<std::endl;
314 
315  out<<" button->Draw();"<<std::endl;
316 
317  TIter next(GetListOfPrimitives());
318  TObject *obj = next(); //do not save first primitive
319 
320  Int_t nprim = 0;
321  while ((obj = next())) {
322  if (!nprim) out<<" button->cd();"<<std::endl;
323  nprim++;
324  obj->SavePrimitive(out, (Option_t *)next.GetOption());
325  }
326 
327  if (nprim) out<<" "<<padsav->GetName()<<"->cd();"<<std::endl;
328  padsav->cd();
329 }
330 
331 ////////////////////////////////////////////////////////////////////////////////
332 /// if framing is set, button will be highlighted
333 
335 {
336  fFraming=f;
337  if (f) SetBit(kFraming);
338  else ResetBit(kFraming);
339 }
virtual void Delete(Option_t *option="")
Remove all objects from the list AND delete all heap based objects.
Definition: TList.cxx:467
TList * fPrimitives
->List of primitives (subpads)
Definition: TPad.h:106
virtual void Range(Double_t x1, Double_t y1, Double_t x2, Double_t y2)
Set world coordinate system for the pad.
Definition: TButton.cxx:261
TList * GetListOfPrimitives() const
Definition: TPad.h:240
virtual Short_t GetBorderSize() const
Definition: TPad.h:197
virtual Color_t GetTextColor() const
Return the text color.
Definition: TAttText.h:34
virtual void Paint(Option_t *option="")
Paint all primitives in pad.
Definition: TPad.cxx:3371
virtual Short_t GetTextAlign() const
Return the text alignment.
Definition: TAttText.h:32
virtual void SetBorderMode(Short_t bordermode)
Definition: TButton.h:43
const char Option_t
Definition: RtypesCore.h:62
virtual Float_t GetTextAngle() const
Return the text angle.
Definition: TAttText.h:33
virtual void SetLogy(Int_t value=1)
Set Lin/Log scale for Y.
Definition: TButton.h:59
#define gROOT
Definition: TROOT.h:402
R__ALWAYS_INLINE Bool_t TestBit(UInt_t f) const
Definition: TObject.h:172
static constexpr double cm
virtual void Update()
Update pad.
Definition: TPad.cxx:2804
int Int_t
Definition: RtypesCore.h:41
bool Bool_t
Definition: RtypesCore.h:59
virtual void PaintModified()
Traverse pad hierarchy and (re)paint only modified pads.
Definition: TPad.cxx:3588
Option_t * GetOption() const
Definition: TCollection.h:249
Frame is requested.
Definition: TPad.h:153
void SetBit(UInt_t f, Bool_t set)
Set or unset the user status bits as specified in f.
Definition: TObject.cxx:694
if object in a list can be deleted
Definition: TObject.h:58
virtual void AppendPad(Option_t *option="")
Append graphics object to current pad.
Definition: TObject.cxx:105
Bool_t fFraming
True if you want a frame to be painted when pressed.
Definition: TButton.h:23
virtual void SetTextFont(Font_t tfont=62)
Set the text font.
Definition: TAttText.h:45
virtual void Draw(Option_t *option="")
Draw this button with its current attributes.
Definition: TButton.cxx:139
TVirtualPad * cd(Int_t subpadnumber=0)
Set Current pad.
Definition: TPad.cxx:585
static const double x2[5]
virtual void SavePrimitive(std::ostream &out, Option_t *option="")
Save primitive as a C++ statement(s) on output stream out.
Definition: TButton.cxx:269
virtual void PaintModified()
Paint is modified.
Definition: TButton.cxx:239
void Class()
Definition: Class.C:29
virtual void SaveLineAttributes(std::ostream &out, const char *name, Int_t coldef=1, Int_t stydef=1, Int_t widdef=1)
Save line attributes as C++ statement(s) on output stream out.
Definition: TAttLine.cxx:260
virtual Float_t GetTextSize() const
Return the text size.
Definition: TAttText.h:36
Int_t fLogx
(=0 if X linear scale, =1 if log scale)
Definition: TPad.h:90
To draw Mathematical Formula.
Definition: TLatex.h:18
TCanvas * fCanvas
! Pointer to mother canvas
Definition: TPad.h:105
const char * GetTitle() const
Returns title of object.
Definition: TPad.h:256
TButton()
Button default constructor.
Definition: TButton.cxx:96
TString fMethod
Method to be executed by this button.
Definition: TButton.h:29
Double_t fYlowNDC
Y bottom left corner of pad in NDC [0,1].
Definition: TPad.h:62
object has not been deleted
Definition: TObject.h:78
virtual void SetEditable(Bool_t mode=kTRUE)
Set pad editable yes/no If a pad is not editable:
Definition: TPad.cxx:5753
virtual void SetTextAlign(Short_t align=11)
Set the text alignment.
Definition: TAttText.h:41
Double_t fX2
X of upper X coordinate.
Definition: TPad.h:37
A doubly linked list.
Definition: TList.h:44
virtual const char * GetMethod() const
Definition: TButton.h:38
virtual void ExecuteEvent(Int_t event, Int_t px, Int_t py)
Execute action corresponding to one event.
Definition: TPad.cxx:1663
virtual TObject * First() const
Return the first object in the list. Returns 0 when list is empty.
Definition: TList.cxx:655
virtual void SetCursor(ECursor cursor)
Set cursor type.
Definition: TPad.cxx:2780
Bool_t fFocused
If cursor is in...
Definition: TButton.h:22
virtual void SaveTextAttributes(std::ostream &out, const char *name, Int_t alidef=12, Float_t angdef=0, Int_t coldef=1, Int_t fondef=61, Float_t sizdef=1)
Save text attributes as C++ statement(s) on output stream out.
Definition: TAttText.cxx:347
Int_t YtoAbsPixel(Double_t y) const
Definition: TPad.h:500
virtual void Range(Double_t x1, Double_t y1, Double_t x2, Double_t y2)
Set world coordinate system for the pad.
Definition: TPad.cxx:5103
virtual Font_t GetTextFont() const
Return the text font.
Definition: TAttText.h:35
virtual Bool_t IsEditable() const
Definition: TPad.h:267
virtual Bool_t InheritsFrom(const char *classname) const
Returns kTRUE if object inherits from class "classname".
Definition: TObject.cxx:443
virtual void SetTextAngle(Float_t tangle=0)
Set the text angle.
Definition: TAttText.h:42
Text Attributes class.
Definition: TAttText.h:18
virtual void SaveFillAttributes(std::ostream &out, const char *name, Int_t coldef=1, Int_t stydef=1001)
Save fill attributes as C++ statement(s) on output stream out.
Definition: TAttFill.cxx:232
virtual ~TButton()
Button default destructor.
Definition: TButton.cxx:131
The most important graphics class in the ROOT system.
Definition: TPad.h:29
A TButton object is a user interface object.
Definition: TButton.h:19
virtual void Paint(Option_t *option="")
Paint this button with its current attributes.
Definition: TButton.cxx:217
virtual TCanvas * GetCanvas() const
Definition: TPad.h:257
Bool_t fModified
Set to true when pad is modified.
Definition: TPad.h:98
const Bool_t kFALSE
Definition: RtypesCore.h:88
Double_t fY2
Y of upper Y coordinate.
Definition: TPad.h:38
virtual void HideToolTip(Int_t event)
Hide tool tip depending on the event type.
Definition: TPad.cxx:2723
virtual void SetFraming(Bool_t f=1)
if framing is set, button will be highlighted
Definition: TButton.cxx:334
static const double x1[5]
#define ClassImp(name)
Definition: Rtypes.h:359
double Double_t
Definition: RtypesCore.h:55
TText * text
virtual void SetLogx(Int_t value=1)
Set Lin/Log scale for X.
Definition: TButton.h:58
Double_t fXlowNDC
X bottom left corner of pad in NDC [0,1].
Definition: TPad.h:61
Mother of all ROOT objects.
Definition: TObject.h:37
const char * GetName() const
Returns name of object.
Definition: TPad.h:255
Int_t XtoAbsPixel(Double_t x) const
Definition: TPad.h:478
virtual void Add(TObject *obj)
Definition: TList.h:87
virtual Short_t GetBorderMode() const
Definition: TPad.h:196
Double_t fHNDC
Height of pad along Y in NDC.
Definition: TPad.h:66
#define gPad
Definition: TVirtualPad.h:285
virtual void SetTextColor(Color_t tcolor=1)
Set the text color.
Definition: TAttText.h:43
void ResetBit(UInt_t f)
Definition: TObject.h:171
virtual void SetTextSize(Float_t tsize=1)
Set the text size.
Definition: TAttText.h:46
Double_t fY1
Y of lower Y coordinate.
Definition: TPad.h:36
virtual Bool_t GetFraming()
Definition: TButton.h:45
Double_t fX1
X of lower X coordinate.
Definition: TPad.h:35
virtual void SetTitle(const char *title="")
Set the title of the TNamed.
Definition: TNamed.cxx:164
const Bool_t kTRUE
Definition: RtypesCore.h:87
void Modified(Bool_t flag=1)
Definition: TPad.h:414
Int_t fLogy
(=0 if Y linear scale, =1 if log scale)
Definition: TPad.h:91
virtual void ExecuteEvent(Int_t event, Int_t px, Int_t py)
Execute action corresponding to one event.
Definition: TButton.cxx:149
Double_t fWNDC
Width of pad along X in NDC.
Definition: TPad.h:65
virtual void SavePrimitive(std::ostream &out, Option_t *option="")
Save a primitive as a C++ statement(s) on output stream "out".
Definition: TObject.cxx:664