RCefWebDisplayHandle Class Reference

Definition at line 23 of file RCefWebDisplayHandle.hxx.

Classes
class	CefCreator

Public Member Functions
	RCefWebDisplayHandle (const std::string &url)
	~RCefWebDisplayHandle () override
	Destructor Closes browser window if any.
void	CloseBrowser ()
	Closes associated browser window.
const std::string &	GetContent () const
	get content
const std::string &	GetUrl () const
	returns url of start web display
bool	IsValid () const
virtual void	RemoveStartupFiles ()
	remove file which was used to startup widget - if possible
bool	Resize (int, int) override
	Resize browser window.
void	SetBrowser (CefRefPtr< CefBrowser > br)
void	SetContent (const std::string &cont)
	set content
bool	WaitForContent (int tmout_sec, const std::string &extra_args)
	Process system events until browser content is available Used in headless mode for batch production like chrome –dump-dom is doing.

Static Public Member Functions
static void	AddCreator ()
	Add CEF creator.
static bool	CanProduceImages (const std::string &browser="")
	Returns true if image production for specified browser kind is supported If browser not specified - use currently configured browser or try to test existing web browsers.
static std::unique_ptr< RWebDisplayHandle >	Display (const RWebDisplayArgs &args)
	Create web display.
static bool	DisplayUrl (const std::string &url)
	Display provided url in configured web browser.
static std::string	GetImageFormat (const std::string &fname)
	Detect image format There is special handling of ".screenshot.pdf" and ".screenshot.png" extensions Creation of such files relies on headless browser functionality and fully supported only by Chrome browser.
static bool	NeedHttpServer (const RWebDisplayArgs &args)
	Check if http server required for display.
static bool	ProduceImage (const std::string &fname, const std::string &json, int width=800, int height=600, const char *batch_file=nullptr)
	Produce image file using JSON data as source Invokes JSROOT drawing functionality in headless browser - Google Chrome or Mozilla Firefox.
static bool	ProduceImages (const std::string &fname, const std::vector< std::string > &jsons, const std::vector< int > &widths, const std::vector< int > &heights, const char *batch_file=nullptr)
	Produce image file(s) using JSON data as source Invokes JSROOT drawing functionality in headless browser - Google Chrome or Mozilla Firefox.
static bool	ProduceImages (const std::vector< std::string > &fnames, const std::vector< std::string > &jsons, const std::vector< int > &widths, const std::vector< int > &heights, const char *batch_file=nullptr)
	Produce image file(s) using JSON data as source Invokes JSROOT drawing functionality in headless browser - Google Chrome or Mozilla Firefox.
static std::vector< std::string >	ProduceImagesNames (const std::string &fname, unsigned nfiles=1)
	Produce vector of file names for specified file pattern Depending from supported file formats.

Protected Types
enum	EValidValues { kValid = 0x3C3C3C3C , kInvalid = 0x92929292 }

Static Protected Member Functions
static bool	CheckIfCanProduceImages (RWebDisplayArgs &args)
	Checks if configured browser can be used for image production.
static std::unique_ptr< Creator > &	FindCreator (const std::string &name, const std::string &libname="")
	Search for specific browser creator If not found, try to add one.
static std::map< std::string, std::unique_ptr< Creator > > &	GetMap ()
	Static holder of registered creators of web displays.

Protected Attributes
CefRefPtr< CefBrowser >	fBrowser
	associated browser
bool	fCloseBrowser = true
unsigned	fValid {kValid}
	used to verify if instance valid or not

Private Attributes
std::string	fContent
	!< URL used to launch display
std::string	fUrl

#include <RCefWebDisplayHandle.hxx>

Inheritance diagram for RCefWebDisplayHandle:

Member Enumeration Documentation

EValidValues

enum RCefWebDisplayHandle::EValidValues

protected

Enumerator
kValid
kInvalid

Definition at line 35 of file RCefWebDisplayHandle.hxx.

Constructor & Destructor Documentation

