GuiTree.h

Go to the documentation of this file.

//
// $Id: GuiTree.h,v 1.9 2008/03/09 10:41:08 rhatcher Exp $
//
// GuiTree
//
// Package: MIDAD
//
// Wraps a TGListTree
//
// Contact: bv@bnl.gov
//
// Created on: Fri Mar 15 10:43:15 2002
//

#ifndef GUITREE_H
#define GUITREE_H

#include <Midad/Gui/GuiBase.h>
#include <TGListTree.h>

// A class to encapsulate information about an entry in the tree as
// well as provide a clicked signal.  This is created and memory
// managed by the underlying TGListTree.  The only real reason to wrap
// it is to provide the signal.  When using methods from the base
// class, you should be able to dynamic_cast<GuiTreeEntry*> any
// returned TGListTreeItem (eg, parent, sibling, etc) in order to get
// at the Signal.  Same goes for methods of TGListTree which return
// items.
#if ROOT_VERSION_CODE >= ROOT_VERSION(5,19,01)
class GuiTreeEntry : public TGListTreeItemStd {
#else
class GuiTreeEntry : public TGListTreeItem {
#endif


public:

    SigC::Signal0<void> clicked, on_mouse_over;

    ~GuiTreeEntry();
    
private:
    friend class GuiTree;
    GuiTreeEntry(TGClient* client, const char* name, 
                 const TGPicture* opened,const TGPicture* closed);

};

class GuiTree : public TGListTree, public GuiBase
{

public:

    GuiTree(TGWindow& parent, UInt_t options = kHorizontalFrame);
    virtual ~GuiTree();

    // parent=0 for top level addition
    GuiTreeEntry* AddEntry(GuiTreeEntry* parent, const char* label);
    
    // override baseclass signal - still calls base signal but also
    // triggers associated GuiTreeEntry's clicked sig.  These also
    // provide some default behavior (ie. DoubleClicked toggles
    // open/closed)
    virtual void Clicked(TGListTreeItem* item, Int_t btn);
    virtual void DoubleClicked(TGListTreeItem* item, Int_t btn);
    virtual void OnMouseOver(TGListTreeItem* entry);

    void DeleteAllItems();

private:

    // copy constructor, assignment:
    GuiTree(const GuiTree& rhs); // copy constructor
    GuiTree& operator=(const GuiTree& rhs); // assignment

    // Don't let user call these since they create TGListTreeItems
    // instead of GuiListEntrys.  Use AddEntry() instead
    TGListTreeItem* AddItem(TGListTreeItem* parent, const char* string,
                            const TGPicture* open = 0, 
                            const TGPicture* closed = 0);
    TGListTreeItem* AddItem(TGListTreeItem* parent, const char* string,
                            void* userData, const TGPicture* open = 0,
                            const TGPicture* closed = 0);

    // ROOT defines this (as empty???).  Do same to avoid warnings:
    void OnMouseOver(TGFrame*) {}
    void Clicked(TGListTreeItem*, int, int, int) {}
    void Clicked(TGFrame*, int, int, int) {}
    void Clicked(TGFrame*, int) {}
#if ROOT_VERSION_CODE >= ROOT_VERSION(5,19,01)
    void Clicked(TGListTreeItem *, Int_t, UInt_t, Int_t, Int_t) {}
#endif
    void DoubleClicked(TGListTreeItem*, int, int, int) {}
    void DoubleClicked(TGFrame*, int, int, int) {}
    void DoubleClicked(TGFrame*, int) {}
};                              // end of class GuiTree

#endif  // GUITREE_H

---