Access to TObject basic properties for RBrowsable.

Author: Sergey Linev S.Lin.nosp@m.ev@g.nosp@m.si.de

Date: 2021-01-11

Warning: This is part of the ROOT 7 prototype! It will change without notice. It might trigger earthquakes. Feedback is welcome!

Definition at line 30 of file TObjectElement.hxx.

Public Member Functions
	TObjectElement (std::unique_ptr< RHolder > &obj, const std::string &name="", bool _hide_childs=false)
	Constructor with std::unique_ptr<RHolder> as argument.

	TObjectElement (TObject *obj, const std::string &name="", bool _hide_childs=false)
	Constructor with plain TObject* as argument - ownership is not defined.

virtual	~TObjectElement ()=default

bool	CheckValid () override
	Returns true if object is still valid.

std::unique_ptr< RItem >	CreateItem () const override
	Create item.

std::unique_ptr< RLevelIter >	GetChildsIter () override
	Create iterator for childs elements if any.

const TClass *	GetClass () const
	Returns class for contained object.

EActionKind	GetDefaultAction () const override
	Provides default action which can be performed with the object.

std::string	GetName () const override
	Name of TObject.

std::unique_ptr< RHolder >	GetObject () override
	Return copy of TObject holder - if possible.

std::string	GetTitle () const override
	Title of TObject.

bool	IsCapable (EActionKind) const override
	Check object capability.

bool	IsFolder () const override
	Returns true if object can have child elements.

bool	IsHideChilds () const
	Is flag to hide all potential object childs set.

bool	IsObject (void *) override
	Returns true if holding specified object.

void	SetHideChilds (bool on)
	Set flag to hide all potential object childs.

void	SetName (const std::string &name)

Public Member Functions inherited from ROOT::Browsable::RElement
virtual	~RElement ()=default

virtual bool	cd ()
	Select element as active.

virtual std::string	GetContent (const std::string &="text")
	Returns element content, depends from kind.

virtual int	GetNumChilds ()
	Returns number of childs By default creates iterator and iterates over all items.

virtual bool	IsExpandByDefault () const
	Should item representing element be expand by default.

virtual bool	MatchName (const std::string &name) const
	Checks if element name match to provided value.

Static Public Member Functions
static std::unique_ptr< RLevelIter >	GetCollectionIter (const TCollection *)
	Creates iterator for TCollection object.

Static Public Member Functions inherited from ROOT::Browsable::RElement
static int	ComparePaths (const RElementPath_t &path1, const RElementPath_t &path2)
	Compare two paths, Returns number of elements matches in both paths.

static int	ExtractItemIndex (std::string &name)
	Extract index from name Index coded by client with `###<indx>$$$` suffix Such coding used by browser to identify element by index.

static EContentKind	GetContentKind (const std::string &kind)
	Find item with specified name Default implementation, should work for all.

static std::string	GetPathAsString (const RElementPath_t &path)
	Converts element path back to string.

static std::shared_ptr< RElement >	GetSubElement (std::shared_ptr< RElement > &elem, const RElementPath_t &path)
	Returns sub element.

static RElementPath_t	ParsePath (const std::string &str)
	Parse string path to produce RElementPath_t One should avoid to use string pathes as much as possible.

Protected Member Functions
virtual const TObject *	CheckObject () const
	Check if object still exists.

void	ForgetObject () const
	Forget object, use when it was deleted behind the scene.

virtual std::string	GetMTime () const

virtual Long64_t	GetSize () const

bool	IsSame (TObject *obj) const

void	SetObject (TObject *obj)
	Constructor with std::unique_ptr<RHolder> as argument.

Protected Attributes
bool	fHideChilds {false}

std::string	fName

TObject *	fObj {nullptr}

std::unique_ptr< RHolder >	fObject

Additional Inherited Members
Public Types inherited from ROOT::Browsable::RElement
enum	EActionKind { kActNone , kActBrowse , kActEdit , kActImage , kActDraw6 , kActDraw7 , kActCanvas , kActTree , kActGeom }
	Possible actions on double-click. More...

