OpenRoadCode
Public API reference for OpenRoadCode
Loading...
Searching...
No Matches
apps.launchers.browser_launcher.BrowserKioskLauncher Class Reference

Launch and orchestrate one browser window on a selected X display. More...

Inheritance diagram for apps.launchers.browser_launcher.BrowserKioskLauncher:
ui.system.app_launcher_if.AppLauncherIf

Public Member Functions

None set_url (self, str url)
 Change the URL used by the next browser launch.
 
None set_color_scheme (self, str|None value)
 Set a light/dark GTK hint for the next browser launch.
 
None set_preferred_color_scheme (self, str scheme)
 Tell Chromium which CSS/browser color scheme ORC currently uses.
 
bool is_running (self)
 Return whether the application is currently running.
 
None configure_kiosk_window (self, *tuple[int, int] position, tuple[int, int] size)
 Configure a fullscreen-style kiosk browser window.
 
bool send_key (self, str remote_display, str key)
 Send a key chord to this browser's current X11 window.
 
None launch (self, str remote_display, StatusCallback set_status=None)
 Launch the application for normal presentation.
 
None stop (self, str remote_display, StatusCallback set_status=None)
 Stop the application.
 
bool toggle (self, str remote_display, StatusCallback set_status=None)
 Toggle the application's running state.
 

Detailed Description

Launch and orchestrate one browser window on a selected X display.

Member Function Documentation

◆ is_running()

bool apps.launchers.browser_launcher.BrowserKioskLauncher.is_running (   self)

Return whether the application is currently running.

Returns
True when the application is running, otherwise False.

Reimplemented from ui.system.app_launcher_if.AppLauncherIf.

◆ launch()

None apps.launchers.browser_launcher.BrowserKioskLauncher.launch (   self,
str  remote_display,
StatusCallback   set_status = None 
)

Launch the application for normal presentation.

Parameters
remote_displayDisplay identifier used for the application presentation.
set_statusOptional callback used to report launcher status text.

Reimplemented from ui.system.app_launcher_if.AppLauncherIf.

◆ stop()

None apps.launchers.browser_launcher.BrowserKioskLauncher.stop (   self,
str  remote_display,
StatusCallback   set_status = None 
)

Stop the application.

Parameters
remote_displayDisplay identifier associated with the application.
set_statusOptional callback used to report launcher status text.

Reimplemented from ui.system.app_launcher_if.AppLauncherIf.

◆ toggle()

bool apps.launchers.browser_launcher.BrowserKioskLauncher.toggle (   self,
str  remote_display,
StatusCallback   set_status = None 
)

Toggle the application's running state.

Parameters
remote_displayDisplay identifier used for the application presentation.
set_statusOptional callback used to report launcher status text.
Returns
True when the application is running after the toggle, otherwise False.

Reimplemented from ui.system.app_launcher_if.AppLauncherIf.


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