The TGPicture class implements pictures and icons used in the different GUI elements and widgets.

The TGPicturePool class implements a TGPicture cache. TGPictures are created, managed and destroyed by the TGPicturePool.

Definition at line 25 of file TGPicture.h.

Public Member Functions
virtual	~TGPicture ()
	Delete picture object.

virtual void	Draw (Handle_t id, GContext_t gc, Int_t x, Int_t y) const
	Draw a picture.

UInt_t	GetHeight () const

Pixmap_t	GetMask () const

const char *	GetName () const override
	Returns name of object.

Pixmap_t	GetPicture () const

UInt_t	GetWidth () const

ULong_t	Hash () const override
	Return hash value for this object.

TClass *	IsA () const override

Bool_t	IsScaled () const

void	Print (Option_t *option="") const override
	Print picture info.

void	Streamer (TBuffer &) override
	Stream an object of class TObject.

void	StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)

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 TObject *	Clone (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	DrawClass () const
	Draw class inheritance tree of the class to which this object belongs.

virtual TObject *	DrawClone (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 TObject *	FindObject (const char *name) const
	Must be redefined in derived classes.

virtual TObject *	FindObject (const TObject *obj) const
	Must be redefined in derived classes.

virtual Option_t *	GetDrawOption () const
	Get option used by the graphics system to draw this object.

virtual const char *	GetIconName () const
	Returns mime type 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_t *	GetOption () 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.

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

virtual void	ls (Option_t *option="") const
	The ls function lists the contents of a class on stdout.

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.

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)
	Operator delete [].

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)

