Web-based ROOT files and objects browser.

Definition at line 27 of file RBrowser.hxx.

Public Member Functions
	RBrowser (bool use_rcanvas=true)
	constructor

virtual	~RBrowser ()
	destructor

bool	ActivateWidget (const std::string &title, const std::string &kind="")
	Activate widget in RBrowser One should specify title and (optionally) kind of widget like "tcanvas" or "geom".

void	AddRCanvas ()

void	AddTCanvas ()

bool	GetCatchWindowShow () const
	Is RWebWindow::Show calls catched for embeding of created widgets.

bool	GetUseRCanvas () const

void	Hide ()
	hide Browser

void	SetCatchWindowShow (bool on=true)
	Enable/disable catch of RWebWindow::Show calls to embed created widgets, default on.

void	SetUseRCanvas (bool on=true)

void	SetWorkingPath (const std::string &path)
	Set working path in the browser.

void	Show (const RWebDisplayArgs &args="", bool always_start_new_browser=false)
	show Browser in specified place

Protected Member Functions
std::shared_ptr< RBrowserWidget >	AddCatchedWidget (const std::string &url, const std::string &kind)
	Add widget catched from external scripts.

void	AddInitWidget (const std::string &kind)
	Create new widget and send init message to the client.

std::shared_ptr< RBrowserWidget >	AddWidget (const std::string &kind)
	Creates new widget.

void	CheckWidgtesModified ()
	Check if any widget was modified and update if necessary.

void	CloseTab (const std::string &name)
	Close and delete specified widget.

std::shared_ptr< RBrowserWidget >	FindWidget (const std::string &name, const std::string &kind="") const
	Find widget by name or kind.

std::shared_ptr< RBrowserWidget >	GetActiveWidget () const

std::string	GetCurrentWorkingDirectory ()
	Return the current directory of ROOT.

std::vector< std::string >	GetRootHistory ()
	Get content of history file.

std::vector< std::string >	GetRootLogs ()
	Get content of log file.

std::string	NewWidgetMsg (std::shared_ptr< RBrowserWidget > &widget)
	Create message which send to client to create new widget.

std::string	ProcessBrowserRequest (const std::string &msg)
	Process browser request.

std::string	ProcessDblClick (std::vector< std::string > &args)
	Process dbl click on browser item.

void	ProcessMsg (unsigned connid, const std::string &arg)
	Process received message from the client.

void	ProcessRunMacro (const std::string &file_path)
	Process run macro command in the editor.

void	ProcessSaveFile (const std::string &fname, const std::string &content)
	Process file save command in the editor.

void	SendInitMsg (unsigned connid)
	Process client connect.

Protected Attributes
std::string	fActiveWidgetName
	! name of active widget

RBrowserData	fBrowsable
	! central browsing element

bool	fCatchWindowShow {true}
	! if arbitrary RWebWindow::Show calls should be catched by browser

unsigned	fConnId {0}
	! default connection id

std::string	fPromptFileOutput
	! file name for prompt output

std::string	fTitle
	! title

bool	fUseRCanvas {false}
	! which canvas should be used

std::shared_ptr< RWebWindow >	fWebWindow
	! web window to browser

int	fWidgetCnt {0}
	! counter for created widgets

std::vector< std::shared_ptr< RBrowserWidget > >	fWidgets
	! all browser widgets

#include <ROOT/RBrowser.hxx>

Constructor & Destructor Documentation

◆ RBrowser()

RBrowser::RBrowser ( bool use_rcanvas = true )

constructor

Definition at line 256 of file RBrowser.cxx.

◆ ~RBrowser()

RBrowser::~RBrowser ( )

virtual

destructor

Definition at line 323 of file RBrowser.cxx.

Member Function Documentation

◆ ActivateWidget()

bool RBrowser::ActivateWidget	(	const std::string &	title,
		const std::string &	kind = `""`
	)

Activate widget in RBrowser One should specify title and (optionally) kind of widget like "tcanvas" or "geom".

Definition at line 864 of file RBrowser.cxx.

◆ AddCatchedWidget()

std::shared_ptr< RBrowserWidget > RBrowser::AddCatchedWidget	(	const std::string &	url,
		const std::string &	kind
	)

protected

Add widget catched from external scripts.

Definition at line 539 of file RBrowser.cxx.

