Logo ROOT  
Reference Guide
TGApplication Class Reference

This class initialize the ROOT GUI toolkit.

This class must be instantiated exactly once in any given application.

Definition at line 21 of file TGApplication.h.

Public Member Functions

 TGApplication (const char *appClassName, Int_t *argc, char **argv, void *options=nullptr, Int_t numOptions=0)
 Create a GUI application environment. More...
 
virtual ~TGApplication ()
 TGApplication dtor. More...
 
void GetOptions (Int_t *argc, char **argv) override
 Handle command line arguments. More...
 
TClassIsA () const override
 
void Streamer (TBuffer &) override
 Stream an object of class TObject. More...
 
void StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)
 
- Public Member Functions inherited from TApplication
 TApplication (const char *appClassName, Int_t *argc, char **argv, void *options=nullptr, Int_t numOptions=0)
 Create an application environment. More...
 
virtual ~TApplication ()
 TApplication dtor. More...
 
virtual const char * ApplicationName () const
 
Int_t Argc () const
 
char ** Argv () const
 
char * Argv (Int_t index) const
 Return specified argument. More...
 
void ClearInputFiles ()
 Clear list containing macro files passed as program arguments. More...
 
EExitOnException ExitOnException (EExitOnException opt=kExit)
 Set the exit on exception option. More...
 
virtual TApplicationImpGetApplicationImp ()
 
TApplicationGetAppRemote () const
 
const char * GetIdleCommand () const
 
virtual void GetOptions (Int_t *argc, char **argv)
 Get and handle command line options. More...
 
TSignalHandlerGetSignalHandler () const
 
virtual void HandleException (Int_t sig)
 Handle exceptions (kSigBus, kSigSegmentationViolation, kSigIllegalInstruction and kSigFloatingException) trapped in TSystem. More...
 
virtual void HandleIdleTimer ()
 Handle idle timeout. More...
 
virtual Bool_t HandleTermInput ()
 
virtual void Hide ()
 
virtual void Iconify ()
 
virtual void Init ()
 
void InitializeGraphics ()
 Initialize the graphics environment. More...
 
TObjArrayInputFiles () const
 
TClassIsA () const override
 
virtual Bool_t IsCmdThread ()
 
Bool_t IsRunning () const
 
virtual void KeyPressed (Int_t key)
 Emit signal when console keyboard key was pressed. More...
 
virtual void LineProcessed (const char *line)
 Emit signal when a line has been processed. More...
 
virtual void Lower ()
 
void ls (Option_t *option="") const override
 Show available sessions. More...
 
Bool_t NoLogoOpt () const
 
Bool_t NoLogOpt () const
 
virtual void Open ()
 
void OpenInBrowser (const TString &url)
 The function generates and executes a command that loads the Doxygen URL in a browser. More...
 
void OpenReferenceGuideFor (const TString &strippedClass)
 It opens the online reference guide, generated with Doxygen, for the chosen scope (class/namespace/struct) or member (method/function/ data member/enumeration/enumerator. More...
 
virtual Longptr_t ProcessFile (const char *file, Int_t *error=nullptr, Bool_t keep=kFALSE)
 Process a file containing a C++ macro. More...
 
virtual Longptr_t ProcessLine (const char *line, Bool_t sync=kFALSE, Int_t *error=nullptr)
 Process a single command line, either a C++ statement or an interpreter command starting with a ".". More...
 
Bool_t QuitOpt () const
 
virtual void Raise ()
 
virtual void RemoveIdleTimer ()
 Remove idle timer. Normally called via TROOT::Idle(0). More...
 
Bool_t ReturnFromRun () const
 
virtual void ReturnPressed (char *text)
 Emit signal when return key was pressed. More...
 
virtual void Run (Bool_t retrn=kFALSE)
 Main application eventloop. Calls system dependent eventloop via gSystem. More...
 
virtual void SetEchoMode (Bool_t mode)
 Set console echo mode: More...
 
virtual void SetIdleTimer (UInt_t idleTimeInSec, const char *command)
 Set the command to be executed after the system has been idle for idleTimeInSec seconds. More...
 
void SetReturnFromRun (Bool_t ret)
 
virtual void Show ()
 
virtual void StartIdleing ()
 Called when system starts idleing. More...
 
virtual void StopIdleing ()
 Called when system stops idleing. More...
 
void Streamer (TBuffer &) override
 Stream an object of class TObject. More...
 
void StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)
 