enum	EContentKind { kNone , kText , kImage , kPng , kJpeg , kJson , kFileName }

#include <ROOT/Browsable/TObjectElement.hxx>

Inheritance diagram for ROOT::Browsable::TObjectElement:

[legend]

Constructor & Destructor Documentation

◆ TObjectElement() [1/2]

TObjectElement::TObjectElement	(	TObject *	obj,
		const std::string &	name = `""`,
		bool	_hide_childs = `false`
	)

Constructor with plain TObject* as argument - ownership is not defined.

Definition at line 277 of file TObjectElement.cxx.

◆ TObjectElement() [2/2]

TObjectElement::TObjectElement	(	std::unique_ptr< RHolder > &	obj,
		const std::string &	name = `""`,
		bool	_hide_childs = `false`
	)

Constructor with std::unique_ptr<RHolder> as argument.

Definition at line 289 of file TObjectElement.cxx.

◆ ~TObjectElement()

virtual ROOT::Browsable::TObjectElement::~TObjectElement ( )

virtualdefault

Member Function Documentation

◆ CheckObject()

const TObject * TObjectElement::CheckObject ( ) const

protectedvirtual

Check if object still exists.

Reimplemented in TDirectoryElement, and ROOT::Browsable::TGeoManagerElement.

Definition at line 328 of file TObjectElement.cxx.

◆ CheckValid()

bool TObjectElement::CheckValid ( )

overridevirtual

Returns true if object is still valid.

Reimplemented from ROOT::Browsable::RElement.

Definition at line 424 of file TObjectElement.cxx.

◆ CreateItem()

std::unique_ptr< RItem > TObjectElement::CreateItem ( ) const

overridevirtual

Create item.

Reimplemented from ROOT::Browsable::RElement.

Definition at line 457 of file TObjectElement.cxx.

◆ ForgetObject()

void TObjectElement::ForgetObject ( ) const

protected

Forget object, use when it was deleted behind the scene.

Definition at line 315 of file TObjectElement.cxx.

◆ GetChildsIter()

std::unique_ptr< RLevelIter > TObjectElement::GetChildsIter ( )

overridevirtual

Create iterator for childs elements if any.

Reimplemented from ROOT::Browsable::RElement.

Definition at line 372 of file TObjectElement.cxx.

◆ GetClass()

const TClass * TObjectElement::GetClass ( ) const

Returns class for contained object.

Definition at line 432 of file TObjectElement.cxx.

◆ GetCollectionIter()

std::unique_ptr< RLevelIter > TObjectElement::GetCollectionIter ( const TCollection * coll )

static

Creates iterator for TCollection object.

Definition at line 517 of file TObjectElement.cxx.

◆ GetDefaultAction()

RElement::EActionKind TObjectElement::GetDefaultAction ( ) const

overridevirtual

Provides default action which can be performed with the object.

Reimplemented from ROOT::Browsable::RElement.

Reimplemented in TTreeBrowsingElement, and TTreeElement.

Definition at line 440 of file TObjectElement.cxx.

◆ GetMTime()

virtual std::string ROOT::Browsable::TObjectElement::GetMTime ( ) const

inlineprotectedvirtual

Reimplemented in TDirectoryElement, and TKeyElement.

Definition at line 45 of file TObjectElement.hxx.

◆ GetName()

std::string TObjectElement::GetName ( ) const

overridevirtual

Name of TObject.

Returns name of the TObject.

Implements ROOT::Browsable::RElement.

Definition at line 353 of file TObjectElement.cxx.

◆ GetObject()

std::unique_ptr< RHolder > TObjectElement::GetObject ( )

overridevirtual

Return copy of TObject holder - if possible.

Returns copy of TObject holder - if possible.

Reimplemented from ROOT::Browsable::RElement.

Definition at line 403 of file TObjectElement.cxx.

◆ GetSize()

