Logo ROOT  

Reference Guide
 
Loading...
Searching...
No Matches
List of all members | Public Member Functions | Private Attributes | List of all members
ROOT::Browsable::RWrapper Class Reference
Web Widgets » Browsable object

Wrapper for other element - to provide different name.

Author
Sergey Linev S.Lin.nosp@m.ev@g.nosp@m.si.de
Date
2019-11-22
Warning
This is part of the ROOT 7 prototype! It will change without notice. It might trigger earthquakes. Feedback is welcome!

Definition at line 26 of file RWrapper.hxx.

Public Member Functions

 RWrapper ()=default
 
 RWrapper (const std::string &name, std::shared_ptr< RElement > elem)
 
virtual ~RWrapper ()=default
 
std::unique_ptr< RLevelIter > GetChildsIter () override
 Create iterator for childs elements if any.
 
std::string GetContent (const std::string &kind="text") override
 Returns element content, depends from kind.
 
EActionKind GetDefaultAction () const override
 Get default action.
 
std::string GetName () const override
 Name of element, must be provided in derived classes.
 
std::unique_ptr< RHolder > GetObject () override
 Access object.
 
std::string GetTitle () const override
 Title of element (optional)
 
bool IsCapable (EActionKind action) const override
 Check if want to perform action.
 
bool IsExpandByDefault () const override
 Should item representing element be expand by default.
 
void SetExpandByDefault (bool on=true)
 
- Public Member Functions inherited from ROOT::Browsable::RElement
virtual ~RElement ()=default
 
virtual bool cd ()
 Select element as active.
 
virtual bool CheckValid ()
 Check if element still contains valid content.
 
virtual std::unique_ptr< RItem > CreateItem () const
 Returns item with element description.
 
virtual int GetNumChilds ()
 Returns number of childs By default creates iterator and iterates over all items.
 
virtual bool IsFolder () const
 Check if element can have childs.
 
virtual bool IsObject (void *)
 Check if element contains provided pointer.
 
virtual bool MatchName (const std::string &name) const
 Checks if element name match to provided value.
 

Private Attributes

std::shared_ptr< RElement > fElem
 
bool fExapndByDefault {false}
 
std::string fName
 

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::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< RElement > GetSubElement (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.
 

#include <ROOT/Browsable/RWrapper.hxx>

Inheritance diagram for ROOT::Browsable::RWrapper:
[legend]

Constructor & Destructor Documentation

◆ RWrapper() [1/2]

ROOT::Browsable::RWrapper::RWrapper ( )
default

◆ RWrapper() [2/2]

ROOT::Browsable::RWrapper::RWrapper ( const std::string & name,
std::shared_ptr< RElement > elem )
inline

Definition at line 34 of file RWrapper.hxx.

◆ ~RWrapper()

virtual ROOT::Browsable::RWrapper::~RWrapper ( )
virtualdefault

Member Function Documentation

◆ GetChildsIter()

std::unique_ptr< RLevelIter > ROOT::Browsable::RWrapper::GetChildsIter ( )
inlineoverridevirtual

Create iterator for childs elements if any.

Reimplemented from ROOT::Browsable::RElement.

Definition at line 45 of file RWrapper.hxx.

◆ GetContent()

std::string ROOT::Browsable::RWrapper::GetContent ( const std::string & kind = "text")
inlineoverridevirtual

Returns element content, depends from kind.

Can be "text" or "image64"

Reimplemented from ROOT::Browsable::RElement.

Definition at line 48 of file RWrapper.hxx.

◆ GetDefaultAction()

EActionKind ROOT::Browsable::RWrapper::GetDefaultAction ( ) const
inlineoverridevirtual

Get default action.

Reimplemented from ROOT::Browsable::RElement.

Definition at line 54 of file RWrapper.hxx.

◆ GetName()

std::string ROOT::Browsable::RWrapper::GetName ( ) const
inlineoverridevirtual

Name of element, must be provided in derived classes.

Implements ROOT::Browsable::RElement.

Definition at line 39 of file RWrapper.hxx.

◆ GetObject()

std::unique_ptr< RHolder > ROOT::Browsable::RWrapper::GetObject ( )
inlineoverridevirtual

Access object.

Reimplemented from ROOT::Browsable::RElement.

Definition at line 51 of file RWrapper.hxx.

◆ GetTitle()

std::string ROOT::Browsable::RWrapper::GetTitle ( ) const
inlineoverridevirtual

Title of element (optional)

Reimplemented from ROOT::Browsable::RElement.

Definition at line 42 of file RWrapper.hxx.

◆ IsCapable()

bool ROOT::Browsable::RWrapper::IsCapable ( EActionKind action) const
inlineoverridevirtual

Check if want to perform action.

Reimplemented from ROOT::Browsable::RElement.

Definition at line 57 of file RWrapper.hxx.

◆ IsExpandByDefault()

bool ROOT::Browsable::RWrapper::IsExpandByDefault ( ) const
inlineoverridevirtual

Should item representing element be expand by default.

Reimplemented from ROOT::Browsable::RElement.

Definition at line 59 of file RWrapper.hxx.

◆ SetExpandByDefault()

void ROOT::Browsable::RWrapper::SetExpandByDefault ( bool on = true)
inline

Definition at line 60 of file RWrapper.hxx.

Member Data Documentation

◆ fElem

std::shared_ptr<RElement> ROOT::Browsable::RWrapper::fElem
private

Definition at line 28 of file RWrapper.hxx.

◆ fExapndByDefault

bool ROOT::Browsable::RWrapper::fExapndByDefault {false}
private

Definition at line 29 of file RWrapper.hxx.

◆ fName

std::string ROOT::Browsable::RWrapper::fName
private

Definition at line 27 of file RWrapper.hxx.

Libraries for ROOT::Browsable::RWrapper:
[legend]
The documentation for this class was generated from the following file: