Element representing TKey from TDirectory.

Definition at line 334 of file TDirectoryElement.cxx.

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
	TKeyElement (TDirectory dir, TKey key)
	~TKeyElement () override=default
bool	cd () override
	Select directory as active.
bool	CheckValid () override
	Returns true if object is still valid.
std::unique_ptr< RItem >	CreateItem () const override
	Returns item with element description.
std::unique_ptr< RLevelIter >	GetChildsIter () override
	Create iterator for childs elements if any Means we should try to browse inside.
const TClass *	GetClass () const
	Returns class for contained object.
std::string	GetContent (const std::string &kind) override
	Returns element content, depends from kind.
EActionKind	GetDefaultAction () const override
	Get default action - browsing for the TFile/TDirectory.
std::string	GetName () const override
	Name of TKeyElement, includes key cycle.
virtual int	GetNumChilds ()
	Returns number of childs By default creates iterator and iterates over all items.
std::unique_ptr< RHolder >	GetObject () override
	Return object associated with the TKey.
std::string	GetTitle () const override
	Title of TKeyElement (optional).
bool	IsCapable (EActionKind action) const override
	Check if want to perform action.
virtual bool	IsExpandByDefault () const
	Should item representing element be expand by default.
bool	IsFolder () const override
	Check if element can have childs.
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
const TObject *	CheckObject () const override
	Check if object still exists.
void	ForgetObject () const
	Forget object, use when it was deleted behind the scene.
TDirectory *	GetDir () const
TFile *	GetFile () 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

Private Member Functions
std::string	GetMTime () const override
Long64_t	GetSize () const override
	Size of TDirectory.

Private Attributes
std::shared_ptr< RElement >	fElement
	! holder of read object
std::string	fFileName
	! file name
bool	fIsFile {false}
	! is TFile instance registered in global list of files
std::string	fKeyClass
Short_t	fKeyCycle {0}
std::string	fKeyMTime
std::string	fKeyName
Long64_t	fKeyObjSize {-1}
std::string	fKeyTitle

Inheritance diagram for TKeyElement:

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

◆ TKeyElement()

TKeyElement::TKeyElement	(	TDirectory *	dir,
		TKey *	key )

inline

Definition at line 345 of file TDirectoryElement.cxx.

◆ ~TKeyElement()

TKeyElement::~TKeyElement ( )

overridedefault

Member Function Documentation

◆ cd()

bool TDirectoryElement::cd ( )

inlineoverridevirtualinherited

Select directory as active.

Reimplemented from ROOT::Browsable::RElement.

Definition at line 290 of file TDirectoryElement.cxx.

◆ CheckObject()

const TObject * TDirectoryElement::CheckObject ( ) const

inlineoverrideprotectedvirtualinherited

Check if object still exists.

Reimplemented from ROOT::Browsable::TObjectElement.

Definition at line 202 of file TDirectoryElement.cxx.

◆ CheckValid()

bool TObjectElement::CheckValid ( )

overridevirtualinherited

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 > TKeyElement::CreateItem ( ) const

inlineoverridevirtual

Returns item with element description.

Reimplemented from ROOT::Browsable::RElement.

Definition at line 514 of file TDirectoryElement.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

protectedinherited

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

Definition at line 315 of file TObjectElement.cxx.

◆ GetChildsIter()

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

inlineoverridevirtual

Create iterator for childs elements if any Means we should try to browse inside.

Either it is directory or some complex object

Reimplemented from TDirectoryElement.

Definition at line 382 of file TDirectoryElement.cxx.

◆ GetClass()

const TClass * TObjectElement::GetClass ( ) const

inherited

Returns class for contained object.

Definition at line 432 of file TObjectElement.cxx.

◆ GetCollectionIter()

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

staticinherited

Creates iterator for TCollection object.

Definition at line 517 of file TObjectElement.cxx.

◆ GetContent()

std::string TDirectoryElement::GetContent ( const std::string & kind )

inlineoverridevirtualinherited

Returns element content, depends from kind.

Returns string content like text file content or json representation.

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

Reimplemented from ROOT::Browsable::RElement.

Definition at line 315 of file TDirectoryElement.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()

EActionKind TKeyElement::GetDefaultAction ( ) const

inlineoverridevirtual

Get default action - browsing for the TFile/TDirectory.

Reimplemented from TDirectoryElement.

Definition at line 449 of file TDirectoryElement.cxx.

◆ GetDir()

TDirectory * TDirectoryElement::GetDir ( ) const

inlineprotectedinherited

Definition at line 222 of file TDirectoryElement.cxx.

◆ GetFile()

TFile * TDirectoryElement::GetFile ( ) const

inlineprotectedinherited

Definition at line 230 of file TDirectoryElement.cxx.

◆ GetMTime()

std::string TKeyElement::GetMTime ( ) const

inlineoverrideprivatevirtual

Reimplemented from TDirectoryElement.

Definition at line 340 of file TDirectoryElement.cxx.

◆ GetName()

std::string TKeyElement::GetName ( ) const

inlineoverridevirtual

Name of TKeyElement, includes key cycle.

