Logo ROOT  
Reference Guide
No Matches
Go to the documentation of this file.
1// @(#)root/gui:$Id$
2// Author: Fons Rademakers 27/12/97
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 *************************************************************************/
12#ifndef ROOT_TGClient
13#define ROOT_TGClient
17// //
18// TGClient //
19// //
20// Window client. In client server windowing systems, like X11 this //
21// class is used to make the initial connection to the window server. //
22// //
25#include "TObject.h"
26#include "GuiTypes.h"
27#include "TString.h"
28#include "TQObject.h"
31class TList;
32class THashList;
33class TGWindow;
34class TGResourcePool;
35class TGPicturePool;
36class TGPicture;
37class TGGCPool;
38class TGGC;
39class TGFontPool;
40class TGFont;
41class TGMimeTypes;
43class TGIdleHandler;
46class TGClient : public TObject, public TQObject {
48friend class TGCocoa;
51 Pixel_t fBackColor; // default background color
52 Pixel_t fForeColor; // default foreground color
53 Pixel_t fHilite; // default hilite color
54 Pixel_t fShadow; // default shadow color
55 Pixel_t fSelBackColor; // default selection background color
56 Pixel_t fSelForeColor; // default selection foreground color
57 Pixel_t fWhite; // white color index
58 Pixel_t fBlack; // black color index
59 TGWindow *fDefaultRoot; // default root window (base window of display)
60 TGWindow *fRoot; // current root window (changing root window allows embedding)
61 Int_t fXfd; // file descriptor of connection to server
62 TGResourcePool *fResourcePool; // global GUI resource pool
63 TGGCPool *fGCPool; // graphics context pool
64 TGFontPool *fFontPool; // font pool
65 TGPicturePool *fPicturePool; // pixmap pool
66 TGMimeTypes *fMimeTypeList; // mimetype list
67 Colormap_t fDefaultColormap; // default colormap
68 Bool_t fGlobalNeedRedraw; // true if at least one window needs to be redrawn
69 Bool_t fForceRedraw; // redraw widgets as soon as possible
70 THashList *fWlist; // list of frames
71 TList *fPlist; // list of popup windows used in HandleMaskEvent()
72 TList *fUWHandlers; // list of event handlers for unknown windows
73 TList *fIdleHandlers; // list of idle handlers
74 EGEventType fWaitForEvent; // event to wait for
75 Window_t fWaitForWindow; // window in which to wait for event
76 UInt_t fStyle; // GUI style (modern or classic)
78 TGClient(const TGClient&) = delete;
79 TGClient& operator=(const TGClient&) = delete;
86 TGClient(const char *dpyName = nullptr);
87 virtual ~TGClient();
89 const TGWindow *GetRoot() const;
90 const TGWindow *GetDefaultRoot() const;
91 void SetRoot(TGWindow *root = nullptr);
93 TGWindow *GetWindowByName(const char *name) const;
95 UInt_t GetDisplayWidth() const;
98 Bool_t IsEditable() const { return fRoot != fDefaultRoot; }
99 Bool_t IsEditDisabled() const;
100 void SetEditDisabled(Bool_t on = kTRUE);
102 FontStruct_t GetFontByName(const char *name, Bool_t fixedDefault = kTRUE) const;
103 Bool_t GetColorByName(const char *name, Pixel_t &pixel) const;
104 Pixel_t GetHilite(Pixel_t base_color) const;
105 Pixel_t GetShadow(Pixel_t base_color) const;
106 void FreeColor(Pixel_t color) const;
108 void NeedRedraw(TGWindow *w, Bool_t force = kFALSE);
109 void CancelRedraw(TGWindow *w);
110 void RegisterWindow(TGWindow *w);
111 void UnregisterWindow(TGWindow *w);
112 void RegisterPopup(TGWindow *w);
113 void UnregisterPopup(TGWindow *w);
119 void ProcessLine(TString cmd, Long_t msg, Long_t parm1, Long_t parm2);
120 void WaitFor(TGWindow *w);
121 void WaitForUnmap(TGWindow *w);
122 void ResetWaitFor(TGWindow *w);
128 Bool_t HandleEvent(Event_t *event);
130 void RegisteredWindow(Window_t w); //*SIGNAL*
131 void ProcessedEvent(Event_t *event, Window_t wid); //*SIGNAL*
136 const TGPicture *GetPicture(const char *name);
137 const TGPicture *GetPicture(const char *name, UInt_t new_width, UInt_t new_height);
138 void FreePicture(const TGPicture *pic);
140 TGGCPool *GetGCPool() const { return fGCPool; }
141 TGGC *GetGC(GCValues_t *values, Bool_t rw = kFALSE);
142 void FreeGC(const TGGC *gc);
143 void FreeGC(GContext_t gc);
145 TGFontPool *GetFontPool() const { return fFontPool; }
146 TGFont *GetFont(const char *font, Bool_t fixedDefault = kTRUE);
147 TGFont *GetFont(const TGFont *font);
148 void FreeFont(const TGFont *font);
150 UInt_t GetStyle() const { return fStyle; }
151 void SetStyle(UInt_t newstyle) { fStyle = newstyle; }
152 void SetStyle(const char *style);
157 THashList *GetListOfWindows() const { return fWlist; }
158 TList *GetListOfPopups() const { return fPlist; }
160 static TGClient *Instance();
162 ClassDef(TGClient,0) // Class making connection to display server
165#ifndef __CINT__
166#define gClient (TGClient::Instance())
Definition GuiTypes.h:59
Handle_t Colormap_t
Colormap handle.
Definition GuiTypes.h:33
Handle_t GContext_t
Graphics context handle.
Definition GuiTypes.h:38
Handle_t FontStruct_t
Pointer to font structure.
Definition GuiTypes.h:39
ULong_t Pixel_t
Pixel value.
Definition GuiTypes.h:40
Handle_t Window_t
Window handle.
Definition GuiTypes.h:29
#define h(i)
Definition RSha256.hxx:106
unsigned int UInt_t
Definition RtypesCore.h:46
const Bool_t kFALSE
Definition RtypesCore.h:92
long Long_t
Definition RtypesCore.h:54
bool Bool_t
Definition RtypesCore.h:63
const Bool_t kTRUE
Definition RtypesCore.h:91
#define ClassDef(name, id)
Definition Rtypes.h:325
char name[80]
Definition TGX11.cxx:110
Pixel_t fBackColor
Definition TGClient.h:51
const TGWindow * GetDefaultRoot() const
Returns the root (i.e.
Definition TGClient.cxx:233
Bool_t IsEditable() const
Definition TGClient.h:98
const TGWindow * GetRoot() const
Returns current root (i.e.
Definition TGClient.cxx:223
EGEventType fWaitForEvent
Definition TGClient.h:74
TGGCPool * fGCPool
Definition TGClient.h:63
Bool_t ProcessIdleEvent()
Process one idle event.
Definition TGClient.cxx:679
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:855
void FreeColor(Pixel_t color) const
Free color.
Definition TGClient.cxx:503
Pixel_t fWhite
Definition TGClient.h:57
void CancelRedraw(TGWindow *w)
Definition TGClient.cxx:385
Pixel_t fHilite
Definition TGClient.h:53
void ProcessLine(TString cmd, Long_t msg, Long_t parm1, Long_t parm2)
Execute string "cmd" via the interpreter.
Definition TGClient.cxx:913
Window_t fWaitForWindow
Definition TGClient.h:75
static TGClient * Instance()
Returns global gClient (initialize graphics first, if not already done)
Definition TGClient.cxx:92
virtual ~TGClient()
Closing down client: cleanup and close X connection.
Definition TGClient.cxx:621
void RegisterPopup(TGWindow *w)
Add a popup menu to the list of popups.
Definition TGClient.cxx:532
void WaitForUnmap(TGWindow *w)
Wait for window to be unmapped.
Definition TGClient.cxx:736
TGFontPool * fFontPool
Definition TGClient.h:64
void UnregisterPopup(TGWindow *w)
Remove a popup menu from the list of popups.
Definition TGClient.cxx:543
void ResetWaitFor(TGWindow *w)
reset waiting
Definition TGClient.cxx:762
TGGC * GetGC(GCValues_t *values, Bool_t rw=kFALSE)
Get graphics context from the gc pool.
Definition TGClient.cxx:319
Colormap_t fDefaultColormap
Definition TGClient.h:67
TGResourcePool * fResourcePool
Definition TGClient.h:62
TGFont * GetFont(const char *font, Bool_t fixedDefault=kTRUE)
Get a font from the font pool.
Definition TGClient.cxx:347
void FreeGC(const TGGC *gc)
Free a graphics context.
Definition TGClient.cxx:327
void AddUnknownWindowHandler(TGUnknownWindowHandler *h)
Add handler for unknown (i.e. unregistered) windows.
Definition TGClient.cxx:551
Pixel_t fForeColor
Definition TGClient.h:52
void SetStyle(UInt_t newstyle)
Definition TGClient.h:151
Colormap_t GetDefaultColormap() const
Definition TGClient.h:154
void RemoveUnknownWindowHandler(TGUnknownWindowHandler *h)
Remove handler for unknown (i.e. unregistered) windows.
Definition TGClient.cxx:564
UInt_t fStyle
Definition TGClient.h:76
void AddIdleHandler(TGIdleHandler *h)
Add handler for idle events.
Definition TGClient.cxx:572
const TGResourcePool * GetResourcePool() const
Definition TGClient.h:133
TGMimeTypes * GetMimeTypeList() const
Definition TGClient.h:155
TGClient & operator=(const TGClient &)=delete
void FreeFont(const TGFont *font)
Free a font.
Definition TGClient.cxx:363
TGWindow * fDefaultRoot
Definition TGClient.h:59
void SetEditDisabled(Bool_t on=kTRUE)
If on is kTRUE editting/guibuilding is forbidden.
Definition TGClient.cxx:942
TList * GetListOfPopups() const
Definition TGClient.h:158
Bool_t ProcessEventsFor(TGWindow *w)
Like gSystem->ProcessEvents() but then only allow events for w to be processed.
Definition TGClient.cxx:772
Bool_t HandleEvent(Event_t *event)
Handle a GUI event.
Definition TGClient.cxx:818
void ForceRedraw()
Definition TGClient.h:107
Bool_t ProcessOneEvent()
Process one event.
Definition TGClient.cxx:645
Bool_t fGlobalNeedRedraw
Definition TGClient.h:68
Pixel_t fSelBackColor
Definition TGClient.h:55
void SetWaitForWindow(Window_t wid)
Definition TGClient.h:125
TGClient(const TGClient &)=delete
void ProcessedEvent(Event_t *event, Window_t wid)
Emits a signal when an event has been processed.
Definition TGClient.cxx:951
TGMimeTypes * fMimeTypeList
Definition TGClient.h:66
Bool_t DoRedraw()
Redraw all windows that need redrawing.
Definition TGClient.cxx:794
UInt_t GetDisplayHeight() const
Get display height.
Definition TGClient.cxx:274
Pixel_t fSelForeColor
Definition TGClient.h:56
void WaitFor(TGWindow *w)
Wait for window to be destroyed.
Definition TGClient.cxx:708
void RegisterWindow(TGWindow *w)
Add a TGWindow to the clients list of windows.
Definition TGClient.cxx:511
TList * fIdleHandlers
Definition TGClient.h:73
TGWindow * GetWindowById(Window_t sw) const
Find a TGWindow via its handle. If window is not found return 0.
Definition TGClient.cxx:593
void RegisteredWindow(Window_t w)
Emits a signal when a Window has been registered in TGClient.
Definition TGClient.cxx:964
Pixel_t fBlack
Definition TGClient.h:58
const TGPicture * GetPicture(const char *name)
Get picture from the picture pool.
Definition TGClient.cxx:288
Window_t GetWaitForWindow() const
Definition TGClient.h:124
TGGCPool * GetGCPool() const
Definition TGClient.h:140
Pixel_t fShadow
Definition TGClient.h:54
Bool_t GetColorByName(const char *name, Pixel_t &pixel) const
Get a color by name.
Definition TGClient.cxx:394
void SetRoot(TGWindow *root=nullptr)
Sets the current root (i.e.
Definition TGClient.cxx:243
Bool_t fForceRedraw
Definition TGClient.h:69
TGWindow * fRoot
Definition TGClient.h:60
UInt_t GetStyle() const
Definition TGClient.h:150
void RemoveIdleHandler(TGIdleHandler *h)
Remove handler for idle events.
Definition TGClient.cxx:585
Bool_t IsEditDisabled() const
Returns kTRUE if edit/guibuilding is forbidden.
Definition TGClient.cxx:934
void NeedRedraw(TGWindow *w, Bool_t force=kFALSE)
Set redraw flags.
Definition TGClient.cxx:371
TList * fPlist
Definition TGClient.h:71
Pixel_t GetHilite(Pixel_t base_color) const
Return pixel value of hilite color based on base_color.
Definition TGClient.cxx:449
FontStruct_t GetFontByName(const char *name, Bool_t fixedDefault=kTRUE) const
Get a font by name.
Definition TGClient.cxx:424
TList * fUWHandlers
Definition TGClient.h:72
EGEventType GetWaitForEvent() const
Definition TGClient.h:123
TGPicturePool * fPicturePool
Definition TGClient.h:65
TGPicturePool * GetPicturePool() const
Definition TGClient.h:135
Bool_t HandleInput()
Handles input from the display server.
Definition TGClient.cxx:696
UInt_t GetDisplayWidth() const
Get display width.
Definition TGClient.cxx:261
TGFontPool * GetFontPool() const
Definition TGClient.h:145
THashList * fWlist
Definition TGClient.h:70
Pixel_t GetShadow(Pixel_t base_color) const
Return pixel value of shadow color based on base_color.
Definition TGClient.cxx:480
void FreePicture(const TGPicture *pic)
Free picture resource.
Definition TGClient.cxx:307
Int_t fXfd
Definition TGClient.h:61
void UnregisterWindow(TGWindow *w)
Remove a TGWindow from the list of windows.
Definition TGClient.cxx:522
THashList * GetListOfWindows() const
Definition TGClient.h:157
TGWindow * GetWindowByName(const char *name) const
Find a TGWindow via its name (unique name used in TGWindow::SavePrimitive).
Definition TGClient.cxx:604
This class implements TVirtualX interface for MacOS X, using Cocoa and Quartz 2D.
Definition TGCocoa.h:58
Definition TGGC.h:31
THashList implements a hybrid collection class consisting of a hash table and a list to store TObject...
Definition THashList.h:34
A doubly linked list.
Definition TList.h:44
Mother of all ROOT objects.
Definition TObject.h:37
This is the ROOT implementation of the Qt object communication mechanism (see also http://www....
Definition TQObject.h:48
Basic string class.
Definition TString.h:136
Event structure.
Definition GuiTypes.h:174
Graphics context structure.
Definition GuiTypes.h:224
TCanvas * style()
Definition style.C:1