/usr/include/root/TGListTree.h is in libroot-gui-dev 5.34.30-0ubuntu8.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 | // @(#)root/gui:$Id$
// Author: Fons Rademakers 25/02/98
/*************************************************************************
* Copyright (C) 1995-2000, Rene Brun and Fons Rademakers. *
* All rights reserved. *
* *
* For the licensing terms see $ROOTSYS/LICENSE. *
* For the list of contributors see $ROOTSYS/README/CREDITS. *
*************************************************************************/
#ifndef ROOT_TGListTree
#define ROOT_TGListTree
//////////////////////////////////////////////////////////////////////////
// //
// TGListTree and TGListTreeItem //
// //
// A list tree is a widget that can contain a number of items //
// arranged in a tree structure. The items are represented by small //
// folder icons that can be either open or closed. //
// //
// The TGListTree is user callable. The TGListTreeItem is a service //
// class of the list tree. //
// //
// A list tree can generate the following events: //
// kC_LISTTREE, kCT_ITEMCLICK, which button, location (y<<16|x). //
// kC_LISTTREE, kCT_ITEMDBLCLICK, which button, location (y<<16|x). //
// //
//////////////////////////////////////////////////////////////////////////
#ifndef ROOT_TGCanvas
#include "TGCanvas.h"
#endif
#ifndef ROOT_TGWidget
#include "TGWidget.h"
#endif
#ifndef ROOT_TDNDManager
#include "TGDNDManager.h"
#endif
class TGPicture;
class TGToolTip;
class TGCanvas;
class TList;
class TBufferFile;
class TGListTreeItem
{
friend class TGListTree;
private:
TGListTreeItem(const TGListTreeItem&); // not implemented
TGListTreeItem& operator=(const TGListTreeItem&); // not implemented
protected:
TGClient *fClient; // pointer to TGClient
TGListTreeItem *fParent; // pointer to parent
TGListTreeItem *fFirstchild; // pointer to first child item
TGListTreeItem *fLastchild; // pointer to last child item
TGListTreeItem *fPrevsibling; // pointer to previous sibling
TGListTreeItem *fNextsibling; // pointer to next sibling
Bool_t fOpen; // true if item is open
Int_t fDNDState; // EDNDFlags
// State managed by TGListTree during drawing.
Int_t fY; // y position of item
Int_t fXtext; // x position of item text
Int_t fYtext; // y position of item text
UInt_t fHeight; // item height
public:
TGListTreeItem(TGClient *client=gClient);
virtual ~TGListTreeItem() {}
TGListTreeItem *GetParent() const { return fParent; }
TGListTreeItem *GetFirstChild() const { return fFirstchild; }
TGListTreeItem *GetLastChild() const { return fLastchild; }
TGListTreeItem *GetPrevSibling() const { return fPrevsibling; }
TGListTreeItem *GetNextSibling() const { return fNextsibling; }
virtual Bool_t IsOpen() const { return fOpen; }
virtual void SetOpen(Bool_t o) { fOpen = o; }
virtual Bool_t IsActive() const = 0;
virtual Pixel_t GetActiveColor() const = 0;
virtual void SetActive(Bool_t) {}
void Rename(const char* new_name) { SetText(new_name); }
virtual const char *GetText() const = 0;
virtual Int_t GetTextLength() const = 0;
virtual const char *GetTipText() const = 0;
virtual Int_t GetTipTextLength() const = 0;
virtual void SetText(const char *) {}
virtual void SetTipText(const char *) {}
virtual void SetUserData(void *, Bool_t=kFALSE) {}
virtual void *GetUserData() const = 0;
virtual const TGPicture*GetPicture() const = 0;
virtual void SetPictures(const TGPicture*, const TGPicture*) {}
virtual const TGPicture*GetCheckBoxPicture() const = 0;
virtual void SetCheckBoxPictures(const TGPicture*, const TGPicture*) {}
virtual UInt_t GetPicWidth() const;
virtual void SetCheckBox(Bool_t=kTRUE) {}
virtual Bool_t HasCheckBox() const = 0;
virtual void CheckItem(Bool_t=kTRUE) = 0;
virtual void Toggle() { SetCheckBox( ! IsChecked()); }
virtual Bool_t IsChecked() const = 0;
// Propagation of checked-state form children to parents.
virtual void CheckAllChildren(Bool_t=kTRUE) {}
virtual void CheckChildren(TGListTreeItem*, Bool_t) {}
virtual Bool_t HasCheckedChild(Bool_t=kFALSE) { return kTRUE; } // !!!!
virtual Bool_t HasUnCheckedChild(Bool_t=kFALSE) { return kTRUE; } // !!!!
virtual void UpdateState() {}
// Item coloration (underline + minibox)
virtual Bool_t HasColor() const = 0;
virtual Color_t GetColor() const = 0;
virtual void SetColor(Color_t) {}
virtual void ClearColor() {}
// Drag and drop.
void SetDNDSource(Bool_t onoff)
{ if (onoff) fDNDState |= kIsDNDSource; else fDNDState &= ~kIsDNDSource; }
void SetDNDTarget(Bool_t onoff)
{ if (onoff) fDNDState |= kIsDNDTarget; else fDNDState &= ~kIsDNDTarget; }
Bool_t IsDNDSource() const { return fDNDState & kIsDNDSource; }
Bool_t IsDNDTarget() const { return fDNDState & kIsDNDTarget; }
// Allow handling by the items themselves ... NOT USED in TGListTree yet !!!!
virtual Bool_t HandlesDragAndDrop() const { return kFALSE; }
virtual void HandleDrag() {}
virtual void HandleDrop() {}
virtual void SavePrimitive(ostream&, Option_t*, Int_t) {}
ClassDef(TGListTreeItem,0) // Abstract base-class for items that go into a TGListTree container.
};
class TGListTreeItemStd : public TGListTreeItem
{
private:
Bool_t fActive; // true if item is active
Bool_t fCheckBox; // true if checkbox is visible
Bool_t fChecked; // true if item is checked
Bool_t fOwnsData; // true if user data has to be deleted
TString fText; // item text
TString fTipText; // tooltip text
const TGPicture *fOpenPic; // icon for open state
const TGPicture *fClosedPic; // icon for closed state
const TGPicture *fCheckedPic; // icon for checked item
const TGPicture *fUncheckedPic; // icon for unchecked item
void *fUserData; // pointer to user data structure
Bool_t fHasColor; // true if item has assigned color
Color_t fColor; // item's color
TGListTreeItemStd(const TGListTreeItemStd&); // not implemented
TGListTreeItemStd& operator=(const TGListTreeItemStd&); // not implemented
public:
TGListTreeItemStd(TGClient *fClient = gClient, const char *name = 0,
const TGPicture *opened = 0, const TGPicture *closed = 0,
Bool_t checkbox = kFALSE);
virtual ~TGListTreeItemStd();
virtual Pixel_t GetActiveColor() const;
virtual Bool_t IsActive() const { return fActive; }
virtual void SetActive(Bool_t a) { fActive = a; }
virtual const char *GetText() const { return fText.Data(); }
virtual Int_t GetTextLength() const { return fText.Length(); }
virtual const char *GetTipText() const { return fTipText.Data(); }
virtual Int_t GetTipTextLength() const { return fTipText.Length(); }
virtual void SetText(const char *text) { fText = text; }
virtual void SetTipText(const char *tip) { fTipText = tip; }
virtual void SetUserData(void *userData, Bool_t own=kFALSE) { fUserData = userData; fOwnsData=own; }
virtual void *GetUserData() const { return fUserData; }
virtual const TGPicture*GetPicture() const { return fOpen ? fOpenPic : fClosedPic; }
virtual const TGPicture*GetCheckBoxPicture() const { return fCheckBox ? (fChecked ? fCheckedPic : fUncheckedPic) : 0; }
virtual void SetPictures(const TGPicture *opened, const TGPicture *closed);
virtual void SetCheckBoxPictures(const TGPicture *checked, const TGPicture *unchecked);
virtual void SetCheckBox(Bool_t on = kTRUE);
virtual Bool_t HasCheckBox() const { return fCheckBox; }
virtual void CheckItem(Bool_t checked = kTRUE) { fChecked = checked; }
virtual void Toggle() { fChecked = !fChecked; }
virtual Bool_t IsChecked() const { return fChecked; }
virtual void CheckAllChildren(Bool_t state = kTRUE);
virtual void CheckChildren(TGListTreeItem *item, Bool_t state);
virtual Bool_t HasCheckedChild(Bool_t first=kFALSE);
virtual Bool_t HasUnCheckedChild(Bool_t first=kFALSE);
virtual void UpdateState();
virtual Bool_t HasColor() const { return fHasColor; }
virtual Color_t GetColor() const { return fColor; }
virtual void SetColor(Color_t color) { fHasColor = true;fColor = color; }
virtual void ClearColor() { fHasColor = false; }
virtual void SavePrimitive(ostream &out, Option_t *option, Int_t n);
ClassDef(TGListTreeItemStd,0) //Item that goes into a TGListTree container
};
class TGListTree : public TGContainer {
public:
//---- color markup mode of tree items
enum EColorMarkupMode {
kDefault = 0,
kColorUnderline = BIT(0),
kColorBox = BIT(1)
};
enum ECheckMode {
kSimple = BIT(2),
kRecursive = BIT(3)
};
protected:
TGListTreeItem *fFirst; // pointer to first item in list
TGListTreeItem *fLast; // pointer to last item in list
TGListTreeItem *fSelected; // pointer to selected item in list
TGListTreeItem *fCurrent; // pointer to current item in list
TGListTreeItem *fBelowMouse; // pointer to item below mouses cursor
Int_t fHspacing; // horizontal spacing between items
Int_t fVspacing; // vertical spacing between items
Int_t fIndent; // number of pixels indentation
Int_t fMargin; // number of pixels margin from left side
Pixel_t fGrayPixel; // gray draw color
GContext_t fActiveGC; // activated (selected) drawing context
GContext_t fDrawGC; // icon drawing context
GContext_t fLineGC; // dashed line drawing context
GContext_t fHighlightGC; // highlighted icon drawing context
FontStruct_t fFont; // font used to draw item text
UInt_t fDefw; // default list width
UInt_t fDefh; // default list height
Int_t fExposeTop; // top y postion of visible region
Int_t fExposeBottom; // bottom y position of visible region
TGToolTip *fTip; // tooltip shown when moving over list items
TGListTreeItem *fTipItem; // item for which tooltip is set
TBufferFile *fBuf; // buffer used for Drag and Drop
TDNDData fDNDData; // Drag and Drop data
Atom_t *fDNDTypeList; // handles DND types
TGListTreeItem *fDropItem; // item on which DND is over
Bool_t fAutoTips; // assume item->fUserData is TObject and use GetTitle() for tip text
Bool_t fAutoCheckBoxPic;// change check box picture if parent and children have diffrent state
Bool_t fDisableOpen; // disable branch opening on double-clicks
Bool_t fUserControlled; // let user decides what is the behaviour on events
Bool_t fEventHandled; // flag used from user code to bypass standard event handling
UInt_t fLastEventState; // modifier state of the last keyboard event
EColorMarkupMode fColorMode; // if/how to render item's main color
ECheckMode fCheckMode; // how to propagate check properties through the tree
GContext_t fColorGC; // drawing context for main item color
static Pixel_t fgGrayPixel;
static const TGFont *fgDefaultFont;
static TGGC *fgActiveGC;
static TGGC *fgDrawGC;
static TGGC *fgLineGC;
static TGGC *fgHighlightGC;
static TGGC *fgColorGC;
static const TGPicture *fgOpenPic; // icon for open item
static const TGPicture *fgClosedPic; // icon for closed item
static const TGPicture *fgCheckedPic; // icon for checked item
static const TGPicture *fgUncheckedPic; // icon for unchecked item
static Pixel_t GetGrayPixel();
static FontStruct_t GetDefaultFontStruct();
static const TGGC &GetActiveGC();
static const TGGC &GetDrawGC();
static const TGGC &GetLineGC();
static const TGGC &GetHighlightGC();
static const TGGC &GetColorGC();
void Draw(Handle_t id, Int_t yevent, Int_t hevent);
void Draw(Option_t * ="") { MayNotUse("Draw(Option_t*)"); }
Int_t DrawChildren(Handle_t id, TGListTreeItem *item, Int_t x, Int_t y, Int_t xroot);
void DrawItem(Handle_t id, TGListTreeItem *item, Int_t x, Int_t y, Int_t *xroot,
UInt_t *retwidth, UInt_t *retheight);
void DrawItemName(Handle_t id, TGListTreeItem *item);
void DrawNode(Handle_t id, TGListTreeItem *item, Int_t x, Int_t y);
virtual void UpdateChecked(TGListTreeItem *item, Bool_t redraw = kFALSE);
void SaveChildren(ostream &out, TGListTreeItem *item, Int_t &n);
void RemoveReference(TGListTreeItem *item);
void PDeleteItem(TGListTreeItem *item);
void PDeleteChildren(TGListTreeItem *item);
void InsertChild(TGListTreeItem *parent, TGListTreeItem *item);
void InsertChildren(TGListTreeItem *parent, TGListTreeItem *item);
Int_t SearchChildren(TGListTreeItem *item, Int_t y, Int_t findy,
TGListTreeItem **finditem);
TGListTreeItem *FindItem(Int_t findy);
void *FindItem(const TString& name,
Bool_t direction = kTRUE,
Bool_t caseSensitive = kTRUE,
Bool_t beginWith = kFALSE)
{ return TGContainer::FindItem(name, direction, caseSensitive, beginWith); }
virtual void Layout() {}
void OnMouseOver(TGFrame*) { }
void CurrentChanged(Int_t /*x*/, Int_t /*y*/) { }
void CurrentChanged(TGFrame *) { }
void ReturnPressed(TGFrame*) { }
void Clicked(TGFrame *, Int_t /*btn*/) { }
void Clicked(TGFrame *, Int_t /*btn*/, Int_t /*x*/, Int_t /*y*/) { }
void DoubleClicked(TGFrame *, Int_t /*btn*/) { }
void DoubleClicked(TGFrame *, Int_t /*btn*/, Int_t /*x*/, Int_t /*y*/) { }
void KeyPressed(TGFrame *, UInt_t /*keysym*/, UInt_t /*mask*/) { }
private:
TGListTree(const TGListTree&); // not implemented
TGListTree& operator=(const TGListTree&); // not implemented
public:
TGListTree(TGWindow *p = 0, UInt_t w = 1, UInt_t h = 1,
UInt_t options = 0, Pixel_t back = GetWhitePixel());
TGListTree(TGCanvas *p, UInt_t options, Pixel_t back = GetWhitePixel());
virtual ~TGListTree();
virtual Bool_t HandleButton(Event_t *event);
virtual Bool_t HandleDoubleClick(Event_t *event);
virtual Bool_t HandleCrossing(Event_t *event);
virtual Bool_t HandleMotion(Event_t *event);
virtual Bool_t HandleKey(Event_t *event);
virtual void SetCanvas(TGCanvas *canvas) { fCanvas = canvas; }
virtual void DrawRegion(Int_t x, Int_t y, UInt_t w, UInt_t h);
virtual void DrawOutline(Handle_t id, TGListTreeItem *item, Pixel_t col=0xbbbbbb,
Bool_t clear=kFALSE);
virtual void DrawActive(Handle_t id, TGListTreeItem *item);
virtual TGDimension GetDefaultSize() const
{ return TGDimension(fDefw, fDefh); }
void AddItem(TGListTreeItem *parent, TGListTreeItem *item);
TGListTreeItem *AddItem(TGListTreeItem *parent, const char *string,
const TGPicture *open = 0,
const TGPicture *closed = 0,
Bool_t checkbox = kFALSE);
TGListTreeItem *AddItem(TGListTreeItem *parent, const char *string,
void *userData, const TGPicture *open = 0,
const TGPicture *closed = 0,
Bool_t checkbox = kFALSE);
void RenameItem(TGListTreeItem *item, const char *string);
Int_t DeleteItem(TGListTreeItem *item);
void OpenItem(TGListTreeItem *item);
void CloseItem(TGListTreeItem *item);
void CheckItem(TGListTreeItem *item, Bool_t check = kTRUE);
void SetCheckBox(TGListTreeItem *item, Bool_t on = kTRUE);
void ToggleItem(TGListTreeItem *item);
Int_t RecursiveDeleteItem(TGListTreeItem *item, void *userData);
Int_t DeleteChildren(TGListTreeItem *item);
Int_t Reparent(TGListTreeItem *item, TGListTreeItem *newparent);
Int_t ReparentChildren(TGListTreeItem *item, TGListTreeItem *newparent);
void SetToolTipItem(TGListTreeItem *item, const char *string);
void SetAutoTips(Bool_t on = kTRUE) { fAutoTips = on; }
void SetAutoCheckBoxPic(Bool_t on) { fAutoCheckBoxPic = on; }
void SetSelected(TGListTreeItem *item) { fSelected = item; }
void AdjustPosition(TGListTreeItem *item);
void AdjustPosition() { TGContainer::AdjustPosition(); }
// overwrite TGContainer's methods
void Home(Bool_t select = kFALSE);
void End(Bool_t select = kFALSE);
void PageUp(Bool_t select = kFALSE);
void PageDown(Bool_t select = kFALSE);
void LineUp(Bool_t select = kFALSE);
void LineDown(Bool_t select = kFALSE);
void Search(Bool_t close = kTRUE);
Int_t Sort(TGListTreeItem *item);
Int_t SortSiblings(TGListTreeItem *item);
Int_t SortChildren(TGListTreeItem *item);
void HighlightItem(TGListTreeItem *item);
void ClearHighlighted();
void GetPathnameFromItem(TGListTreeItem *item, char *path, Int_t depth = 0);
void UnselectAll(Bool_t draw);
void SetToolTipText(const char *text, Int_t x, Int_t y, Long_t delayms);
void HighlightItem(TGListTreeItem *item, Bool_t state, Bool_t draw);
void HighlightChildren(TGListTreeItem *item, Bool_t state, Bool_t draw);
void DisableOpen(Bool_t disable = kTRUE) { fDisableOpen = disable;}
void GetChecked(TList *checked);
void GetCheckedChildren(TList *checked, TGListTreeItem *item);
void CheckAllChildren(TGListTreeItem *item, Bool_t state);
TGListTreeItem *GetFirstItem() const { return fFirst; }
TGListTreeItem *GetSelected() const { return fSelected; }
TGListTreeItem *GetCurrent() const { return fCurrent; }
TGListTreeItem *GetBelowMouse() const { return fBelowMouse; }
TGListTreeItem *FindSiblingByName(TGListTreeItem *item, const char *name);
TGListTreeItem *FindSiblingByData(TGListTreeItem *item, void *userData);
TGListTreeItem *FindChildByName(TGListTreeItem *item, const char *name);
TGListTreeItem *FindChildByData(TGListTreeItem *item, void *userData);
TGListTreeItem *FindItemByPathname(const char *path);
TGListTreeItem *FindItemByObj(TGListTreeItem *item, void *ptr);
void AddItem(const char *string) { AddItem(fSelected, string); } //*MENU*
void AddRoot(const char *string) { AddItem(0, string); } //*MENU*
Int_t DeleteSelected() { return (fSelected ? DeleteItem(fSelected) : 0); } //*MENU*
void RenameSelected(const char *string) { if (fSelected) RenameItem(fSelected, string); } //*MENU*
virtual void MouseOver(TGListTreeItem *entry); //*SIGNAL*
virtual void MouseOver(TGListTreeItem *entry, UInt_t mask); //*SIGNAL*
virtual void KeyPressed(TGListTreeItem *entry, UInt_t keysym, UInt_t mask); //*SIGNAL*
virtual void ReturnPressed(TGListTreeItem *entry); //*SIGNAL*
virtual void Clicked(TGListTreeItem *entry, Int_t btn); //*SIGNAL*
virtual void Clicked(TGListTreeItem *entry, Int_t btn, Int_t x, Int_t y); //*SIGNAL*
virtual void Clicked(TGListTreeItem *entry, Int_t btn, UInt_t mask, Int_t x, Int_t y); //*SIGNAL*
virtual void DoubleClicked(TGListTreeItem *entry, Int_t btn); //*SIGNAL*
virtual void DoubleClicked(TGListTreeItem *entry, Int_t btn, Int_t x, Int_t y); //*SIGNAL*
virtual void Checked(TObject *obj, Bool_t check); //*SIGNAL*
virtual void DataDropped(TGListTreeItem *item, TDNDData *data); //*SIGNAL*
// Utility functions
Int_t FontHeight();
Int_t FontAscent();
Int_t TextWidth(const char *c);
static const TGPicture *GetOpenPic();
static const TGPicture *GetClosedPic();
static const TGPicture *GetCheckedPic();
static const TGPicture *GetUncheckedPic();
// User control
void SetUserControl(Bool_t ctrl=kTRUE) { fUserControlled = ctrl; }
Bool_t HasUserControl() const { return fUserControlled; }
void SetEventHandled(Bool_t eh=kTRUE) { fEventHandled = eh; }
Bool_t IsEventHandled() const { return fEventHandled; }
Bool_t HandleDNDDrop(TDNDData *data);
Atom_t HandleDNDPosition(Int_t x, Int_t y, Atom_t action,
Int_t xroot, Int_t yroot);
Atom_t HandleDNDEnter(Atom_t * typelist);
Bool_t HandleDNDLeave();
virtual TDNDData *GetDNDData(Atom_t) {
return &fDNDData;
}
EColorMarkupMode GetColorMode() const { return fColorMode; }
void SetColorMode(EColorMarkupMode colorMode) { fColorMode = colorMode; }
ECheckMode GetCheckMode() const { return fCheckMode; }
void SetCheckMode(ECheckMode mode) { fCheckMode = mode; }
virtual void SavePrimitive(ostream &out, Option_t *option = "");
ClassDef(TGListTree,0) //Show items in a tree structured list
};
#endif
|