virtual Int_t TabCompletionHook (char *buf, int *pLoc, std::ostream &out)
 What to do when tab is pressed. More...
 
virtual void Terminate (Int_t status=0)
 Terminate the application by call TSystem::Exit() unless application has been told to return from Run(), by a call to SetReturnFromRun(). More...
 
const char * WorkingDirectory () const
 
- Public Member Functions inherited from TObject
 TObject ()
 TObject constructor. More...
 
 TObject (const TObject &object)
 TObject copy ctor. More...
 
virtual ~TObject ()
 TObject destructor. More...
 
void AbstractMethod (const char *method) const
 Use this method to implement an "abstract" method that you don't want to leave purely abstract. More...
 
virtual void AppendPad (Option_t *option="")
 Append graphics object to current pad. More...
 
virtual void Browse (TBrowser *b)
 Browse object. May be overridden for another default action. More...
 
ULong_t CheckedHash ()
 Check and record whether this class has a consistent Hash/RecursiveRemove setup (*) and then return the regular Hash value for this object. More...
 
virtual const char * ClassName () const
 Returns name of class to which the object belongs. More...
 
virtual void Clear (Option_t *="")
 
virtual TObjectClone (const char *newname="") const
 Make a clone of an object using the Streamer facility. More...
 
virtual Int_t Compare (const TObject *obj) const
 Compare abstract method. More...
 
virtual void Copy (TObject &object) const
 Copy this to obj. More...
 
virtual void Delete (Option_t *option="")
 Delete this object. More...
 
virtual Int_t DistancetoPrimitive (Int_t px, Int_t py)
 Computes distance from point (px,py) to the object. More...
 
virtual void Draw (Option_t *option="")
 Default Draw method for all objects. More...
 
virtual void DrawClass () const
 Draw class inheritance tree of the class to which this object belongs. More...
 
virtual TObjectDrawClone (Option_t *option="") const
 Draw a clone of this object in the current selected pad for instance with: gROOT->SetSelectedPad(gPad). More...
 
virtual void Dump () const
 Dump contents of object on stdout. More...
 
virtual void Error (const char *method, const char *msgfmt,...) const
 Issue error message. More...
 
virtual void Execute (const char *method, const char *params, Int_t *error=0)
 Execute method on this object with the given parameter string, e.g. More...
 
virtual void Execute (TMethod *method, TObjArray *params, Int_t *error=0)
 Execute method on this object with parameters stored in the TObjArray. More...
 
virtual void ExecuteEvent (Int_t event, Int_t px, Int_t py)
 Execute action corresponding to an event at (px,py). More...
 
virtual void Fatal (const char *method, const char *msgfmt,...) const
 Issue fatal error message. More...
 
virtual TObjectFindObject (const char *name) const
 Must be redefined in derived classes. More...
 
virtual TObjectFindObject (const TObject *obj) const
 Must be redefined in derived classes. More...
 
virtual Option_tGetDrawOption () const
 Get option used by the graphics system to draw this object. More...
 
virtual const char * GetIconName () const
 Returns mime type name of object. More...
 
virtual const char * GetName () const
 Returns name of object. More...
 
virtual char * GetObjectInfo (Int_t px, Int_t py) const
 Returns string containing info about the object at position (px,py). More...
 
virtual Option_tGetOption () const
 
virtual const char * GetTitle () const
 Returns title of object. More...
 
virtual UInt_t GetUniqueID () const
 Return the unique object id. More...
 
virtual Bool_t HandleTimer (TTimer *timer)
 Execute action in response of a timer timing out. More...
 
