Logo ROOT   master
Reference Guide
TGToolTip.h
Go to the documentation of this file.
1 // @(#)root/gui:$Id$
2 // Author: Fons Rademakers 22/02/98
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 #ifndef ROOT_TGToolTip
13 #define ROOT_TGToolTip
14 
15 
16 //////////////////////////////////////////////////////////////////////////
17 // //
18 // TGToolTip //
19 // //
20 // A tooltip can be a one or multiple lines help text that is displayed //
21 // in a window when the mouse cursor overs a widget, without clicking //
22 // it. A small box appears with suplementary information regarding the //
23 // item being hovered over. //
24 // //
25 //////////////////////////////////////////////////////////////////////////
26 
27 #include "TGFrame.h"
28 
29 class TGLabel;
30 class TTimer;
31 class TVirtualPad;
32 class TBox;
33 
34 
35 class TGToolTip : public TGCompositeFrame {
36 
37 private:
38  TGLabel *fLabel; // help text
39  TGLayoutHints *fL1; // layout used to place text in frame
40  TTimer *fDelay; // popup delay timer
41  const TGFrame *fWindow; // frame to which tool tip is associated
42  const TVirtualPad *fPad; // pad to which tooltip is associated
43  const TBox *fBox; // box in pad to which tooltip is associated
44  Int_t fX; // X position in fWindow where to popup
45  Int_t fY; // Y position in fWindow where to popup
46 
47  TGToolTip(const TGToolTip&); // not implemented
48  TGToolTip& operator=(const TGToolTip&); // not implemented
49 
50 public:
51  TGToolTip(const TGWindow *p = 0, const TGFrame *f = 0, const char *text = 0, Long_t delayms = 350);
52  TGToolTip(const TGWindow *p, const TBox *b, const char *text, Long_t delayms);
53  TGToolTip(const TBox *b, const char *text, Long_t delayms);
54  TGToolTip(Int_t x, Int_t y, const char *text, Long_t delayms);
55  virtual ~TGToolTip();
56 
57  virtual void DrawBorder();
58 
60  void Show(Int_t x, Int_t y); //*SIGNAL*
61  void Hide(); //*SIGNAL*
62  void Reset(); //*SIGNAL*
63  void Reset(const TVirtualPad *parent);
64  void SetText(const char *new_text);
65  void SetPosition(Int_t x, Int_t y);
66  void SetDelay(Long_t delayms);
67  const TGString *GetText() const;
68 
69  ClassDef(TGToolTip,0) //One or multiple lines help text
70 };
71 
72 #endif
Int_t fX
Definition: TGToolTip.h:44
const TVirtualPad * fPad
Definition: TGToolTip.h:42
Create a Box.
Definition: TBox.h:22
void Reset()
Reset tool tip popup delay timer.
Definition: TGToolTip.cxx:260
void SetText(const char *new_text)
Set new tool tip text.
Definition: TGToolTip.cxx:387
void Show(Int_t x, Int_t y)
Show tool tip window.
Definition: TGToolTip.cxx:230
#define f(i)
Definition: RSha256.hxx:104
Int_t fY
Definition: TGToolTip.h:45
void Hide()
Hide tool tip window.
Definition: TGToolTip.cxx:247
TGLabel * fLabel
Definition: TGToolTip.h:38
Double_t x[n]
Definition: legend1.C:17
#define ClassDef(name, id)
Definition: Rtypes.h:322
void SetDelay(Long_t delayms)
Set delay in milliseconds.
Definition: TGToolTip.cxx:396
void SetPosition(Int_t x, Int_t y)
Set popup position within specified frame (as specified in the ctor).
Definition: TGToolTip.cxx:406
TVirtualPad is an abstract base class for the Pad and Canvas classes.
Definition: TVirtualPad.h:50
TGToolTip & operator=(const TGToolTip &)
Bool_t HandleTimer(TTimer *t)
If tool tip delay timer times out show tool tip window.
Definition: TGToolTip.cxx:285
virtual ~TGToolTip()
Delete a tool tip object.
Definition: TGToolTip.cxx:209
TGToolTip(const TGToolTip &)
Handles synchronous and a-synchronous timer events.
Definition: TTimer.h:51
TTimer * fDelay
Definition: TGToolTip.h:40
TText * text
Double_t y[n]
Definition: legend1.C:17
const TBox * fBox
Definition: TGToolTip.h:43
long Long_t
Definition: CPyCppyy.h:50
TGLayoutHints * fL1
Definition: TGToolTip.h:39
you should not use this method at all Int_t Int_t Double_t Double_t Double_t Int_t Double_t Double_t Double_t Double_t b
Definition: TRolke.cxx:630
const TGString * GetText() const
Get the tool tip text.
Definition: TGToolTip.cxx:427
virtual void DrawBorder()
Draw border of tool tip window.
Definition: TGToolTip.cxx:219
const TGFrame * fWindow
Definition: TGToolTip.h:41