ROOT  6.06/09
Reference Guide
Public Member Functions | Protected Attributes | Private Attributes | List of all members
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 51 of file TToggle.h.

Public Member Functions

 TToggle ()
 
virtual void SetToggledObject (TObject *obj, TMethod *anymethod)
 Initializes it to toggle an object's datamember using this object's method. More...
 
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. More...
 
virtual Bool_t IsInitialized ()
 
virtual Bool_t GetState ()
 Returns the state of Toggle according to its current value and fOnValue, returns true if they match. More...
 
virtual void SetState (Bool_t state)
 Sets the value of toggle to fOnValue or fOffValue according to passed argument. More...
 
virtual void Toggle ()
 Toggles the Values and State of this object and connected data! More...
 
virtual void SetOnValue (Long_t lon)
 
virtual Long_t GetOnValue ()
 
virtual void SetOffValue (Long_t lof)
 
virtual Long_t GetOffValue ()
 
virtual Int_t GetValue ()
 
virtual void SetValue (Long_t val)
 Sets the value of toggle and modifies its state according to whether the value is equal to fOnValue. More...
 
TMethodCallGetGetter () const
 
TMethodCallGetSetter () const
 
- Public Member Functions inherited from TNamed
 TNamed ()
 
 TNamed (const char *name, const char *title)
 
 TNamed (const TString &name, const TString &title)
 
 TNamed (const TNamed &named)
 
TNamedoperator= (const TNamed &rhs)
 TNamed assignment operator. More...
 
virtual ~TNamed ()
 
virtual void Clear (Option_t *option="")
 Set name and title to empty strings (""). More...
 
virtual TObjectClone (const char *newname="") const
 Make a clone of an object using the Streamer facility. More...
 
virtual Int_t Compare (const TObject *obj) const
 Compare two TNamed objects. More...
 
virtual void Copy (TObject &named) const
 Copy this to obj. More...
 
virtual void FillBuffer (char *&buffer)
 Encode TNamed into output buffer. More...
 
virtual const char * GetName () const
 Returns name of object. More...
 
virtual const char * GetTitle () const
 Returns title of object. More...
 
virtual ULong_t Hash () const
 Return hash value for this object. More...
 
virtual Bool_t IsSortable () const
 