virtual ULong_t Hash () const
 Return hash value for this object. More...
 
Bool_t HasInconsistentHash () const
 Return true is the type of this object is known to have an inconsistent setup for Hash and RecursiveRemove (i.e. More...
 
virtual void Info (const char *method, const char *msgfmt,...) const
 Issue info message. More...
 
virtual Bool_t InheritsFrom (const char *classname) const
 Returns kTRUE if object inherits from class "classname". More...
 
virtual Bool_t InheritsFrom (const TClass *cl) const
 Returns kTRUE if object inherits from TClass cl. More...
 
virtual void Inspect () const
 Dump contents of this object in a graphics canvas. More...
 
void InvertBit (UInt_t f)
 
virtual TClassIsA () const
 
virtual Bool_t IsEqual (const TObject *obj) const
 Default equal comparison (objects are equal if they have the same address in memory). More...
 
virtual Bool_t IsFolder () const
 Returns kTRUE in case object contains browsable objects (like containers or lists of other objects). More...
 
R__ALWAYS_INLINE Bool_t IsOnHeap () const
 
virtual Bool_t IsSortable () const
 
R__ALWAYS_INLINE Bool_t IsZombie () const
 
virtual void ls (Option_t *option="") const
 The ls function lists the contents of a class on stdout. More...
 
void MayNotUse (const char *method) const
 Use this method to signal that a method (defined in a base class) may not be called in a derived class (in principle against good design since a child class should not provide less functionality than its parent, however, sometimes it is necessary). More...
 
virtual Bool_t Notify ()
 This method must be overridden to handle object notification. More...
 
void Obsolete (const char *method, const char *asOfVers, const char *removedFromVers) const
 Use this method to declare a method obsolete. More...
 
void operator delete (void *ptr)
 Operator delete. More...
 
void operator delete[] (void *ptr)
 Operator delete []. More...
 
void * operator new (size_t sz)
 
void * operator new (size_t sz, void *vp)
 
void * operator new[] (size_t sz)
 
void * operator new[] (size_t sz, void *vp)
 
TObjectoperator= (const TObject &rhs)
 TObject assignment operator. More...
 
virtual void Paint (Option_t *option="")
 This method must be overridden if a class wants to paint itself. More...
 
virtual void Pop ()
 Pop on object drawn in a pad to the top of the display list. More...
 
virtual void Print (Option_t *option="") const
 This method must be overridden when a class wants to print itself. More...
 
virtual Int_t Read (const char *name)
 Read contents of object with specified name from the current directory. More...
 
virtual void RecursiveRemove (TObject *obj)
 Recursively remove this object from a list. More...
 
void ResetBit (UInt_t f)
 
virtual void SaveAs (const char *filename="", Option_t *option="") const
 Save this object in the file specified by filename. More...
 
virtual void SavePrimitive (std::ostream &out, Option_t *option="")
 Save a primitive as a C++ statement(s) on output stream "out". More...
 
void SetBit (UInt_t f)
 
void SetBit (UInt_t f, Bool_t set)
 Set or unset the user status bits as specified in f. More...
 
virtual void SetDrawOption (Option_t *option="")
 Set drawing option for object. More...
 
virtual void SetUniqueID (UInt_t uid)
 Set the unique object id. More...
 
virtual void Streamer (TBuffer &)
 Stream an object of class TObject. More...
 
void StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)
 
virtual void SysError (const char *method, const char *msgfmt,...) const
 Issue system error message. More...
 
R__ALWAYS_INLINE Bool_t TestBit (UInt_t f) const
 
Int_t TestBits (UInt_t f) const
 
virtual void UseCurrentStyle ()
 Set current style settings in this object This function is called when either TCanvas::UseCurrentStyle or TROOT::ForceStyle have been invoked. More...
 
virtual void Warning (const char *method, const char *msgfmt,...) const
 Issue warning message. More...
 
virtual Int_t Write (const char *name=0, Int_t option=0, Int_t bufsize=0)
 Write this object to the current directory. More...
 
