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

Element representing TKey from TDirectory.

Definition at line 348 of file TDirectoryElement.cxx.

Public Member Functions

 TKeyElement (TDirectory *dir, TKey *key)
 
virtual ~TKeyElement ()=default
 
std::unique_ptr< RItemCreateItem () const override
 Returns item with element description.
 
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 - browsing for the TFile/TDirectory.
 
std::string GetName () const override
 Name of TKeyElement, includes key cycle.
 
std::unique_ptr< RHolderGetObject () 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.
 
bool IsFolder () const override
 Check if element can have childs.
 
- Public Member Functions inherited from TDirectoryElement
 TDirectoryElement (const std::string &fname, TDirectory *dir=nullptr, bool isfile=false)
 
virtual ~TDirectoryElement ()=default
 
bool cd () override
 Select directory as active.
 
std::string GetContent (const std::string &kind) override
 Returns element content, depends from kind.
 
- Public Member Functions inherited from ROOT::Browsable::TObjectElement
 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< RItemCreateItem () const override
 Create item.
 
std::unique_ptr< RLevelIterGetChildsIter () override
 Create iterator for childs elements if any.
 
const TClassGetClass () 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< RHolderGetObject () 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 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 Member Functions

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

Private Attributes

std::shared_ptr< RElementfElement
 ! holder of read object
 
std::string fKeyClass
 
Short_t fKeyCycle {0}
 
std::string fKeyMTime
 
std::string fKeyName
 
Long64_t fKeyObjSize {-1}
 
std::string fKeyTitle
 

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
}
 
- Static Public Member Functions inherited from ROOT::Browsable::TObjectElement
static std::unique_ptr< RLevelIterGetCollectionIter (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< 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.
 
- Protected Member Functions inherited from TDirectoryElement
const TObjectCheckObject () const override
 Check if object still exists.
 
TDirectoryGetDir () const
 
TFileGetFile () const
 
- Protected Member Functions inherited from ROOT::Browsable::TObjectElement
void ForgetObject () const
 Forget object, use when it was deleted behind the scene.
 
bool IsSame (TObject *obj) const
 
void SetObject (TObject *obj)
 Constructor with std::unique_ptr<RHolder> as argument.
 
- Protected Attributes inherited from ROOT::Browsable::TObjectElement
bool fHideChilds {false}
 
std::string fName
 
TObjectfObj {nullptr}
 
std::unique_ptr< RHolderfObject
 
Inheritance diagram for TKeyElement:
[legend]

Constructor & Destructor Documentation

◆ TKeyElement()

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

Definition at line 359 of file TDirectoryElement.cxx.

◆ ~TKeyElement()

virtual TKeyElement::~TKeyElement ( )
virtualdefault

Member Function Documentation

◆ CreateItem()

std::unique_ptr< RItem > TKeyElement::CreateItem ( ) const
inlineoverridevirtual

Returns item with element description.

Reimplemented from ROOT::Browsable::RElement.

Definition at line 528 of file TDirectoryElement.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 396 of file TDirectoryElement.cxx.

◆ GetDefaultAction()

EActionKind TKeyElement::GetDefaultAction ( ) const
inlineoverridevirtual

Get default action - browsing for the TFile/TDirectory.

Reimplemented from TDirectoryElement.

Definition at line 463 of file TDirectoryElement.cxx.

◆ GetMTime()

std::string TKeyElement::GetMTime ( ) const
inlineoverrideprivatevirtual

Reimplemented from TDirectoryElement.

Definition at line 354 of file TDirectoryElement.cxx.

◆ GetName()

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

Name of TKeyElement, includes key cycle.

Reimplemented from TDirectoryElement.

Definition at line 372 of file TDirectoryElement.cxx.

◆ GetObject()

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

Return object associated with the TKey.

Reimplemented from ROOT::Browsable::RElement.

Definition at line 424 of file TDirectoryElement.cxx.

◆ GetSize()

Long64_t TKeyElement::GetSize ( ) const
inlineoverrideprivatevirtual

Size of TDirectory.

Reimplemented from TDirectoryElement.

Definition at line 356 of file TDirectoryElement.cxx.

◆ GetTitle()

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

Title of TKeyElement (optional)

Reimplemented from TDirectoryElement.

Definition at line 385 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 493 of file TDirectoryElement.cxx.

◆ IsFolder()

bool TKeyElement::IsFolder ( ) const
inlineoverridevirtual

Check if element can have childs.

Reimplemented from TDirectoryElement.

Definition at line 478 of file TDirectoryElement.cxx.

Member Data Documentation

◆ fElement

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

! holder of read object

Definition at line 352 of file TDirectoryElement.cxx.

◆ fKeyClass

std::string TKeyElement::fKeyClass
private

Definition at line 349 of file TDirectoryElement.cxx.

◆ fKeyCycle

Short_t TKeyElement::fKeyCycle {0}
private

Definition at line 350 of file TDirectoryElement.cxx.

◆ fKeyMTime

std::string TKeyElement::fKeyMTime
private

Definition at line 349 of file TDirectoryElement.cxx.

◆ fKeyName

std::string TKeyElement::fKeyName
private

Definition at line 349 of file TDirectoryElement.cxx.

◆ fKeyObjSize

Long64_t TKeyElement::fKeyObjSize {-1}
private

Definition at line 351 of file TDirectoryElement.cxx.

◆ fKeyTitle

std::string TKeyElement::fKeyTitle
private

Definition at line 349 of file TDirectoryElement.cxx.

  • gui/browsable/src/TDirectoryElement.cxx