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

Encapsulate a graphics context used in the low level graphics.

TGGCPool provides a pool of graphics contexts.

Definition at line 22 of file TGGC.h.

Public Member Functions

 TGGC (const TGGC &g)
 Copy a graphics context.
 
 TGGC (GCValues_t *values=nullptr)
 Create a graphics context, registers GC in GCPool.
 
virtual ~TGGC ()
 Delete graphics context.
 
Int_t GetArcMode () const
 
const GCValues_tGetAttributes () const
 
Pixel_t GetBackground () const
 
Int_t GetCapStyle () const
 
Pixmap_t GetClipMask () const
 
Int_t GetClipXOrigin () const
 
Int_t GetClipYOrigin () const
 
const char * GetDashes () const
 
Int_t GetDashLen () const
 
Int_t GetDashOffset () const
 
Int_t GetFillRule () const
 
Int_t GetFillStyle () const
 
FontH_t GetFont () const
 
Pixel_t GetForeground () const
 
EGraphicsFunction GetFunction () const
 
GContext_t GetGC () const
 
Bool_t GetGraphicsExposures () const
 
Int_t GetJoinStyle () const
 
Int_t GetLineStyle () const
 
Int_t GetLineWidth () const
 
Mask_t GetMask () const
 
ULong_t GetPlaneMask () const
 
Pixmap_t GetStipple () const
 
Int_t GetSubwindowMode () const
 
Pixmap_t GetTile () const
 
Int_t GetTileStipXOrigin () const
 
Int_t GetTileStipYOrigin () const
 
GContext_t operator() () const
 Not inline due to a bug in g++ 2.96 20000731 (Red Hat Linux 7.0).
 
TGGCoperator= (const TGGC &rhs)
 Graphics context assignment operator.
 
void Print (Option_t *option="") const
 Print graphics contexts info.
 
void SavePrimitive (std::ostream &out, Option_t *option="")
 Save graphics context info as a C++ statement(s) on output stream out.
 
void SetArcMode (Int_t v)
 Set arc mode (kArcChord, kArcPieSlice).
 
void SetAttributes (GCValues_t *values)
 Set attributes as specified in the values structure.
 
void SetBackground (Pixel_t v)
 Set background color.
 
void SetCapStyle (Int_t v)
 Set cap style (kCapNotLast, kCapButt, kCapRound, kCapProjecting).
 
void SetClipMask (Pixmap_t v)
 Bitmap for clipping.
 
void SetClipXOrigin (Int_t v)
 X origin for clipping.
 
void SetClipYOrigin (Int_t v)
 Y origin for clipping.
 
void SetDashList (const char v[], Int_t len)
 Set dash pattern. First use SetDashOffset() if not 0.
 
void SetDashOffset (Int_t v)
 Patterned/dashed line offset.
 
void SetFillRule (Int_t v)
 Set fill rule (kEvenOddRule, kWindingRule).
 
void SetFillStyle (Int_t v)
 Set fill style (kFillSolid, kFillTiled, kFillStippled, kFillOpaeueStippled).
 
void SetFont (FontH_t v)
 Set font.
 
void SetForeground (Pixel_t v)
 Set foreground color.
 
void SetFunction (EGraphicsFunction v)
 Set graphics context drawing function.
 
void SetGraphicsExposures (Bool_t v)
 True if graphics exposure should be generated.
 
void SetJoinStyle (Int_t v)
 Set line join style (kJoinMiter, kJoinRound, kJoinBevel).
 
void SetLineStyle (Int_t v)
 Set line style (kLineSolid, kLineOnOffDash, kLineDoubleDash).
 
void SetLineWidth (Int_t v)
 Set line width.
 
void SetPlaneMask (ULong_t v)
 Set plane mask.
 
void SetStipple (Pixmap_t v)
 Set 1 plane pixmap for stippling.
 
void SetSubwindowMode (Int_t v)
 Set sub window mode (kClipByChildren, kIncludeInferiors).
 
void SetTile (Pixmap_t v)
 Set tile pixmap for tiling operations.
 
void SetTileStipXOrigin (Int_t v)
 X offset for tile or stipple operations.
 
void SetTileStipYOrigin (Int_t v)
 Y offset for tile or stipple operations.
 
