TRootBrowser.h

Go to the documentation of this file.

// @(#)root/gui:$Id: 7cf312b9bc9940a03d7c0cee95eea0085dc9898c $
// Author: Bertrand Bellenot   26/09/2007
 
/*************************************************************************
 * Copyright (C) 1995-2021, 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_TRootBrowser
#define ROOT_TRootBrowser
 
#include "TGFrame.h"
 
#include "TBrowserImp.h"
 
class TGLayoutHints;
class TGTab;
class TGMenuBar;
class TGPopupMenu;
class TGStatusBar;
class TGVSplitter;
class TGHSplitter;
 
 
/** \class TBrowserPlugin
    \ingroup guiwidgets
 
Helper class used to manage plugins (command or macro to be executed).
*/
 
 
class TBrowserPlugin : public TNamed
{
public:
   Int_t    fTab{0};             ///< Tab number
   Int_t    fSubTab{0};          ///< Tab element number
   TString  fCommand;            ///< Command to be executed
 
   TBrowserPlugin(const char *name, const char *cmd = "", Int_t tab = 1,
                  Int_t sub = -1) : TNamed(name, cmd), fTab(tab),
      fSubTab(sub), fCommand(cmd) { }
   ~TBrowserPlugin() override {}
 
   void     SetTab(Int_t tab) { fTab = tab; }
   void     SetSubTab(Int_t sub) { fSubTab = sub; }
   void     SetCommand(const char *cmd) { fCommand = cmd; }
 
   ClassDefOverride(TBrowserPlugin, 0)  // basic plugin description class
};
 
class TRootBrowser : public TGMainFrame, public TBrowserImp {
   TRootBrowser(const TRootBrowser&) = delete;
   TRootBrowser& operator=(const TRootBrowser&) = delete;
 
protected:
 
   TGLayoutHints     *fLH0, *fLH1, *fLH2, *fLH3;   ///< Layout hints, part 1
   TGLayoutHints     *fLH4, *fLH5, *fLH6, *fLH7;   ///< Layout hints, part 2
   TGTab             *fTabLeft;                    ///< Left Tab
   TGTab             *fTabRight;                   ///< Right Tab
   TGTab             *fTabBottom;                  ///< Bottom Tab
   TGTab             *fEditTab;                    ///< Tab in "Edit" mode
   Int_t              fEditPos;                    ///< Id of tab in "Edit" mode
   Int_t              fEditSubPos;                 ///< Id of subtab in "Edit" mode
   TGVerticalFrame   *fVf;                         ///< Vertical frame
   TGHorizontalFrame *fHf;                         ///< Horizontal frame
   TGHorizontalFrame *fH1;                         ///< Horizontal frame
   TGHorizontalFrame *fH2;                         ///< Horizontal frame
   TGVerticalFrame   *fV1;                         ///< Vertical frame
   TGVerticalFrame   *fV2;                         ///< Vertical frame
   TGVSplitter       *fVSplitter;                  ///< Vertical splitter
   TGHSplitter       *fHSplitter;                  ///< Horizontal splitter
   TGCompositeFrame  *fEditFrame;                  ///< Frame in "Edit" mode
   TGHorizontalFrame *fTopMenuFrame;               ///< Top menu frame
   TGHorizontalFrame *fPreMenuFrame;               ///< First (owned) menu frame
   TGHorizontalFrame *fMenuFrame;                  ///< Shared menu frame
   TGHorizontalFrame *fToolbarFrame;               ///< Toolbar frame
   TGMenuBar         *fMenuBar;                    ///< Main (owned) menu bar
   TGPopupMenu       *fMenuFile;                   ///< "File" popup menu
   TGPopupMenu       *fMenuExecPlugin;             ///< "Exec Plugin" popup menu
   TGPopupMenu       *fMenuHelp;                   ///< "Browser Help" popup menu
   TGCompositeFrame  *fActMenuBar;                 ///< Actual (active) menu bar
   TBrowserImp       *fActBrowser;                 ///< Actual (active) browser imp
   TList              fBrowsers;                   ///< List of (sub)browsers
   TList              fPlugins;                    ///< List of plugins
   TGStatusBar       *fStatusBar;                  ///< Status bar
   Int_t              fNbInitPlugins;              ///< Number of initial plugins (from .rootrc)
   Int_t              fNbTab[3];                   ///< Number of tab elements (for each Tab)
   Int_t              fCrTab[3];                   ///< Actual (active) tab elements (for each Tab)
   Int_t              fPid;                        ///< Current process id
   Bool_t             fShowCloseTab;               ///< kTRUE to show close icon on tab elements
   const TGPicture   *fIconPic;                    ///< icon picture
 
public:
   enum ENewBrowserMessages {
      kBrowse = 11011,
      kOpenFile,
      kClone,
      kHelpAbout,
      kHelpOnBrowser,
      kHelpOnCanvas,
      kHelpOnMenus,
      kHelpOnGraphicsEd,
      kHelpOnObjects,
      kHelpOnPS,
      kHelpOnRemote,
      kNewEditor,
      kNewCanvas,
      kNewHtml,
      kExecPluginMacro,
      kExecPluginCmd,
      kCloseTab,
      kCloseWindow,
      kQuitRoot
   };
 
