Logo ROOT  
Reference Guide
 
Loading...
Searching...
No Matches
TKeyElement Class Reference

Element representing TKey from TDirectory.

Definition at line 196 of file TDirectoryElement.cxx.

Public Member Functions

 TKeyElement (TDirectory *dir, TKey *key)
 
virtual ~TKeyElement ()=default
 
std::unique_ptr< RLevelIterGetChildsIter () override
 Create iterator for childs elements if any Means we should try to browse inside.
 
EActionKind GetDefaultAction () const override
 Get default action.
 
std::string GetName () const override
 Name of TKeyElement, includes key cycle.
 
std::unique_ptr< RHolderGetObject () override
 Return object associated with TKey, if TDirectory has object of that name it will be returned.
 
std::string GetTitle () const override
 Title of TKeyElement (optional)
 
bool IsCapable (EActionKind action) const override
 Check if want to perform action.
 
- Public Member Functions inherited from ROOT::Experimental::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.
 

Private Attributes

TDirectoryfDir {nullptr}
 
std::shared_ptr< RElementfElement
 ! holder of read object
 
std::string fKeyClass
 
Short_t fKeyCycle {0}
 
std::string fKeyName
 
std::string fKeyTitle
 

Additional Inherited Members

- Public Types inherited from ROOT::Experimental::Browsable::RElement
enum  EActionKind {
  kActNone , kActBrowse , kActEdit , kActImage ,
  kActDraw6 , kActDraw7 , kActCanvas , kActGeom
}
 Possible actions on double-click. More...
 
enum  EContentKind {
  kNone , kText , kImage , kPng ,
  kJpeg , kJson , kFileName
}
 
- Static Public Member Functions inherited from ROOT::Experimental::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< RElementGetSubElement (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.
 
Inheritance diagram for TKeyElement:
[legend]

Constructor & Destructor Documentation

◆ TKeyElement()

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

Definition at line 205 of file TDirectoryElement.cxx.

◆ ~TKeyElement()

virtual TKeyElement::~TKeyElement ( )
virtualdefault

Member Function Documentation

◆ 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 ROOT::Experimental::Browsable::RElement.

Definition at line 239 of file TDirectoryElement.cxx.

◆ GetDefaultAction()

EActionKind TKeyElement::GetDefaultAction ( ) const
inlineoverridevirtual

Get default action.

Reimplemented from ROOT::Experimental::Browsable::RElement.

Definition at line 296 of file TDirectoryElement.cxx.

◆ GetName()

std::string TKeyElement::GetName ( ) const
inlineoverridevirtual

Name of TKeyElement, includes key cycle.

Implements ROOT::Experimental::Browsable::RElement.

Definition at line 216 of file TDirectoryElement.cxx.

◆ GetObject()

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

Return object associated with TKey, if TDirectory has object of that name it will be returned.

Reimplemented from ROOT::Experimental::Browsable::RElement.

Definition at line 264 of file TDirectoryElement.cxx.

◆ GetTitle()

std::string TKeyElement::GetTitle ( ) const
inlineoverridevirtual

Title of TKeyElement (optional)

Reimplemented from ROOT::Experimental::Browsable::RElement.

Definition at line 228 of file TDirectoryElement.cxx.

◆ IsCapable()

bool TKeyElement::IsCapable ( EActionKind  action) const
inlineoverridevirtual

Check if want to perform action.

Reimplemented from ROOT::Experimental::Browsable::RElement.

Definition at line 310 of file TDirectoryElement.cxx.

Member Data Documentation

◆ fDir

TDirectory* TKeyElement::fDir {nullptr}
private

Definition at line 197 of file TDirectoryElement.cxx.

◆ fElement

std::shared_ptr<RElement> TKeyElement::fElement
private

! holder of read object

Definition at line 202 of file TDirectoryElement.cxx.

◆ fKeyClass

std::string TKeyElement::fKeyClass
private

Definition at line 201 of file TDirectoryElement.cxx.

◆ fKeyCycle

Short_t TKeyElement::fKeyCycle {0}
private

Definition at line 200 of file TDirectoryElement.cxx.

◆ fKeyName

std::string TKeyElement::fKeyName
private

Definition at line 198 of file TDirectoryElement.cxx.

◆ fKeyTitle

std::string TKeyElement::fKeyTitle
private

Definition at line 199 of file TDirectoryElement.cxx.

  • gui/browsable/src/TDirectoryElement.cxx