Logo ROOT  
Reference Guide
TClassMenuItem Class Reference

Describes one element of the context menu associated to a class The menu item may describe

  • a separator,
  • standard list of methods i.e. the methods defined in the described class by a MENU in the comment field of the header,
  • a method of an external class or a global function All the standard methods of the class are described by only one item. Since a complete context menu is described by a TList of TClassMenuItem elements, it is possible to customize the context menu of a class by removing the element "standard methods" and replacing it by whatever one wants.

Definition at line 31 of file TClassMenuItem.h.

Public Types

enum  { kIsExternal, kIsSelf }
 
enum  EClassMenuItemType { kPopupUserFunction, kPopupSeparator, kPopupStandardList }
 
- 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 Member Functions

 TClassMenuItem ()
 Default TClassMenuItem ctor. More...
 
 TClassMenuItem (Int_t type, TClass *parent, const char *title="", const char *functionname="", TObject *obj=0, const char *args="", Int_t selfobjposition=-1, Bool_t self=kFALSE)
 TClassMenuItem ctor. More...
 
virtual ~TClassMenuItem ()
 TClassMenuItem dtor. More...
 
virtual const char * GetArgs () const
 
virtual TObjectGetCalledObject () const
 
virtual const char * GetFunctionName () const
 
virtual Int_t GetSelfObjectPos () const
 
virtual const char * GetTitle () const
 Returns title of object. More...
 
virtual Int_t GetType () const
 
virtual Bool_t IsCallSelf () const
 
virtual Bool_t IsSeparator () const
 
virtual Bool_t IsStandardList () const
 
virtual Bool_t IsToggle () const
 
virtual void SetCall (TObject *obj, const char *method, const char *args="", Int_t selfobjposition=0)
 
virtual void SetSelf (Bool_t self)
 
virtual void SetTitle (const char *title)
 
virtual void SetToggle (Bool_t toggle=kTRUE)
 
virtual void SetType (Int_t type)
 
- Public Member Functions inherited from TObject
 TObject ()
 TObject constructor. More...
 
 TObject (const TObject &object)
 TObject copy ctor. More...
 
virtual ~TObject ()
 TObject destructor. 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...
 
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...
 
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. More...
 
virtual const char * ClassName () const
 Returns name of class to which the object belongs. More...
 
virtual void Clear (Option_t *="")
 
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 abstract method. More...
 
virtual void Copy (TObject &object) const
 Copy this to obj. 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 selected pad for instance with: gROOT->SetSelectedPad(gPad). More...
 
virtual void Dump () const
 Dump contents of object on stdout. More...
 
virtual void Error (const char *method, const char *msgfmt,...) const
 Issue error message. 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 void Fatal (const char *method, const char *msgfmt,...) const
 Issue fatal error message. 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 const char * GetIconName () const
 Returns mime type name of object. More...
 
virtual const char * GetName () const
 Returns name of object. More...
 
virtual char * GetObjectInfo (Int_t px, Int_t py) const
 Returns string containing info about the object at position (px,py). More...
 
virtual Option_tGetOption () const
 
virtual UInt_t GetUniqueID () const
 Return the unique object id. More...
 
virtual Bool_t HandleTimer (TTimer *timer)
 Execute action in response of a timer timing out. More...
 
virtual ULong_t Hash () const
 Return hash value for this object. More...
 
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. More...
 
virtual void Info (const char *method, const char *msgfmt,...) const
 Issue info message. 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...
 
void InvertBit (UInt_t f)
 
virtual Bool_t IsEqual (const TObject *obj) const
 Default equal comparison (objects are equal if they have the same address in memory). More...
 
virtual Bool_t IsFolder () const
 Returns kTRUE in case object contains browsable objects (like containers or lists of other objects). More...
 
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. 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...
 
virtual Bool_t Notify ()
 This method must be overridden to handle object notification. More...
 
void Obsolete (const char *method, const char *asOfVers, const char *removedFromVers) const
 Use this method to declare a method obsolete. More...
 
void operator delete (void *ptr)
 Operator delete. More...
 