◆ AddInitWidget()

void RBrowser::AddInitWidget ( const std::string & kind )

protected

Create new widget and send init message to the client.

Definition at line 558 of file RBrowser.cxx.

◆ AddRCanvas()

void ROOT::Experimental::RBrowser::AddRCanvas ( )

inline

Definition at line 77 of file RBrowser.hxx.

◆ AddTCanvas()

void ROOT::Experimental::RBrowser::AddTCanvas ( )

inline

Definition at line 76 of file RBrowser.hxx.

◆ AddWidget()

std::shared_ptr< RBrowserWidget > RBrowser::AddWidget ( const std::string & kind )

protected

Creates new widget.

Definition at line 507 of file RBrowser.cxx.

◆ CheckWidgtesModified()

void RBrowser::CheckWidgtesModified ( )

protected

Check if any widget was modified and update if necessary.

Definition at line 698 of file RBrowser.cxx.

◆ CloseTab()

void RBrowser::CloseTab ( const std::string & name )

protected

Close and delete specified widget.

Definition at line 584 of file RBrowser.cxx.

◆ FindWidget()

std::shared_ptr< RBrowserWidget > RBrowser::FindWidget	(	const std::string &	name,
		const std::string &	kind = `""`
	)		const

protected

Find widget by name or kind.

Definition at line 568 of file RBrowser.cxx.

◆ GetActiveWidget()

std::shared_ptr< RBrowserWidget > ROOT::Experimental::RBrowser::GetActiveWidget ( ) const

inlineprotected

Definition at line 48 of file RBrowser.hxx.

◆ GetCatchWindowShow()

bool ROOT::Experimental::RBrowser::GetCatchWindowShow ( ) const

inline

Is RWebWindow::Show calls catched for embeding of created widgets.

Definition at line 91 of file RBrowser.hxx.

◆ GetCurrentWorkingDirectory()

std::string RBrowser::GetCurrentWorkingDirectory ( )

protected

Return the current directory of ROOT.

Definition at line 680 of file RBrowser.cxx.

◆ GetRootHistory()

std::vector< std::string > RBrowser::GetRootHistory ( )

protected

Get content of history file.

Definition at line 597 of file RBrowser.cxx.

◆ GetRootLogs()

std::vector< std::string > RBrowser::GetRootLogs ( )

protected

Get content of log file.

Definition at line 620 of file RBrowser.cxx.

◆ GetUseRCanvas()

bool ROOT::Experimental::RBrowser::GetUseRCanvas ( ) const

inline

Definition at line 73 of file RBrowser.hxx.

◆ Hide()

void RBrowser::Hide ( )

hide Browser

Hide ROOT Browser.

Definition at line 497 of file RBrowser.cxx.

◆ NewWidgetMsg()

std::string RBrowser::NewWidgetMsg ( std::shared_ptr< RBrowserWidget > & widget )

protected

Create message which send to client to create new widget.

Definition at line 688 of file RBrowser.cxx.

◆ ProcessBrowserRequest()

std::string RBrowser::ProcessBrowserRequest ( const std::string & msg )

protected

Process browser request.

Definition at line 332 of file RBrowser.cxx.

◆ ProcessDblClick()

std::string RBrowser::ProcessDblClick ( std::vector< std::string > & args )

protected

Process dbl click on browser item.

Definition at line 381 of file RBrowser.cxx.

◆ ProcessMsg()

void RBrowser::ProcessMsg	(	unsigned	connid,
		const std::string &	arg
	)

protected

Process received message from the client.

Definition at line 707 of file RBrowser.cxx.

◆ ProcessRunMacro()

void RBrowser::ProcessRunMacro ( const std::string & file_path )

protected

Process run macro command in the editor.

Definition at line 367 of file RBrowser.cxx.

◆ ProcessSaveFile()

void RBrowser::ProcessSaveFile	(	const std::string &	fname,
		const std::string &	content
	)

protected

Process file save command in the editor.

Definition at line 356 of file RBrowser.cxx.

◆ SendInitMsg()

void RBrowser::SendInitMsg ( unsigned connid )

protected

Process client connect.

Definition at line 638 of file RBrowser.cxx.

◆ SetCatchWindowShow()

void ROOT::Experimental::RBrowser::SetCatchWindowShow ( bool on = true )

inline