virtual Int_t Write (const char *name=0, Int_t option=0, Int_t bufsize=0) const
 Write this object to the current directory. More...
 
- Public Member Functions inherited from TQObject
 TQObject ()
 TQObject Constructor. More...
 
virtual ~TQObject ()
 TQObject Destructor. More...
 
Bool_t AreSignalsBlocked () const
 
Bool_t BlockSignals (Bool_t b)
 
virtual void ChangedBy (const char *method)
 
void CollectClassSignalLists (TList &list, TClass *cls)
 Collect class signal lists from class cls and all its base-classes. More...
 
Bool_t Connect (const char *signal, const char *receiver_class, void *receiver, const char *slot)
 Non-static method is used to connect from the signal of this object to the receiver slot. More...
 
virtual void Connected (const char *)
 
virtual void Destroyed ()
 
Bool_t Disconnect (const char *signal=nullptr, void *receiver=nullptr, const char *slot=nullptr)
 Disconnects signal of this object from slot of receiver. More...
 
virtual void Disconnected (const char *)
 
void Emit (const char *signal)
 Activate signal without args. More...
 
template<typename T >
void Emit (const char *signal, const T &arg)
 Activate signal with single parameter. More...
 
template<typename... T>
void EmitVA (const char *signal_name, Int_t, const T &... params)
 Emit a signal with a varying number of arguments. More...
 
TListGetListOfClassSignals () const
 Returns pointer to list of signals of this class. More...
 
TListGetListOfConnections () const
 
TListGetListOfSignals () const
 
virtual Bool_t HasConnection (const char *signal_name) const
 Return true if there is any object connected to this signal. More...
 
virtual void HighPriority (const char *signal_name, const char *slot_name=nullptr)
 
virtual TClassIsA () const
 
virtual void LowPriority (const char *signal_name, const char *slot_name=nullptr)
 
virtual void Message (const char *msg)
 
virtual Int_t NumberOfConnections () const
 Return number of connections for this object. More...
 
virtual Int_t NumberOfSignals () const
 Return number of signals for this object. More...
 
virtual void Streamer (TBuffer &)
 Stream an object of class TQObject. More...
 
void StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)
 

Static Public Member Functions

static TClassClass ()
 
static const char * Class_Name ()
 
static Version_t Class_Version ()
 
static const char * DeclFileName ()
 
- Static Public Member Functions inherited from TApplication
static TClassClass ()
 
static const char * Class_Name ()
 
static Version_t Class_Version ()
 
static void CreateApplication ()
 Static function used to create a default application environment. More...
 
static const char * DeclFileName ()
 
static Longptr_t ExecuteFile (const char *file, Int_t *error=nullptr, Bool_t keep=kFALSE)
 Execute a file containing a C++ macro (static method). More...
 
static TListGetApplications ()
 Static method returning the list of available applications. More...
 
static void NeedGraphicsLibs ()
 Static method. More...
 
- Static Public Member Functions inherited from TObject
static TClassClass ()
 
static const char * Class_Name ()
 
static Version_t Class_Version ()
 
static const char * DeclFileName ()
 
static Longptr_t GetDtorOnly ()
 Return destructor only flag. More...
 
static Bool_t GetObjectStat ()
 Get status of object stat flag. More...
 
static void SetDtorOnly (void *obj)
 Set destructor only flag. More...
 
static void SetObjectStat (Bool_t stat)
 Turn on/off tracking of objects in the TObjectTable. More...
 
- Static Public Member Functions inherited from TQObject
static Bool_t AreAllSignalsBlocked ()
 Returns true if all signals are blocked. More...
 
static Bool_t BlockAllSignals (Bool_t b)
 Block or unblock all signals. Returns the previous block status. More...
 
static TClassClass ()
 
static const char * Class_Name ()
 
static Version_t Class_Version ()
 
static Bool_t Connect (const char *sender_class, const char *signal, const char *receiver_class, void *receiver, const char *slot)
 This method allows to make a connection from any object of the same class to a single slot. More...
 