void operator delete[] (void *ptr)
 Operator delete []. More...
 
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. 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 void Print (Option_t *option="") const
 This method must be overridden when a class wants to print itself. 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...
 
void ResetBit (UInt_t f)
 
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...
 
void SetBit (UInt_t f)
 
void SetBit (UInt_t f, Bool_t set)
 Set or unset the user status bits as specified in f. 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 SysError (const char *method, const char *msgfmt,...) const
 Issue system error message. More...
 
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. More...
 
virtual void Warning (const char *method, const char *msgfmt,...) const
 Issue warning message. 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...
 

Protected Member Functions

 TClassMenuItem (const TClassMenuItem &)
 copy constructor More...
 
TClassMenuItemoperator= (const TClassMenuItem &)
 assignment operator More...
 
- 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). More...
 
void MakeZombie ()
 

Private Attributes

TString fArgs
 
TObjectfCalledObject
 
TString fFunctionName
 
TClassfParent
 
Bool_t fSelf
 
Int_t fSelfObjectPos
 
TListfSubMenu
 
TString fTitle
 
Bool_t fToggle
 
EClassMenuItemType fType
 

Additional Inherited Members

- Static Public Member Functions inherited from TObject
static Long_t GetDtorOnly ()
 Return destructor only flag. More...
 
static Bool_t GetObjectStat ()
 Get status of object stat flag. More...
 
static void SetDtorOnly (void *obj)
 Set destructor only flag. More...
 
static void SetObjectStat (Bool_t stat)
 Turn on/off tracking of objects in the TObjectTable. More...
 

#include <TClassMenuItem.h>

Inheritance diagram for TClassMenuItem:
[legend]

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
Enumerator
kIsExternal 
kIsSelf 

Definition at line 37 of file TClassMenuItem.h.

◆ EClassMenuItemType

Enumerator
kPopupUserFunction 
kPopupSeparator 
kPopupStandardList 

Definition at line 34 of file TClassMenuItem.h.

Constructor & Destructor Documentation

◆ TClassMenuItem() [1/3]

TClassMenuItem::TClassMenuItem ( const TClassMenuItem cmi)
protected

copy constructor

Note: It is the responsibility of the caller/creator to add to the menu list.

Definition at line 88 of file TClassMenuItem.cxx.

◆ TClassMenuItem() [2/3]

TClassMenuItem::TClassMenuItem ( )

Default TClassMenuItem ctor.

TClassMenuItems are constructed in TClass with a standard content but may be customized later

  • fType = 0 : external method/function
  • fType = 1 : separator
  • fType = 2 : standard methods list

Definition at line 41 of file TClassMenuItem.cxx.

◆ TClassMenuItem() [3/3]

TClassMenuItem::TClassMenuItem ( Int_t  type,
TClass parentcl,
const char *  title = "",
const char *  functionname = "",
TObject obj = 0,
const char *  args = "",
Int_t  selfobjposition = -1,
Bool_t  self = kFALSE 
)

TClassMenuItem ctor.

TClassMenuItems are constructed in TClass with a standard content but may be customized later

  • type = 0 : external method/function
  • type = 1 : separator
  • type = 2 : standard methods list self indicates if the object to be called is the one selected by the popup menu selfobjposition, if non zero, indicates the position in the arguments list of the argument corresponding to the selected (clicked) object. This argument in the calling method should be a TObject* Note: It is the responsibility of the caller/creator to add to the menu list.

Definition at line 66 of file TClassMenuItem.cxx.

◆ ~TClassMenuItem()

TClassMenuItem::~TClassMenuItem ( )
virtual

TClassMenuItem dtor.

Definition at line 130 of file TClassMenuItem.cxx.

Member Function Documentation

◆ GetArgs()

virtual const char* TClassMenuItem::GetArgs ( ) const
inlinevirtual

Definition at line 64 of file TClassMenuItem.h.

◆ GetCalledObject()

virtual TObject* TClassMenuItem::GetCalledObject ( ) const
inlinevirtual

Definition at line 65 of file TClassMenuItem.h.

