include/Geant4/G4VInteractiveSession.hh

0001 //
0002 // ********************************************************************
0003 // * License and Disclaimer                                           *
0004 // *                                                                  *
0005 // * The  Geant4 software  is  copyright of the Copyright Holders  of *
0006 // * the Geant4 Collaboration.  It is provided  under  the terms  and *
0007 // * conditions of the Geant4 Software License,  included in the file *
0008 // * LICENSE and available at  http://cern.ch/geant4/license .  These *
0009 // * include a list of copyright holders.                             *
0010 // *                                                                  *
0011 // * Neither the authors of this software system, nor their employing *
0012 // * institutes,nor the agencies providing financial support for this *
0013 // * work  make  any representation or  warranty, express or implied, *
0014 // * regarding  this  software system or assume any liability for its *
0015 // * use.  Please see the license in the file  LICENSE  and URL above *
0016 // * for the full disclaimer and the limitation of liability.         *
0017 // *                                                                  *
0018 // * This  code  implementation is the result of  the  scientific and *
0019 // * technical work of the GEANT4 collaboration.                      *
0020 // * By using,  copying,  modifying or  distributing the software (or *
0021 // * any work based  on the software)  you  agree  to acknowledge its *
0022 // * use  in  resulting  scientific  publications,  and indicate your *
0023 // * acceptance of all terms of the Geant4 Software license.          *
0024 // ********************************************************************
0025 //
0026 //
0027
0028 #ifndef G4VInteractiveSession_H
0029 #define G4VInteractiveSession_H 1
0030
0031 #include "G4VInteractorManager.hh"
0032
0033 #include <map>
0034
0035 class G4UImessenger;
0036 class G4SceneTreeItem;
0037
0038 // Class description :
0039 //
0040 // G4VInteractiveSession is a base class to isolate common things
0041 // to various graphical "basic" G4UI sessions ; AddMenu, AddButton,
0042 // a dictionnary for widgets.
0043 // The word "interactor" is for "piece of user interface" or "widget".
0044
0045 class G4VInteractiveSession
0046 {
0047  public:  // with description
0048   struct OutputStyle
0049   {
0050     G4bool fixed, bold, highlight;
0051   };
0052
0053   G4VInteractiveSession();
0054   virtual ~G4VInteractiveSession();
0055   virtual void AddMenu(const char*, const char*);
0056   virtual void AddButton(const char*, const char*, const char*);
0057   virtual void AddIcon(const char*, const char*, const char*, const char*);
0058   virtual void DefaultIcons(bool);
0059   virtual void SetOutputStyle(const char*, const char*);
0060   virtual void NativeMenu(bool);
0061   virtual void ClearMenu();
0062   virtual void UpdateSceneTree(const G4SceneTreeItem&);
0063   void AddInteractor(G4String, G4Interactor);
0064   G4Interactor GetInteractor(const G4String&);
0065   const std::map<G4String, OutputStyle>& GetOutputStyles() const;
0066
0067  protected:
0068   void SetStyleUtility(const G4String& destination, const G4String& style);
0069   // clang-format off
0070     std::map<G4String,OutputStyle> fOutputStyles {
0071       {"cout",{true,false,true}},
0072       {"cerr",{true,true,true}},
0073       {"warn",{true,false,true}},
0074       {"error",{true,true,true}},
0075       {"debug",{true,false,true}}};
0076   // clang-format on
0077
0078  private:
0079   G4UImessenger* messenger;
0080   using G4interactor_map = std::map<G4String, G4Interactor, std::less<G4String>>;
0081   G4interactor_map interactors;
0082 };
0083
0084 #endif