- 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 for instance with: gROOT->SetSelectedPad(gPad).
 
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=0)
 Execute method on this object with the given parameter string, e.g.
 
virtual void Execute (TMethod *method, TObjArray *params, Int_t *error=0)
 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
 
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 [].
 
voidoperator new (size_t sz)
 
voidoperator new (size_t sz, void *vp)
 
voidoperator new[] (size_t sz)
 
voidoperator 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 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.
 
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.
 
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=0, Int_t option=0, Int_t bufsize=0)
 Write this object to the current directory.
 
virtual Int_t Write (const char *name=0, 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)
 

Protected Member Functions

 TGGC (GCValues_t *values, Bool_t calledByGCPool)
 Create a graphics context (only called via TGGCPool::GetGC()).
 
TString GetMaskString () const
 Returns GC mask as a string - used in SavePrimitive().
 
void UpdateValues (GCValues_t *v)
 Update values + mask.
 
- 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

GContext_t fContext
 graphics context handle
 
GCValues_t fValues = {}
 graphics context values + mask
 
- Protected Attributes inherited from TRefCnt
UInt_t fRefs
 

Friends

class TGGCPool
 

Additional Inherited Members

- Public Types inherited from TObject
enum  {
  kIsOnHeap = 0x01000000 , kNotDeleted = 0x02000000 , kZombie = 0x04000000 , kInconsistent = 0x08000000 ,
  kBitMask = 0x00ffffff
}
 
enum  { kSingleKey = BIT(0) , kOverwrite = BIT(1) , kWriteDelete = BIT(2) }
 
enum  EDeprecatedStatusBits { kObjInCanvas = BIT(3) }
 
enum  EStatusBits {
  kCanDelete = BIT(0) , kMustCleanup = BIT(3) , kIsReferenced = BIT(4) , kHasUUID = BIT(5) ,
  kCannotPick = BIT(6) , kNoContextMenu = BIT(8) , kInvalidObject = BIT(13)
}
 
- Public Types inherited from TRefCnt
enum  EReferenceFlag { kStaticInit }
 
- Static Public Member Functions inherited from TObject
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 Types inherited from TObject
enum  { kOnlyPrepStep = BIT(3) }
 

#include <TGGC.h>

Inheritance diagram for TGGC:
[legend]

Constructor & Destructor Documentation

◆ TGGC() [1/3]

TGGC::TGGC ( GCValues_t values,
Bool_t  calledByGCPool 
)
protected

Create a graphics context (only called via TGGCPool::GetGC()).

Definition at line 38 of file TGGC.cxx.

◆ TGGC() [2/3]

TGGC::TGGC ( GCValues_t values = nullptr)

Create a graphics context, registers GC in GCPool.

Definition at line 62 of file TGGC.cxx.

◆ TGGC() [3/3]

TGGC::TGGC ( const TGGC g)

Copy a graphics context.

Definition at line 84 of file TGGC.cxx.

◆ ~TGGC()

TGGC::~TGGC ( )
virtual

Delete graphics context.

Definition at line 103 of file TGGC.cxx.

Member Function Documentation

◆ GetArcMode()

Int_t TGGC::GetArcMode ( ) const
inline

Definition at line 94 of file TGGC.h.

◆ GetAttributes()

const GCValues_t * TGGC::GetAttributes ( ) const
inline

Definition at line 69 of file TGGC.h.

◆ GetBackground()

Pixel_t TGGC::GetBackground ( ) const
inline

Definition at line 74 of file TGGC.h.

◆ GetCapStyle()

Int_t TGGC::GetCapStyle ( ) const
inline

Definition at line 87 of file TGGC.h.

◆ GetClipMask()

Pixmap_t TGGC::GetClipMask ( ) const
inline

Definition at line 86 of file TGGC.h.

◆ GetClipXOrigin()

Int_t TGGC::GetClipXOrigin ( ) const
inline

Definition at line 84 of file TGGC.h.

◆ GetClipYOrigin()

Int_t TGGC::GetClipYOrigin ( ) const
inline

Definition at line 85 of file TGGC.h.

◆ GetDashes()

const char * TGGC::GetDashes ( ) const
inline

Definition at line 93 of file TGGC.h.

◆ GetDashLen()

Int_t TGGC::GetDashLen ( ) const
inline

Definition at line 92 of file TGGC.h.

◆ GetDashOffset()