TObject &	operator= (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 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 TRefCnt
	TRefCnt (EReferenceFlag)
	Leave fRefs alone.

	TRefCnt (Int_t initRef=0)

virtual	~TRefCnt ()

void	AddReference ()

UInt_t	References () const

UInt_t	RemoveReference ()

void	SetRefCount (UInt_t r)

Static Public Member Functions
static TClass *	Class ()

static const char *	Class_Name ()

static constexpr Version_t	Class_Version ()

static const char *	DeclFileName ()

static const char *	HashName (const char *name, Int_t width, Int_t height)
	Static function returning a unique name used to look up a picture.

Static Public Member Functions inherited from TObject
static TClass *	Class ()

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.

Protected Member Functions
	TGPicture (const char *name, Bool_t scaled=kFALSE)

	TGPicture (const char *name, Pixmap_t pxmap, Pixmap_t mask=0)
	ctor. Important: both pixmaps pxmap and mask must be unique (not shared)

void	Draw (Option_t *="") override
	Default Draw method for all objects.

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 Attributes
PictureAttributes_t	fAttributes
	picture attributes

Pixmap_t	fMask
	picture mask pixmap

TString	fName
	name of picture

Pixmap_t	fPic
	picture pixmap

Bool_t	fScaled
	kTRUE if picture is scaled

Protected Attributes inherited from TRefCnt
UInt_t	fRefs

Friends
class	TGPicturePool

Additional Inherited Members
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 Types inherited from TRefCnt
enum	EReferenceFlag { kStaticInit }

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

#include <TGPicture.h>

Inheritance diagram for TGPicture:

[legend]

Constructor & Destructor Documentation

◆ TGPicture() [1/2]

TGPicture::TGPicture	(	const char *	name,
		Bool_t	scaled = `kFALSE`
	)

inlineprotected

Definition at line 36 of file TGPicture.h.

◆ TGPicture() [2/2]

TGPicture::TGPicture	(	const char *	name,
		Pixmap_t	pxmap,
		Pixmap_t	mask = `0`
	)

protected

ctor. Important: both pixmaps pxmap and mask must be unique (not shared)

Definition at line 318 of file TGPicture.cxx.

◆ ~TGPicture()

TGPicture::~TGPicture ( )

virtual

Delete picture object.

Definition at line 361 of file TGPicture.cxx.

Member Function Documentation

◆ Class()

static TClass * TGPicture::Class ( )

static

Returns: TClass describing this class

◆ Class_Name()

static const char * TGPicture::Class_Name ( )

static

Returns: Name of this class

◆ Class_Version()

static constexpr Version_t TGPicture::Class_Version ( )

inlinestaticconstexpr

Returns: Version of this class

Definition at line 63 of file TGPicture.h.

◆ DeclFileName()

static const char * TGPicture::DeclFileName ( )

inlinestatic

Returns: Name of the file containing the class declaration

Definition at line 63 of file TGPicture.h.

◆ Draw() [1/2]

void TGPicture::Draw	(	Handle_t	id,
		GContext_t	gc,
		Int_t	x,
		Int_t	y
	)		const

virtual

Draw a picture.

Definition at line 342 of file TGPicture.cxx.

◆ Draw() [2/2]

void TGPicture::Draw ( Option_t * option = "" )

inlineoverrideprotectedvirtual

Default Draw method for all objects.

Reimplemented from TObject.

Definition at line 46 of file TGPicture.h.

◆ GetHeight()

UInt_t TGPicture::GetHeight ( ) const

inline

Definition at line 53 of file TGPicture.h.

◆ GetMask()

Pixmap_t TGPicture::GetMask ( ) const

inline

Definition at line 55 of file TGPicture.h.

◆ GetName()

const char * TGPicture::GetName ( ) const

inlineoverridevirtual

Returns name of object.

This default method returns the class name. Classes that give objects a name should override this method.

Reimplemented from TObject.

Definition at line 51 of file TGPicture.h.

◆ GetPicture()

Pixmap_t TGPicture::GetPicture ( ) const

inline

Definition at line 54 of file TGPicture.h.

◆ GetWidth()

UInt_t TGPicture::GetWidth ( ) const

inline

Definition at line 52 of file TGPicture.h.

◆ Hash()

ULong_t TGPicture::Hash ( ) const

inlineoverridevirtual

Return hash value for this object.

Note: If this routine is overloaded in a derived class, this derived class should also add

ROOT::CallRecursiveRemoveIfNeeded(*this)

ROOT::CallRecursiveRemoveIfNeeded

void CallRecursiveRemoveIfNeeded(TObject &obj)

call RecursiveRemove for obj if gROOT is valid and obj.TestBit(kMustCleanup) is true.

Definition TROOT.h:394

Otherwise, when RecursiveRemove is called (by ~TObject or example) for this type of object, the transversal of THashList and THashTable containers will will have to be done without call Hash (and hence be linear rather than logarithmic complexity). You will also see warnings like

Error in <ROOT::Internal::TCheckHashRecursiveRemoveConsistency::CheckRecursiveRemove>: The class SomeName overrides TObject::Hash but does not call TROOT::RecursiveRemove in its destructor.

TGPicture::Hash

ULong_t Hash() const override

Return hash value for this object.

Definition TGPicture.h:57

TObject

Mother of all ROOT objects.

Definition TObject.h:41

TObject::Error

virtual void Error(const char *method, const char *msgfmt,...) const

Issue error message.

Definition TObject.cxx:970

TROOT::RecursiveRemove

void RecursiveRemove(TObject *obj) override

Recursively remove this object from the list of Cleanups.

Definition TROOT.cxx:2465

Reimplemented from TObject.

Definition at line 57 of file TGPicture.h.

◆ HashName()

const char * TGPicture::HashName	(	const char *	name,
		Int_t	width,
		Int_t	height
	)

static

Static function returning a unique name used to look up a picture.

The unique name has the form "name__widthxheight".

Definition at line 375 of file TGPicture.cxx.

◆ IsA()

TClass * TGPicture::IsA ( ) const

inlineoverridevirtual

Returns: TClass describing current object

Reimplemented from TObject.

Reimplemented in TGSelectedPicture.

Definition at line 63 of file TGPicture.h.

◆ IsScaled()

Bool_t TGPicture::IsScaled ( ) const

inline

Definition at line 56 of file TGPicture.h.

◆ Print()

void TGPicture::Print ( Option_t * option = "" ) const

overridevirtual

Print picture info.

Reimplemented from TObject.

Definition at line 386 of file TGPicture.cxx.

◆ Streamer()

void TGPicture::Streamer ( TBuffer & R__b )

overridevirtual

Stream an object of class TObject.

Reimplemented from TObject.

Reimplemented in TGSelectedPicture.

◆ StreamerNVirtual()

void TGPicture::StreamerNVirtual ( TBuffer & ClassDef_StreamerNVirtual_b )

inline

Definition at line 63 of file TGPicture.h.

Friends And Related Symbol Documentation

◆ TGPicturePool

friend class TGPicturePool

friend

Definition at line 27 of file TGPicture.h.

Member Data Documentation

◆ fAttributes

PictureAttributes_t TGPicture::fAttributes

protected

picture attributes

Definition at line 34 of file TGPicture.h.

◆ fMask

Pixmap_t TGPicture::fMask

protected

picture mask pixmap

Definition at line 33 of file TGPicture.h.

◆ fName

TString TGPicture::fName

protected

name of picture

Definition at line 30 of file TGPicture.h.

◆ fPic

Pixmap_t TGPicture::fPic

protected

picture pixmap

Definition at line 32 of file TGPicture.h.

◆ fScaled

Bool_t TGPicture::fScaled

protected

kTRUE if picture is scaled

Definition at line 31 of file TGPicture.h.

Libraries for TGPicture:

[legend]

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

gui/gui/inc/TGPicture.h
gui/gui/src/TGPicture.cxx

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Additional Inherited Members

Constructor & Destructor Documentation

◆ TGPicture() [1/2]

◆ TGPicture() [2/2]

◆ ~TGPicture()

Member Function Documentation

◆ Class()

◆ Class_Name()

◆ Class_Version()

◆ DeclFileName()

◆ Draw() [1/2]

◆ Draw() [2/2]

◆ GetHeight()

◆ GetMask()

◆ GetName()

◆ GetPicture()

◆ GetWidth()

◆ Hash()

◆ HashName()

◆ IsA()

◆ IsScaled()

◆ Print()

◆ Streamer()

◆ StreamerNVirtual()

Friends And Related Symbol Documentation

◆ TGPicturePool

Member Data Documentation

◆ fAttributes

◆ fMask

◆ fName

◆ fPic

◆ fScaled