Reimplemented from TDirectoryElement.

Definition at line 358 of file TDirectoryElement.cxx.

◆ GetNumChilds()

int RElement::GetNumChilds ( )

virtualinherited

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

Reimplemented in TBrBrowsableElement, TCollectionElement, and TFolderElement.

Definition at line 41 of file RElement.cxx.

◆ GetObject()

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

inlineoverridevirtual

Return object associated with the TKey.

Reimplemented from ROOT::Browsable::RElement.

Definition at line 410 of file TDirectoryElement.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()

Long64_t TKeyElement::GetSize ( ) const

inlineoverrideprivatevirtual

Size of TDirectory.

Reimplemented from TDirectoryElement.

Definition at line 342 of file TDirectoryElement.cxx.

◆ 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 TKeyElement::GetTitle ( ) const

inlineoverridevirtual

Title of TKeyElement (optional).

Reimplemented from TDirectoryElement.

Definition at line 371 of file TDirectoryElement.cxx.

◆ IsCapable()

bool TKeyElement::IsCapable ( EActionKind action ) const

inlineoverridevirtual

Check if want to perform action.

Reimplemented from ROOT::Browsable::RElement.

Definition at line 479 of file TDirectoryElement.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 TKeyElement::IsFolder ( ) const

inlineoverridevirtual

Check if element can have childs.

Reimplemented from TDirectoryElement.

Definition at line 464 of file TDirectoryElement.cxx.

◆ IsHideChilds()

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

inlineinherited

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 )

overridevirtualinherited

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

inlineprotectedinherited

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 )

inlineinherited

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 )

inlineinherited

Definition at line 59 of file TObjectElement.hxx.

◆ SetObject()

void TObjectElement::SetObject ( TObject * obj )

protectedinherited

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

Definition at line 306 of file TObjectElement.cxx.

Member Data Documentation

◆ fElement

std::shared_ptr<RElement> TKeyElement::fElement

private

! holder of read object

Definition at line 338 of file TDirectoryElement.cxx.

◆ fFileName

std::string TDirectoryElement::fFileName

privateinherited

! file name

Definition at line 197 of file TDirectoryElement.cxx.

◆ fHideChilds

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

protectedinherited

Definition at line 35 of file TObjectElement.hxx.

◆ fIsFile

bool TDirectoryElement::fIsFile {false}

privateinherited

! is TFile instance registered in global list of files

Definition at line 198 of file TDirectoryElement.cxx.

◆ fKeyClass

std::string TKeyElement::fKeyClass

private

Definition at line 335 of file TDirectoryElement.cxx.

◆ fKeyCycle

Short_t TKeyElement::fKeyCycle {0}

private

Definition at line 336 of file TDirectoryElement.cxx.

◆ fKeyMTime

std::string TKeyElement::fKeyMTime

private

Definition at line 335 of file TDirectoryElement.cxx.

◆ fKeyName

std::string TKeyElement::fKeyName

private

Definition at line 335 of file TDirectoryElement.cxx.

◆ fKeyObjSize

Long64_t TKeyElement::fKeyObjSize {-1}

private

Definition at line 337 of file TDirectoryElement.cxx.

◆ fKeyTitle

std::string TKeyElement::fKeyTitle

private

Definition at line 335 of file TDirectoryElement.cxx.

◆ fName

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

protectedinherited

Definition at line 34 of file TObjectElement.hxx.

◆ fObj

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

protectedinherited

Definition at line 33 of file TObjectElement.hxx.

◆ fObject

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

protectedinherited

Definition at line 32 of file TObjectElement.hxx.

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

gui/browsable/src/TDirectoryElement.cxx

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Member Enumeration Documentation

◆ EActionKind

◆ EContentKind

Constructor & Destructor Documentation

◆ TKeyElement()

◆ ~TKeyElement()

Member Function Documentation

◆ cd()

◆ CheckObject()

◆ CheckValid()

◆ ComparePaths()

◆ CreateItem()

◆ ExtractItemIndex()

◆ ForgetObject()

◆ GetChildsIter()

◆ GetClass()

◆ GetCollectionIter()

◆ GetContent()

◆ GetContentKind()

◆ GetDefaultAction()

◆ GetDir()

◆ GetFile()

◆ GetMTime()

◆ GetName()

◆ GetNumChilds()

◆ GetObject()

◆ GetPathAsString()

◆ GetSize()

◆ GetSubElement()

◆ GetTitle()

◆ IsCapable()

◆ IsExpandByDefault()

◆ IsFolder()

◆ IsHideChilds()

◆ IsLastKeyCycle()

◆ IsObject()

◆ IsSame()

◆ MatchName()

◆ ParsePath()

◆ SetHideChilds()

◆ SetLastKeyCycle()

◆ SetName()

◆ SetObject()

Member Data Documentation

◆ fElement

◆ fFileName

◆ fHideChilds

◆ fIsFile

◆ fKeyClass

◆ fKeyCycle

◆ fKeyMTime

◆ fKeyName

◆ fKeyObjSize

◆ fKeyTitle

◆ fName

◆ fObj

◆ fObject