Logo ROOT   master
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 //////////////////////////////////////////////////////////////////////////
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 // //
23 //////////////////////////////////////////////////////////////////////////
24 
25 #include "TObject.h"
26 #include "GuiTypes.h"
27 #include "TString.h"
28 #include "TQObject.h"
29 
30 
31 class TList;
32 class THashList;
33 class TGWindow;
34 class TGResourcePool;
35 class TGPicturePool;
36 class TGPicture;
37 class TGGCPool;
38 class TGGC;
39 class TGFontPool;
40 class TGFont;
41 class TGMimeTypes;
43 class TGIdleHandler;
44 
45 
46 class TGClient : public TObject, public TQObject {
47 
48 friend class TGCocoa;
49 
50 protected:
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)
77 
78  TGClient(const TGClient&); // not implemented
79  TGClient& operator=(const TGClient&); // not implemented
80 
83  Bool_t DoRedraw();
84 
85 public:
86  TGClient(const char *dpyName = 0);
87  virtual ~TGClient();
88 
89  const TGWindow *GetRoot() const;
90  const TGWindow *GetDefaultRoot() const;
91  void SetRoot(TGWindow *root = 0);
92  TGWindow *GetWindowById(Window_t sw) const;
93  TGWindow *GetWindowByName(const char *name) const;
94 
95  UInt_t GetDisplayWidth() const;
96  UInt_t GetDisplayHeight() const;
97 
98  Bool_t IsEditable() const { return fRoot != fDefaultRoot; }
99  Bool_t IsEditDisabled() const;
100  void SetEditDisabled(Bool_t on = kTRUE);
101 
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);
127 
128  Bool_t HandleEvent(Event_t *event);
129  Bool_t HandleMaskEvent(Event_t *event, Window_t wid);
130  void RegisteredWindow(Window_t w); //*SIGNAL*
131  void ProcessedEvent(Event_t *event, Window_t wid); //*SIGNAL*
132 
133  const TGResourcePool *GetResourcePool() const { return fResourcePool; }
134 
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);
139 
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);
144 
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);
149 
150  UInt_t GetStyle() const { return fStyle; }
151  void SetStyle(UInt_t newstyle) { fStyle = newstyle; }
152  void SetStyle(const char *style);
153 
156 
157  THashList *GetListOfWindows() const { return fWlist; }
158  TList *GetListOfPopups() const { return fPlist; }
159 
160  static TGClient *Instance();
161 
162  ClassDef(TGClient,0) // Class making connection to display server
163 };
164 
165 #ifndef __CINT__
166 #define gClient (TGClient::Instance())
167 #endif
168 
169 #endif
void ProcessedEvent(Event_t *event, Window_t wid)
Emits a signal when an event has been processed.
Definition: TGClient.cxx:951
Pixel_t fHilite
Definition: TGClient.h:53
Pixel_t fBlack
Definition: TGClient.h:58
Bool_t IsEditDisabled() const
Returns kTRUE if edit/guibuilding is forbidden.
Definition: TGClient.cxx:934
void ForceRedraw()
Definition: TGClient.h:107
Handle_t FontStruct_t
Definition: GuiTypes.h:38
Bool_t HandleEvent(Event_t *event)
Handle a GUI event.
Definition: TGClient.cxx:818
TGPicturePool * fPicturePool
Definition: TGClient.h:65
void SetRoot(TGWindow *root=0)
Sets the current root (i.e.
Definition: TGClient.cxx:244
virtual ~TGClient()
Closing down client: cleanup and close X connection.
Definition: TGClient.cxx:621
THashList * fWlist
Definition: TGClient.h:70
void RemoveIdleHandler(TGIdleHandler *h)
Remove handler for idle events.
Definition: TGClient.cxx:585
const TGWindow * GetRoot() const
Returns current root (i.e.
Definition: TGClient.cxx:224
void FreeColor(Pixel_t color) const
Free color.
Definition: TGClient.cxx:503
TGWindow * fRoot
Definition: TGClient.h:60
EGEventType
Definition: GuiTypes.h:58
Pixel_t GetShadow(Pixel_t base_color) const
Return pixel value of shadow color based on base_color.
Definition: TGClient.cxx:480
This is the ROOT implementation of the Qt object communication mechanism (see also http://www...
Definition: TQObject.h:48
const TGResourcePool * GetResourcePool() const
Definition: TGClient.h:133
Handle_t GContext_t
Definition: GuiTypes.h:37
Basic string class.
Definition: TString.h:131
Pixel_t fBackColor
Definition: TGClient.h:51
bool Bool_t
Definition: RtypesCore.h:59
Bool_t GetColorByName(const char *name, Pixel_t &pixel) const
Get a color by name.
Definition: TGClient.cxx:394
EGEventType GetWaitForEvent() const
Definition: TGClient.h:123
TList * GetListOfPopups() const
Definition: TGClient.h:158
void WaitForUnmap(TGWindow *w)
Wait for window to be unmapped.
Definition: TGClient.cxx:736
void CancelRedraw(TGWindow *w)
Definition: TGClient.cxx:385
void UnregisterWindow(TGWindow *w)
Remove a TGWindow from the list of windows.
Definition: TGClient.cxx:522
Bool_t ProcessIdleEvent()
Process one idle event.
Definition: TGClient.cxx:679
Definition: TGGC.h:112
UInt_t GetDisplayWidth() const
Get display width.
Definition: TGClient.cxx:262
TGWindow * fDefaultRoot
Definition: TGClient.h:59
void RegisterPopup(TGWindow *w)
Add a popup menu to the list of popups.
Definition: TGClient.cxx:532
TGWindow * GetWindowByName(const char *name) const
Find a TGWindow via its name (unique name used in TGWindow::SavePrimitive).
Definition: TGClient.cxx:604
TGClient(const TGClient &)
#define ClassDef(name, id)
Definition: Rtypes.h:326
TGPicturePool * GetPicturePool() const
Definition: TGClient.h:135
ULong_t Pixel_t
Definition: GuiTypes.h:39
Pixel_t fSelForeColor
Definition: TGClient.h:56
THashList implements a hybrid collection class consisting of a hash table and a list to store TObject...
Definition: THashList.h:34
void RegisterWindow(TGWindow *w)
Add a TGWindow to the clients list of windows.
Definition: TGClient.cxx:511
void FreePicture(const TGPicture *pic)
Free picture resource.
Definition: TGClient.cxx:308
void ProcessLine(TString cmd, Long_t msg, Long_t parm1, Long_t parm2)
Execute string "cmd" via the interpreter.
Definition: TGClient.cxx:913
void SetStyle(UInt_t newstyle)
Definition: TGClient.h:151
Pixel_t fSelBackColor
Definition: TGClient.h:55
TList * fIdleHandlers
Definition: TGClient.h:73
Bool_t DoRedraw()
Redraw all windows that need redrawing.
Definition: TGClient.cxx:794
void FreeGC(const TGGC *gc)
Free a graphics context.
Definition: TGClient.cxx:328
void RegisteredWindow(Window_t w)
Emits a signal when a Window has been registered in TGClient.
Definition: TGClient.cxx:964
Bool_t fForceRedraw
Definition: TGClient.h:69
Pixel_t fForeColor
Definition: TGClient.h:52
void SetWaitForWindow(Window_t wid)
Definition: TGClient.h:125
TGMimeTypes * GetMimeTypeList() const
Definition: TGClient.h:155
void WaitFor(TGWindow *w)
Wait for window to be destroyed.
Definition: TGClient.cxx:708
A doubly linked list.
Definition: TList.h:44
void FreeFont(const TGFont *font)
Free a font.
Definition: TGClient.cxx:364
TGResourcePool * fResourcePool
Definition: TGClient.h:62
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
Bool_t IsEditable() const
Definition: TGClient.h:98
void RemoveUnknownWindowHandler(TGUnknownWindowHandler *h)
Remove handler for unknown (i.e. unregistered) windows.
Definition: TGClient.cxx:564
void AddUnknownWindowHandler(TGUnknownWindowHandler *h)
Add handler for unknown (i.e. unregistered) windows.
Definition: TGClient.cxx:551
Bool_t ProcessOneEvent()
Process one event.
Definition: TGClient.cxx:645
unsigned int UInt_t
Definition: RtypesCore.h:42
Bool_t fGlobalNeedRedraw
Definition: TGClient.h:68
static TGClient * Instance()
Returns global gClient (initialize graphics first, if not already done)
Definition: TGClient.cxx:91
Bool_t HandleInput()
Handles input from the display server.
Definition: TGClient.cxx:696
#define h(i)
Definition: RSha256.hxx:106
Handle_t Colormap_t
Definition: GuiTypes.h:32
TGGC * GetGC(GCValues_t *values, Bool_t rw=kFALSE)
Get graphics context from the gc pool.
Definition: TGClient.cxx:320
const Bool_t kFALSE
Definition: RtypesCore.h:88
TGFontPool * GetFontPool() const
Definition: TGClient.h:145
long Long_t
Definition: RtypesCore.h:50
Pixel_t fWhite
Definition: TGClient.h:57
TGMimeTypes * fMimeTypeList
Definition: TGClient.h:66
Pixel_t GetHilite(Pixel_t base_color) const
Return pixel value of hilite color based on base_color.
Definition: TGClient.cxx:449
Window_t GetWaitForWindow() const
Definition: TGClient.h:124
void ResetWaitFor(TGWindow *w)
reset waiting
Definition: TGClient.cxx:762
TList * fUWHandlers
Definition: TGClient.h:72
const TGPicture * GetPicture(const char *name)
Get picture from the picture pool.
Definition: TGClient.cxx:289
Int_t fXfd
Definition: TGClient.h:61
Definition: TGFont.h:149
TCanvas * style()
Definition: style.C:1
UInt_t GetDisplayHeight() const
Get display height.
Definition: TGClient.cxx:275
void AddIdleHandler(TGIdleHandler *h)
Add handler for idle events.
Definition: TGClient.cxx:572
Mother of all ROOT objects.
Definition: TObject.h:37
FontStruct_t GetFontByName(const char *name, Bool_t fixedDefault=kTRUE) const
Get a font by name.
Definition: TGClient.cxx:424
Colormap_t GetDefaultColormap() const
Definition: TGClient.h:154
Handle_t Window_t
Definition: GuiTypes.h:28
This class implements TVirtualX interface for MacOS X, using Cocoa and Quartz 2D. ...
Definition: TGCocoa.h:58
TGFontPool * fFontPool
Definition: TGClient.h:64
Bool_t ProcessEventsFor(TGWindow *w)
Like gSystem->ProcessEvents() but then only allow events for w to be processed.
Definition: TGClient.cxx:772
const TGWindow * GetDefaultRoot() const
Returns the root (i.e.
Definition: TGClient.cxx:234
void NeedRedraw(TGWindow *w, Bool_t force=kFALSE)
Set redraw flags.
Definition: TGClient.cxx:372
EGEventType fWaitForEvent
Definition: TGClient.h:74
TList * fPlist
Definition: TGClient.h:71
TGClient & operator=(const TGClient &)
Colormap_t fDefaultColormap
Definition: TGClient.h:67
UInt_t GetStyle() const
Definition: TGClient.h:150
Window_t fWaitForWindow
Definition: TGClient.h:75
TGGCPool * fGCPool
Definition: TGClient.h:63
Pixel_t fShadow
Definition: TGClient.h:54
THashList * GetListOfWindows() const
Definition: TGClient.h:157
const Bool_t kTRUE
Definition: RtypesCore.h:87
void SetEditDisabled(Bool_t on=kTRUE)
If on is kTRUE editting/guibuilding is forbidden.
Definition: TGClient.cxx:942
Definition: TGGC.h:31
void UnregisterPopup(TGWindow *w)
Remove a popup menu from the list of popups.
Definition: TGClient.cxx:543
char name[80]
Definition: TGX11.cxx:109
TGFont * GetFont(const char *font, Bool_t fixedDefault=kTRUE)
Get a font from the font pool.
Definition: TGClient.cxx:348
TGGCPool * GetGCPool() const
Definition: TGClient.h:140
TGWindow * GetWindowById(Window_t sw) const
Find a TGWindow via its handle. If window is not found return 0.
Definition: TGClient.cxx:593
UInt_t fStyle
Definition: TGClient.h:76