Logo ROOT  
Reference Guide
 
Loading...
Searching...
No Matches
TApplication Class Reference

This class creates the ROOT Application Environment that interfaces to the windowing system eventloop and eventhandlers.

This class must be instantiated exactly once in any given application. Normally the specific application class inherits from TApplication (see TRint).

Definition at line 39 of file TApplication.h.

Public Types

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 ))
}
 

Public Member Functions

 TApplication (const char *appClassName, Int_t *argc, char **argv, void *options=nullptr, Int_t numOptions=0)
 Create an application environment.
 
virtual ~TApplication ()
 TApplication dtor.
 
virtual const char * ApplicationName () const
 
Int_t Argc () const
 
char ** Argv () const
 
char * Argv (Int_t index) const
 Return specified argument.
 
void ClearInputFiles ()
 Clear list containing macro files passed as program arguments.
 
EExitOnException ExitOnException (EExitOnException opt=kExit)
 Set the exit on exception option.
 
virtual TApplicationImpGetApplicationImp ()
 
TApplicationGetAppRemote () const
 
const char * GetIdleCommand () const
 
virtual void GetOptions (Int_t *argc, char **argv)
 Get and handle command line options.
 
TString GetSetup ()
 It gets the ROOT installation setup as TString.
 
TSignalHandlerGetSignalHandler () const
 
virtual void HandleException (Int_t sig)
 Handle exceptions (kSigBus, kSigSegmentationViolation, kSigIllegalInstruction and kSigFloatingException) trapped in TSystem.
 
virtual void HandleIdleTimer ()
 Handle idle timeout.
 
virtual Bool_t HandleTermInput ()
 
virtual void Hide ()
 
virtual void Iconify ()
 
virtual void Init ()
 
void InitializeGraphics (Bool_t only_web=kFALSE)
 Initialize the graphics environment.
 
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.
 
virtual void LineProcessed (const char *line)
 Emit signal when a line has been processed.
 
virtual void Lower ()
 
void ls (Option_t *option="") const override
 Show available sessions.
 
Bool_t NoLogoOpt () const
 
Bool_t NoLogOpt () const
 
virtual void Open ()
 
void OpenForumTopic (const TString &type)
 It opens a Forum topic in a web browser with prefilled ROOT version.
 
void OpenGitHubIssue (const TString &type)
 It opens a GitHub issue in a web browser with prefilled ROOT version.
 
void OpenInBrowser (const TString &url)
 The function generates and executes a command that loads the Doxygen URL in a browser.
 
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.
 
virtual Longptr_t ProcessFile (const char *file, Int_t *error=nullptr, Bool_t keep=kFALSE)
 Process a file containing a C++ macro.
 
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 ".".
 
Bool_t QuitOpt () const
 
virtual void Raise ()
 
virtual void RemoveIdleTimer ()
 Remove idle timer. Normally called via TROOT::Idle(0).
 
Bool_t ReturnFromRun () const
 
virtual void ReturnPressed (char *text)
 Emit signal when return key was pressed.
 
virtual void Run (Bool_t retrn=kFALSE)
 Main application eventloop. Calls system dependent eventloop via gSystem.
 
virtual void SetEchoMode (Bool_t mode)
 Set console echo mode:
 
virtual void SetIdleTimer (UInt_t idleTimeInSec, const char *command)
 Set the command to be executed after the system has been idle for idleTimeInSec seconds.
 
void SetReturnFromRun (Bool_t ret)
 
virtual void Show ()
 
virtual void StartIdleing ()
 Called when system starts idleing.
 
virtual void StopIdleing ()
 Called when system stops idleing.
 
void Streamer (TBuffer &) override
 Stream an object of class TObject.
 
void StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)
 
virtual Int_t TabCompletionHook (char *buf, int *pLoc, std::ostream &out)
 What to do when tab is pressed.
 
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().
 
const char * WorkingDirectory () const
 
- Public Member Functions inherited from TObject
 TObject ()
 TObject constructor.
 
 TObject (const TObject &object)
 TObject copy ctor.
 
virtual ~TObject ()
 TObject destructor.
 
void AbstractMethod (const char *method) const
 Use this method to implement an "abstract" method that you don't want to leave purely abstract.
 
virtual void AppendPad (Option_t *option="")
 Append graphics object to current pad.
 
