TBrowser.h

Go to the documentation of this file.

// @(#)root/base:$Id$
// Author: Fons Rademakers   25/10/95
 
/*************************************************************************
 * 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_TBrowser
#define ROOT_TBrowser
 
//////////////////////////////////////////////////////////////////////////
//                                                                      //
// TBrowser                                                             //
//                                                                      //
// Using a TBrowser on can browse all ROOT objects. It shows in a list  //
// on the left side of the window all browsable ROOT classes. Selecting //
// one of the classes displays, in the iconbox on the right side, all   //
// objects in the class. Selecting one of the objects in the iconbox,   //
// will place all browsable objects in a new list and draws the         //
// contents of the selected class in the iconbox. And so on....         //
//                                                                      //
//////////////////////////////////////////////////////////////////////////
 
#include "TNamed.h"
#include "TBrowserImp.h"
 
 
class TContextMenu;
class TBrowserTimer;
 
 
class TBrowser : public TNamed {
 
private:
   TObject       *fLastSelectedObject{nullptr}; //!The last TObject selected by user
 
   TBrowser(const TBrowser&) = delete;             // TBrowser can not be copied since we do not know the type of the TBrowserImp (and it can not be 'Cloned')
   TBrowser& operator=(const TBrowser&) = delete;  // TBrowser can not be copied since we do not know the type of the TBrowserImp (and it can not be 'Cloned')
 
protected:
   TBrowserImp   *fImp{nullptr};                //!Window system specific browser implementation
   TBrowserTimer *fTimer{nullptr};              //!Browser's timer
   TContextMenu  *fContextMenu{nullptr};        //!Context menu pointer
   Bool_t         fNeedRefresh{kFALSE};         //True if the browser needs refresh
 
   Bool_t         InitGraphics();
 
public:
   enum EStatusBits {
      kNoHidden     = BIT(9)   // don't show '.' files and directories
   };
 
   TBrowser(const char *name="Browser", const char *title = "ROOT Object Browser", TBrowserImp *extimp = nullptr, Option_t *opt = "");
   TBrowser(const char *name, const char *title, UInt_t width, UInt_t height, TBrowserImp *extimp = nullptr, Option_t *opt = "");
   TBrowser(const char *name, const char *title, Int_t x, Int_t y, UInt_t width, UInt_t height, TBrowserImp *extimp = nullptr, Option_t *opt = "");
 
   TBrowser(const char *name, TObject *obj, const char *title="ROOT Object Browser", Option_t *opt="");
   TBrowser(const char *name, TObject *obj, const char *title, UInt_t width, UInt_t height, Option_t *opt="");
   TBrowser(const char *name, TObject *obj, const char *title, Int_t x, Int_t y, UInt_t width, UInt_t height, Option_t *opt="");
 
   TBrowser(const char *name, void *obj, TClass *cl, const char *objname="", const char *title="ROOT Foreign Browser", Option_t *opt="");
   TBrowser(const char *name, void *obj, TClass *cl, const char *objname, const char *title, UInt_t width, UInt_t height, Option_t *opt="");
   TBrowser(const char *name, void *obj, TClass *cl, const char *objname, const char *title, Int_t x, Int_t y, UInt_t width, UInt_t height, Option_t *opt="");
 
   // In a world with only standard C++ compliant compilers, we could also add:
   // template <class T>  TBrowser(const char *name, T *obj, const char *objname="", const char *title="ROOT Foreign Browser") :
   //       : TNamed(name, title), fLastSelectedObject(0), fTimer(0), fContextMenu(0),
   //            fNeedRefresh(kFALSE)
   // {
   //    Create a new browser with a name, title, width and height for TObject *obj.
   //
   //    fImp = gGuiFactory->CreateBrowserImp(this, title, width, height);
   //    Create(new TBrowserObject(obj,gROOT->GetClass(typeid(T)),objname));
   // }
 
   virtual ~TBrowser();
 
   void          Add(TObject *obj,             const char *name = nullptr, Int_t check = -1);
   void          Add(void    *obj, TClass *cl, const char *name = nullptr, Int_t check = -1);
 
   void          AddCheckBox(TObject *obj, Bool_t check = kFALSE);
   void          CheckObjectItem(TObject *obj, Bool_t check = kFALSE);
   void          RemoveCheckBox(TObject *obj);
 
   virtual void  Create(TObject *obj = nullptr);      // Create this Browser
   virtual void  Destructor();
   void          BrowseObject(TObject *obj)    { if (fImp) fImp->BrowseObj(obj); }
   void          ExecuteDefaultAction(TObject *obj);
   TBrowserImp  *GetBrowserImp() const         { return fImp; }
   void          SetBrowserImp(TBrowserImp *i) { fImp = i; }
   TContextMenu *GetContextMenu() const        { return fContextMenu; }
   Bool_t        GetRefreshFlag() const        { return fNeedRefresh; }
   TObject      *GetSelected() const           { return fLastSelectedObject; }
   void          SetRefreshFlag(Bool_t flag)   { fNeedRefresh = flag; }
   void          Iconify()                     { if (fImp) fImp->Iconify(); }
   void          RecursiveRemove(TObject *obj) override;
   void          Refresh();
   void          SetSelected(TObject *clickedObject);
   void          Show()                        { if (fImp) fImp->Show(); }
   void          SetDrawOption(Option_t *option="") override { if (fImp) fImp->SetDrawOption(option); }
   Option_t     *GetDrawOption() const override { return  (fImp) ? fImp->GetDrawOption() : nullptr; }
 
   Longptr_t     ExecPlugin(const char *name = nullptr, const char *fname = nullptr,
                            const char *cmd = nullptr, Int_t pos = 1, Int_t subpos = -1) {
                    return (fImp) ? fImp->ExecPlugin(name, fname, cmd, pos, subpos) : -1;
                 }
   void          SetStatusText(const char *txt, Int_t col) {
                    if (fImp) fImp->SetStatusText(txt, col);
                 }
   void          StartEmbedding(Int_t pos, Int_t subpos) {
                    if (fImp) fImp->StartEmbedding(pos, subpos);
                 }
   void          StopEmbedding(const char *name = "") { if (fImp) fImp->StopEmbedding(name); }
 
   ClassDefOverride(TBrowser,0)  //ROOT Object Browser
};
 
#endif