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 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
	RWrapper ()=default
	RWrapper (const std::string &name, std::shared_ptr< RElement > elem)
virtual	~RWrapper ()=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.
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.
virtual int	GetNumChilds ()
	Returns number of childs By default creates iterator and iterates over all items.
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.
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.
void	SetExpandByDefault (bool on=true)

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 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.

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

#include <ROOT/Browsable/RWrapper.hxx>

Inheritance diagram for ROOT::Browsable::RWrapper:

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

◆ 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

◆ cd()

virtual bool ROOT::Browsable::RElement::cd ( )

inlinevirtualinherited

Select element as active.

Reimplemented in TDirectoryElement.

Definition at line 103 of file RElement.hxx.

◆ CheckValid()

virtual bool ROOT::Browsable::RElement::CheckValid ( )

inlinevirtualinherited

Check if element still contains valid content.

Reimplemented in ROOT::Browsable::TObjectElement.

Definition at line 91 of file RElement.hxx.

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

virtualinherited

Returns item with element description.

Reimplemented in RNTupleElement, ROOT::Browsable::TObjectElement, RTreeMapElement, RVisualizationElement, and TKeyElement.

Definition at line 107 of file RElement.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.

◆ 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.

◆ 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 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.

◆ 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 > ROOT::Browsable::RWrapper::GetObject ( )

inlineoverridevirtual

Access object.

Reimplemented from ROOT::Browsable::RElement.

Definition at line 51 of file RWrapper.hxx.

◆ GetPathAsString()

std::string RElement::GetPathAsString ( const RElementPath_t & path )

staticinherited

Converts element path back to string.

Definition at line 162 of file RElement.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 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.

◆ IsFolder()

virtual bool ROOT::Browsable::RElement::IsFolder ( ) const

inlinevirtualinherited

Check if element can have childs.

Reimplemented in ROOT::Browsable::TGeoManagerElement, ROOT::Browsable::TGeoVolumeElement, ROOT::Browsable::TObjectElement, RTreeMapElement, RVisualizationElement, TDirectoryElement, and TKeyElement.

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

virtual bool ROOT::Browsable::RElement::IsObject ( void * )

inlinevirtualinherited

Check if element contains provided pointer.

Reimplemented in ROOT::Browsable::TObjectElement.

Definition at line 83 of file RElement.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.

◆ SetExpandByDefault()

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

inline

Definition at line 60 of file RWrapper.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.

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.

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

gui/browsable/inc/ROOT/Browsable/RWrapper.hxx

Public Types

Public Member Functions

Static Public Member Functions

Private Attributes

Member Enumeration Documentation

◆ EActionKind

◆ EContentKind

Constructor & Destructor Documentation

◆ RWrapper() [1/2]

◆ RWrapper() [2/2]

◆ ~RWrapper()

Member Function Documentation

◆ cd()

◆ CheckValid()

◆ ComparePaths()

◆ CreateItem()

◆ ExtractItemIndex()

◆ GetChildsIter()

◆ GetContent()

◆ GetContentKind()

◆ GetDefaultAction()

◆ GetName()

◆ GetNumChilds()

◆ GetObject()

◆ GetPathAsString()

◆ GetSubElement()

◆ GetTitle()

◆ IsCapable()

◆ IsExpandByDefault()

◆ IsFolder()

◆ IsLastKeyCycle()

◆ IsObject()

◆ MatchName()

◆ ParsePath()

◆ SetExpandByDefault()

◆ SetLastKeyCycle()

Member Data Documentation

◆ fElem

◆ fExapndByDefault

◆ fName