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 Types
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 }

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

virtual bool	cd ()
	Select element as active.

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.

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

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

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

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

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.

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

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.

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

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

void	SetName (const std::string &name)

Static Public Member Functions
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 std::unique_ptr< RLevelIter >	GetCollectionIter (const TCollection *)
	Creates iterator for TCollection object.

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 bool	IsLastKeyCycle ()
	Is only last cycle from the list of keys is shown.

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.

static void	SetLastKeyCycle (bool on=true)
	Set flag to show only last cycle from the list of keys.

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

#include <ROOT/Browsable/TObjectElement.hxx>

Inheritance diagram for ROOT::Browsable::TObjectElement:

Member Enumeration Documentation

◆ EActionKind

enum ROOT::Browsable::RElement::EActionKind

inherited

Possible actions on double-click.

Enumerator
kActNone	do nothing
kActBrowse	just browse (expand) item
kActEdit	can provide data for text editor
kActImage	can be shown in image viewer, can provide image
kActDraw6	can be drawn inside ROOT6 canvas
kActDraw7	can be drawn inside ROOT7 canvas
kActCanvas	indicate that it is canvas and should be drawn directly
kActTree	can be shown in tree viewer
kActGeom	can be shown in geometry viewer

Definition at line 50 of file RElement.hxx.

◆ EContentKind

enum ROOT::Browsable::RElement::EContentKind

inherited

Enumerator
kNone	not recognized
kText	"text" - plain text for code editor
kImage	"image64" - base64 for supported image formats (png/gif/gpeg)
kPng	"png" - plain png binary code, returned inside std::string
kJpeg	"jpg" or "jpeg" - plain jpg binary code, returned inside std::string
kJson	"json" representation of object, can be used in code editor
kFileName	"filename" - file name if applicable

Definition at line 37 of file RElement.hxx.

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

◆ cd()

virtual bool ROOT::Browsable::RElement::cd ( )

inlinevirtualinherited

Select element as active.

Reimplemented in TDirectoryElement.

Definition at line 103 of file RElement.hxx.

◆ 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.

◆ ComparePaths()

int RElement::ComparePaths	(	const RElementPath_t &	path1,
		const RElementPath_t &	path2 )

staticinherited

Compare two paths, Returns number of elements matches in both paths.

Definition at line 147 of file RElement.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.

◆ ExtractItemIndex()

int RElement::ExtractItemIndex ( std::string & name )

staticinherited

Extract index from name Index coded by client with ###<indx>$$$ suffix Such coding used by browser to identify element by index.

Definition at line 180 of file RElement.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.

◆ GetContent()

std::string RElement::GetContent ( const std::string & kind = "text" )

virtualinherited

Returns element content, depends from kind.

Returns string content like text file content or json representation.

Can be "text" or "image64" or "json"

Reimplemented in ROOT::Browsable::RSysFile, TTreeBrowsingElement, TDirectoryElement, and ROOT::Browsable::RWrapper.

Definition at line 92 of file RElement.cxx.

◆ GetContentKind()

RElement::EContentKind RElement::GetContentKind ( const std::string & kind )

staticinherited

Find item with specified name Default implementation, should work for all.

Definition at line 54 of file RElement.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.

◆ GetNumChilds()

int RElement::GetNumChilds ( )

virtualinherited

Returns number of childs By default creates iterator and iterates over all items.

Reimplemented in TBrBrowsableElement, TFolderElement, and TCollectionElement.

Definition at line 41 of file RElement.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.

◆ GetPathAsString()

std::string RElement::GetPathAsString ( const RElementPath_t & path )

staticinherited

Converts element path back to string.

Definition at line 162 of file RElement.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.

◆ GetSubElement()

std::shared_ptr< RElement > RElement::GetSubElement	(	std::shared_ptr< RElement > &	elem,
		const RElementPath_t &	path )

staticinherited

Returns sub element.

Definition at line 71 of file RElement.cxx.

◆ 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.

◆ IsExpandByDefault()

virtual bool ROOT::Browsable::RElement::IsExpandByDefault ( ) const

inlinevirtualinherited

Should item representing element be expand by default.

Reimplemented in ROOT::Browsable::RWrapper.

Definition at line 100 of file RElement.hxx.

◆ 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.

◆ IsLastKeyCycle()

bool RElement::IsLastKeyCycle ( )

staticinherited

Is only last cycle from the list of keys is shown.

Definition at line 195 of file RElement.cxx.

◆ 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.

◆ MatchName()

virtual bool ROOT::Browsable::RElement::MatchName ( const std::string & name ) const

inlinevirtualinherited

Checks if element name match to provided value.

Reimplemented in ROOT::Browsable::RSysFile.

Definition at line 68 of file RElement.hxx.

◆ ParsePath()

RElementPath_t RElement::ParsePath ( const std::string & str )

staticinherited

Parse string path to produce RElementPath_t One should avoid to use string pathes as much as possible.

Definition at line 118 of file RElement.cxx.

◆ 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.

◆ SetLastKeyCycle()

void RElement::SetLastKeyCycle ( bool on = true )

staticinherited

Set flag to show only last cycle from the list of keys.

Definition at line 203 of file RElement.cxx.

◆ 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.

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

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

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Member Enumeration Documentation

◆ EActionKind

◆ EContentKind

Constructor & Destructor Documentation

◆ TObjectElement() [1/2]

◆ TObjectElement() [2/2]

◆ ~TObjectElement()

Member Function Documentation

◆ cd()

◆ CheckObject()

◆ CheckValid()

◆ ComparePaths()

◆ CreateItem()

◆ ExtractItemIndex()

◆ ForgetObject()

◆ GetChildsIter()

◆ GetClass()

◆ GetCollectionIter()

◆ GetContent()

◆ GetContentKind()

◆ GetDefaultAction()

◆ GetMTime()

◆ GetName()

◆ GetNumChilds()

◆ GetObject()

◆ GetPathAsString()

◆ GetSize()

◆ GetSubElement()

◆ GetTitle()

◆ IsCapable()

◆ IsExpandByDefault()

◆ IsFolder()

◆ IsHideChilds()

◆ IsLastKeyCycle()

◆ IsObject()

◆ IsSame()

◆ MatchName()

◆ ParsePath()

◆ SetHideChilds()

◆ SetLastKeyCycle()

◆ SetName()

◆ SetObject()

Member Data Documentation

◆ fHideChilds

◆ fName

◆ fObj

◆ fObject