Int_t TGGC::GetDashOffset ( ) const
inline

Definition at line 91 of file TGGC.h.

◆ GetFillRule()

Int_t TGGC::GetFillRule ( ) const
inline

Definition at line 90 of file TGGC.h.

◆ GetFillStyle()

Int_t TGGC::GetFillStyle ( ) const
inline

Definition at line 89 of file TGGC.h.

◆ GetFont()

FontH_t TGGC::GetFont ( ) const
inline

Definition at line 82 of file TGGC.h.

◆ GetForeground()

Pixel_t TGGC::GetForeground ( ) const
inline

Definition at line 73 of file TGGC.h.

◆ GetFunction()

EGraphicsFunction TGGC::GetFunction ( ) const
inline

Definition at line 71 of file TGGC.h.

◆ GetGC()

GContext_t TGGC::GetGC ( ) const
inline

Definition at line 41 of file TGGC.h.

◆ GetGraphicsExposures()

Bool_t TGGC::GetGraphicsExposures ( ) const
inline

Definition at line 83 of file TGGC.h.

◆ GetJoinStyle()

Int_t TGGC::GetJoinStyle ( ) const
inline

Definition at line 88 of file TGGC.h.

◆ GetLineStyle()

Int_t TGGC::GetLineStyle ( ) const
inline

Definition at line 76 of file TGGC.h.

◆ GetLineWidth()

Int_t TGGC::GetLineWidth ( ) const
inline

Definition at line 75 of file TGGC.h.

◆ GetMask()

Mask_t TGGC::GetMask ( ) const
inline

Definition at line 70 of file TGGC.h.

◆ GetMaskString()

TString TGGC::GetMaskString ( ) const
protected

Returns GC mask as a string - used in SavePrimitive().

Definition at line 523 of file TGGC.cxx.

◆ GetPlaneMask()

ULong_t TGGC::GetPlaneMask ( ) const
inline

Definition at line 72 of file TGGC.h.

◆ GetStipple()

Pixmap_t TGGC::GetStipple ( ) const
inline

Definition at line 78 of file TGGC.h.

◆ GetSubwindowMode()

Int_t TGGC::GetSubwindowMode ( ) const
inline

Definition at line 81 of file TGGC.h.

◆ GetTile()

Pixmap_t TGGC::GetTile ( ) const
inline

Definition at line 77 of file TGGC.h.

◆ GetTileStipXOrigin()

Int_t TGGC::GetTileStipXOrigin ( ) const
inline

Definition at line 79 of file TGGC.h.

◆ GetTileStipYOrigin()

Int_t TGGC::GetTileStipYOrigin ( ) const
inline

Definition at line 80 of file TGGC.h.

◆ operator()()

GContext_t TGGC::operator() ( ) const

Not inline due to a bug in g++ 2.96 20000731 (Red Hat Linux 7.0).

Definition at line 138 of file TGGC.cxx.

◆ operator=()

TGGC & TGGC::operator= ( const TGGC rhs)

Graphics context assignment operator.

Definition at line 115 of file TGGC.cxx.

◆ Print()

void TGGC::Print ( Option_t option = "") const
virtual

Print graphics contexts info.

Reimplemented from TObject.

Definition at line 514 of file TGGC.cxx.

◆ SavePrimitive()

void TGGC::SavePrimitive ( std::ostream &  out,
Option_t option = "" 
)
virtual

Save graphics context info as a C++ statement(s) on output stream out.

Reimplemented from TObject.

Definition at line 627 of file TGGC.cxx.

◆ SetArcMode()

void TGGC::SetArcMode ( Int_t  v)

Set arc mode (kArcChord, kArcPieSlice).

Definition at line 503 of file TGGC.cxx.

◆ SetAttributes()

void TGGC::SetAttributes ( GCValues_t values)

Set attributes as specified in the values structure.

Definition at line 235 of file TGGC.cxx.

◆ SetBackground()

void TGGC::SetBackground ( Pixel_t  v)

Set background color.

Definition at line 289 of file TGGC.cxx.

◆ SetCapStyle()

void TGGC::SetCapStyle ( Int_t  v)

Set cap style (kCapNotLast, kCapButt, kCapRound, kCapProjecting).

Definition at line 322 of file TGGC.cxx.

◆ SetClipMask()