RCefWebDisplayHandle()

RCefWebDisplayHandle::RCefWebDisplayHandle ( const std::string & url )

inline

Definition at line 43 of file RCefWebDisplayHandle.hxx.

~RCefWebDisplayHandle()

RCefWebDisplayHandle::~RCefWebDisplayHandle ( )

override

Destructor Closes browser window if any.

Definition at line 258 of file RCefWebDisplayHandle.cxx.

Member Function Documentation

AddCreator()

void RCefWebDisplayHandle::AddCreator ( )

static

Add CEF creator.

Definition at line 329 of file RCefWebDisplayHandle.cxx.

CanProduceImages()

bool RWebDisplayHandle::CanProduceImages ( const std::string & browser = "" )

staticinherited

Returns true if image production for specified browser kind is supported If browser not specified - use currently configured browser or try to test existing web browsers.

Definition at line 1076 of file RWebDisplayHandle.cxx.

CheckIfCanProduceImages()

bool RWebDisplayHandle::CheckIfCanProduceImages ( RWebDisplayArgs & args )

staticprotectedinherited

Checks if configured browser can be used for image production.

Definition at line 1028 of file RWebDisplayHandle.cxx.

CloseBrowser()

void RCefWebDisplayHandle::CloseBrowser

(

)

Closes associated browser window.

Definition at line 268 of file RCefWebDisplayHandle.cxx.

Display()

std::unique_ptr< RWebDisplayHandle > RWebDisplayHandle::Display ( const RWebDisplayArgs & args )

staticinherited

Create web display.

Parameters

args	- defines where and how to display web window Returns RWebDisplayHandle, which holds information of running browser application Can be used fully independent from RWebWindow classes just to show any web page

Definition at line 918 of file RWebDisplayHandle.cxx.

DisplayUrl()

bool RWebDisplayHandle::DisplayUrl ( const std::string & url )

staticinherited

Display provided url in configured web browser.

Parameters

url	- specified URL address like https://root.cern Browser can specified when starting root --web=firefox Returns true when browser started It is convenience method, equivalent to: RWebDisplayArgs args; args.SetUrl(url); args.SetStandalone(false); auto handle = RWebDisplayHandle::Display(args);

Definition at line 1014 of file RWebDisplayHandle.cxx.

FindCreator()

std::unique_ptr< RWebDisplayHandle::Creator > & RWebDisplayHandle::FindCreator ( const std::string & name, const std::string & libname = "" )

staticprotectedinherited

Search for specific browser creator If not found, try to add one.

Parameters

name	- creator name like ChromeCreator
libname	- shared library name where creator could be provided

Definition at line 80 of file RWebDisplayHandle.cxx.

GetContent()

const std::string & ROOT::RWebDisplayHandle::GetContent ( ) const

inlineinherited

get content

Definition at line 107 of file RWebDisplayHandle.hxx.

GetImageFormat()

std::string RWebDisplayHandle::GetImageFormat ( const std::string & fname )

staticinherited

Detect image format There is special handling of ".screenshot.pdf" and ".screenshot.png" extensions Creation of such files relies on headless browser functionality and fully supported only by Chrome browser.

Definition at line 1088 of file RWebDisplayHandle.cxx.

GetMap()

std::map< std::string, std::unique_ptr< RWebDisplayHandle::Creator > > & RWebDisplayHandle::GetMap ( )

staticprotectedinherited

Static holder of registered creators of web displays.

Definition at line 68 of file RWebDisplayHandle.cxx.

GetUrl()

const std::string & ROOT::RWebDisplayHandle::GetUrl ( ) const

inlineinherited

returns url of start web display

Definition at line 102 of file RWebDisplayHandle.hxx.

IsValid()

bool RCefWebDisplayHandle::IsValid ( ) const

inline

Definition at line 47 of file RCefWebDisplayHandle.hxx.

NeedHttpServer()

bool RWebDisplayHandle::NeedHttpServer ( const RWebDisplayArgs & args )

