qgis_deployment_toolbelt.jobs.job_splash_screen module

Manage splash screens for QGIS Profiles.

Author: Julien Moura (https://github.com/guts)

class qgis_deployment_toolbelt.jobs.job_splash_screen.JobSplashScreenManager(options: dict)

Bases: GenericJob

Job to set-up splash screen for QGIS profile.

DEFAULT_SPLASH_FILEPATH: str = 'images/splash.png'

ID: str = 'splash-screen-manager'

OPTIONS_SCHEMA: dict = {'action': {'condition': 'in', 'default': 'create_or_restore', 'possible_values': ('create', 'create_or_restore', 'remove'), 'required': False, 'type': <class 'str'>}, 'strict': {'condition': None, 'default': False, 'possible_values': None, 'required': False, 'type': <class 'bool'>}}

SPLASH_FILENAME: str = 'splash.png'

__init__(options: dict) → None

Instantiate the class.

Parameters:

options (dict) – dictionary of options.

_abc_impl = <_abc._abc_data object>

run() → None

Execute job logic.

static set_customization_splash_screen(qini_helper: QgisIniHelper, splash_screen_filepath: Path | None = None, switch: bool = True) → bool

Add/remove the splash screen in the customization file read by QGIS.

Parameters:

• qini_helper (QgisIniHelper) – helper of the profile settings file

• splash_screen_filepath (Path | None, optional) – path to the splash screen image. Required if switch is True. Defaults to None.

• switch (bool, optional) – True to add, False to remove. Defaults to True.

Returns:

True if the customization files are in the expected state.

Return type:

bool