Enable/disable catch of RWebWindow::Show calls to embed created widgets, default on.

Definition at line 88 of file RBrowser.hxx.

◆ SetUseRCanvas()

void ROOT::Experimental::RBrowser::SetUseRCanvas ( bool on = true )

inline

Definition at line 74 of file RBrowser.hxx.

◆ SetWorkingPath()

void RBrowser::SetWorkingPath ( const std::string & path )

Set working path in the browser.

Definition at line 849 of file RBrowser.cxx.

◆ Show()

void RBrowser::Show	(	const RWebDisplayArgs &	args = `""`,
		bool	always_start_new_browser = `false`
	)

show Browser in specified place

Show or update RBrowser in web window If web window already started - just refresh it like "reload" button does If no web window exists or.

Parameters

always_start_new_browser	configured, starts new window
args	display arguments

Definition at line 485 of file RBrowser.cxx.

Member Data Documentation

◆ fActiveWidgetName

std::string ROOT::Experimental::RBrowser::fActiveWidgetName

protected

! name of active widget

Definition at line 36 of file RBrowser.hxx.

◆ fBrowsable

RBrowserData ROOT::Experimental::RBrowser::fBrowsable

protected

! central browsing element

Definition at line 43 of file RBrowser.hxx.

◆ fCatchWindowShow

bool ROOT::Experimental::RBrowser::fCatchWindowShow {true}

protected

! if arbitrary RWebWindow::Show calls should be catched by browser

Definition at line 35 of file RBrowser.hxx.

◆ fConnId

unsigned ROOT::Experimental::RBrowser::fConnId {0}

protected

! default connection id

Definition at line 32 of file RBrowser.hxx.

◆ fPromptFileOutput

std::string ROOT::Experimental::RBrowser::fPromptFileOutput

protected

! file name for prompt output

Definition at line 39 of file RBrowser.hxx.

◆ fTitle

std::string ROOT::Experimental::RBrowser::fTitle

protected

! title

Definition at line 31 of file RBrowser.hxx.

◆ fUseRCanvas

bool ROOT::Experimental::RBrowser::fUseRCanvas {false}

protected

! which canvas should be used

Definition at line 34 of file RBrowser.hxx.

◆ fWebWindow

std::shared_ptr<RWebWindow> ROOT::Experimental::RBrowser::fWebWindow

protected

! web window to browser

Definition at line 41 of file RBrowser.hxx.

◆ fWidgetCnt

int ROOT::Experimental::RBrowser::fWidgetCnt {0}

protected

! counter for created widgets

Definition at line 38 of file RBrowser.hxx.

◆ fWidgets

std::vector<std::shared_ptr<RBrowserWidget> > ROOT::Experimental::RBrowser::fWidgets

protected

! all browser widgets

Definition at line 37 of file RBrowser.hxx.

Libraries for ROOT::Experimental::RBrowser:

[legend]

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

gui/browserv7/inc/ROOT/RBrowser.hxx
gui/browserv7/src/RBrowser.cxx

Public Member Functions

Protected Member Functions

Protected Attributes

Constructor & Destructor Documentation

◆ RBrowser()

◆ ~RBrowser()

Member Function Documentation

◆ ActivateWidget()

◆ AddCatchedWidget()

◆ AddInitWidget()

◆ AddRCanvas()

◆ AddTCanvas()

◆ AddWidget()

◆ CheckWidgtesModified()

◆ CloseTab()

◆ FindWidget()

◆ GetActiveWidget()

◆ GetCatchWindowShow()

◆ GetCurrentWorkingDirectory()

◆ GetRootHistory()

◆ GetRootLogs()

◆ GetUseRCanvas()

◆ Hide()

◆ NewWidgetMsg()

◆ ProcessBrowserRequest()

◆ ProcessDblClick()

◆ ProcessMsg()

◆ ProcessRunMacro()

◆ ProcessSaveFile()

◆ SendInitMsg()

◆ SetCatchWindowShow()

◆ SetUseRCanvas()

◆ SetWorkingPath()

◆ Show()

Member Data Documentation

◆ fActiveWidgetName

◆ fBrowsable

◆ fCatchWindowShow

◆ fConnId

◆ fPromptFileOutput

◆ fTitle

◆ fUseRCanvas

◆ fWebWindow

◆ fWidgetCnt

◆ fWidgets