virtual void Browse (TBrowser *b)
 Browse object. May be overridden for another default action.
 
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.
 
virtual const char * ClassName () const
 Returns name of class to which the object belongs.
 
virtual void Clear (Option_t *="")
 
virtual TObjectClone (const char *newname="") const
 Make a clone of an object using the Streamer facility.
 
virtual Int_t Compare (const TObject *obj) const
 Compare abstract method.
 
virtual void Copy (TObject &object) const
 Copy this to obj.
 
virtual void Delete (Option_t *option="")
 Delete this object.
 
virtual Int_t DistancetoPrimitive (Int_t px, Int_t py)
 Computes distance from point (px,py) to the object.
 
virtual void Draw (Option_t *option="")
 Default Draw method for all objects.
 
virtual void DrawClass () const
 Draw class inheritance tree of the class to which this object belongs.
 
virtual TObjectDrawClone (Option_t *option="") const
 Draw a clone of this object in the current selected pad with: gROOT->SetSelectedPad(c1).
 
virtual void Dump () const
 Dump contents of object on stdout.
 
virtual void Error (const char *method, const char *msgfmt,...) const
 Issue error message.
 
virtual void Execute (const char *method, const char *params, Int_t *error=nullptr)
 Execute method on this object with the given parameter string, e.g.
 
virtual void Execute (TMethod *method, TObjArray *params, Int_t *error=nullptr)
 Execute method on this object with parameters stored in the TObjArray.
 
virtual void ExecuteEvent (Int_t event, Int_t px, Int_t py)
 Execute action corresponding to an event at (px,py).
 
virtual void Fatal (const char *method, const char *msgfmt,...) const
 Issue fatal error message.
 
virtual TObjectFindObject (const char *name) const
 Must be redefined in derived classes.
 
virtual TObjectFindObject (const TObject *obj) const
 Must be redefined in derived classes.
 
virtual Option_tGetDrawOption () const
 Get option used by the graphics system to draw this object.
 
virtual const char * GetIconName () const
 Returns mime type name of object.
 
virtual const char * GetName () const
 Returns name of object.
 
virtual char * GetObjectInfo (Int_t px, Int_t py) const
 Returns string containing info about the object at position (px,py).
 
virtual Option_tGetOption () const
 
virtual const char * GetTitle () const
 Returns title of object.
 
virtual UInt_t GetUniqueID () const
 Return the unique object id.
 
virtual Bool_t HandleTimer (TTimer *timer)
 Execute action in response of a timer timing out.
 
virtual ULong_t Hash () const
 Return hash value for this object.
 
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.
 
virtual void Info (const char *method, const char *msgfmt,...) const
 Issue info message.
 
virtual Bool_t InheritsFrom (const char *classname) const
 Returns kTRUE if object inherits from class "classname".
 
virtual Bool_t InheritsFrom (const TClass *cl) const
 Returns kTRUE if object inherits from TClass cl.
 
virtual void Inspect () const
 Dump contents of this object in a graphics canvas.
 
void InvertBit (UInt_t f)
 
Bool_t IsDestructed () const
 IsDestructed.
 
virtual Bool_t IsEqual (const TObject *obj) const
 Default equal comparison (objects are equal if they have the same address in memory).
 
virtual Bool_t IsFolder () const
 Returns kTRUE in case object contains browsable objects (like containers or lists of other objects).
 
R__ALWAYS_INLINE Bool_t IsOnHeap () const
 
virtual Bool_t IsSortable () const
 
R__ALWAYS_INLINE Bool_t IsZombie () const
 
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).
 
virtual Bool_t Notify ()
 This method must be overridden to handle object notification (the base implementation is no-op).
 
void Obsolete (const char *method, const char *asOfVers, const char *removedFromVers) const
 Use this method to declare a method obsolete.
 
void operator delete (void *ptr)
 Operator delete.
 
void operator delete (void *ptr, void *vp)
 Only called by placement new when throwing an exception.
 
void operator delete[] (void *ptr)
 Operator delete [].
 
void operator delete[] (void *ptr, void *vp)
 Only called by placement new[] when throwing an exception.
 
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.
 
virtual void Paint (Option_t *option="")
 This method must be overridden if a class wants to paint itself.
 
virtual void Pop ()
 Pop on object drawn in a pad to the top of the display list.
 
virtual void Print (Option_t *option="") const
 This method must be overridden when a class wants to print itself.
 
