Logo ROOT   6.30.04
Reference Guide
 All Namespaces Files Pages
TGLabel.cxx
Go to the documentation of this file.
1 // @(#)root/gui:$Id$
2 // Author: Fons Rademakers 06/01/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 
13  This source is based on Xclass95, a Win95-looking GUI toolkit.
14  Copyright (C) 1996, 1997 David Barth, Ricky Ralston, Hector Peraza.
15 
16  Xclass95 is free software; you can redistribute it and/or
17  modify it under the terms of the GNU Library General Public
18  License as published by the Free Software Foundation; either
19  version 2 of the License, or (at your option) any later version.
20 
21 **************************************************************************/
22 
23 //////////////////////////////////////////////////////////////////////////
24 // //
25 // TGLabel //
26 // //
27 // This class handles GUI labels. //
28 // //
29 //////////////////////////////////////////////////////////////////////////
30 
31 #include "TGLabel.h"
32 #include "TGString.h"
33 #include "TGWidget.h"
34 #include "TGResourcePool.h"
35 #include "Riostream.h"
36 #include "TColor.h"
37 #include "TClass.h"
38 
39 
40 const TGFont *TGLabel::fgDefaultFont = 0;
41 const TGGC *TGLabel::fgDefaultGC = 0;
42 
43 ClassImp(TGLabel);
44 
45 ////////////////////////////////////////////////////////////////////////////////
46 /// Create a label GUI object. TGLabel will become the owner of the
47 /// text and will delete it in its dtor.
48 
49 TGLabel::TGLabel(const TGWindow *p, TGString *text, GContext_t norm,
50  FontStruct_t font, UInt_t options, ULong_t back) :
51  TGFrame(p, 1, 1, options, back)
52 {
53  fText = text;
54  fTMode = kTextCenterX | kTextCenterY;
55  fTextChanged = kTRUE;
56  fHasOwnFont = kFALSE;
57  fDisabled = kFALSE;
58  f3DStyle = 0;
59  fWrapLength = -1;
60  fTFlags = 0;
61  fMLeft = fMRight = fMTop = fMBottom = 0;
62 
63  if (!norm) {
64  norm = GetDefaultGC().GetGC();
65  }
66  fNormGC = norm;
67 
68  if (!font) {
69  font = fgDefaultFont->GetFontStruct();
70  }
71 
72  fFont = fClient->GetFontPool()->GetFont(font);
73  fTLayout = fFont->ComputeTextLayout(fText->GetString(), fText->GetLength(),
74  fWrapLength, kTextLeft, fTFlags,
75  &fTWidth, &fTHeight);
76 
77  SetWindowAttributes_t wattr;
78  wattr.fMask = kWAWinGravity | kWABitGravity;
79  wattr.fBitGravity = 5; // center
80  wattr.fWinGravity = 1;
81  gVirtualX->ChangeWindowAttributes(fId, &wattr);
82 
83  Resize();
84  SetWindowName();
85 }
86 
87 ////////////////////////////////////////////////////////////////////////////////
88 /// Create a label GUI object.
89 
90 TGLabel::TGLabel(const TGWindow *p, const char *text, GContext_t norm,
91  FontStruct_t font, UInt_t options, ULong_t back) :
92  TGFrame(p, 1, 1, options, back)
93 {
94  fText = new TGString(!text && !p ? GetName() : text);
95  fTMode = kTextCenterX | kTextCenterY;
96  fTextChanged = kTRUE;
97  fHasOwnFont = kFALSE;
98  fDisabled = kFALSE;
99  f3DStyle = 0;
100  fWrapLength = -1;
101  fTFlags = 0;
102  fMLeft = fMRight = fMTop = fMBottom = 0;
103 
104  if (!norm) {
105  norm = GetDefaultGC().GetGC();
106  }
107  fNormGC = norm;
108 
109  if (!font) {
110  font = fgDefaultFont->GetFontStruct();
111  }
112 
113  fFont = fClient->GetFontPool()->GetFont(font);
114  fTLayout = fFont->ComputeTextLayout(fText->GetString(), fText->GetLength(),
115  fWrapLength, kTextLeft, fTFlags,
116  &fTWidth, &fTHeight);
117 
118  SetWindowAttributes_t wattr;
119  wattr.fMask = kWAWinGravity | kWABitGravity;
120  wattr.fBitGravity = 5; // center
121  wattr.fWinGravity = 1;
122  gVirtualX->ChangeWindowAttributes(fId, &wattr);
123 
124  Resize();
125  SetWindowName();
126 }
127 
128 ////////////////////////////////////////////////////////////////////////////////
129 /// Delete label.
130 
131 TGLabel::~TGLabel()
132 {
133  if (fText) {
134  delete fText;
135  }
136 
137  if (fHasOwnFont) {
138  TGGCPool *pool = fClient->GetGCPool();
139  TGGC *gc = pool->FindGC(fNormGC);
140  if (gc) pool->FreeGC(gc);
141  }
142 
143  if (fFont != fgDefaultFont) {
144  fClient->GetFontPool()->FreeFont(fFont);
145  }
146 
147  delete fTLayout;
148 }
149 
150 ////////////////////////////////////////////////////////////////////////////////
151 /// Layout label.
152 
153 void TGLabel::Layout()
154 {
155  delete fTLayout;
156  fTLayout = fFont->ComputeTextLayout(fText->GetString(), fText->GetLength(),
157  fWrapLength, kTextLeft, fTFlags,
158  &fTWidth, &fTHeight);
159  fClient->NeedRedraw(this);
160 }
161 
162 ////////////////////////////////////////////////////////////////////////////////
163 /// Return default size.
164 
165 TGDimension TGLabel::GetDefaultSize() const
166 {
167  UInt_t w = GetOptions() & kFixedWidth ? fWidth : fTWidth + fMLeft + fMRight;
168  UInt_t h = GetOptions() & kFixedHeight ? fHeight : fTHeight + fMTop + fMBottom + 1;
169  return TGDimension(w, h);
170 }
171 
172 ////////////////////////////////////////////////////////////////////////////////
173 /// Set new text in label. After calling this method one needs to call
174 /// the parents frame's Layout() method to force updating of the label size.
175 /// The new_text is adopted by the TGLabel and will be properly deleted.
176 
177 void TGLabel::SetText(TGString *new_text)
178 {
179  if (fText) delete fText;
180  fText = new_text;
181  fTextChanged = kTRUE;
182 
183  Layout();
184 }
185 
186 ////////////////////////////////////////////////////////////////////////////////
187 /// Draw text at position (x, y).
188 
189 void TGLabel::DrawText(GContext_t gc, Int_t x, Int_t y)
190 {
191  fTLayout->DrawText(fId, gc, x, y, 0, -1);
192  //fTLayout->UnderlineChar(fId, gc, x, y, fText->GetHotPos());
193 }
194 
195 ////////////////////////////////////////////////////////////////////////////////
196 /// Redraw label widget.
197 
198 void TGLabel::DoRedraw()
199 {
200  int x, y;
201 
202  TGFrame::DoRedraw();
203  fTextChanged = kFALSE;
204 
205  if (fTMode & kTextLeft) {
206  x = fMLeft;
207  } else if (fTMode & kTextRight) {
208  x = fWidth - fTWidth - fMRight;
209  } else {
210  x = (fWidth - fTWidth + fMLeft - fMRight) >> 1;
211  }
212 
213  if (fTMode & kTextTop) {
214  y = 0;
215  } else if (fTMode & kTextBottom) {
216  y = fHeight - fTHeight;
217  } else {
218  y = (fHeight - fTHeight) >> 1;
219  }
220 
221 
222  if (!fDisabled) {
223  TGGCPool *pool = fClient->GetResourcePool()->GetGCPool();
224  TGGC *gc = pool->FindGC(fNormGC);
225 
226  if (!gc) {
227  fNormGC = GetDefaultGC().GetGC();
228  gc = pool->FindGC(fNormGC);
229  }
230  if (!gc) return;
231 
232  switch (f3DStyle) {
233  case kRaisedFrame:
234  case kSunkenFrame:
235  {
236  Pixel_t forecolor = gc->GetForeground();
237  Pixel_t hi = TGFrame::GetWhitePixel();
238  Pixel_t sh = forecolor;
239 
240  if (f3DStyle == kRaisedFrame) {
241  Pixel_t t = hi;
242  hi = sh;
243  sh = t;
244  }
245 
246  gc->SetForeground(hi);
247  DrawText(gc->GetGC(), x+1, y+1);
248  gc->SetForeground(sh);
249  DrawText(gc->GetGC(), x, y);
250  gc->SetForeground(forecolor);
251  }
252  break;
253 
254  default:
255  DrawText(fNormGC, x, y);
256  break;
257  }
258  } else { // disabled
259  FontH_t fontH;
260 
261  if (GetDefaultFontStruct() != fFont->GetFontStruct()) {
262  fontH = gVirtualX->GetFontHandle(fFont->GetFontStruct());
263  } else {
264  fontH = gVirtualX->GetFontHandle(GetDefaultFontStruct());
265  }
266  static TGGC *gc1 = 0;
267  static TGGC *gc2 = 0;
268 
269  if (!gc1) {
270  gc1 = fClient->GetResourcePool()->GetGCPool()->FindGC(GetHilightGC()());
271  gc1 = new TGGC(*gc1); // copy
272  }
273  gc1->SetFont(fontH);
274  DrawText(gc1->GetGC(), x + 1, y + 1);
275 
276  if (!gc2) {
277  gc2 = fClient->GetResourcePool()->GetGCPool()->FindGC(GetShadowGC()());
278  gc2 = new TGGC(*gc2); // copy
279  }
280  gc2->SetFont(fontH);
281  DrawText(gc2->GetGC(), x, y);
282  }
283 }
284 
285 ////////////////////////////////////////////////////////////////////////////////
286 /// Changes text font.
287 /// If global is true font is changed globally - otherwise locally.
288 
289 void TGLabel::SetTextFont(FontStruct_t fontStruct, Bool_t global)
290 {
291  TGFont *font = fClient->GetFontPool()->GetFont(fontStruct);
292 
293  if (!font) {
294  //error
295  return;
296  }
297 
298  SetTextFont(font, global);
299 }
300 
301 ////////////////////////////////////////////////////////////////////////////////
302 /// Changes text font specified by name.
303 /// If global is true font is changed globally - otherwise locally.
304 
305 void TGLabel::SetTextFont(const char *fontName, Bool_t global)
306 {
307  TGFont *font = fClient->GetFont(fontName);
308 
309  if (!font) {
310  // error
311  return;
312  }
313 
314  SetTextFont(font, global);
315 }
316 
317 ////////////////////////////////////////////////////////////////////////////////
318 /// Changes text font specified by pointer to TGFont object.
319 /// If global is true font is changed globally - otherwise locally.
320 
321 void TGLabel::SetTextFont(TGFont *font, Bool_t global)
322 {
323  if (!font) {
324  //error
325  return;
326  }
327 
328  TGFont *oldfont = fFont;
329  fFont = fClient->GetFont(font); // increase usage count
330  if (!fFont) {
331  fFont = oldfont;
332  return;
333  }
334 
335  TGGCPool *pool = fClient->GetResourcePool()->GetGCPool();
336  TGGC *gc = pool->FindGC(fNormGC);
337 
338  if (!global) {
339  if (gc == &GetDefaultGC() ) { // create new GC
340  gc = pool->GetGC((GCValues_t*)gc->GetAttributes(), kTRUE); // copy ctor.
341  }
342  fHasOwnFont = kTRUE;
343  }
344  if (oldfont != fgDefaultFont) {
345  fClient->FreeFont(oldfont);
346  }
347  if (gc) {
348  gc->SetFont(fFont->GetFontHandle());
349  fNormGC = gc->GetGC();
350  }
351  fTextChanged = kTRUE;
352  Layout();
353 }
354 
355 ////////////////////////////////////////////////////////////////////////////////
356 /// Changes text color.
357 /// If global is true color is changed globally - otherwise locally.
358 
359 void TGLabel::SetTextColor(Pixel_t color, Bool_t global)
360 {
361  TGGCPool *pool = fClient->GetResourcePool()->GetGCPool();
362  TGGC *gc = pool->FindGC(fNormGC);
363 
364  if (!global) {
365  if (gc == &GetDefaultGC() ) {
366  gc = pool->GetGC((GCValues_t*)gc->GetAttributes(), kTRUE); // copy
367  }
368  fHasOwnFont = kTRUE;
369  }
370  if (gc) {
371  gc->SetForeground(color);
372  fNormGC = gc->GetGC();
373  }
374  fClient->NeedRedraw(this);
375 }
376 
377 ////////////////////////////////////////////////////////////////////////////////
378 /// Changes text color.
379 /// If global is true color is changed globally - otherwise locally.
380 
381 void TGLabel::SetTextColor(TColor *color, Bool_t global)
382 {
383  if (color) {
384  SetTextColor(color->GetPixel(), global);
385  }
386 }
387 
388 ////////////////////////////////////////////////////////////////////////////////
389 /// Set text justification. Mode is an OR of the bits:
390 /// kTextTop, kTextBottom, kTextLeft, kTextRight, kTextCenterX and
391 /// kTextCenterY.
392 
393 void TGLabel::SetTextJustify(Int_t mode)
394 {
395  fTextChanged = kTRUE;
396  fTMode = mode;
397 
398  SetWindowAttributes_t wattr;
399  wattr.fMask = kWAWinGravity | kWABitGravity;
400  wattr.fWinGravity = 1;
401 
402  switch (mode) {
403  case kTextTop | kTextLeft:
404  wattr.fBitGravity = 1; //NorthWestGravity
405  break;
406  case kTextTop | kTextCenterX:
407  case kTextTop:
408  wattr.fBitGravity = 2; //NorthGravity
409  break;
410  case kTextTop | kTextRight:
411  wattr.fBitGravity = 3; //NorthEastGravity
412  break;
413  case kTextLeft | kTextCenterY:
414  case kTextLeft:
415  wattr.fBitGravity = 4; //WestGravity
416  break;
417  case kTextCenterY | kTextCenterX:
418  wattr.fBitGravity = 5; //CenterGravity
419  break;
420  case kTextRight | kTextCenterY:
421  case kTextRight:
422  wattr.fBitGravity = 6; //EastGravity
423  break;
424  case kTextBottom | kTextLeft:
425  wattr.fBitGravity = 7; //SouthWestGravity
426  break;
427  case kTextBottom | kTextCenterX:
428  case kTextBottom:
429  wattr.fBitGravity = 8; //SouthGravity
430  break;
431  case kTextBottom | kTextRight:
432  wattr.fBitGravity = 9; //SouthEastGravity
433  break;
434  default:
435  wattr.fBitGravity = 5; //CenterGravity
436  break;
437  }
438 
439  gVirtualX->ChangeWindowAttributes(fId, &wattr);
440 
441  Layout();
442 }
443 
444 ////////////////////////////////////////////////////////////////////////////////
445 /// Returns kTRUE if text attributes are unique.
446 /// Returns kFALSE if text attributes are shared (global).
447 
448 Bool_t TGLabel::HasOwnFont() const
449 {
450  return fHasOwnFont;
451 }
452 
453 ////////////////////////////////////////////////////////////////////////////////
454 /// Save a label widget as a C++ statement(s) on output stream out.
455 
456 void TGLabel::SavePrimitive(std::ostream &out, Option_t *option /*= ""*/)
457 {
458  char quote = '"';
459 
460  // font + GC
461  option = GetName()+5; // unique digit id of the name
462  TString parGC, parFont;
463  parFont.Form("%s::GetDefaultFontStruct()",IsA()->GetName());
464  parGC.Form("%s::GetDefaultGC()()",IsA()->GetName());
465 
466  if ((GetDefaultFontStruct() != fFont->GetFontStruct()) || (GetDefaultGC()() != fNormGC)) {
467  TGFont *ufont = fClient->GetResourcePool()->GetFontPool()->FindFont(fFont->GetFontStruct());
468  if (ufont) {
469  ufont->SavePrimitive(out, option);
470  parFont.Form("ufont->GetFontStruct()");
471  }
472 
473  TGGC *userGC = fClient->GetResourcePool()->GetGCPool()->FindGC(fNormGC);
474  if (userGC) {
475  userGC->SavePrimitive(out, option);
476  parGC.Form("uGC->GetGC()");
477  }
478  }
479 
480  if (fBackground != GetDefaultFrameBackground()) SaveUserColor(out, option);
481 
482  TString label = GetText()->GetString();
483  label.ReplaceAll("\"","\\\"");
484  label.ReplaceAll("\n","\\n");
485 
486  out << " TGLabel *";
487  out << GetName() << " = new TGLabel("<< fParent->GetName()
488  << "," << quote << label << quote;
489  if (fBackground == GetDefaultFrameBackground()) {
490  if (!GetOptions()) {
491  if (fFont->GetFontStruct() == GetDefaultFontStruct()) {
492  if (fNormGC == GetDefaultGC()()) {
493  out <<");" << std::endl;
494  } else {
495  out << "," << parGC.Data() << ");" << std::endl;
496  }
497  } else {
498  out << "," << parGC.Data() << "," << parFont.Data() << ");" << std::endl;
499  }
500  } else {
501  out << "," << parGC.Data() << "," << parFont.Data() << "," << GetOptionString() <<");" << std::endl;
502  }
503  } else {
504  out << "," << parGC.Data() << "," << parFont.Data() << "," << GetOptionString() << ",ucolor);" << std::endl;
505  }
506  if (option && strstr(option, "keep_names"))
507  out << " " << GetName() << "->SetName(\"" << GetName() << "\");" << std::endl;
508 
509  if (fDisabled)
510  out << " " << GetName() << "->Disable();" << std::endl;
511 
512  out << " " << GetName() << "->SetTextJustify(" << GetTextJustify() << ");" << std::endl;
513  out << " " << GetName() << "->SetMargins(" << fMLeft << "," << fMRight << ",";
514  out << fMTop << "," << fMBottom << ");" << std::endl;
515  out << " " << GetName() << "->SetWrapLength(" << fWrapLength << ");" << std::endl;
516 
517 }
518 
519 ////////////////////////////////////////////////////////////////////////////////
520 /// Static returning label default font struct.
521 
522 FontStruct_t TGLabel::GetDefaultFontStruct()
523 {
524  if (!fgDefaultFont) {
525  fgDefaultFont = gClient->GetResourcePool()->GetDefaultFont();
526  }
527  return fgDefaultFont->GetFontStruct();
528 }
529 
530 ////////////////////////////////////////////////////////////////////////////////
531 /// Static returning label default graphics context.
532 
533 const TGGC &TGLabel::GetDefaultGC()
534 {
535  if (!fgDefaultGC) {
536  fgDefaultGC = gClient->GetResourcePool()->GetFrameGC();
537  }
538  return *fgDefaultGC;
539 }