staticinherited

Check if http server required for display.

Parameters

args	- defines where and how to display web window

Definition at line 888 of file RWebDisplayHandle.cxx.

ProduceImage()

bool RWebDisplayHandle::ProduceImage ( const std::string & fname, const std::string & json, int width = 800, int height = 600, const char * batch_file = nullptr )

staticinherited

Produce image file using JSON data as source Invokes JSROOT drawing functionality in headless browser - Google Chrome or Mozilla Firefox.

Definition at line 1123 of file RWebDisplayHandle.cxx.

ProduceImages() [1/2]

bool RWebDisplayHandle::ProduceImages ( const std::string & fname, const std::vector< std::string > & jsons, const std::vector< int > & widths, const std::vector< int > & heights, const char * batch_file = nullptr )

staticinherited

Produce image file(s) using JSON data as source Invokes JSROOT drawing functionality in headless browser - Google Chrome or Mozilla Firefox.

Definition at line 1170 of file RWebDisplayHandle.cxx.

ProduceImages() [2/2]

bool RWebDisplayHandle::ProduceImages ( const std::vector< std::string > & fnames, const std::vector< std::string > & jsons, const std::vector< int > & widths, const std::vector< int > & heights, const char * batch_file = nullptr )

staticinherited

Produce image file(s) using JSON data as source Invokes JSROOT drawing functionality in headless browser - Google Chrome or Mozilla Firefox.

Definition at line 1179 of file RWebDisplayHandle.cxx.

ProduceImagesNames()

std::vector< std::string > RWebDisplayHandle::ProduceImagesNames ( const std::string & fname, unsigned nfiles = 1 )

staticinherited

Produce vector of file names for specified file pattern Depending from supported file formats.

Definition at line 1133 of file RWebDisplayHandle.cxx.

RemoveStartupFiles()

virtual void ROOT::RWebDisplayHandle::RemoveStartupFiles ( )

inlinevirtualinherited

remove file which was used to startup widget - if possible

Reimplemented in ROOT::RWebBrowserHandle.

Definition at line 113 of file RWebDisplayHandle.hxx.

Resize()

bool RCefWebDisplayHandle::Resize ( int width, int height )

overridevirtual

Resize browser window.

Reimplemented from ROOT::RWebDisplayHandle.

Definition at line 319 of file RCefWebDisplayHandle.cxx.

SetBrowser()

void RCefWebDisplayHandle::SetBrowser ( CefRefPtr< CefBrowser > br )

inline

Definition at line 49 of file RCefWebDisplayHandle.hxx.

SetContent()

void ROOT::RWebDisplayHandle::SetContent ( const std::string & cont )

inlineinherited

set content

Definition at line 105 of file RWebDisplayHandle.hxx.

WaitForContent()

bool RCefWebDisplayHandle::WaitForContent	(	int	tmout_sec,
		const std::string &	extra_args )

Process system events until browser content is available Used in headless mode for batch production like chrome –dump-dom is doing.

Definition at line 281 of file RCefWebDisplayHandle.cxx.

Member Data Documentation

fBrowser

CefRefPtr<CefBrowser> RCefWebDisplayHandle::fBrowser

protected

associated browser

Definition at line 39 of file RCefWebDisplayHandle.hxx.

fCloseBrowser

bool RCefWebDisplayHandle::fCloseBrowser = true

protected

Definition at line 40 of file RCefWebDisplayHandle.hxx.

fContent

std::string ROOT::RWebDisplayHandle::fContent

privateinherited

!< URL used to launch display

Definition at line 29 of file RWebDisplayHandle.hxx.

fUrl

std::string ROOT::RWebDisplayHandle::fUrl

privateinherited

Definition at line 27 of file RWebDisplayHandle.hxx.

fValid

unsigned RCefWebDisplayHandle::fValid {kValid}

protected

used to verify if instance valid or not

Definition at line 37 of file RCefWebDisplayHandle.hxx.