virtual Int_t Read (const char *name)
 Read contents of object with specified name from the current directory.
 
virtual void RecursiveRemove (TObject *obj)
 Recursively remove this object from a list.
 
void ResetBit (UInt_t f)
 
virtual void SaveAs (const char *filename="", Option_t *option="") const
 Save this object in the file specified by filename.
 
virtual void SavePrimitive (std::ostream &out, Option_t *option="")
 Save a primitive as a C++ statement(s) on output stream "out".
 
void SetBit (UInt_t f)
 
void SetBit (UInt_t f, Bool_t set)
 Set or unset the user status bits as specified in f.
 
virtual void SetDrawOption (Option_t *option="")
 Set drawing option for object.
 
virtual void SetUniqueID (UInt_t uid)
 Set the unique object id.
 
void StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)
 
virtual void SysError (const char *method, const char *msgfmt,...) const
 Issue system error message.
 
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.
 
virtual void Warning (const char *method, const char *msgfmt,...) const
 Issue warning message.
 
virtual Int_t Write (const char *name=nullptr, Int_t option=0, Int_t bufsize=0)
 Write this object to the current directory.
 
virtual Int_t Write (const char *name=nullptr, Int_t option=0, Int_t bufsize=0) const
 Write this object to the current directory.
 
- Public Member Functions inherited from TQObject
 TQObject ()
 TQObject Constructor.
 
virtual ~TQObject ()
 TQObject Destructor.
 
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.
 
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.
 
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.
 
virtual void Disconnected (const char *)
 
void Emit (const char *signal)
 Activate signal without args.
 
template<typename T >
void Emit (const char *signal, const T &arg)
 Activate signal with single parameter.
 
template<typename... T>
void EmitVA (const char *signal_name, Int_t, const T &... params)
 Emit a signal with a varying number of arguments.
 
TListGetListOfClassSignals () const
 Returns pointer to list of signals of this class.
 
TListGetListOfConnections () const
 
TListGetListOfSignals () const
 
virtual Bool_t HasConnection (const char *signal_name) const
 Return true if there is any object connected to this signal.
 
virtual void HighPriority (const char *signal_name, const char *slot_name=nullptr)
 
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.
 
virtual Int_t NumberOfSignals () const
 Return number of signals for this object.
 
void StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)
 

Static Public Member Functions

static TClassClass ()
 
static const char * Class_Name ()
 
static constexpr Version_t Class_Version ()
 
static void CreateApplication ()
 Static function used to create a default application environment.
 
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).
 
static TListGetApplications ()
 Static method returning the list of available applications.
 
static void NeedGraphicsLibs ()
 Static method.
 
- Static Public Member Functions inherited from TObject
static TClassClass ()
 
static const char * Class_Name ()
 
static constexpr Version_t Class_Version ()
 
static const char * DeclFileName ()
 
static Longptr_t GetDtorOnly ()
 Return destructor only flag.
 
static Bool_t GetObjectStat ()
 Get status of object stat flag.
 
static void SetDtorOnly (void *obj)
 Set destructor only flag.
 
static void SetObjectStat (Bool_t stat)
 Turn on/off tracking of objects in the TObjectTable.
 
- Static Public Member Functions inherited from TQObject
static Bool_t AreAllSignalsBlocked ()
 Returns true if all signals are blocked.
 
static Bool_t BlockAllSignals (Bool_t b)
 Block or unblock all signals. Returns the previous block status.
 
static TClassClass ()
 
static const char * Class_Name ()
 
static constexpr 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.
 
static Bool_t Connect (TQObject *sender, const char *signal, const char *receiver_class, void *receiver, const char *slot)
 Create connection between sender and receiver.
 
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".
 
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.
 

Protected Member Functions

 TApplication ()
 Default ctor. Can be used by classes deriving from TApplication.
 
virtual void Forum (const char *line)
 The function (".forum <type>") submits a new post on the ROOT forum via web browser.
 
virtual void GitHub (const char *line)
 The function (".gh <type>") submits a new issue on GitHub via web browser.
 
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").
 
virtual void LoadGraphicsLibs ()
 Load shared libs necessary for graphics.
 
virtual void MakeBatch ()
 Switch to batch mode.
 
virtual Longptr_t ProcessRemote (const char *line, Int_t *error=nullptr)
 Process the content of a line starting with ".R" (already stripped-off) The format is.
 
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).
 
