pyra.tray_icon

Responsible for system tray icon and related functions.

pyra.tray_icon.donate_github()[source]

Open GitHub Sponsors.

Open GitHub Sponsors in the default web browser.

Returns:
bool

True if opening page was successful, otherwise False.

Examples

>>> donate_github()
True
pyra.tray_icon.donate_mee6()[source]

Open MEE6.

Open MEE6 in the default web browser.

Returns:
bool

True if opening page was successful, otherwise False.

Examples

>>> donate_mee6()
True
pyra.tray_icon.donate_patreon()[source]

Open Patreon.

Open Patreon in the default web browser.

Returns:
bool

True if opening page was successful, otherwise False.

Examples

>>> donate_patreon()
True
pyra.tray_icon.donate_paypal()[source]

Open PayPal.

Open PayPal in the default web browser.

Returns:
bool

True if opening page was successful, otherwise False.

Examples

>>> donate_paypal()
True
pyra.tray_icon.github_releases()[source]

Open GitHub Releases.

Open GitHub Releases in the default web browser.

Returns:
bool

True if opening page was successful, otherwise False.

Examples

>>> github_releases()
True
pyra.tray_icon.open_webapp() bool[source]

Open the webapp.

Open RetroArcher in the default web browser.

Returns:
bool

True if opening page was successful, otherwise False.

Examples

>>> open_webapp()
True
pyra.tray_icon.tray_browser()[source]

Toggle the config option ‘LAUNCH_BROWSER’.

This functions switches the LAUNCH_BROWSER config option from True to False, or False to True.

Examples

>>> tray_browser()
pyra.tray_icon.tray_disable()[source]

Turn off the config option ‘SYSTEM_TRAY’.

This function ends and disables the SYSTEM_TRAY config option.

Examples

>>> tray_disable()
pyra.tray_icon.tray_end() bool[source]

End the system tray icon.

Hide and then stop the system tray icon.

Returns:
bool

True if successful, otherwise False.

Examples

>>> tray_end()
pyra.tray_icon.tray_initialize() None | bool[source]

Initialize the system tray icon.

Some features of the tray icon may not be available, depending on the operating system. An attempt is made to setup the tray icon with all the available features supported by the OS.

Returns:
Union[Icon, bool]
Icon

Instance of pystray.Icon if icon is supported.

bool

False if icon is not supported.

Examples

>>> tray_initialize()
pyra.tray_icon.tray_quit()[source]

Shutdown RetroArcher.

Set the ‘pyra.SIGNAL’ variable to ‘shutdown’.

Examples

>>> tray_quit()
pyra.tray_icon.tray_restart()[source]

Restart RetroArcher.

Set the ‘pyra.SIGNAL’ variable to ‘restart’.

Examples

>>> tray_restart()
pyra.tray_icon.tray_run()[source]

Start the tray icon.

Run the system tray icon in detached mode.

Examples

>>> tray_run()
pyra.tray_icon.tray_run_threaded() bool[source]

Run the system tray in a thread.

This function exectues various other functions to simplify starting the tray icon.

Returns:
bool

True if successful, otherwise False.

See also

tray_initialize

This function first, initializes the tray icon using tray_initialize().

tray_run

Then, tray_run is executed in a thread.

pyra.threads.run_in_thread

Run a method within a thread.

Examples

>>> tray_run_threaded()
True
pyra.tray_icon.tray_toggle() bool[source]

Toggle the system tray icon.

Hide/unhide the system tray icon.

Returns:
bool

True if successful, otherwise False.

Examples

>>> tray_toggle()