splash_screen

_splash_screen ¶

Custom splash screen widget.

Classes:

Name	Description
`FXSplashScreen`	Customized QSplashScreen class.

Classes¶

FXSplashScreen ¶

FXSplashScreen(
    image_path: Optional[str] = None,
    icon: Optional[str] = None,
    title: Optional[str] = None,
    information: Optional[str] = None,
    show_progress_bar: bool = False,
    project: Optional[str] = None,
    version: Optional[str] = None,
    company: Optional[str] = None,
    fade_in: bool = False,
    set_stylesheet: bool = True,
    overlay_opacity: float = 1.0,
    corner_radius: int = 0,
    border_width: int = 0,
    border_color: str = "#4a4949",
)

Bases: FXThemeAware, QSplashScreen


              flowchart TD
              fxgui.fxwidgets._splash_screen.FXSplashScreen[FXSplashScreen]
              fxgui.fxstyle.FXThemeAware[FXThemeAware]

                              fxgui.fxstyle.FXThemeAware --> fxgui.fxwidgets._splash_screen.FXSplashScreen
                


              click fxgui.fxwidgets._splash_screen.FXSplashScreen href "" "fxgui.fxwidgets._splash_screen.FXSplashScreen"
              click fxgui.fxstyle.FXThemeAware href "" "fxgui.fxstyle.FXThemeAware"

Customized QSplashScreen class.

Methods:

Name	Description
`paintEvent`	Override to draw the pixmap with rounded corners.
`set_border`	Set the border around the splash screen.
`set_company_label`	Set the company name for the splash screen.
`set_corner_radius`	Set the corner radius for rounded corners.
`set_icon`	Set the icon for the splash screen.
`set_information_text`	Set the information text for the splash screen.
`set_overlay_opacity`	Set the opacity of the grey overlay background.
`set_pixmap`	Set the pixmap for the splash screen.
`set_progress`	Set the progress value for the splash screen.
`set_project_label`	Set the project name for the splash screen.
`set_title`	Set the title for the splash screen.
`set_version_label`	Set the version information for the splash screen.
`toggle_fade_in`	Toggle the fade-in effect for the splash screen.
`toggle_progress_bar_visibility`	Toggle the visibility of the progress bar.

Functions¶

paintEvent ¶

paintEvent(event) -> None

Override to draw the pixmap with rounded corners.

set_border ¶

set_border(width: int, color: str = '#555555') -> None

Set the border around the splash screen.

Parameters:

Name	Type	Description	Default
`width` ¶	`int`	The border width in pixels. Use 0 for no border.	required
`color` ¶	`str`	The border color as a hex string.	`'#555555'`

set_company_label ¶

set_company_label(company: str) -> None

Set the company name for the splash screen.

Parameters:

Name	Type	Description	Default
`company` ¶	`str`	The company name.	required

set_corner_radius ¶

set_corner_radius(radius: int) -> None

Set the corner radius for rounded corners.

Parameters:

Name	Type	Description	Default
`radius` ¶	`int`	The corner radius in pixels. Use 0 for sharp corners.	required

set_icon ¶

set_icon(icon_path: str) -> None

Set the icon for the splash screen.

Parameters:

Name	Type	Description	Default
`icon_path` ¶	`str`	The path to the icon file.	required

set_information_text ¶

set_information_text(information: str) -> None

Set the information text for the splash screen.

Parameters:

Name	Type	Description	Default
`information` ¶	`str`	The information text.	required

set_overlay_opacity ¶

set_overlay_opacity(opacity: float) -> None

Set the opacity of the grey overlay background.

Parameters:

Name	Type	Description	Default
`opacity` ¶	`float`	The opacity value between 0.0 (transparent) and 1.0 (opaque).	required

set_pixmap ¶

set_pixmap(image_path: str) -> None

Set the pixmap for the splash screen.

Parameters:

Name	Type	Description	Default
`image_path` ¶	`str`	The path to the image file.	required

set_progress ¶

set_progress(value: int, max_range: int = 100)

Set the progress value for the splash screen.

Parameters:

Name	Type	Description	Default
`value` ¶	`int`	The progress value.	required
`max_range` ¶	`int`	The maximum progress value. Defaults to `100`.	`100`

set_project_label ¶

set_project_label(project: str) -> None

Set the project name for the splash screen.

Parameters:

Name	Type	Description	Default
`project` ¶	`str`	The project name.	required

set_title ¶

set_title(title: str) -> None

Set the title for the splash screen.

Parameters:

Name	Type	Description	Default
`title` ¶	`str`	The title string.	required

set_version_label ¶

set_version_label(version: str) -> None

Set the version information for the splash screen.

Parameters:

Name	Type	Description	Default
`version` ¶	`str`	The version string.	required

toggle_fade_in ¶

toggle_fade_in(fade_in: bool) -> None

Toggle the fade-in effect for the splash screen.

Parameters:

Name	Type	Description	Default
`fade_in` ¶	`bool`	Whether to fade in the splash screen.	required

toggle_progress_bar_visibility ¶

toggle_progress_bar_visibility(show: bool) -> None

Toggle the visibility of the progress bar.

Parameters:

Name	Type	Description	Default
`show` ¶	`bool`	Whether to show the progress bar.	required