void MakeZombie ()
 
- Protected Member Functions inherited from TQObject
virtual void * GetSender ()
 
virtual const char * GetSenderClassName () const
 

Static Protected Member Functions

static void Close (TApplication *app)
 Static function used to close a remote application.
 
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.
 
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.
 
- 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.
 
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.
 
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.
 
static Bool_t ConnectToClass (TQObject *sender, const char *signal, TClass *receiver_class, void *receiver, const char *slot)
 Create connection between sender and receiver.
 

Protected Attributes

TApplicationfAppRemote
 
- Protected Attributes inherited from TQObject
TListfListOfConnections
 list of signals from this object
 
TListfListOfSignals
 
Bool_t fSignalsBlocked
 list of connections to this object
 

Static Protected Attributes

static TListfgApplications = nullptr
 
- Static Protected Attributes inherited from TQObject
static Bool_t fgAllSignalsBlocked = kFALSE
 flag used for suppression of signals
 

Private Member Functions

 TApplication (const TApplication &)=delete
 
TApplicationoperator= (const TApplication &)=delete
 

Private Attributes

TApplicationImpfAppImp
 
Int_t fArgc
 
char ** fArgv
 
EExitOnException fExitOnException
 
TObjArrayfFiles
 
TString fIdleCommand
 
TTimerfIdleTimer
 
std::atomic< boolfIsRunning
 Window system specific application implementation.
 
Bool_t fNoLog
 
Bool_t fNoLogo
 
Bool_t fQuit
 
Bool_t fReturnFromRun
 
TSignalHandlerfSigHandler
 
TString fWorkDir
 

Static Private Attributes

static Bool_t fgGraphInit = kFALSE
 
static Bool_t fgGraphNeeded = kFALSE
 

Additional Inherited Members

- Protected Types inherited from TObject
enum  { kOnlyPrepStep = (1ULL << ( 3 )) }
 

#include <TApplication.h>

Inheritance diagram for TApplication:
[legend]

Member Enumeration Documentation

◆ EExitOnException

Enumerator
kDontExit 
kExit 
kAbort 

Definition at line 51 of file TApplication.h.

◆ EFileBits

Enumerator
kExpression 

Definition at line 48 of file TApplication.h.

◆ EStatusBits

Enumerator
kProcessRemotely 
kDefaultApplication 

Definition at line 43 of file TApplication.h.

Constructor & Destructor Documentation

◆ TApplication() [1/3]

TApplication::TApplication ( const TApplication )
privatedelete

◆ TApplication() [2/3]

TApplication::TApplication ( )
protected

Default ctor. Can be used by classes deriving from TApplication.

Definition at line 97 of file TApplication.cxx.

◆ TApplication() [3/3]

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

Create an application environment.

The application environment provides an interface to the graphics system and eventloop (be it X, Windows, macOS or BeOS). After creating the application object start the eventloop by calling its Run() method. The command line options recognized by TApplication are described in the GetOptions() method. The recognized options are removed from the argument array. The original list of argument options can be retrieved via the Argc() and Argv() methods. The appClassName "proofserv" is reserved for the PROOF system. The "options" and "numOptions" arguments are not used, except if you want to by-pass the argv processing by GetOptions() in which case you should specify numOptions<0. All options will still be available via the Argv() method for later use.

Definition at line 120 of file TApplication.cxx.

◆ ~TApplication()

TApplication::~TApplication ( )
virtual

TApplication dtor.

Definition at line 210 of file TApplication.cxx.

Member Function Documentation

◆ ApplicationName()

virtual const char * TApplication::ApplicationName ( ) const
inlinevirtual

Reimplemented in TApplicationRemote.

Definition at line 128 of file TApplication.h.

◆ Argc()

Int_t TApplication::Argc ( ) const
inline

Definition at line 140 of file TApplication.h.

◆ Argv() [1/2]

char ** TApplication::Argv ( ) const
inline

Definition at line 141 of file TApplication.h.

◆ Argv() [2/2]

char * TApplication::Argv ( Int_t  index) const

Return specified argument.

Definition at line 329 of file TApplication.cxx.

◆ Class()

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

◆ Class_Name()

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

◆ Class_Version()

static constexpr Version_t TApplication::Class_Version ( )
inlinestaticconstexpr
Returns
Version of this class

