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

This class defines toggling facility for both - object's method or variables.

Assume that user provides an object with a two-state field , and methods to Get/Set value of this field. This object enables to switch values via this method when the only thing you know about the field is the name of the method (or method itself) which sets the field. This facility is required in context Pop-Up menu, when the only information about how to toggle a field is a name of methhod which sets it. This class may be also used for toggling an integer variable, which may be important while building universal objects... When user provides a "set-method" of name SetXXX this object tries automaticaly find a matching "get-method" by lookin for a method with name GetXXX, IsXXX or HasXXX for given object.

Definition at line 47 of file TToggle.h.

Public Member Functions

 TToggle ()
 TToggle default constructor.
 
TMethodCallGetGetter () const
 
virtual Long_t GetOffValue ()
 
virtual Long_t GetOnValue ()
 
TMethodCallGetSetter () const
 
virtual Bool_t GetState ()
 Returns the state of Toggle according to its current value and fOnValue, returns true if they match.
 
virtual Int_t GetValue ()
 
TClassIsA () const override
 
virtual Bool_t IsInitialized ()
 
virtual void SetOffValue (Long_t lof)
 
virtual void SetOnValue (Long_t lon)
 
virtual void SetState (Bool_t state)
 Sets the value of toggle to fOnValue or fOffValue according to passed argument.
 
virtual void SetToggledObject (TObject *obj, TMethod *anymethod)
 Initializes it to toggle an object's datamember using this object's method.
 
virtual void SetToggledVariable (Int_t &var)
 Initializes object for use with a variable - you pass it via reference so it will be modified by Toggle.
 
virtual void SetValue (Long_t val)
 Sets the value of toggle and modifies its state according to whether the value is equal to fOnValue.
 
void Streamer (TBuffer &) override
 Stream an object of class TObject.
 
void StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)
 
virtual void Toggle ()
 Toggles the Values and State of this object and connected data!
 
- Public Member Functions inherited from TNamed
 TNamed ()
 
 TNamed (const char *name, const char *title)
 
 TNamed (const TNamed &named)
 TNamed copy ctor.
 
 TNamed (const TString &name, const TString &title)
 
virtual ~TNamed ()
 TNamed destructor.
 
void Clear (Option_t *option="") override
 Set name and title to empty strings ("").
 
TObjectClone (const char *newname="") const override
 Make a clone of an object using the Streamer facility.
 
Int_t Compare (const TObject *obj) const override
 Compare two TNamed objects.
 
void Copy (TObject &named) const override
 Copy this to obj.
 
virtual void FillBuffer (char *&buffer)
 Encode TNamed into output buffer.
 
const char * GetName () const override
 Returns name of object.
 
const char * GetTitle () const override
 Returns title of object.
 
ULong_t Hash () const override
 Return hash value for this object.
 
Bool_t IsSortable () const override
 
void ls (Option_t *option="") const override
 List TNamed name and title.
 
TNamedoperator= (const TNamed &rhs)
 TNamed assignment operator.
 
void Print (Option_t *option="") const override
 Print TNamed name and title.
 
virtual void SetName (const char *name)
 Set the name of the TNamed.
 
virtual void SetNameTitle (const char *name, const char *title)
 Set all the TNamed parameters (name and title).
 
virtual void SetTitle (const char *title="")
 Set the title of the TNamed.
 
virtual Int_t Sizeof () const
 Return size of the TNamed part of the 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 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 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 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
 
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 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.
 

Static Public Member Functions

static TClassClass ()
 
static const char * Class_Name ()
 
static constexpr Version_t Class_Version ()
 
static const char * DeclFileName ()
 
- Static Public Member Functions inherited from TNamed
static TClassClass ()
 
static const char * Class_Name ()
 
static constexpr Version_t Class_Version ()
 
static const char * DeclFileName ()
 
- 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.
 

Protected Attributes

TMethodCallfGetter
 
Bool_t fInitialized
 
TObjectfObject
 
TMethodCallfSetter
 
Int_tfTglVariable
 
- Protected Attributes inherited from TNamed
TString fName
 
TString fTitle
 

Private Attributes

Long_t fOffValue
 
Long_t fOnValue
 
Bool_t fState
 
Longptr_t fValue
 

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 ))
}
 
- Protected Types inherited from TObject
enum  { kOnlyPrepStep = (1ULL << ( 3 )) }
 
- 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 ()
 

#include <TToggle.h>

