Holds different arguments for starting browser with RWebDisplayHandle::Display() method.
Definition at line 30 of file RWebDisplayArgs.hxx.
Public Types | |
enum | EBrowserKind { kChrome , kFirefox , kNative , kCEF , kQt5 , kQt6 , kLocal , kStandard , kEmbedded , kOff , kCustom } |
Public Member Functions | |
RWebDisplayArgs () | |
Default constructor - browser kind configured from gROOT->GetWebDisplay() More... | |
RWebDisplayArgs (const char *browser) | |
Constructor - browser kind specified as const char * See SetBrowserKind method for description of allowed parameters. More... | |
RWebDisplayArgs (const std::string &browser) | |
Constructor - browser kind specified as std::string See SetBrowserKind() method for description of allowed parameters. More... | |
RWebDisplayArgs (int width, int height, int x=-1, int y=-1, const std::string &browser="") | |
Constructor - specify window width and height. More... | |
RWebDisplayArgs (std::shared_ptr< RWebWindow > master, int channel=-1) | |
Constructor - specify master window and channel (if reserved already) More... | |
virtual | ~RWebDisplayArgs () |
Destructor must be defined in source code to correctly call RWebWindow destructor. More... | |
void | AppendUrlOpt (const std::string &opt) |
append extra url options, add "&" as separator if required More... | |
EBrowserKind | GetBrowserKind () const |
returns configured browser kind, see EBrowserKind for supported values More... | |
std::string | GetBrowserName () const |
Returns configured browser name. More... | |
std::string | GetCustomExec () const |
returns custom executable to start web browser More... | |
void * | GetDriverData () const |
[internal] returns web-driver data, used to start window More... | |
const std::string & | GetExtraArgs () const |
get extra command line arguments for starting web browser command More... | |
std::string | GetFullUrl () const |
returns window url with append options More... | |
int | GetHeight () const |
returns preferable web window height More... | |
THttpServer * | GetHttpServer () const |
returns http server instance, used for window display More... | |
const std::string & | GetPageContent () const |
returns window url More... | |
const std::string & | GetRedirectOutput () const |
get file name to which web browser output should be redirected More... | |
const std::string & | GetUrl () const |
returns window url More... | |
const std::string & | GetUrlOpt () const |
returns window url options More... | |
const std::string & | GetWidgetKind () const |
returns widget kind More... | |
int | GetWidth () const |
returns preferable web window width More... | |
int | GetX () const |
set preferable web window x position More... | |
int | GetY () const |
set preferable web window y position More... | |
bool | IsBatchMode () const |
returns batch mode More... | |
bool | IsHeadless () const |
returns headless mode More... | |
bool | IsLocalDisplay () const |
returns true if local display like CEF or Qt5 QWebEngine should be used More... | |
bool | IsStandalone () const |
Return true if browser should runs in standalone mode. More... | |
bool | IsSupportHeadless () const |
returns true if browser supports headless mode More... | |
void | SetBatchMode (bool on=true) |
set batch mode More... | |
RWebDisplayArgs & | SetBrowserKind (const std::string &kind) |
Set browser kind as string argument Recognized values: chrome - use Google Chrome web browser, supports headless mode from v60, default firefox - use Mozilla Firefox browser, supports headless mode from v57 native - (or empty string) either chrome or firefox, only these browsers support batch (headless) mode browser - default system web-browser, no batch mode safari - Safari browser on Mac cef - Chromium Embeded Framework, local display, local communication qt5 - Qt5 QWebEngine, local display, local communication qt6 - Qt6 QWebEngineCore, local display, local communication local - either cef or qt5 or qt6 <prog> - any program name which will be started instead of default browser, like /usr/bin/opera. More... | |
RWebDisplayArgs & | SetBrowserKind (EBrowserKind kind) |
set browser kind, see EBrowserKind for allowed values More... | |
void | SetCustomExec (const std::string &exec) |
set custom executable to start web browser More... | |
void | SetDriverData (void *data) |
[internal] set web-driver data, used to start window More... | |
void | SetExtraArgs (const std::string &args) |
set extra command line arguments for starting web browser command More... | |
void | SetHeadless (bool on=true) |
set headless mode More... | |
RWebDisplayArgs & | SetHeight (int h=0) |
set preferable web window height More... | |
void | SetHttpServer (THttpServer *serv) |
set http server instance, used for window display More... | |
void | SetMasterWindow (std::shared_ptr< RWebWindow > master, int channel=-1) |
Assign window and channel id where other window will be embed. More... | |
RWebDisplayArgs & | SetPageContent (const std::string &cont) |
set window url More... | |
RWebDisplayArgs & | SetPos (int x=-1, int y=-1) |
set preferable web window x and y position, negative is default More... | |
void | SetRedirectOutput (const std::string &fname="") |
specify file name to which web browser output should be redirected More... | |
RWebDisplayArgs & | SetSize (int w, int h) |
set preferable web window width and height More... | |
void | SetStandalone (bool on=true) |
Set standalone mode for running browser, default on When disabled, normal browser window (or just tab) will be started. More... | |
RWebDisplayArgs & | SetUrl (const std::string &url) |
set window url More... | |
RWebDisplayArgs & | SetUrlOpt (const std::string &opt) |
set window url options More... | |
RWebDisplayArgs & | SetWidgetKind (const std::string &kind) |
set widget kind More... | |
RWebDisplayArgs & | SetWidth (int w=0) |
set preferable web window width More... | |
RWebDisplayArgs & | SetX (int x=-1) |
set preferable web window x position, negative is default More... | |
RWebDisplayArgs & | SetY (int y=-1) |
set preferable web window y position, negative is default More... | |
Static Public Member Functions | |
static std::string | GetQt5EmbedQualifier (const void *qparent, const std::string &urlopt="") |
returns string which can be used as argument in RWebWindow::Show() method to display web window in provided QWidget After RWebWindow is displayed created QWebEngineView can be found with the command: auto view = qparent->findChild<QWebEngineView*>("RootWebView"); More... | |
Protected Member Functions | |
bool | SetPosAsStr (const std::string &str) |
Set position of web browser window as string like "100,100". More... | |
bool | SetSizeAsStr (const std::string &str) |
Set size of web browser window as string like "800x600". More... | |
Protected Attributes | |
bool | fBatchMode {false} |
! is browser runs in batch mode More... | |
void * | fDriverData {nullptr} |
! special data delivered to driver, can be used for QWebEngine More... | |
std::string | fExec |
! string to run browser, used with kCustom type More... | |
std::string | fExtraArgs |
! extra arguments which will be append to exec string More... | |
bool | fHeadless {false} |
! is browser runs in headless mode More... | |
int | fHeight {0} |
! custom window height, when not specified - used RWebWindow geometry More... | |
EBrowserKind | fKind {kNative} |
! id of web browser used for display More... | |
std::shared_ptr< RWebWindow > | fMaster |
! master window More... | |
int | fMasterChannel {-1} |
! used master channel More... | |
std::string | fPageContent |
! HTML page content More... | |
std::string | fRedirectOutput |
! filename where browser output should be redirected More... | |
THttpServer * | fServer {nullptr} |
! http server which handle all requests More... | |
bool | fStandalone {true} |
! indicates if browser should run isolated from other browser instances More... | |
std::string | fUrl |
! URL to display More... | |
std::string | fUrlOpt |
! extra URL options, which are append to window URL More... | |
std::string | fWidgetKind |
! widget kind, used to identify that will be displayed in the web window More... | |
int | fWidth {0} |
! custom window width, when not specified - used RWebWindow geometry More... | |
int | fX {-1} |
! custom window x position, negative is default More... | |
int | fY {-1} |
! custom window y position, negative is default More... | |
Friends | |
class | RWebWindow |
#include <ROOT/RWebDisplayArgs.hxx>
Enumerator | |
---|---|
kChrome | Google Chrome browser. |
kFirefox | Mozilla Firefox browser. |
kNative | either Chrome or Firefox - both support major functionality |
kCEF | Chromium Embedded Framework - local display with CEF libs. |
kQt5 | Qt5 QWebEngine libraries - Chromium code packed in qt5. |
kQt6 | Qt6 QWebEngine libraries - Chromium code packed in qt6. |
kLocal | either CEF or Qt5 - both runs on local display without real http server |
kStandard | standard system web browser, not recognized by ROOT, without batch mode |
kEmbedded | window will be embedded into other, no extra browser need to be started |
kOff | disable web display, do not start any browser |
kCustom | custom web browser, execution string should be provided |
Definition at line 35 of file RWebDisplayArgs.hxx.
RWebDisplayArgs::RWebDisplayArgs | ( | ) |
Default constructor - browser kind configured from gROOT->GetWebDisplay()
Definition at line 41 of file RWebDisplayArgs.cxx.
RWebDisplayArgs::RWebDisplayArgs | ( | const std::string & | browser | ) |
Constructor - browser kind specified as std::string See SetBrowserKind() method for description of allowed parameters.
Definition at line 50 of file RWebDisplayArgs.cxx.
RWebDisplayArgs::RWebDisplayArgs | ( | const char * | browser | ) |
Constructor - browser kind specified as const char * See SetBrowserKind method for description of allowed parameters.
Definition at line 59 of file RWebDisplayArgs.cxx.
RWebDisplayArgs::RWebDisplayArgs | ( | int | width, |
int | height, | ||
int | x = -1 , |
||
int | y = -1 , |
||
const std::string & | browser = "" |
||
) |
Constructor - specify window width and height.
Definition at line 67 of file RWebDisplayArgs.cxx.
RWebDisplayArgs::RWebDisplayArgs | ( | std::shared_ptr< RWebWindow > | master, |
int | channel = -1 |
||
) |
Constructor - specify master window and channel (if reserved already)
Definition at line 77 of file RWebDisplayArgs.cxx.
|
virtualdefault |
Destructor must be defined in source code to correctly call RWebWindow destructor.
void RWebDisplayArgs::AppendUrlOpt | ( | const std::string & | opt | ) |
append extra url options, add "&" as separator if required
Append string to url options Add "&" as separator if any options already exists.
Definition at line 264 of file RWebDisplayArgs.cxx.
|
inline |
returns configured browser kind, see EBrowserKind for supported values
Definition at line 91 of file RWebDisplayArgs.hxx.
std::string RWebDisplayArgs::GetBrowserName | ( | ) | const |
Returns configured browser name.
Definition at line 229 of file RWebDisplayArgs.cxx.
std::string RWebDisplayArgs::GetCustomExec | ( | ) | const |
returns custom executable to start web browser
Definition at line 309 of file RWebDisplayArgs.cxx.
|
inline |
[internal] returns web-driver data, used to start window
Definition at line 196 of file RWebDisplayArgs.hxx.
|
inline |
get extra command line arguments for starting web browser command
Definition at line 176 of file RWebDisplayArgs.hxx.
std::string RWebDisplayArgs::GetFullUrl | ( | ) | const |
returns window url with append options
Returns full url, which is combined from URL and extra URL options Takes into account "#" symbol in url - options are inserted before that symbol.
Definition at line 278 of file RWebDisplayArgs.cxx.
|
inline |
returns preferable web window height
Definition at line 167 of file RWebDisplayArgs.hxx.
|
inline |
returns http server instance, used for window display
Definition at line 191 of file RWebDisplayArgs.hxx.
|
inline |
returns window url
Definition at line 121 of file RWebDisplayArgs.hxx.
|
static |
returns string which can be used as argument in RWebWindow::Show() method to display web window in provided QWidget After RWebWindow is displayed created QWebEngineView can be found with the command: auto view = qparent->findChild<QWebEngineView*>("RootWebView");
Definition at line 328 of file RWebDisplayArgs.cxx.
|
inline |
get file name to which web browser output should be redirected
Definition at line 181 of file RWebDisplayArgs.hxx.
|
inline |
returns window url
Definition at line 111 of file RWebDisplayArgs.hxx.
|
inline |
returns window url options
Definition at line 132 of file RWebDisplayArgs.hxx.
|
inline |
returns widget kind
Definition at line 116 of file RWebDisplayArgs.hxx.
|
inline |
returns preferable web window width
Definition at line 165 of file RWebDisplayArgs.hxx.
|
inline |
set preferable web window x position
Definition at line 169 of file RWebDisplayArgs.hxx.
|
inline |
set preferable web window y position
Definition at line 171 of file RWebDisplayArgs.hxx.
|
inline |
returns batch mode
Definition at line 143 of file RWebDisplayArgs.hxx.
|
inline |
returns headless mode
Definition at line 148 of file RWebDisplayArgs.hxx.
|
inline |
returns true if local display like CEF or Qt5 QWebEngine should be used
Definition at line 97 of file RWebDisplayArgs.hxx.
|
inline |
Return true if browser should runs in standalone mode.
Definition at line 127 of file RWebDisplayArgs.hxx.
|
inline |
returns true if browser supports headless mode
Definition at line 103 of file RWebDisplayArgs.hxx.
|
inline |
set batch mode
Definition at line 141 of file RWebDisplayArgs.hxx.
RWebDisplayArgs & RWebDisplayArgs::SetBrowserKind | ( | const std::string & | kind | ) |
Set browser kind as string argument Recognized values: chrome - use Google Chrome web browser, supports headless mode from v60, default firefox - use Mozilla Firefox browser, supports headless mode from v57 native - (or empty string) either chrome or firefox, only these browsers support batch (headless) mode browser - default system web-browser, no batch mode safari - Safari browser on Mac cef - Chromium Embeded Framework, local display, local communication qt5 - Qt5 QWebEngine, local display, local communication qt6 - Qt6 QWebEngineCore, local display, local communication local - either cef or qt5 or qt6 <prog>
- any program name which will be started instead of default browser, like /usr/bin/opera.
Definition at line 150 of file RWebDisplayArgs.cxx.
|
inline |
set browser kind, see EBrowserKind for allowed values
Definition at line 89 of file RWebDisplayArgs.hxx.
void RWebDisplayArgs::SetCustomExec | ( | const std::string & | exec | ) |
set custom executable to start web browser
Configure custom web browser Either just name of browser which can be used like "opera" or full execution string which must includes $url like "/usr/bin/opera $url".
Definition at line 300 of file RWebDisplayArgs.cxx.
|
inline |
[internal] set web-driver data, used to start window
Definition at line 194 of file RWebDisplayArgs.hxx.
|
inline |
set extra command line arguments for starting web browser command
Definition at line 174 of file RWebDisplayArgs.hxx.
|
inline |
set headless mode
Definition at line 146 of file RWebDisplayArgs.hxx.
|
inline |
set preferable web window height
Definition at line 153 of file RWebDisplayArgs.hxx.
|
inline |
set http server instance, used for window display
Definition at line 189 of file RWebDisplayArgs.hxx.
void RWebDisplayArgs::SetMasterWindow | ( | std::shared_ptr< RWebWindow > | master, |
int | channel = -1 |
||
) |
Assign window and channel id where other window will be embed.
Definition at line 253 of file RWebDisplayArgs.cxx.
|
inline |
set window url
Definition at line 119 of file RWebDisplayArgs.hxx.
|
inline |
set preferable web window x and y position, negative is default
Definition at line 162 of file RWebDisplayArgs.hxx.
|
protected |
Set position of web browser window as string like "100,100".
Definition at line 115 of file RWebDisplayArgs.cxx.
|
inline |
specify file name to which web browser output should be redirected
Definition at line 179 of file RWebDisplayArgs.hxx.
|
inline |
set preferable web window width and height
Definition at line 155 of file RWebDisplayArgs.hxx.
|
protected |
Set size of web browser window as string like "800x600".
Definition at line 91 of file RWebDisplayArgs.cxx.
|
inline |
Set standalone mode for running browser, default on When disabled, normal browser window (or just tab) will be started.
Definition at line 125 of file RWebDisplayArgs.hxx.
|
inline |
set window url
Definition at line 109 of file RWebDisplayArgs.hxx.
|
inline |
set window url options
Definition at line 130 of file RWebDisplayArgs.hxx.
|
inline |
set widget kind
Definition at line 114 of file RWebDisplayArgs.hxx.
|
inline |
set preferable web window width
Definition at line 151 of file RWebDisplayArgs.hxx.
|
inline |
set preferable web window x position, negative is default
Definition at line 158 of file RWebDisplayArgs.hxx.
|
inline |
set preferable web window y position, negative is default
Definition at line 160 of file RWebDisplayArgs.hxx.
|
friend |
Definition at line 32 of file RWebDisplayArgs.hxx.
|
protected |
! is browser runs in batch mode
Definition at line 56 of file RWebDisplayArgs.hxx.
|
protected |
! special data delivered to driver, can be used for QWebEngine
Definition at line 66 of file RWebDisplayArgs.hxx.
|
protected |
! string to run browser, used with kCustom type
Definition at line 65 of file RWebDisplayArgs.hxx.
|
protected |
! extra arguments which will be append to exec string
Definition at line 52 of file RWebDisplayArgs.hxx.
|
protected |
! is browser runs in headless mode
Definition at line 57 of file RWebDisplayArgs.hxx.
|
protected |
! custom window height, when not specified - used RWebWindow geometry
Definition at line 61 of file RWebDisplayArgs.hxx.
|
protected |
! id of web browser used for display
Definition at line 50 of file RWebDisplayArgs.hxx.
|
protected |
! master window
Definition at line 68 of file RWebDisplayArgs.hxx.
|
protected |
! used master channel
Definition at line 69 of file RWebDisplayArgs.hxx.
|
protected |
! HTML page content
Definition at line 53 of file RWebDisplayArgs.hxx.
|
protected |
! filename where browser output should be redirected
Definition at line 54 of file RWebDisplayArgs.hxx.
|
protected |
! http server which handle all requests
Definition at line 59 of file RWebDisplayArgs.hxx.
|
protected |
! indicates if browser should run isolated from other browser instances
Definition at line 58 of file RWebDisplayArgs.hxx.
|
protected |
! URL to display
Definition at line 51 of file RWebDisplayArgs.hxx.
|
protected |
! extra URL options, which are append to window URL
Definition at line 64 of file RWebDisplayArgs.hxx.
|
protected |
! widget kind, used to identify that will be displayed in the web window
Definition at line 55 of file RWebDisplayArgs.hxx.
|
protected |
! custom window width, when not specified - used RWebWindow geometry
Definition at line 60 of file RWebDisplayArgs.hxx.
|
protected |
! custom window x position, negative is default
Definition at line 62 of file RWebDisplayArgs.hxx.
|
protected |
! custom window y position, negative is default
Definition at line 63 of file RWebDisplayArgs.hxx.