Definition at line 167 of file TApplication.h.

◆ ClearInputFiles()

void TApplication::ClearInputFiles ( )

Clear list containing macro files passed as program arguments.

This method is called from TRint::Run() to ensure that the macro files are only executed the first time Run() is called.

Definition at line 318 of file TApplication.cxx.

◆ Close()

void TApplication::Close ( TApplication app)
staticprotected

Static function used to close a remote application.

Definition at line 2063 of file TApplication.cxx.

◆ CreateApplication()

void TApplication::CreateApplication ( )
static

Static function used to create a default application environment.

Definition at line 1968 of file TApplication.cxx.

◆ DeclFileName()

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

Definition at line 167 of file TApplication.h.

◆ ExecuteFile()

Longptr_t TApplication::ExecuteFile ( const char *  file,
Int_t error = nullptr,
Bool_t  keep = kFALSE 
)
static

Execute a file containing a C++ macro (static method).

Can be used while TApplication is not yet created.

Definition at line 1722 of file TApplication.cxx.

◆ ExitOnException()

TApplication::EExitOnException TApplication::ExitOnException ( TApplication::EExitOnException  opt = kExit)

Set the exit on exception option.

Setting this option determines what happens in HandleException() in case an exception (kSigBus, kSigSegmentationViolation, kSigIllegalInstruction or kSigFloatingException) is trapped. Choices are: kDontExit (default), kExit or kAbort. Returns the previous value.

Definition at line 615 of file TApplication.cxx.

◆ Forum()

void TApplication::Forum ( const char *  line)
protectedvirtual

The function (".forum <type>") submits a new post on the ROOT forum via web browser.

Note
You can use "bug" as <type>.
Parameters
[in]linecommand from the command line

Definition at line 1166 of file TApplication.cxx.

◆ GetApplicationImp()

virtual TApplicationImp * TApplication::GetApplicationImp ( )
inlinevirtual

Definition at line 136 of file TApplication.h.

◆ GetApplications()

TList * TApplication::GetApplications ( )
static

Static method returning the list of available applications.

Definition at line 2096 of file TApplication.cxx.

◆ GetAppRemote()

TApplication * TApplication::GetAppRemote ( ) const
inline

Definition at line 150 of file TApplication.h.

◆ GetIdleCommand()

const char * TApplication::GetIdleCommand ( ) const
inline

Definition at line 123 of file TApplication.h.

◆ GetOptions()

void TApplication::GetOptions ( Int_t argc,
char **  argv 
)
virtual

Get and handle command line options.

Arguments handled are removed from the argument array. See CommandLineOptionsHelp.h for options.

Reimplemented in TGApplication, TApplicationServer, and TProofServ.

Definition at line 345 of file TApplication.cxx.

◆ GetSetup()

TString TApplication::GetSetup ( )

It gets the ROOT installation setup as TString.

Returns
a string with several lines

Definition at line 968 of file TApplication.cxx.

◆ GetSignalHandler()

TSignalHandler * TApplication::GetSignalHandler ( ) const
inline

Definition at line 107 of file TApplication.h.

◆ GitHub()

void TApplication::GitHub ( const char *  line)
protectedvirtual

The function (".gh <type>") submits a new issue on GitHub via web browser.

Note
You can use "bug", "feature" or "improvement" as <type>.
Parameters
[in]linecommand from the command line

Definition at line 1187 of file TApplication.cxx.

◆ HandleException()

void TApplication::HandleException ( Int_t  sig)
virtual

Handle exceptions (kSigBus, kSigSegmentationViolation, kSigIllegalInstruction and kSigFloatingException) trapped in TSystem.

Specific TApplication implementations may want something different here.

Reimplemented in TRint, and TProofServ.

Definition at line 591 of file TApplication.cxx.

◆ HandleIdleTimer()

void TApplication::HandleIdleTimer ( )
virtual

Handle idle timeout.

When this timer expires the registered idle command will be executed by this routine and a signal will be emitted.

Definition at line 578 of file TApplication.cxx.

◆ HandleTermInput()

virtual Bool_t TApplication::HandleTermInput ( )
inlinevirtual

Reimplemented in TRint.

Definition at line 116 of file TApplication.h.

◆ Help()

void TApplication::Help ( const char *  line)
protectedvirtual

The function lists useful commands (".help") or opens the online reference guide, generated with Doxygen (".help scope" or ".help scope::member").

