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

Element representing TDirectory.

Definition at line 210 of file TDirectoryElement.cxx.

Public Member Functions

 TDirectoryElement (const std::string &fname, TDirectory *dir=nullptr, bool isfile=false)
 
virtual ~TDirectoryElement ()=default
 
bool cd () override
 Select directory as active.
 
std::unique_ptr< RLevelIterGetChildsIter () override
 Provide iterator over TDirectory.
 
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 GetMTime () const override
 
std::string GetName () const override
 Name of TDirectoryElement.
 
Long64_t GetSize () const override
 Size of TDirectory.
 
std::string GetTitle () const override
 Title of TDirectoryElement.
 
bool IsFolder () const override
 Check if element can have childs.
 
- Public Member Functions inherited from ROOT::Experimental::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::Experimental::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.
 

Protected Member Functions

const TObjectCheckObject () const override
 Check if object still exists.
 
TDirectoryGetDir () const
 
TFileGetFile () const
 
- Protected Member Functions inherited from ROOT::Experimental::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.
 

Private Attributes

std::string fFileName
 ! file name
 
bool fIsFile {false}
 ! is TFile instance registered in global list of files
 

Additional Inherited Members

- Public Types inherited from ROOT::Experimental::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::Experimental::Browsable::TObjectElement
static std::unique_ptr< RLevelIterGetCollectionIter (const TCollection *)
 Creates iterator for TCollection object.
 
- 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.
 
- Protected Attributes inherited from ROOT::Experimental::Browsable::TObjectElement
bool fHideChilds {false}
 
std::string fName
 
TObjectfObj {nullptr}
 
std::unique_ptr< RHolderfObject
 
Inheritance diagram for TDirectoryElement:
[legend]

Constructor & Destructor Documentation

◆ TDirectoryElement()

TDirectoryElement::TDirectoryElement ( const std::string &  fname,
TDirectory dir = nullptr,
bool  isfile = false 
)
inline

Definition at line 248 of file TDirectoryElement.cxx.

◆ ~TDirectoryElement()

virtual TDirectoryElement::~TDirectoryElement ( )
virtualdefault

Member Function Documentation

◆ cd()

bool TDirectoryElement::cd ( )
inlineoverridevirtual

Select directory as active.

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

Definition at line 297 of file TDirectoryElement.cxx.

◆ CheckObject()

const TObject * TDirectoryElement::CheckObject ( ) const
inlineoverrideprotectedvirtual

Check if object still exists.

Reimplemented from ROOT::Experimental::Browsable::TObjectElement.

Definition at line 216 of file TDirectoryElement.cxx.

◆ GetChildsIter()

std::unique_ptr< RLevelIter > TDirectoryElement::GetChildsIter ( )
inlineoverridevirtual

Provide iterator over TDirectory.

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

Reimplemented in TKeyElement.

Definition at line 286 of file TDirectoryElement.cxx.

◆ GetContent()

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

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

Definition at line 322 of file TDirectoryElement.cxx.

◆ GetDefaultAction()

EActionKind TDirectoryElement::GetDefaultAction ( ) const
inlineoverridevirtual

Get default action - browsing for the TFile/TDirectory.

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

Reimplemented in TKeyElement.

Definition at line 294 of file TDirectoryElement.cxx.

◆ GetDir()

TDirectory * TDirectoryElement::GetDir ( ) const
inlineprotected

Definition at line 229 of file TDirectoryElement.cxx.

◆ GetFile()

TFile * TDirectoryElement::GetFile ( ) const
inlineprotected

Definition at line 237 of file TDirectoryElement.cxx.

◆ GetMTime()

std::string TDirectoryElement::GetMTime ( ) const
inlineoverridevirtual

Reimplemented from ROOT::Experimental::Browsable::TObjectElement.

Reimplemented in TKeyElement.

Definition at line 315 of file TDirectoryElement.cxx.

◆ GetName()

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

Name of TDirectoryElement.

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

Reimplemented in TKeyElement.

Definition at line 261 of file TDirectoryElement.cxx.

◆ GetSize()

Long64_t TDirectoryElement::GetSize ( ) const
inlineoverridevirtual

Size of TDirectory.

Reimplemented from ROOT::Experimental::Browsable::TObjectElement.

Reimplemented in TKeyElement.

Definition at line 308 of file TDirectoryElement.cxx.

◆ GetTitle()

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

Title of TDirectoryElement.

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

Reimplemented in TKeyElement.

Definition at line 275 of file TDirectoryElement.cxx.

◆ IsFolder()

bool TDirectoryElement::IsFolder ( ) const
inlineoverridevirtual

Check if element can have childs.

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

Reimplemented in TKeyElement.

Definition at line 283 of file TDirectoryElement.cxx.

Member Data Documentation

◆ fFileName

std::string TDirectoryElement::fFileName
private

! file name

Definition at line 211 of file TDirectoryElement.cxx.

◆ fIsFile

bool TDirectoryElement::fIsFile {false}
private

! is TFile instance registered in global list of files

Definition at line 212 of file TDirectoryElement.cxx.

  • gui/browsable/src/TDirectoryElement.cxx