void TGGC::SetClipMask ( Pixmap_t  v)

Bitmap for clipping.

Definition at line 466 of file TGGC.cxx.

◆ SetClipXOrigin()

void TGGC::SetClipXOrigin ( Int_t  v)

X origin for clipping.

Definition at line 444 of file TGGC.cxx.

◆ SetClipYOrigin()

void TGGC::SetClipYOrigin ( Int_t  v)

Y origin for clipping.

Definition at line 455 of file TGGC.cxx.

◆ SetDashList()

void TGGC::SetDashList ( const char  v[],
Int_t  len 
)

Set dash pattern. First use SetDashOffset() if not 0.

Definition at line 488 of file TGGC.cxx.

◆ SetDashOffset()

void TGGC::SetDashOffset ( Int_t  v)

Patterned/dashed line offset.

Definition at line 477 of file TGGC.cxx.

◆ SetFillRule()

void TGGC::SetFillRule ( Int_t  v)

Set fill rule (kEvenOddRule, kWindingRule).

Definition at line 356 of file TGGC.cxx.

◆ SetFillStyle()

void TGGC::SetFillStyle ( Int_t  v)

Set fill style (kFillSolid, kFillTiled, kFillStippled, kFillOpaeueStippled).

Definition at line 345 of file TGGC.cxx.

◆ SetFont()

void TGGC::SetFont ( FontH_t  v)

Set font.

Definition at line 411 of file TGGC.cxx.

◆ SetForeground()

void TGGC::SetForeground ( Pixel_t  v)

Set foreground color.

Definition at line 278 of file TGGC.cxx.

◆ SetFunction()

void TGGC::SetFunction ( EGraphicsFunction  v)

Set graphics context drawing function.

Definition at line 256 of file TGGC.cxx.

◆ SetGraphicsExposures()

void TGGC::SetGraphicsExposures ( Bool_t  v)

True if graphics exposure should be generated.

Definition at line 433 of file TGGC.cxx.

◆ SetJoinStyle()

void TGGC::SetJoinStyle ( Int_t  v)

Set line join style (kJoinMiter, kJoinRound, kJoinBevel).

Definition at line 333 of file TGGC.cxx.

◆ SetLineStyle()

void TGGC::SetLineStyle ( Int_t  v)

Set line style (kLineSolid, kLineOnOffDash, kLineDoubleDash).

Definition at line 311 of file TGGC.cxx.

◆ SetLineWidth()

void TGGC::SetLineWidth ( Int_t  v)

Set line width.

Definition at line 300 of file TGGC.cxx.

◆ SetPlaneMask()

void TGGC::SetPlaneMask ( ULong_t  v)

Set plane mask.

Definition at line 267 of file TGGC.cxx.

◆ SetStipple()

void TGGC::SetStipple ( Pixmap_t  v)

Set 1 plane pixmap for stippling.

Definition at line 378 of file TGGC.cxx.

◆ SetSubwindowMode()

void TGGC::SetSubwindowMode ( Int_t  v)

Set sub window mode (kClipByChildren, kIncludeInferiors).

Definition at line 422 of file TGGC.cxx.

◆ SetTile()

void TGGC::SetTile ( Pixmap_t  v)

Set tile pixmap for tiling operations.

Definition at line 367 of file TGGC.cxx.

◆ SetTileStipXOrigin()

void TGGC::SetTileStipXOrigin ( Int_t  v)

X offset for tile or stipple operations.

Definition at line 389 of file TGGC.cxx.

◆ SetTileStipYOrigin()

void TGGC::SetTileStipYOrigin ( Int_t  v)

Y offset for tile or stipple operations.

Definition at line 400 of file TGGC.cxx.

◆ UpdateValues()

void TGGC::UpdateValues ( GCValues_t v)
protected

Update values + mask.

Definition at line 146 of file TGGC.cxx.

Friends And Related Symbol Documentation

◆ TGGCPool

friend class TGGCPool
friend

Definition at line 24 of file TGGC.h.

Member Data Documentation

◆ fContext

GContext_t TGGC::fContext
protected

graphics context handle

Definition at line 28 of file TGGC.h.

◆ fValues

GCValues_t TGGC::fValues = {}
protected

graphics context values + mask

Definition at line 27 of file TGGC.h.

Libraries for TGGC:

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