Note
You can use ".?" as the short version of ".help"
Parameters
[in]linecommand from the command line

Definition at line 1209 of file TApplication.cxx.

◆ Hide()

virtual void TApplication::Hide ( )
inlinevirtual

Definition at line 130 of file TApplication.h.

◆ Iconify()

virtual void TApplication::Iconify ( )
inlinevirtual

Definition at line 131 of file TApplication.h.

◆ Init()

virtual void TApplication::Init ( )
inlinevirtual

Definition at line 117 of file TApplication.h.

◆ InitializeGraphics()

void TApplication::InitializeGraphics ( Bool_t  only_web = kFALSE)

Initialize the graphics environment.

If

Parameters
only_webis specified, only web-related part of graphics is loaded

Definition at line 244 of file TApplication.cxx.

◆ InputFiles()

TObjArray * TApplication::InputFiles ( ) const
inline

Definition at line 146 of file TApplication.h.

◆ IsA()

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

Reimplemented from TObject.

Reimplemented in TRint, TGApplication, TApplicationRemote, TApplicationServer, TProofServ, TProofServLite, and TXProofServ.

Definition at line 167 of file TApplication.h.

◆ IsCmdThread()

virtual Bool_t TApplication::IsCmdThread ( )
inlinevirtual

Definition at line 135 of file TApplication.h.

◆ IsRunning()

Bool_t TApplication::IsRunning ( ) const
inline

Definition at line 152 of file TApplication.h.

◆ KeyPressed()

void TApplication::KeyPressed ( Int_t  key)
virtual

Emit signal when console keyboard key was pressed.

Definition at line 1942 of file TApplication.cxx.

◆ LineProcessed()

void TApplication::LineProcessed ( const char *  line)
virtual

Emit signal when a line has been processed.

Definition at line 1934 of file TApplication.cxx.

◆ LoadGraphicsLibs()

void TApplication::LoadGraphicsLibs ( )
protectedvirtual

Load shared libs necessary for graphics.

These libraries are only loaded when gROOT->IsBatch() is kFALSE.

Reimplemented in TGApplication.

Definition at line 1332 of file TApplication.cxx.

◆ Lower()

virtual void TApplication::Lower ( )
inlinevirtual

Definition at line 134 of file TApplication.h.

◆ ls()

void TApplication::ls ( Option_t option = "") const
overridevirtual

Show available sessions.

Reimplemented from TObject.

Definition at line 2080 of file TApplication.cxx.

◆ MakeBatch()

void TApplication::MakeBatch ( )
protectedvirtual

Switch to batch mode.

Definition at line 1394 of file TApplication.cxx.

◆ NeedGraphicsLibs()

void TApplication::NeedGraphicsLibs ( )
static

Static method.

This method should be called from static library initializers if the library needs the low level graphics system.

Definition at line 235 of file TApplication.cxx.

◆ NoLogoOpt()

Bool_t TApplication::NoLogoOpt ( ) const
inline

Definition at line 144 of file TApplication.h.

◆ NoLogOpt()

Bool_t TApplication::NoLogOpt ( ) const
inline

Definition at line 143 of file TApplication.h.

◆ Open() [1/2]

virtual void TApplication::Open ( )
inlinevirtual

Definition at line 132 of file TApplication.h.

◆ Open() [2/2]

TApplication * TApplication::Open ( const char *  url,
Int_t  debug,
const char *  script 
)
staticprotected

Static function used to attach to an existing remote application or to start one.

Definition at line 1992 of file TApplication.cxx.

◆ OpenForumTopic()

void TApplication::OpenForumTopic ( const TString type)

It opens a Forum topic in a web browser with prefilled ROOT version.

Parameters
[in]typethe issue type (only bug supported right now)

Definition at line 1012 of file TApplication.cxx.

◆ OpenGitHubIssue()

void TApplication::OpenGitHubIssue ( const TString type)

It opens a GitHub issue in a web browser with prefilled ROOT version.

Parameters
[in]typethe issue type (bug, feature or improvement)

Definition at line 1035 of file TApplication.cxx.

◆ OpenInBrowser()

void TApplication::OpenInBrowser ( const TString url)

The function generates and executes a command that loads the Doxygen URL in a browser.

It works for Mac, Windows and Linux. In the case of Linux, the function also checks if the DISPLAY is set. If it isn't, a warning message and the URL will be displayed on the terminal.

