about.py

"""
@package libtextworker.interface.wx.about
@brief About dialog for wxPython projects
"""
 
#   A cross-platform library for Python apps.
#   Copyright (C) 2023-2024 Le Bao Nguyen and contributors.
#   This is a part of the libtextworker project.
#   Licensed under the GNU General Public License version 3.0 or later.
 
import wx
import wx.adv
 
from typing import Any
from ...general import CraftItems
from ... import LICENSES
 
 
class AboutDialog:
    """
    About dialog built with wxPython.
    All self-set infomations are stored in the ```infos``` attribute.
    Just run ShowBox() to see your work.
    You can set the parent of the dialog if needed, use the Parent variable.
    This class is ~~not~~ sub-class-able. (since 0.1.4)
    """
 
    infos = wx.adv.AboutDialogInfo()
    Parent: Any | None = None
 
    SetArtists = infos.SetArtists
    SetCopyright = infos.SetCopyright
    SetDescription = infos.SetDescription
    SetDevelopers = infos.SetDevelopers
    SetDocWriters = infos.SetDocWriters
    SetIcon = infos.SetIcon
    SetName = infos.SetName
    SetTranslators = infos.SetTranslators
    SetVersion = infos.SetVersion
    SetWebSite = infos.SetWebSite
 
    def SetLicense(self, license: str, include_copyright: bool = False):
        """
        Set the long, multiline string containing the text of the program license.
        @see available_licenses
        @see SetCopyright
        """
        data = ""  # Our result
 
        if include_copyright == True and self.infosinfos.GetCopyright() != "":
            data += self.infosinfos.GetCopyright() + "\n"
 
        data += license
        self.infosinfos.SetLicence(data)
 
    def ShowBox(self, event=None):
        """
        Shows a About dialog with infomations collected.
        @param event | None: wxPython event
        @return wx.adv.AboutBox: About window
        """
        return wx.adv.AboutBox(self.infosinfos, self.Parent)