virtual Long64_t ROOT::Browsable::TObjectElement::GetSize ( ) const

inlineprotectedvirtual

Reimplemented in TBrLeafElement, TBrElement, TTreeElement, TDirectoryElement, TKeyElement, and ROOT::Browsable::TGeoManagerElement.

Definition at line 47 of file TObjectElement.hxx.

◆ GetTitle()

std::string TObjectElement::GetTitle ( ) const

overridevirtual

Title of TObject.

Returns title of the TObject.

Reimplemented from ROOT::Browsable::RElement.

Definition at line 364 of file TObjectElement.cxx.

◆ IsCapable()

bool TObjectElement::IsCapable ( RElement::EActionKind action ) const

overridevirtual

Check object capability.

Reimplemented from ROOT::Browsable::RElement.

Reimplemented in TTreeBrowsingElement, and TTreeElement.

Definition at line 491 of file TObjectElement.cxx.

◆ IsFolder()

bool TObjectElement::IsFolder ( ) const

overridevirtual

Returns true if object can have child elements.

Reimplemented from ROOT::Browsable::RElement.

Definition at line 342 of file TObjectElement.cxx.

◆ IsHideChilds()

bool ROOT::Browsable::TObjectElement::IsHideChilds ( ) const

inline

Is flag to hide all potential object childs set.

Definition at line 62 of file TObjectElement.hxx.

◆ IsObject()

bool TObjectElement::IsObject ( void * obj )

overridevirtual

Returns true if holding specified object.

Reimplemented from ROOT::Browsable::RElement.

Definition at line 414 of file TObjectElement.cxx.

◆ IsSame()

bool ROOT::Browsable::TObjectElement::IsSame ( TObject * obj ) const

inlineprotected

Definition at line 37 of file TObjectElement.hxx.

◆ SetHideChilds()

void ROOT::Browsable::TObjectElement::SetHideChilds ( bool on )

inline

Set flag to hide all potential object childs.

Definition at line 65 of file TObjectElement.hxx.

◆ SetName()

void ROOT::Browsable::TObjectElement::SetName ( const std::string & name )

inline

Definition at line 59 of file TObjectElement.hxx.

◆ SetObject()

void TObjectElement::SetObject ( TObject * obj )

protected

Constructor with std::unique_ptr<RHolder> as argument.

Definition at line 306 of file TObjectElement.cxx.

Member Data Documentation

◆ fHideChilds

bool ROOT::Browsable::TObjectElement::fHideChilds {false}

protected

Definition at line 35 of file TObjectElement.hxx.

◆ fName

std::string ROOT::Browsable::TObjectElement::fName

protected

Definition at line 34 of file TObjectElement.hxx.

◆ fObj

TObject* ROOT::Browsable::TObjectElement::fObj {nullptr}

protected

Definition at line 33 of file TObjectElement.hxx.

◆ fObject

std::unique_ptr<RHolder> ROOT::Browsable::TObjectElement::fObject

protected

Definition at line 32 of file TObjectElement.hxx.

Libraries for ROOT::Browsable::TObjectElement:

[legend]

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

gui/browsable/inc/ROOT/Browsable/TObjectElement.hxx
gui/browsable/src/TObjectElement.cxx

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ TObjectElement() [1/2]

◆ TObjectElement() [2/2]

◆ ~TObjectElement()

Member Function Documentation

◆ CheckObject()

◆ CheckValid()

◆ CreateItem()

◆ ForgetObject()

◆ GetChildsIter()

◆ GetClass()

◆ GetCollectionIter()

◆ GetDefaultAction()

◆ GetMTime()

◆ GetName()

◆ GetObject()

◆ GetSize()

◆ GetTitle()

◆ IsCapable()

◆ IsFolder()

◆ IsHideChilds()

◆ IsObject()

◆ IsSame()

◆ SetHideChilds()

◆ SetName()

◆ SetObject()

Member Data Documentation

◆ fHideChilds

◆ fName

◆ fObj

◆ fObject