Parameters
[in]urlweb page to be displayed in a browser

Definition at line 630 of file TApplication.cxx.

◆ OpenReferenceGuideFor()

void TApplication::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.

If the user types incorrect value, it will return an error or warning.

Parameters
[in]strippedClassthe scope or scope::member

Definition at line 1066 of file TApplication.cxx.

◆ operator=()

TApplication & TApplication::operator= ( const TApplication )
privatedelete

◆ ParseRemoteLine()

Int_t TApplication::ParseRemoteLine ( const char *  ln,
TString hostdir,
TString user,
Int_t dbg,
TString script 
)
staticprotected

Parse the content of a line starting with ".R" (already stripped-off) The format is.

[user@]host[:dir] [-l user] [-d dbg] [script]
#define d(i)
Definition RSha256.hxx:102
TLine l
Definition textangle.C:4

The variable 'dir' is the remote directory to be used as working dir. The username can be specified in two ways, "-l" having the priority (as in ssh). A 'dbg' value > 0 gives increasing verbosity. The last argument 'script' allows to specify an alternative script to be executed remotely to startup the session.

Definition at line 1418 of file TApplication.cxx.

◆ ProcessFile()

Longptr_t TApplication::ProcessFile ( const char *  file,
Int_t error = nullptr,
Bool_t  keep = kFALSE 
)
virtual

Process a file containing a C++ macro.

Definition at line 1713 of file TApplication.cxx.

◆ ProcessLine()

Longptr_t TApplication::ProcessLine ( const char *  line,
Bool_t  sync = kFALSE,
Int_t err = nullptr 
)
virtual

Process a single command line, either a C++ statement or an interpreter command starting with a ".".

Return the return value of the command cast to a long.

Reimplemented in TApplicationServer, and TApplicationRemote.

Definition at line 1564 of file TApplication.cxx.

◆ ProcessRemote()

Longptr_t TApplication::ProcessRemote ( const char *  line,
Int_t error = nullptr 
)
protectedvirtual

Process the content of a line starting with ".R" (already stripped-off) The format is.

[user@]host[:dir] [-l user] [-d dbg] [script] | [host] -close

The variable 'dir' is the remote directory to be used as working dir. The username can be specified in two ways, "-l" having the priority (as in ssh). A 'dbg' value > 0 gives increasing verbosity. The last argument 'script' allows to specify an alternative script to be executed remotely to startup the session.

Reimplemented in TRint.

Definition at line 1484 of file TApplication.cxx.

◆ QuitOpt()

Bool_t TApplication::QuitOpt ( ) const
inline

Definition at line 145 of file TApplication.h.

◆ Raise()

virtual void TApplication::Raise ( )
inlinevirtual

Definition at line 133 of file TApplication.h.

◆ RemoveIdleTimer()

void TApplication::RemoveIdleTimer ( )
virtual

Remove idle timer. Normally called via TROOT::Idle(0).

Definition at line 1878 of file TApplication.cxx.

◆ ReturnFromRun()

Bool_t TApplication::ReturnFromRun ( ) const
inline

Definition at line 153 of file TApplication.h.

◆ ReturnPressed()

void TApplication::ReturnPressed ( char *  text)
virtual

Emit signal when return key was pressed.

Definition at line 1950 of file TApplication.cxx.

◆ Run()

void TApplication::Run ( Bool_t  retrn = kFALSE)
virtual

Main application eventloop. Calls system dependent eventloop via gSystem.

Reimplemented in TRint, TApplicationServer, and TProofServ.

Definition at line 1853 of file TApplication.cxx.

◆ SetEchoMode()

void TApplication::SetEchoMode ( Bool_t  mode)
virtual

Set console echo mode:

  • mode = kTRUE - echo input symbols
  • mode = kFALSE - noecho input symbols

Reimplemented in TRint.

Definition at line 1961 of file TApplication.cxx.

◆ SetIdleTimer()

void TApplication::SetIdleTimer ( UInt_t  idleTimeInSec,
const char *  command 
)
virtual

Set the command to be executed after the system has been idle for idleTimeInSec seconds.

Normally called via TROOT::Idle(...).

Definition at line 1867 of file TApplication.cxx.

◆ SetReturnFromRun()

void TApplication::SetReturnFromRun ( Bool_t  ret)
inline