virtual void SetName (const char *name)
 Change (i.e. More...
 
virtual void SetNameTitle (const char *name, const char *title)
 Change (i.e. set) all the TNamed parameters (name and title). More...
 
virtual void SetTitle (const char *title="")
 Change (i.e. set) the title of the TNamed. More...
 
virtual void ls (Option_t *option="") const
 List TNamed name and title. More...
 
virtual void Print (Option_t *option="") const
 Print TNamed name and title. More...
 
virtual Int_t Sizeof () const
 Return size of the TNamed part of the TObject. More...
 
- Public Member Functions inherited from TObject
 TObject ()
 
 TObject (const TObject &object)
 TObject copy ctor. More...
 
TObjectoperator= (const TObject &rhs)
 TObject assignment operator. More...
 
virtual ~TObject ()
 TObject destructor. More...
 
virtual void AppendPad (Option_t *option="")
 Append graphics object to current pad. More...
 
virtual void Browse (TBrowser *b)
 Browse object. May be overridden for another default action. More...
 
virtual const char * ClassName () const
 Returns name of class to which the object belongs. More...
 
virtual void Delete (Option_t *option="")
 Delete this object. More...
 
virtual Int_t DistancetoPrimitive (Int_t px, Int_t py)
 Computes distance from point (px,py) to the object. More...
 
virtual void Draw (Option_t *option="")
 Default Draw method for all objects. More...
 
virtual void DrawClass () const
 Draw class inheritance tree of the class to which this object belongs. More...
 
virtual TObjectDrawClone (Option_t *option="") const
 Draw a clone of this object in the current pad. More...
 
virtual void Dump () const
 Dump contents of object on stdout. More...
 
virtual void Execute (const char *method, const char *params, Int_t *error=0)
 Execute method on this object with the given parameter string, e.g. More...
 
virtual void Execute (TMethod *method, TObjArray *params, Int_t *error=0)
 Execute method on this object with parameters stored in the TObjArray. More...
 
virtual void ExecuteEvent (Int_t event, Int_t px, Int_t py)
 Execute action corresponding to an event at (px,py). More...
 
virtual TObjectFindObject (const char *name) const
 Must be redefined in derived classes. More...
 
virtual TObjectFindObject (const TObject *obj) const
 Must be redefined in derived classes. More...
 
virtual Option_tGetDrawOption () const
 Get option used by the graphics system to draw this object. More...
 
virtual UInt_t GetUniqueID () const
 Return the unique object id. More...
 
virtual const char * GetIconName () const
 Returns mime type name of object. More...
 
virtual Option_tGetOption () const
 
virtual char * GetObjectInfo (Int_t px, Int_t py) const
 Returns string containing info about the object at position (px,py). More...
 
virtual Bool_t HandleTimer (TTimer *timer)
 Execute action in response of a timer timing out. More...
 
virtual Bool_t InheritsFrom (const char *classname) const
 Returns kTRUE if object inherits from class "classname". More...
 
virtual Bool_t InheritsFrom (const TClass *cl) const
 Returns kTRUE if object inherits from TClass cl. More...
 
virtual void Inspect () const
 Dump contents of this object in a graphics canvas. More...
 
virtual Bool_t IsFolder () const
 Returns kTRUE in case object contains browsable objects (like containers or lists of other objects). More...
 
virtual Bool_t IsEqual (const TObject *obj) const
 Default equal comparison (objects are equal if they have the same address in memory). More...
 
Bool_t IsOnHeap () const
 
Bool_t IsZombie () const
 
virtual Bool_t Notify ()
 This method must be overridden to handle object notification. More...
 
virtual void Paint (Option_t *option="")
 This method must be overridden if a class wants to paint itself. More...
 
virtual void Pop ()
 Pop on object drawn in a pad to the top of the display list. More...
 
virtual Int_t Read (const char *name)
 Read contents of object with specified name from the current directory. More...
 
virtual void RecursiveRemove (TObject *obj)
 Recursively remove this object from a list. More...
 
virtual void SaveAs (const char *filename="", Option_t *option="") const
 Save this object in the file specified by filename. More...
 
virtual void SavePrimitive (std::ostream &out, Option_t *option="")
 Save a primitive as a C++ statement(s) on output stream "out". More...
 
virtual void SetDrawOption (Option_t *option="")
 Set drawing option for object. More...
 
virtual void SetUniqueID (UInt_t uid)
 Set the unique object id. More...
 
virtual void UseCurrentStyle ()
 Set current style settings in this object This function is called when either TCanvas::UseCurrentStyle or TROOT::ForceStyle have been invoked. More...
 
virtual Int_t Write (const char *name=0, Int_t option=0, Int_t bufsize=0)
 Write this object to the current directory. More...
 
virtual Int_t Write (const char *name=0, Int_t option=0, Int_t bufsize=0) const
 Write this object to the current directory. More...
 
voidoperator new (size_t sz)
 
voidoperator new[] (size_t sz)
 
voidoperator new (size_t sz, void *vp)
 
voidoperator new[] (size_t sz, void *vp)
 
void operator delete (void *ptr)
 Operator delete. More...
 
void operator delete[] (void *ptr)
 Operator delete []. More...
 
void SetBit (UInt_t f, Bool_t set)
 Set or unset the user status bits as specified in f. More...
 
void SetBit (UInt_t f)
 
void ResetBit (UInt_t f)
 
Bool_t TestBit (UInt_t f) const
 
Int_t TestBits (UInt_t f) const
 
void InvertBit (UInt_t f)
 
virtual void Info (const char *method, const char *msgfmt,...) const
 Issue info message. More...
 
virtual void Warning (const char *method, const char *msgfmt,...) const
 Issue warning message. More...
 
virtual void Error (const char *method, const char *msgfmt,...) const
 Issue error message. More...
 
virtual void SysError (const char *method, const char *msgfmt,...) const
 Issue system error message. More...
 
virtual void Fatal (const char *method, const char *msgfmt,...) const
 Issue fatal error message. More...
 
void AbstractMethod (const char *method) const
 Use this method to implement an "abstract" method that you don't want to leave purely abstract. More...
 
void MayNotUse (const char *method) const
 Use this method to signal that a method (defined in a base class) may not be called in a derived class (in principle against good design since a child class should not provide less functionality than its parent, however, sometimes it is necessary). More...
 
void Obsolete (const char *method, const char *asOfVers, const char *removedFromVers) const
 Use this method to declare a method obsolete. More...
 

Protected Attributes

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

Private Attributes

Bool_t fState
 
Long_t fOnValue
 
Long_t fOffValue
 
Long_t fValue
 

Additional Inherited Members

- Public Types inherited from TObject
enum  EStatusBits {
  kCanDelete = BIT(0), kMustCleanup = BIT(3), kObjInCanvas = BIT(3), kIsReferenced = BIT(4),
  kHasUUID = BIT(5), kCannotPick = BIT(6), kNoContextMenu = BIT(8), kInvalidObject = BIT(13)
}
 
enum  { kIsOnHeap = 0x01000000, kNotDeleted = 0x02000000, kZombie = 0x04000000, kBitMask = 0x00ffffff }
 
enum  { kSingleKey = BIT(0), kOverwrite = BIT(1), kWriteDelete = BIT(2) }
 
- Static Public Member Functions inherited from TObject
static Long_t GetDtorOnly ()
 Return destructor only flag. More...
 
static void SetDtorOnly (void *obj)
 Set destructor only flag. More...
 
static Bool_t GetObjectStat ()
 Get status of object stat flag. More...
 
static void SetObjectStat (Bool_t stat)
 Turn on/off tracking of objects in the TObjectTable. More...
 
- Protected Member Functions inherited from TObject
void MakeZombie ()
 
virtual void DoError (int level, const char *location, const char *fmt, va_list va) const
 Interface to ErrorHandler (protected). More...
 

#include <TToggle.h>

+ Inheritance diagram for TToggle:
+ Collaboration diagram for TToggle:

Constructor & Destructor Documentation

TToggle::TToggle ( )

Member Function Documentation

TMethodCall* TToggle::GetGetter ( ) const
inline

Definition at line 90 of file TToggle.h.

virtual Long_t TToggle::GetOffValue ( )
inlinevirtual

Definition at line 85 of file TToggle.h.

virtual Long_t TToggle::GetOnValue ( )
inlinevirtual

Definition at line 83 of file TToggle.h.

TMethodCall* TToggle::GetSetter ( ) const
inline

Definition at line 91 of file TToggle.h.

Referenced by TRootContextMenu::HandleButton().

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 68 of file TToggle.cxx.

Referenced by TGuiBldDragManager::AddClassMenuMethods(), TRootContextMenu::CreateMenu(), TRootContextMenu::ProcessMessage(), and TToggleGroup::Select().

virtual Int_t TToggle::GetValue ( )
inlinevirtual

Definition at line 87 of file TToggle.h.

virtual Bool_t TToggle::IsInitialized ( )
inlinevirtual

Definition at line 76 of file TToggle.h.

virtual void TToggle::SetOffValue ( Long_t  lof)
inlinevirtual

Definition at line 84 of file TToggle.h.

virtual void TToggle::SetOnValue ( Long_t  lon)
inlinevirtual
void TToggle::SetState ( Bool_t  state)
virtual

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

Definition at line 79 of file TToggle.cxx.

Referenced by TRootContextMenu::ProcessMessage().

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

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

Definition at line 134 of file TToggle.cxx.

Referenced by TGuiBldDragManager::AddClassMenuMethods(), and TRootContextMenu::CreateMenu().

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 58 of file TToggle.cxx.

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 97 of file TToggle.cxx.

void TToggle::Toggle ( )
virtual

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

Definition at line 111 of file TToggle.cxx.

Referenced by TContextMenu::Action(), TGuiBldDragManager::DoClassMenu(), and TToggleGroup::Select().

Member Data Documentation

TMethodCall* TToggle::fGetter
protected

Definition at line 62 of file TToggle.h.

Referenced by GetGetter(), GetState(), SetToggledObject(), and Toggle().

Bool_t TToggle::fInitialized
protected

Definition at line 60 of file TToggle.h.

Referenced by GetState(), IsInitialized(), SetState(), SetToggledObject(), SetValue(), and Toggle().

TObject* TToggle::fObject
protected

Definition at line 61 of file TToggle.h.

Referenced by GetState(), SetState(), SetToggledObject(), SetValue(), and Toggle().

Long_t TToggle::fOffValue
private

Definition at line 56 of file TToggle.h.

Referenced by GetOffValue(), SetState(), and Toggle().

Long_t TToggle::fOnValue
private

Definition at line 55 of file TToggle.h.

Referenced by GetOnValue(), GetState(), SetState(), SetValue(), and Toggle().

TMethodCall* TToggle::fSetter
protected

Definition at line 63 of file TToggle.h.

Referenced by GetSetter(), SetState(), SetToggledObject(), SetValue(), and Toggle().

Bool_t TToggle::fState
private

Definition at line 54 of file TToggle.h.

Referenced by GetState(), SetState(), SetValue(), and Toggle().

Int_t* TToggle::fTglVariable
protected

Definition at line 65 of file TToggle.h.

Referenced by SetToggledVariable(), and Toggle().

Long_t TToggle::fValue
private

Definition at line 57 of file TToggle.h.

Referenced by GetState(), GetValue(), SetState(), SetToggledVariable(), SetValue(), and Toggle().


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