Inheritance diagram for TToggle:
[legend]

Constructor & Destructor Documentation

◆ TToggle()

TToggle::TToggle ( )

TToggle default constructor.

You have to initialize it before using by making a call to SetToggledVariable() or SetToggledObject().

Definition at line 42 of file TToggle.cxx.

Member Function Documentation

◆ Class()

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

◆ Class_Name()

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

◆ Class_Version()

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

Definition at line 89 of file TToggle.h.

◆ DeclFileName()

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

Definition at line 89 of file TToggle.h.

◆ GetGetter()

TMethodCall * TToggle::GetGetter ( ) const
inline

Definition at line 86 of file TToggle.h.

◆ GetOffValue()

virtual Long_t TToggle::GetOffValue ( )
inlinevirtual

Definition at line 81 of file TToggle.h.

◆ GetOnValue()

virtual Long_t TToggle::GetOnValue ( )
inlinevirtual

Definition at line 79 of file TToggle.h.

◆ GetSetter()

TMethodCall * TToggle::GetSetter ( ) const
inline

Definition at line 87 of file TToggle.h.

◆ GetState()

Bool_t TToggle::GetState ( )
virtual

Returns the state of Toggle according to its current value and fOnValue, returns true if they match.

Definition at line 69 of file TToggle.cxx.

◆ GetValue()

virtual Int_t TToggle::GetValue ( )
inlinevirtual

Definition at line 83 of file TToggle.h.

◆ IsA()

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

Reimplemented from TNamed.

Definition at line 89 of file TToggle.h.

◆ IsInitialized()

virtual Bool_t TToggle::IsInitialized ( )
inlinevirtual

Definition at line 72 of file TToggle.h.

◆ SetOffValue()

virtual void TToggle::SetOffValue ( Long_t  lof)
inlinevirtual

Definition at line 80 of file TToggle.h.

◆ SetOnValue()

virtual void TToggle::SetOnValue ( Long_t  lon)
inlinevirtual

Definition at line 78 of file TToggle.h.

◆ SetState()

void TToggle::SetState ( Bool_t  state)
virtual

Sets the value of toggle to fOnValue or fOffValue according to passed argument.

Definition at line 80 of file TToggle.cxx.

◆ SetToggledObject()

void TToggle::SetToggledObject ( TObject obj,
TMethod anymethod 
)
virtual

Initializes it to toggle an object's datamember using this object's method.

Definition at line 135 of file TToggle.cxx.

◆ SetToggledVariable()

void TToggle::SetToggledVariable ( Int_t var)
virtual

Initializes object for use with a variable - you pass it via reference so it will be modified by Toggle.

Definition at line 59 of file TToggle.cxx.

◆ SetValue()

void TToggle::SetValue ( Long_t  val)
virtual

Sets the value of toggle and modifies its state according to whether the value is equal to fOnValue.

Definition at line 98 of file TToggle.cxx.

◆ Streamer()

void TToggle::Streamer ( TBuffer R__b)
overridevirtual

Stream an object of class TObject.

Reimplemented from TNamed.

◆ StreamerNVirtual()

void TToggle::StreamerNVirtual ( TBuffer ClassDef_StreamerNVirtual_b)
inline

Definition at line 89 of file TToggle.h.

◆ Toggle()

void TToggle::Toggle ( )
virtual

Toggles the Values and State of this object and connected data!

Definition at line 112 of file TToggle.cxx.

Member Data Documentation

◆ fGetter

TMethodCall* TToggle::fGetter
protected

Definition at line 58 of file TToggle.h.

◆ fInitialized

Bool_t TToggle::fInitialized
protected

Definition at line 56 of file TToggle.h.

◆ fObject

TObject* TToggle::fObject
protected

Definition at line 57 of file TToggle.h.

◆ fOffValue

Long_t TToggle::fOffValue
private

Definition at line 52 of file TToggle.h.

◆ fOnValue

Long_t TToggle::fOnValue
private

Definition at line 51 of file TToggle.h.

◆ fSetter

TMethodCall* TToggle::fSetter
protected

Definition at line 59 of file TToggle.h.

◆ fState

Bool_t TToggle::fState
private

Definition at line 50 of file TToggle.h.

◆ fTglVariable

Int_t* TToggle::fTglVariable
protected

Definition at line 61 of file TToggle.h.

◆ fValue

Longptr_t TToggle::fValue
private

Definition at line 53 of file TToggle.h.

Libraries for TToggle:

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