Definition at line 154 of file TApplication.h.

◆ SetSignalHandler()

void TApplication::SetSignalHandler ( TSignalHandler sh)
inlineprotected

Definition at line 92 of file TApplication.h.

◆ Show()

virtual void TApplication::Show ( )
inlinevirtual

Definition at line 129 of file TApplication.h.

◆ StartIdleing()

void TApplication::StartIdleing ( )
virtual

Called when system starts idleing.

Definition at line 1889 of file TApplication.cxx.

◆ StopIdleing()

void TApplication::StopIdleing ( )
virtual

Called when system stops idleing.

Definition at line 1900 of file TApplication.cxx.

◆ Streamer()

void TApplication::Streamer ( TBuffer R__b)
overridevirtual

Stream an object of class TObject.

Reimplemented from TObject.

Reimplemented in TRint, TGApplication, TApplicationRemote, TApplicationServer, TProofServ, TProofServLite, and TXProofServ.

◆ StreamerNVirtual()

void TApplication::StreamerNVirtual ( TBuffer ClassDef_StreamerNVirtual_b)
inline

Definition at line 167 of file TApplication.h.

◆ TabCompletionHook()

Int_t TApplication::TabCompletionHook ( char *  buf,
int pLoc,
std::ostream &  out 
)
virtual

What to do when tab is pressed.

Re-implemented by TRint. See TTabCom::Hook() for meaning of return values.

Reimplemented in TRint.

Definition at line 1910 of file TApplication.cxx.

◆ Terminate()

void TApplication::Terminate ( Int_t  status = 0)
virtual

Terminate the application by call TSystem::Exit() unless application has been told to return from Run(), by a call to SetReturnFromRun().

Reimplemented in TRint, TApplicationServer, TProofServ, TProofServLite, TXProofServ, and TApplicationRemote.

Definition at line 1920 of file TApplication.cxx.

◆ WorkingDirectory()

const char * TApplication::WorkingDirectory ( ) const
inline

Definition at line 147 of file TApplication.h.

Member Data Documentation

◆ fAppImp

TApplicationImp* TApplication::fAppImp
private

Definition at line 60 of file TApplication.h.

◆ fAppRemote

TApplication* TApplication::fAppRemote
protected

Definition at line 80 of file TApplication.h.

◆ fArgc

Int_t TApplication::fArgc
private

Definition at line 58 of file TApplication.h.

◆ fArgv

char** TApplication::fArgv
private

Definition at line 59 of file TApplication.h.

◆ fExitOnException

EExitOnException TApplication::fExitOnException
private

Definition at line 71 of file TApplication.h.

◆ fFiles

TObjArray* TApplication::fFiles
private

Definition at line 66 of file TApplication.h.

◆ fgApplications

TList * TApplication::fgApplications = nullptr
staticprotected

Definition at line 82 of file TApplication.h.

◆ fgGraphInit

Bool_t TApplication::fgGraphInit = kFALSE
staticprivate

Definition at line 74 of file TApplication.h.

◆ fgGraphNeeded

Bool_t TApplication::fgGraphNeeded = kFALSE
staticprivate

Definition at line 73 of file TApplication.h.

◆ fIdleCommand

TString TApplication::fIdleCommand
private

Definition at line 68 of file TApplication.h.

◆ fIdleTimer

TTimer* TApplication::fIdleTimer
private

Definition at line 69 of file TApplication.h.

◆ fIsRunning

std::atomic<bool> TApplication::fIsRunning
private

Window system specific application implementation.

Definition at line 61 of file TApplication.h.

◆ fNoLog

Bool_t TApplication::fNoLog
private

Definition at line 63 of file TApplication.h.

◆ fNoLogo

Bool_t TApplication::fNoLogo
private

Definition at line 64 of file TApplication.h.

◆ fQuit

Bool_t TApplication::fQuit
private

Definition at line 65 of file TApplication.h.

◆ fReturnFromRun

Bool_t TApplication::fReturnFromRun
private

Definition at line 62 of file TApplication.h.

◆ fSigHandler

TSignalHandler* TApplication::fSigHandler
private

Definition at line 70 of file TApplication.h.

◆ fWorkDir

TString TApplication::fWorkDir
private

Definition at line 67 of file TApplication.h.

  • core/base/inc/TApplication.h
  • core/base/src/TApplication.cxx