   enum EInsertPosition {
      kLeft, kRight, kBottom
   };
 
   TRootBrowser(TBrowser *b = nullptr, const char *name = "ROOT Browser", UInt_t width = 800, UInt_t height = 500, Option_t *opt = "", Bool_t initshow = kTRUE);
   TRootBrowser(TBrowser *b, const char *name, Int_t x, Int_t y, UInt_t width, UInt_t height, Option_t *opt = "", Bool_t initshow = kTRUE);
   ~TRootBrowser() override;
 
   void              InitPlugins(Option_t *opt="");
 
   void              CreateBrowser(const char *name);
   void              CloneBrowser();
   void              CloseWindow() override;
   virtual void      CloseTab(Int_t id);
   void              CloseTabs() override;
   void              DoTab(Int_t id);
   void              EventInfo(Int_t event, Int_t px, Int_t py, TObject *selected);
   TGFrame          *GetActFrame() const { return (TGFrame *)fEditFrame; }
   TGFrame          *GetToolbarFrame() const { return (TGFrame *)fToolbarFrame; }
   TGStatusBar      *GetStatusBar() const { return fStatusBar; }
   TGTab            *GetTabLeft() const { return fTabLeft; }
   TGTab            *GetTabRight() const { return fTabRight; }
   TGTab            *GetTabBottom() const { return fTabBottom; }
   TGTab            *GetTab(Int_t pos) const;
   void              SetTab(Int_t pos = kRight, Int_t subpos = -1);
   void              SetTabTitle(const char *title, Int_t pos = kRight, Int_t subpos = -1);
   void              HandleMenu(Int_t id);
   void              RecursiveReparent(TGPopupMenu *popup);
   void              RemoveTab(Int_t pos, Int_t subpos);
   TBrowserImp      *GetActBrowser() const { return fActBrowser; }
   void              SetActBrowser(TBrowserImp *b) { fActBrowser = b; }
   void              ShowMenu(TGCompositeFrame *menu);
   void              StartEmbedding(Int_t pos = kRight, Int_t subpos = -1) override;
   void              StopEmbedding(const char *name = nullptr) override { StopEmbedding(name, nullptr); }
   void              StopEmbedding(const char *name, TGLayoutHints *layout);
   void              SwitchMenus(TGCompositeFrame *from);
 
   void              BrowseObj(TObject *obj) override;             //*SIGNAL*
   void              ExecuteDefaultAction(TObject *obj) override;  //*SIGNAL*
   virtual void      DoubleClicked(TObject *obj);         //*SIGNAL*
   virtual void      Checked(TObject *obj, Bool_t check); //*SIGNAL*
 
   void              Add(TObject *obj, const char *name = nullptr, Int_t check = -1) override;
   void              RecursiveRemove(TObject *obj) override;
   void              Refresh(Bool_t force = kFALSE) override;
   void              Show() override { MapRaised(); }
   Option_t         *GetDrawOption() const override;
   TGMainFrame      *GetMainFrame() const override { return (TGMainFrame *)this; }
 
   Longptr_t         ExecPlugin(const char *name = nullptr, const char *fname = nullptr,
                                const char *cmd = nullptr, Int_t pos = kRight,
                                Int_t subpos = -1) override;
   void              SetStatusText(const char *txt, Int_t col) override;
   Bool_t            HandleKey(Event_t *event) override;
 
   virtual void      ShowCloseTab(Bool_t show) { fShowCloseTab = show; }
   virtual Bool_t    IsCloseTabShown() const { return fShowCloseTab; }
   Bool_t            IsWebGUI();
 
   // overridden from TGMainFrame
   void              ReallyDelete() override;
 
   static TBrowserImp *NewBrowser(TBrowser *b = nullptr, const char *title = "ROOT Browser", UInt_t width = 800, UInt_t height = 500, Option_t *opt = "");
   static TBrowserImp *NewBrowser(TBrowser *b, const char *title, Int_t x, Int_t y, UInt_t width, UInt_t height, Option_t *opt = "");
 
   ClassDefOverride(TRootBrowser, 0) // New ROOT Browser
};
 
#endif