static Bool_t Connect (TQObject *sender, const char *signal, const char *receiver_class, void *receiver, const char *slot)
 Create connection between sender and receiver. More...
 
static const char * DeclFileName ()
 
static Bool_t Disconnect (const char *class_name, const char *signal, void *receiver=nullptr, const char *slot=nullptr)
 Disconnects "class signal". More...
 
static Bool_t Disconnect (TQObject *sender, const char *signal=nullptr, void *receiver=nullptr, const char *slot=nullptr)
 Disconnects signal in object sender from slot_method in object receiver. More...
 

Protected Member Functions

 TGApplication ()
 
void LoadGraphicsLibs () override
 Load shared libs necessary for GUI. More...
 
- Protected Member Functions inherited from TApplication
 TApplication ()
 Default ctor. Can be used by classes deriving from TApplication. More...
 
virtual void Help (const char *line)
 The function lists useful commands (".help") or opens the online reference guide, generated with Doxygen (".help scope" or ".help scope::member"). More...
 
virtual void LoadGraphicsLibs ()
 Load shared libs necessary for graphics. More...
 
virtual void MakeBatch ()
 Switch to batch mode. More...
 
virtual Longptr_t ProcessRemote (const char *line, Int_t *error=0)
 Process the content of a line starting with ".R" (already stripped-off) The format is. More...
 
void SetSignalHandler (TSignalHandler *sh)
 
- Protected Member Functions inherited from TObject
virtual void DoError (int level, const char *location, const char *fmt, va_list va) const
 Interface to ErrorHandler (protected). More...
 
void MakeZombie ()
 
- Protected Member Functions inherited from TQObject
virtual void * GetSender ()
 
virtual const char * GetSenderClassName () const
 

Private Attributes

TGClientfClient {nullptr}
 pointer to the client environment More...
 
TString fDisplay
 display server to connect to More...
 

Additional Inherited Members

- Public Types inherited from TApplication
enum  EExitOnException { kDontExit , kExit , kAbort }
 
enum  EFileBits { kExpression = (1ULL << ( 14 )) }
 
enum  EStatusBits { kProcessRemotely = (1ULL << ( 15 )) , kDefaultApplication = (1ULL << ( 16 )) }
 
- Public Types inherited from TObject
enum  {
  kIsOnHeap = 0x01000000 , kNotDeleted = 0x02000000 , kZombie = 0x04000000 , kInconsistent = 0x08000000 ,
  kBitMask = 0x00ffffff
}
 
enum  { kSingleKey = (1ULL << ( 0 )) , kOverwrite = (1ULL << ( 1 )) , kWriteDelete = (1ULL << ( 2 )) }
 
enum  EDeprecatedStatusBits { kObjInCanvas = (1ULL << ( 3 )) }
 
enum  EStatusBits {
  kCanDelete = (1ULL << ( 0 )) , kMustCleanup = (1ULL << ( 3 )) , kIsReferenced = (1ULL << ( 4 )) , kHasUUID = (1ULL << ( 5 )) ,
  kCannotPick = (1ULL << ( 6 )) , kNoContextMenu = (1ULL << ( 8 )) , kInvalidObject = (1ULL << ( 13 ))
}
 
- Protected Types inherited from TObject
enum  { kOnlyPrepStep = (1ULL << ( 3 )) }
 
- Static Protected Member Functions inherited from TApplication
static void Close (TApplication *app)
 Static function used to close a remote application. More...
 
static TApplicationOpen (const char *url, Int_t debug, const char *script)
 Static function used to attach to an existing remote application or to start one. More...
 
static Int_t ParseRemoteLine (const char *ln, TString &hostdir, TString &user, Int_t &dbg, TString &script)
 Parse the content of a line starting with ".R" (already stripped-off) The format is. More...
 
- Static Protected Member Functions inherited from TQObject
static Int_t CheckConnectArgs (TQObject *sender, TClass *sender_class, const char *signal, TClass *receiver_class, const char *slot)
 Checking of consistency of sender/receiver methods/arguments. More...
 