◆ GetFunctionName()

virtual const char* TClassMenuItem::GetFunctionName ( ) const
inlinevirtual

Definition at line 63 of file TClassMenuItem.h.

◆ GetSelfObjectPos()

virtual Int_t TClassMenuItem::GetSelfObjectPos ( ) const
inlinevirtual

Definition at line 67 of file TClassMenuItem.h.

◆ GetTitle()

virtual const char* TClassMenuItem::GetTitle ( ) const
inlinevirtual

Returns title of object.

This default method returns the class title (i.e. description). Classes that give objects a title should override this method.

Reimplemented from TObject.

Definition at line 62 of file TClassMenuItem.h.

◆ GetType()

virtual Int_t TClassMenuItem::GetType ( ) const
inlinevirtual

Definition at line 66 of file TClassMenuItem.h.

◆ IsCallSelf()

virtual Bool_t TClassMenuItem::IsCallSelf ( ) const
inlinevirtual

Definition at line 68 of file TClassMenuItem.h.

◆ IsSeparator()

virtual Bool_t TClassMenuItem::IsSeparator ( ) const
inlinevirtual

Definition at line 69 of file TClassMenuItem.h.

◆ IsStandardList()

virtual Bool_t TClassMenuItem::IsStandardList ( ) const
inlinevirtual

Definition at line 70 of file TClassMenuItem.h.

◆ IsToggle()

virtual Bool_t TClassMenuItem::IsToggle ( ) const
inlinevirtual

Definition at line 71 of file TClassMenuItem.h.

◆ operator=()

TClassMenuItem & TClassMenuItem::operator= ( const TClassMenuItem cmi)
protected

assignment operator

Note: It is the responsibility of the caller/creator to add to the menu list.

Definition at line 109 of file TClassMenuItem.cxx.

◆ SetCall()

virtual void TClassMenuItem::SetCall ( TObject obj,
const char *  method,
const char *  args = "",
Int_t  selfobjposition = 0 
)
inlinevirtual

Definition at line 76 of file TClassMenuItem.h.

◆ SetSelf()

virtual void TClassMenuItem::SetSelf ( Bool_t  self)
inlinevirtual

Definition at line 74 of file TClassMenuItem.h.

◆ SetTitle()

virtual void TClassMenuItem::SetTitle ( const char *  title)
inlinevirtual

Definition at line 73 of file TClassMenuItem.h.

◆ SetToggle()

virtual void TClassMenuItem::SetToggle ( Bool_t  toggle = kTRUE)
inlinevirtual

Definition at line 75 of file TClassMenuItem.h.

◆ SetType()

virtual void TClassMenuItem::SetType ( Int_t  type)
inlinevirtual

Definition at line 72 of file TClassMenuItem.h.

Member Data Documentation

◆ fArgs

TString TClassMenuItem::fArgs
private

Definition at line 47 of file TClassMenuItem.h.

◆ fCalledObject

TObject* TClassMenuItem::fCalledObject
private

Definition at line 45 of file TClassMenuItem.h.

◆ fFunctionName

TString TClassMenuItem::fFunctionName
private

Definition at line 46 of file TClassMenuItem.h.

◆ fParent

TClass* TClassMenuItem::fParent
private

Definition at line 49 of file TClassMenuItem.h.

◆ fSelf

Bool_t TClassMenuItem::fSelf
private

Definition at line 42 of file TClassMenuItem.h.

◆ fSelfObjectPos

Int_t TClassMenuItem::fSelfObjectPos
private

Definition at line 41 of file TClassMenuItem.h.

◆ fSubMenu

TList* TClassMenuItem::fSubMenu
private

Definition at line 48 of file TClassMenuItem.h.

◆ fTitle

TString TClassMenuItem::fTitle
private

Definition at line 44 of file TClassMenuItem.h.

◆ fToggle

Bool_t TClassMenuItem::fToggle
private

Definition at line 43 of file TClassMenuItem.h.

◆ fType

EClassMenuItemType TClassMenuItem::fType
private

Definition at line 40 of file TClassMenuItem.h.


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