QGUIBaseFrame.hh

Go to the documentation of this file.

#ifndef _QGUI_BASE_FRAME_HH_
#define _QGUI_BASE_FRAME_HH_



// Apollo Includes


// Root Includes
#include "TGFrame.h"
#include "TROOT.h"
#include "Rtypes.h"
#include "TGTextView.h"

// C/C++ Includes
#include <list>


// Used class
class TGIcon;
class TGPictures;
class TGTextView;
class TGLayoutHints;

class QGUIBaseFrame: public TGTransientFrame
{

public:


  // GUI Standard Buttons
  enum QGUIButtons_t
  {
    QGUI_CANCEL =0,
    QGUI_YES    =1,
    QGUI_OK     =3,
    QGUI_NO     =4,
    QGUI_RETRY  =5,
    QGUI_CLOSE  =6,
    QGUI_IGNORE =7
  };

  
   /*
    * @brief constructor
    * @param p pointer to the parent window, i.e. the frame in which this frame
    *          will be contained. This is needed to delete correctly all
    *          subframes as soon as the parent frame is deleted
    * @param main tdb. this is the window this 'transient' frame refers to
    * @param w window width
    * @param h window height
    * @param Options same options that can be passed to TGTransientFrame
    */
     QGUIBaseFrame(const TGWindow *p, const TGWindow *main, UInt_t w, UInt_t h, UInt_t Options);

  // dtor
  virtual ~QGUIBaseFrame();

  // Close Window and Exit
  virtual void CloseWindow();

  // Signals
  void Closed() {Emit("Closed()");}  //*SIGNAL*


protected:
  
  // Check if Is Colored
  inline const bool IsColored() const {return fIsColor; }

  // Set/Enable/Disable Frame Color Status
  inline void SetDebugColor(bool isColored) {fIsColor=isColored;return;}
  inline void EnableColor()                 {SetDebugColor(true) ;return;}
  inline void DisableColor()                {SetDebugColor(false);return;}

  // Get ROOT version

  const std::string GetROOTVersion() const{return std::string(gROOT->GetVersion());}

  // Set/Get Window and Icon Names
  void SetMainFrameName(const std::string& qName);
  inline const std::string GetMainFrameName() const {return std::string(GetWindowName());}

  // Set/Get Short Name
  inline void SetWho(const std::string& qWho) {fWho=qWho;return;}
  inline const std::string& GetWho() const {return fWho;} 


  // Make the Frame Non-Resizable
  void NoResizable();

  // Add image to frame with defined border
  bool AddImageToFrame(const std::string& qPathName, TGCompositeFrame* qFrame, size_t qWidth, size_t qHeight,
                       int qLeft, int qRight, int qTop, int qBottom,
                       size_t qOptions);
  
  // Add image to frame with standard border (1,1,1,1)
  bool AddImageToFrame(const std::string& qPathName, TGCompositeFrame* qFrame, size_t qWidth, size_t qHeight,
                       size_t qOptions);

  // Add a writing to frame
  void AddWritingToFrame(TGCompositeFrame* qFrame, const std::string& qWriting);

  
  // Add Logger
  void AddLogger(TGCompositeFrame* qParent, TGTextView* &qLog, TGGroupFrame* qGroup);
  

  // Add Horizontal Frame, Fitted Width and Fixed Height and with standard border (1,1,1,1)
  TGHorizontalFrame* CreateHFrame(TGCompositeFrame* qParent, 
                                  size_t qWidth, size_t qHeight);

  // Add Horizontal Frame, Fitted Width and Fixed Height and with defined border
  TGHorizontalFrame* CreateHFrame(TGCompositeFrame* qParent,
                                  int qLeft, int qRight, int qTop, int qBottom,
                                  size_t qWidth, size_t qHeight);
        
  
  // Add Vertival Frame, Fixed Width and Fitted Height and with standard border (1,1,1,1)
  TGVerticalFrame* CreateVFrame(TGCompositeFrame* qParent, 
                                size_t qWidth, size_t qHeight);
  
  // Add Vertival Frame, Fixed Width and Fitted Height and with defined border
  TGVerticalFrame* CreateVFrame(TGCompositeFrame* qParent,
                                int qLeft, int qRight, int qTop, int qBottom,
                                size_t qWidth, size_t qHeight);

  // Get Current Time
  const std::string GetTime();

  // Send Message On Screen
  void SendMsgOnScreen(const std::string& qWho, const std::string& qMsg, bool without);
  void SendMsgOnScreen(const std::string& qMsg, bool without) {return SendMsgOnScreen(GetWho(),qMsg,without);}
  void SendMsgOnScreen(const std::string& qMsg) {return SendMsgOnScreen(GetWho(),qMsg,false);}

  // Set Message on Logger (if it exists) and on Screen
  void SetMessage(TGTextView* qLog, const std::string& qMsg, bool without);
  void SetMessage(TGTextView* qLog, const std::string& qMsg) {return SetMessage(qLog,qMsg,false);}
  
  // Transform interger to std::string
  std::string ToString(int Value, size_t nDigit);
  std::string ToString(int Value) {return ToString(Value,4);}

   TGLayoutHints* AddHints(const ULong_t& hints   = kLHintsNormal,
                           const Int_t& padLeft   = 0,
                           const Int_t& padRight  = 0,
                           const Int_t& padTop    = 0,
                           const Int_t& padBottom = 0);


private:
  
  TGIcon          *fIcon;    // Icon
  const TGPicture *fPicture; // Picture

  // Gui Short Name
  std::string fWho;


  // If fIsColor=true frame are colored (only for debugging)
  bool     fIsColor;    

   TGLayoutHints* FindHints(const ULong_t& hints   = kLHintsNormal,
                            const Int_t& padLeft   = 0,
                            const Int_t& padRight  = 0,
                            const Int_t& padTop    = 0,
                            const Int_t& padBottom = 0) const;
   
   void CleanHints();

   std::list<TGLayoutHints*> fHints;


  // To integrate QGUIBaseFrame class into the ROOT system
  ClassDef(QGUIBaseFrame,0)

};

#endif // _QGUI_BASE_FRAME_HH_

---