Logo ROOT  
Reference Guide
TGClient.h
Go to the documentation of this file.
1 // @(#)root/gui:$Id$
2 // Author: Fons Rademakers 27/12/97
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_TGClient
13 #define ROOT_TGClient
14 
15 
16 #include "TObject.h"
17 #include "GuiTypes.h"
18 #include "TString.h"
19 #include "TQObject.h"
20 
21 
22 class TList;
23 class THashList;
24 class TGWindow;
25 class TGResourcePool;
26 class TGPicturePool;
27 class TGPicture;
28 class TGGCPool;
29 class TGGC;
30 class TGFontPool;
31 class TGFont;
32 class TGMimeTypes;
34 class TGIdleHandler;
35 
36 
37 class TGClient : public TObject, public TQObject {
38 
39 friend class TGCocoa;
40 
41 protected:
42  Pixel_t fBackColor; ///< default background color
43  Pixel_t fForeColor; ///< default foreground color
44  Pixel_t fHilite; ///< default highlight color
45  Pixel_t fShadow; ///< default shadow color
46  Pixel_t fSelBackColor; ///< default selection background color
47  Pixel_t fSelForeColor; ///< default selection foreground color
48  Pixel_t fWhite; ///< white color index
49  Pixel_t fBlack; ///< black color index
50  TGWindow *fDefaultRoot; ///< default root window (base window of display)
51  TGWindow *fRoot; ///< current root window (changing root window allows embedding)
52  Int_t fXfd; ///< file descriptor of connection to server
53  TGResourcePool *fResourcePool; ///< global GUI resource pool
54  TGGCPool *fGCPool; ///< graphics context pool
55  TGFontPool *fFontPool; ///< font pool
56  TGPicturePool *fPicturePool; ///< pixmap pool
57  TGMimeTypes *fMimeTypeList; ///< mimetype list
58  Colormap_t fDefaultColormap; ///< default colormap
59  Bool_t fGlobalNeedRedraw; ///< true if at least one window needs to be redrawn
60  Bool_t fForceRedraw; ///< redraw widgets as soon as possible
61  THashList *fWlist; ///< list of frames
62  TList *fPlist; ///< list of popup windows used in HandleMaskEvent()
63  TList *fUWHandlers; ///< list of event handlers for unknown windows
64  TList *fIdleHandlers; ///< list of idle handlers
65  EGEventType fWaitForEvent; ///< event to wait for
66  Window_t fWaitForWindow; ///< window in which to wait for event
67  UInt_t fStyle; ///< GUI style (modern or classic)
68 
69  TGClient(const TGClient&) = delete;
70  TGClient& operator=(const TGClient&) = delete;
71 
74  Bool_t DoRedraw();
75 
76 public:
77  TGClient(const char *dpyName = nullptr);
78  virtual ~TGClient();
79 
80  const TGWindow *GetRoot() const;
81  const TGWindow *GetDefaultRoot() const;
82  void SetRoot(TGWindow *root = nullptr);
83  TGWindow *GetWindowById(Window_t sw) const;
84  TGWindow *GetWindowByName(const char *name) const;
85 
86  UInt_t GetDisplayWidth() const;
87  UInt_t GetDisplayHeight() const;
88 
89  Bool_t IsEditable() const { return fRoot != fDefaultRoot; }
90  Bool_t IsEditDisabled() const;
91  void SetEditDisabled(Bool_t on = kTRUE);
92 
93  FontStruct_t GetFontByName(const char *name, Bool_t fixedDefault = kTRUE) const;
94  Bool_t GetColorByName(const char *name, Pixel_t &pixel) const;
95  Pixel_t GetHilite(Pixel_t base_color) const;
96  Pixel_t GetShadow(Pixel_t base_color) const;
97  void FreeColor(Pixel_t color) const;
99  void NeedRedraw(TGWindow *w, Bool_t force = kFALSE);
100  void CancelRedraw(TGWindow *w);
101  void RegisterWindow(TGWindow *w);
102  void UnregisterWindow(TGWindow *w);
103  void RegisterPopup(TGWindow *w);
104  void UnregisterPopup(TGWindow *w);
110  void ProcessLine(TString cmd, Long_t msg, Long_t parm1, Long_t parm2);
111  void WaitFor(TGWindow *w);
112  void WaitForUnmap(TGWindow *w);
113  void ResetWaitFor(TGWindow *w);
118 
119  Bool_t HandleEvent(Event_t *event);
120  Bool_t HandleMaskEvent(Event_t *event, Window_t wid);
121  void RegisteredWindow(Window_t w); //*SIGNAL*
122  void ProcessedEvent(Event_t *event, Window_t wid); //*SIGNAL*
123 
124  const TGResourcePool *GetResourcePool() const { return fResourcePool; }
125 
127  const TGPicture *GetPicture(const char *name);
128  const TGPicture *GetPicture(const char *name, UInt_t new_width, UInt_t new_height);
129  void FreePicture(const TGPicture *pic);
130 
131  TGGCPool *GetGCPool() const { return fGCPool; }
132  TGGC *GetGC(GCValues_t *values, Bool_t rw = kFALSE);
133  void FreeGC(const TGGC *gc);
134  void FreeGC(GContext_t gc);
135 
136  TGFontPool *GetFontPool() const { return fFontPool; }
137  TGFont *GetFont(const char *font, Bool_t fixedDefault = kTRUE);
138  TGFont *GetFont(const TGFont *font);
139  void FreeFont(const TGFont *font);
140 
141  UInt_t GetStyle() const { return fStyle; }
142  void SetStyle(UInt_t newstyle) { fStyle = newstyle; }
143  void SetStyle(const char *style);
144 
147 
148  THashList *GetListOfWindows() const { return fWlist; }
149  TList *GetListOfPopups() const { return fPlist; }
150 
151  static TGClient *Instance();
152 
153  ClassDef(TGClient,0) // Class making connection to display server
154 };
155 
156 #ifndef __CINT__
157 #define gClient (TGClient::Instance())
158 #endif
159 
160 #endif
TGClient::fMimeTypeList
TGMimeTypes * fMimeTypeList
mimetype list
Definition: TGClient.h:57
TGClient::fXfd
Int_t fXfd
file descriptor of connection to server
Definition: TGClient.h:52
TGClient::GetDefaultRoot
const TGWindow * GetDefaultRoot() const
Returns the root (i.e.
Definition: TGClient.cxx:236
TGClient::RegisterPopup
void RegisterPopup(TGWindow *w)
Add a popup menu to the list of popups.
Definition: TGClient.cxx:535
TGClient::AddUnknownWindowHandler
void AddUnknownWindowHandler(TGUnknownWindowHandler *h)
Add handler for unknown (i.e. unregistered) windows.
Definition: TGClient.cxx:554
TGClient::FreeFont
void FreeFont(const TGFont *font)
Free a font.
Definition: TGClient.cxx:366
TGClient::fDefaultRoot
TGWindow * fDefaultRoot
default root window (base window of display)
Definition: TGClient.h:50
TGClient::fForeColor
Pixel_t fForeColor
default foreground color
Definition: TGClient.h:43
TGWindow
ROOT GUI Window base class.
Definition: TGWindow.h:23
kTRUE
const Bool_t kTRUE
Definition: RtypesCore.h:100
TGClient::GetDisplayWidth
UInt_t GetDisplayWidth() const
Get display width.
Definition: TGClient.cxx:264
TGClient::RegisterWindow
void RegisterWindow(TGWindow *w)
Add a TGWindow to the clients list of windows.
Definition: TGClient.cxx:514
TGClient::fWlist
THashList * fWlist
list of frames
Definition: TGClient.h:61
TGClient::GetWindowByName
TGWindow * GetWindowByName(const char *name) const
Find a TGWindow via its name (unique name used in TGWindow::SavePrimitive).
Definition: TGClient.cxx:607
TGClient::RegisteredWindow
void RegisteredWindow(Window_t w)
Emits a signal when a Window has been registered in TGClient.
Definition: TGClient.cxx:967
TGPicture
The TGPicture class implements pictures and icons used in the different GUI elements and widgets.
Definition: TGPicture.h:25
TGClient::fPlist
TList * fPlist
list of popup windows used in HandleMaskEvent()
Definition: TGClient.h:62
TGClient::ProcessLine
void ProcessLine(TString cmd, Long_t msg, Long_t parm1, Long_t parm2)
Execute string "cmd" via the interpreter.
Definition: TGClient.cxx:916
TGClient::ProcessEventsFor
Bool_t ProcessEventsFor(TGWindow *w)
Like gSystem->ProcessEvents() but then only allow events for w to be processed.
Definition: TGClient.cxx:775
TGIdleHandler
Handle idle events, i.e.
Definition: TGIdleHandler.h:21
TGClient::fUWHandlers
TList * fUWHandlers
list of event handlers for unknown windows
Definition: TGClient.h:63
TGClient::SetWaitForWindow
void SetWaitForWindow(Window_t wid)
Definition: TGClient.h:116
TGClient::GetFontPool
TGFontPool * GetFontPool() const
Definition: TGClient.h:136
TGClient::fPicturePool
TGPicturePool * fPicturePool
pixmap pool
Definition: TGClient.h:56
TGClient::GetGCPool
TGGCPool * GetGCPool() const
Definition: TGClient.h:131
TGClient::GetShadow
Pixel_t GetShadow(Pixel_t base_color) const
Return pixel value of shadow color based on base_color.
Definition: TGClient.cxx:483
Pixel_t
ULong_t Pixel_t
Pixel value.
Definition: GuiTypes.h:40
TGClient::RemoveUnknownWindowHandler
void RemoveUnknownWindowHandler(TGUnknownWindowHandler *h)
Remove handler for unknown (i.e. unregistered) windows.
Definition: TGClient.cxx:567
TGClient::AddIdleHandler
void AddIdleHandler(TGIdleHandler *h)
Add handler for idle events.
Definition: TGClient.cxx:575
TGClient::UnregisterPopup
void UnregisterPopup(TGWindow *w)
Remove a popup menu from the list of popups.
Definition: TGClient.cxx:546
FontStruct_t
Handle_t FontStruct_t
Pointer to font structure.
Definition: GuiTypes.h:39
TGClient::DoRedraw
Bool_t DoRedraw()
Redraw all windows that need redrawing.
Definition: TGClient.cxx:797
TGClient::RemoveIdleHandler
void RemoveIdleHandler(TGIdleHandler *h)
Remove handler for idle events.
Definition: TGClient.cxx:588
TGClient::fShadow
Pixel_t fShadow
default shadow color
Definition: TGClient.h:45
GCValues_t
Graphics context structure.
Definition: GuiTypes.h:224
TGClient::fStyle
UInt_t fStyle
GUI style (modern or classic)
Definition: TGClient.h:67
TGClient::WaitFor
void WaitFor(TGWindow *w)
Wait for window to be destroyed.
Definition: TGClient.cxx:711
TGClient::IsEditable
Bool_t IsEditable() const
Definition: TGClient.h:89
TGClient::fFontPool
TGFontPool * fFontPool
font pool
Definition: TGClient.h:55
TGClient::WaitForUnmap
void WaitForUnmap(TGWindow *w)
Wait for window to be unmapped.
Definition: TGClient.cxx:739
TGClient::GetHilite
Pixel_t GetHilite(Pixel_t base_color) const
Return pixel value of hilite color based on base_color.
Definition: TGClient.cxx:452
TGClient::FreePicture
void FreePicture(const TGPicture *pic)
Free picture resource.
Definition: TGClient.cxx:310
TGClient::GetResourcePool
const TGResourcePool * GetResourcePool() const
Definition: TGClient.h:124
TGClient::fSelBackColor
Pixel_t fSelBackColor
default selection background color
Definition: TGClient.h:46
TGClient::fDefaultColormap
Colormap_t fDefaultColormap
default colormap
Definition: TGClient.h:58
TGClient::ProcessedEvent
void ProcessedEvent(Event_t *event, Window_t wid)
Emits a signal when an event has been processed.
Definition: TGClient.cxx:954
TString
Basic string class.
Definition: TString.h:136
TGClient::fResourcePool
TGResourcePool * fResourcePool
global GUI resource pool
Definition: TGClient.h:53
Bool_t
bool Bool_t
Definition: RtypesCore.h:63
TGClient::GetPicturePool
TGPicturePool * GetPicturePool() const
Definition: TGClient.h:126
TString.h
TGResourcePool
This class implements a pool for the default GUI resource set, like GC's, colors, fonts,...
Definition: TGResourcePool.h:28
bool
TGClient::fWaitForWindow
Window_t fWaitForWindow
window in which to wait for event
Definition: TGClient.h:66
TGFontPool
provides a pool of fonts.
Definition: TGFont.h:217
GContext_t
Handle_t GContext_t
Graphics context handle.
Definition: GuiTypes.h:38
TGClient::GetFontByName
FontStruct_t GetFontByName(const char *name, Bool_t fixedDefault=kTRUE) const
Get a font by name.
Definition: TGClient.cxx:427
TGClient::GetStyle
UInt_t GetStyle() const
Definition: TGClient.h:141
style
TCanvas * style()
Definition: style.C:1
TQObject.h
TGClient::GetListOfPopups
TList * GetListOfPopups() const
Definition: TGClient.h:149
TQObject
This is the ROOT implementation of the Qt object communication mechanism (see also http://www....
Definition: TQObject.h:48
TGClient::GetWaitForEvent
EGEventType GetWaitForEvent() const
Definition: TGClient.h:114
TGClient::SetRoot
void SetRoot(TGWindow *root=nullptr)
Sets the current root (i.e.
Definition: TGClient.cxx:246
TGClient::GetColorByName
Bool_t GetColorByName(const char *name, Pixel_t &pixel) const
Get a color by name.
Definition: TGClient.cxx:397
TGClient::SetEditDisabled
void SetEditDisabled(Bool_t on=kTRUE)
If on is kTRUE editting/guibuilding is forbidden.
Definition: TGClient.cxx:945
TGClient::fIdleHandlers
TList * fIdleHandlers
list of idle handlers
Definition: TGClient.h:64
TGClient::GetDisplayHeight
UInt_t GetDisplayHeight() const
Get display height.
Definition: TGClient.cxx:277
Colormap_t
Handle_t Colormap_t
Colormap handle.
Definition: GuiTypes.h:33
THashList
THashList implements a hybrid collection class consisting of a hash table and a list to store TObject...
Definition: THashList.h:34
h
#define h(i)
Definition: RSha256.hxx:106
TGCocoa
This class implements TVirtualX interface for MacOS X, using Cocoa and Quartz 2D.
Definition: TGCocoa.h:58
TGClient::fBackColor
Pixel_t fBackColor
default background color
Definition: TGClient.h:42
TGClient::fGCPool
TGGCPool * fGCPool
graphics context pool
Definition: TGClient.h:54
TGGC
Encapsulate a graphics context used in the low level graphics.
Definition: TGGC.h:22
TGClient::ProcessOneEvent
Bool_t ProcessOneEvent()
Process one event.
Definition: TGClient.cxx:648
GuiTypes.h
TGClient::HandleMaskEvent
Bool_t HandleMaskEvent(Event_t *event, Window_t wid)
Handle masked events only if window wid is the window for which the event was reported or if wid is a...
Definition: TGClient.cxx:858
kFALSE
const Bool_t kFALSE
Definition: RtypesCore.h:101
TGClient::GetDefaultColormap
Colormap_t GetDefaultColormap() const
Definition: TGClient.h:145
TGClient::fWaitForEvent
EGEventType fWaitForEvent
event to wait for
Definition: TGClient.h:65
Long_t
long Long_t
Definition: RtypesCore.h:54
TGClient::GetWindowById
TGWindow * GetWindowById(Window_t sw) const
Find a TGWindow via its handle. If window is not found return 0.
Definition: TGClient.cxx:596
TGClient::ForceRedraw
void ForceRedraw()
Definition: TGClient.h:98
TGClient::HandleEvent
Bool_t HandleEvent(Event_t *event)
Handle a GUI event.
Definition: TGClient.cxx:821
TGClient::fWhite
Pixel_t fWhite
white color index
Definition: TGClient.h:48
TGClient::HandleInput
Bool_t HandleInput()
Handles input from the display server.
Definition: TGClient.cxx:699
TGClient::fSelForeColor
Pixel_t fSelForeColor
default selection foreground color
Definition: TGClient.h:47
TGPicturePool
Definition: TGPicture.h:89
TGClient::GetPicture
const TGPicture * GetPicture(const char *name)
Get picture from the picture pool.
Definition: TGClient.cxx:291
Window_t
Handle_t Window_t
Window handle.
Definition: GuiTypes.h:29
TGClient::fGlobalNeedRedraw
Bool_t fGlobalNeedRedraw
true if at least one window needs to be redrawn
Definition: TGClient.h:59
UInt_t
unsigned int UInt_t
Definition: RtypesCore.h:46
TGClient::fRoot
TGWindow * fRoot
current root window (changing root window allows embedding)
Definition: TGClient.h:51
TGMimeTypes
This class handles mime types, used by browsers to map file types to applications and icons.
Definition: TGMimeTypes.h:41
TGClient::operator=
TGClient & operator=(const TGClient &)=delete
TGClient::GetListOfWindows
THashList * GetListOfWindows() const
Definition: TGClient.h:148
unsigned int
TGClient::GetMimeTypeList
TGMimeTypes * GetMimeTypeList() const
Definition: TGClient.h:146
TGClient::SetStyle
void SetStyle(UInt_t newstyle)
Definition: TGClient.h:142
TGClient::GetWaitForWindow
Window_t GetWaitForWindow() const
Definition: TGClient.h:115
TGClient::fBlack
Pixel_t fBlack
black color index
Definition: TGClient.h:49
TGClient::IsEditDisabled
Bool_t IsEditDisabled() const
Returns kTRUE if edit/guibuilding is forbidden.
Definition: TGClient.cxx:937
TGClient::GetGC
TGGC * GetGC(GCValues_t *values, Bool_t rw=kFALSE)
Get graphics context from the gc pool.
Definition: TGClient.cxx:322
TGClient::NeedRedraw
void NeedRedraw(TGWindow *w, Bool_t force=kFALSE)
Set redraw flags.
Definition: TGClient.cxx:374
TObject.h
TGClient::fHilite
Pixel_t fHilite
default highlight color
Definition: TGClient.h:44
TGGCPool
Definition: TGGC.h:103
TObject
Mother of all ROOT objects.
Definition: TObject.h:37
ClassDef
#define ClassDef(name, id)
Definition: Rtypes.h:325
Event_t
Event structure.
Definition: GuiTypes.h:174
name
char name[80]
Definition: TGX11.cxx:110
TGClient::ProcessIdleEvent
Bool_t ProcessIdleEvent()
Process one idle event.
Definition: TGClient.cxx:682
TGClient::GetFont
TGFont * GetFont(const char *font, Bool_t fixedDefault=kTRUE)
Get a font from the font pool.
Definition: TGClient.cxx:350
TGClient::fForceRedraw
Bool_t fForceRedraw
redraw widgets as soon as possible
Definition: TGClient.h:60
TGClient::FreeColor
void FreeColor(Pixel_t color) const
Free color.
Definition: TGClient.cxx:506
TGUnknownWindowHandler
Handle events for windows that are not part of the native ROOT GUI.
Definition: TGWindow.h:134
TGFont
Encapsulate fonts used in the GUI system.
Definition: TGFont.h:140
TGClient::Instance
static TGClient * Instance()
Returns global gClient (initialize graphics first, if not already done)
Definition: TGClient.cxx:93
TGClient::ResetWaitFor
void ResetWaitFor(TGWindow *w)
reset waiting
Definition: TGClient.cxx:765
TGClient::GetRoot
const TGWindow * GetRoot() const
Returns current root (i.e.
Definition: TGClient.cxx:226
TGClient::CancelRedraw
void CancelRedraw(TGWindow *w)
Definition: TGClient.cxx:388
TGClient
Window client.
Definition: TGClient.h:37
EGEventType
EGEventType
Definition: GuiTypes.h:59
TGClient::~TGClient
virtual ~TGClient()
Closing down client: cleanup and close X connection.
Definition: TGClient.cxx:624
TList
A doubly linked list.
Definition: TList.h:44
TGClient::TGClient
TGClient(const TGClient &)=delete
int
TGClient::UnregisterWindow
void UnregisterWindow(TGWindow *w)
Remove a TGWindow from the list of windows.
Definition: TGClient.cxx:525
TGClient::FreeGC
void FreeGC(const TGGC *gc)
Free a graphics context.
Definition: TGClient.cxx:330