static TString CompressName (const char *method_name)
 Removes "const" words and blanks from full (with prototype) method name and resolve any typedefs in the method signature. More...
 
static Bool_t ConnectToClass (const char *sender_class, const char *signal, TClass *receiver_class, void *receiver, const char *slot)
 This method allows to make connection from any object of the same class to the receiver object. More...
 
static Bool_t ConnectToClass (TQObject *sender, const char *signal, TClass *receiver_class, void *receiver, const char *slot)
 Create connection between sender and receiver. More...
 
- Protected Attributes inherited from TApplication
TApplicationfAppRemote
 
- Protected Attributes inherited from TQObject
TListfListOfConnections
 list of signals from this object More...
 
TListfListOfSignals
 
Bool_t fSignalsBlocked
 list of connections to this object More...
 
- Static Protected Attributes inherited from TApplication
static TListfgApplications = nullptr
 
- Static Protected Attributes inherited from TQObject
static Bool_t fgAllSignalsBlocked = kFALSE
 flag used for suppression of signals More...
 

#include <TGApplication.h>

Inheritance diagram for TGApplication:
[legend]

Constructor & Destructor Documentation

◆ TGApplication() [1/2]

TGApplication::TGApplication ( )
inlineprotected

Definition at line 28 of file TGApplication.h.

◆ TGApplication() [2/2]

TGApplication::TGApplication ( const char *  appClassName,
Int_t argc,
char **  argv,
void *  options = nullptr,
Int_t  numOptions = 0 
)

Create a GUI application environment.

Use this class if you only want to use the ROOT GUI and no other services. In all other cases use either TApplication or TRint.

Definition at line 44 of file TGApplication.cxx.

◆ ~TGApplication()

TGApplication::~TGApplication ( )
virtual

TGApplication dtor.

Definition at line 126 of file TGApplication.cxx.

Member Function Documentation

◆ Class()

static TClass * TGApplication::Class ( )
static
Returns
TClass describing this class

◆ Class_Name()

static const char * TGApplication::Class_Name ( )
static
Returns
Name of this class

◆ Class_Version()

static Version_t TGApplication::Class_Version ( )
inlinestatic
Returns
Version of this class

Definition at line 39 of file TGApplication.h.

◆ DeclFileName()

static const char * TGApplication::DeclFileName ( )
inlinestatic
Returns
Name of the file containing the class declaration

Definition at line 39 of file TGApplication.h.

◆ GetOptions()

void TGApplication::GetOptions ( Int_t argc,
char **  argv 
)
overridevirtual

Handle command line arguments.

Arguments handled are removed from the argument array. Currently only option "-display xserver" is considered.

Reimplemented from TApplication.

Definition at line 170 of file TGApplication.cxx.

◆ IsA()

TClass * TGApplication::IsA ( ) const
inlineoverridevirtual
Returns
TClass describing current object

Reimplemented from TApplication.

Definition at line 39 of file TGApplication.h.

◆ LoadGraphicsLibs()

void TGApplication::LoadGraphicsLibs ( )
overrideprotectedvirtual

Load shared libs necessary for GUI.

Reimplemented from TApplication.

Definition at line 134 of file TGApplication.cxx.

◆ Streamer()

void TGApplication::Streamer ( TBuffer R__b)
overridevirtual

Stream an object of class TObject.

Reimplemented from TApplication.

◆ StreamerNVirtual()

void TGApplication::StreamerNVirtual ( TBuffer ClassDef_StreamerNVirtual_b)
inline

Definition at line 39 of file TGApplication.h.

Member Data Documentation

◆ fClient

TGClient* TGApplication::fClient {nullptr}
private

pointer to the client environment

Definition at line 25 of file TGApplication.h.

◆ fDisplay

TString TGApplication::fDisplay
private

display server to connect to

Definition at line 24 of file TGApplication.h.

Libraries for TGApplication:
[legend]

The documentation for this class was generated from the following files: