wxPython 4.3.2__cp315-cp315-win_amd64.whl

wx/tools/helpviewer.py

@@ -0,0 +1,92 @@
+#----------------------------------------------------------------------
+# Name:        wx.tools.helpviewer
+# Purpose:     HTML Help viewer
+#
+# Author:      Robin Dunn
+#
+# Created:     11-Dec-2002
+# Copyright:   (c) 2002-2020 by Total Control Software
+# Licence:     wxWindows license
+# Tags:        phoenix-port, py3-port
+#----------------------------------------------------------------------
+
+"""
+helpviewer.py   --  Displays HTML Help in a wxHtmlHelpController window.
+
+Usage:
+    helpviewer [--cache=path] helpfile [helpfile(s)...]
+
+    Where helpfile is the path to either a .hhp file or a .zip file
+    which contains a .hhp file.  The .hhp files are the same as those
+    used by Microsoft's HTML Help Workshop for creating CHM files.
+"""
+
+
+import sys, os
+
+#---------------------------------------------------------------------------
+
+def makeOtherFrame(helpctrl):
+    import wx
+    parent = helpctrl.GetFrame()
+    otherFrame = wx.Frame(parent)
+
+
+def main(args=sys.argv):
+    if len(args) < 2:
+        print(__doc__)
+        return
+
+    args = args[1:]
+    cachedir = None
+    if args[0][:7] == '--cache':
+        cachedir = os.path.expanduser(args[0].split('=')[1])
+        args = args[1:]
+
+    if len(args) == 0:
+        print(__doc__)
+        return
+
+    import wx
+    import wx.html
+
+    app = wx.App()
+    #wx.Log.SetActiveTarget(wx.LogStderr())
+    wx.Log.SetLogLevel(wx.LOG_Error)
+
+    # Set up the default config so the htmlhelp frame can save its preferences
+    app.SetVendorName('wxWindows')
+    app.SetAppName('helpviewer')
+    cfg = wx.ConfigBase.Get()
+
+    # Add the Zip filesystem
+    wx.FileSystem.AddHandler(wx.ArchiveFSHandler())
+
+    # Create the viewer
+    helpctrl = wx.html.HtmlHelpController()
+    if cachedir:
+        helpctrl.SetTempDir(cachedir)
+
+    # and add the books
+    for helpfile in args:
+        print("Adding %s..." % helpfile)
+        helpctrl.AddBook(helpfile, 1)
+
+    # The frame used by the HtmlHelpController is set to not prevent
+    # app exit, so in the case of a standalone helpviewer like this
+    # when the Print dialog is closed the help frame will be the only
+    # one left and the app will close unexpectedly. [Strangely, this
+    # doesn't happen when the Options dialog is closed].
+    # To work around this we'll create another frame that is never shown,
+    # but which will be closed when the helpviewer frame is closed.
+    wx.CallAfter(makeOtherFrame, helpctrl)
+
+    # start it up!
+    helpctrl.DisplayContents()
+    app.MainLoop()
+
+
+if __name__ == '__main__':
+    main()
+
+

wx/tools/img2img.py

@@ -0,0 +1,85 @@
+#----------------------------------------------------------------------
+# Name:        wx.tools.img2img
+# Purpose:     Common routines for the image converter utilities.
+#
+# Author:      Robin Dunn
+#
+# Copyright:   (c) 2002-2020 by Total Control Software
+# Licence:     wxWindows license
+# Tags:        phoenix-port, py3-port
+#----------------------------------------------------------------------
+# 12/21/2003 - Jeff Grimmett (grimmtooth@softhome.net)
+#
+# o V2.5 compatibility update
+#
+
+import  getopt
+import  glob
+import  os
+import  sys
+
+import  wx
+
+def convert(file, maskClr, outputDir, outputName, outType, outExt):
+    img = wx.Bitmap(file, wx.BITMAP_TYPE_ANY)
+    if not img.IsOk():
+        return 0, file + " failed to load!"
+    else:
+        if maskClr:
+            om = img.GetMask()
+            mask = wx.Mask(img, maskClr)
+            img.SetMask(mask)
+            if om is not None:
+                om.Destroy()
+        if outputName:
+            newname = outputName
+        else:
+            newname = os.path.join(outputDir,
+                                   os.path.basename(os.path.splitext(file)[0]) + outExt)
+        if img.SaveFile(newname, outType):
+            return 1, file + " converted to " + newname
+        else:
+            img = img.ConvertToImage()
+            if img.SaveFile(newname, outType):
+                return 1, "ok"
+            else:
+                return 0, file + " failed to save!"
+
+
+
+
+def main(args, outType, outExt, doc):
+    if not args or ("-h" in args):
+        print(doc)
+        return
+
+    outputDir = ""
+    maskClr = None
+    outputName = None
+
+    try:
+        opts, fileArgs = getopt.getopt(args, "m:n:o:")
+    except getopt.GetoptError:
+        print(__doc__)
+        return
+
+    for opt, val in opts:
+        if opt == "-m":
+            maskClr = val
+        elif opt == "-n":
+            outputName = val
+        elif opt == "-o":
+            outputDir = val
+
+    if not fileArgs:
+        print(doc)
+        return
+
+    for arg in fileArgs:
+        for file in glob.glob(arg):
+            if not os.path.isfile(file):
+                continue
+            ok, msg = convert(file, maskClr, outputDir, outputName,
+                              outType, outExt)
+            print(msg)
+

wx/tools/img2png.py

@@ -0,0 +1,54 @@
+#----------------------------------------------------------------------
+# Name:        wx.tools.img2png
+# Purpose:     Convert an image to PNG format
+#
+# Author:      Robin Dunn
+#
+# Copyright:   (c) 2002-2020 by Total Control Software
+# Licence:     wxWindows license
+#----------------------------------------------------------------------
+# 12/21/2003 - Jeff Grimmett (grimmtooth@softhome.net)
+#
+# o V2.5 compatibility update
+#
+
+"""
+img2png.py  -- convert several image formats to PNG format.
+
+Usage:
+
+    img2png.py [options] image_files...
+
+Options:
+
+    -o <dir>       The directory to place the .png file(s), defaults to
+                   the current directory.
+
+    -m <#rrggbb>   If the original image has a mask or transparency defined
+                   it will be used by default.  You can use this option to
+                   override the default or provide a new mask by specifying
+                   a colour in the image to mark as transparent.
+
+    -n <name>      A filename to write the .png data to.  Defaults to the
+                   basename of the image file + '.png'  This option overrides
+                   the -o option.
+"""
+
+
+import  sys
+import  wx
+from wx.tools import img2img
+
+app = None
+def main():
+    # some bitmap related things need to have a wxApp initialized...
+    if wx.GetApp() is None:
+        global app
+        app = wx.App()
+    img2img.main(sys.argv[1:], wx.BITMAP_TYPE_PNG, ".png", __doc__)
+
+if __name__ == '__main__':
+    main()
+
+
+

wx/tools/img2py.py

@@ -0,0 +1,306 @@
+#----------------------------------------------------------------------
+# Name:        wx.tools.img2py
+# Purpose:     Convert an image to Python code.
+#
+# Author:      Robin Dunn
+#
+# Copyright:   (c) 2002-2020 by Total Control Software
+# Licence:     wxWindows license
+# Tags:        phoenix-port, py3-port
+#----------------------------------------------------------------------
+#
+# Changes:
+#    - Cliff Wells <LogiplexSoftware@earthlink.net>
+#      20021206: Added catalog (-c) option.
+#
+# 12/21/2003 - Jeff Grimmett (grimmtooth@softhome.net)
+#        V2.5 compatibility update
+#
+# 2/25/2007 - Gianluca Costa (archimede86@katamail.com)
+#        -Refactorization of the script-creation code in a specific "img2py()" function
+#        -Added regex parsing instead of module importing
+#        -Added some "try/finally" statements
+#        -Added default values as named constants
+#        -Made some parts of code a bit easier to read
+#        -Updated the module docstring
+#        -Corrected a bug with EmptyIcon
+#
+# 11/26/2007 - Anthony Tuininga (anthony.tuininga@gmail.com)
+#        -Use base64 encoding instead of simple repr
+#        -Remove compression which doesn't buy anything in most cases and
+#         costs more in many cases
+#        -Use wx.lib.embeddedimage.PyEmbeddedImage class which has methods
+#         rather than using standalone methods
+#
+
+
+"""
+img2py.py  --  Convert an image to PNG format and embed it in a Python
+               module with appropriate code so it can be loaded into
+               a program at runtime.  The benefit is that since it is
+               Python source code it can be delivered as a .pyc or
+               'compiled' into the program using freeze, py2exe, etc.
+
+Usage:
+
+    img2py.py [options] image_file python_file
+
+Options:
+
+    -m <#rrggbb>   If the original image has a mask or transparency defined
+                   it will be used by default.  You can use this option to
+                   override the default or provide a new mask by specifying
+                   a colour in the image to mark as transparent.
+
+    -n <name>      Normally generic names (getBitmap, etc.) are used for the
+                   image access functions.  If you use this option you can
+                   specify a name that should be used to customize the access
+                   functions, (getNameBitmap, etc.)
+
+    -c             Maintain a catalog of names that can be used to reference
+                   images.  Catalog can be accessed via catalog and
+                   index attributes of the module.
+                   If the -n <name> option is specified then <name>
+                   is used for the catalog key and index value, otherwise
+                   the filename without any path or extension is used
+                   as the key.
+
+    -a             This flag specifies that the python_file should be appended
+                   to instead of overwritten.  This in combination with -n will
+                   allow you to put multiple images in one Python source file.
+
+    -i             Also output a function to return the image as a wxIcon.
+
+    -f             Generate code compatible with the old function interface.
+                   (This option is ON by default in 2.8, use -f to turn off.)
+
+You can also import this module from your Python scripts, and use its img2py()
+function. See its docstring for more info.
+"""
+
+import base64
+import getopt
+import os
+import re
+import sys
+import tempfile
+
+import wx
+from wx.tools import img2img
+
+try:
+    b64encode = base64.b64encode
+except AttributeError:
+    b64encode = base64.encodestring
+
+app = None
+DEFAULT_APPEND = False
+DEFAULT_COMPRESSED = True
+DEFAULT_MASKCLR = None
+DEFAULT_IMGNAME = ""
+DEFAULT_ICON = False
+DEFAULT_CATALOG = False
+DEFAULT_COMPATIBLE = False
+
+# THIS IS USED TO IDENTIFY, IN THE GENERATED SCRIPT, LINES IN THE FORM
+# "index.append('Image name')"
+indexPattern = re.compile(r"\s*index.append\('(.+)'\)\s*")
+
+
+def convert(fileName, maskClr, outputDir, outputName, outType, outExt):
+    # if the file is already the right type then just use it directly
+    if maskClr == DEFAULT_MASKCLR and fileName.upper().endswith(outExt.upper()):
+        if outputName:
+            newname = outputName
+        else:
+            newname = os.path.join(outputDir,
+                                   os.path.basename(os.path.splitext(fileName)[0]) + outExt)
+        with open(newname, "wb") as f_out:
+            with open(fileName, "rb") as f_in:
+                f_out.write(f_in.read())
+        return True, "ok"
+    return img2img.convert(fileName, maskClr, outputDir, outputName, outType, outExt)
+
+
+def _replace_non_alphanumeric_with_underscore(imgName):
+    letters = [letter if letter.isalnum() else '_' for letter in imgName]
+
+    if not letters[0].isalpha() and letters[0] != '_':
+        letters.insert(0, "_")
+    varName = "".join(letters)
+    return varName
+
+
+def _write_image(out, imgName, data, append, icon, catalog, functionCompatible, old_index):
+    out.write("#" + "-" * 70 + "\n")
+    if not append:
+        out.write("# This file was generated by %s\n#\n" % sys.argv[0])
+        out.write("from wx.lib.embeddedimage import PyEmbeddedImage\n\n")
+        if catalog:
+            out.write("catalog = {}\n")
+            out.write("index = []\n\n")
+    varName = _replace_non_alphanumeric_with_underscore(imgName)
+    out.write("%s = PyEmbeddedImage(\n%s\n" % (varName, data))
+    if catalog:
+        if imgName in old_index:
+            print("Warning: %s already in catalog." % imgName)
+            print("         Only the last entry will be accessible.\n")
+        old_index.append(imgName)
+        out.write("index.append('%s')\n" % imgName)
+        out.write("catalog['%s'] = %s\n" % (imgName, varName))
+    if functionCompatible:
+        out.write("get%sData = %s.GetData\n" % (varName, varName))
+        out.write("get%sImage = %s.GetImage\n" % (varName, varName))
+        out.write("get%sBitmap = %s.GetBitmap\n" % (varName, varName))
+        if icon:
+            out.write("get%sIcon = %s.GetIcon\n" % (varName, varName))
+    out.write("\n")
+
+
+def img2py(image_file, python_file,
+           append=DEFAULT_APPEND,
+           compressed=DEFAULT_COMPRESSED,
+           maskClr=DEFAULT_MASKCLR,
+           imgName=DEFAULT_IMGNAME,
+           icon=DEFAULT_ICON,
+           catalog=DEFAULT_CATALOG,
+           functionCompatible=DEFAULT_COMPATIBLE,
+           functionCompatibile=-1,   # typo version for backward compatibility
+           ):
+    """
+    Converts an image file to a data structure written in a Python file
+    --image_file: string; the path of the source image file
+    --python_file: string; the path of the destination python file
+    --other arguments: they are equivalent to the command-line arguments
+    """
+
+    # was the typo version used?
+    if functionCompatibile != -1:
+        functionCompatible = functionCompatibile
+
+    global app
+    if not wx.GetApp():
+        app = wx.App(0)
+
+    # convert the image file to a temporary file
+    with tempfile.NamedTemporaryFile(delete=False) as fid:
+        tfname = fid.name
+
+    try:
+        ok, msg = convert(image_file, maskClr, None, tfname, wx.BITMAP_TYPE_PNG, ".png")
+        if not ok:
+            print(msg)
+            return
+
+        lines = []
+        with open(tfname, "rb") as fid:
+            data = b64encode(fid.read())
+        while data:
+            part = data[:72]
+            data = data[72:]
+            output = '    %s' % part
+            if not data:
+                output += ")"
+            lines.append(output)
+        data = "\n".join(lines)
+    finally:
+        if os.path.exists(tfname):
+            os.remove(tfname)
+
+    old_index = []
+    if catalog and append and python_file != '-':
+        # check to see if catalog exists already (file may have been created
+        # with an earlier version of img2py or without -c option)
+        pyPath, pyFile = os.path.split(python_file)
+
+        append_catalog = True
+
+        with open(python_file, "r") as sourcePy:
+            for line in sourcePy:
+                if line == "catalog = {}\n":
+                    append_catalog = False
+                else:
+                    lineMatcher = indexPattern.match(line)
+                    if lineMatcher:
+                        old_index.append(lineMatcher.groups()[0])
+
+        if append_catalog:
+            with open(python_file, "a") as out:
+                out.write("\n# ***************** Catalog starts here *******************")
+                out.write("\n\ncatalog = {}\n")
+                out.write("index = []\n\n")
+
+    if not imgName:
+        imgPath, imgFile = os.path.split(image_file)
+        imgName = os.path.splitext(imgFile)[0]
+        print("\nWarning: -n not specified. Using filename (%s) for name of image and/or catalog entry." % imgName)
+
+    if python_file == '-':
+        out = sys.stdout
+        _write_image(out, imgName, data, append, icon, catalog, functionCompatible, old_index)
+    else:
+        mode = "a" if append else "w"
+        with open(python_file, mode) as out:
+            _write_image(out, imgName, data, append, icon, catalog, functionCompatible, old_index)
+
+    if imgName:
+        n_msg = ' using "%s"' % imgName
+    else:
+        n_msg = ""
+
+    if maskClr:
+        m_msg = " with mask %s" % maskClr
+    else:
+        m_msg = ""
+
+    print("Embedded %s%s into %s%s" % (image_file, n_msg, python_file, m_msg))
+
+def main(args=None):
+    if not args:
+        args = sys.argv[1:]
+
+    if not args or ("-h" in args):
+        print(__doc__)
+        return
+
+    append = DEFAULT_APPEND
+    compressed = DEFAULT_COMPRESSED
+    maskClr = DEFAULT_MASKCLR
+    imgName = DEFAULT_IMGNAME
+    icon = DEFAULT_ICON
+    catalog = DEFAULT_CATALOG
+    compatible = DEFAULT_COMPATIBLE
+
+    try:
+        opts, fileArgs = getopt.getopt(args, "auicfFn:m:")
+    except getopt.GetoptError:
+        print(__doc__)
+        return
+
+    for opt, val in opts:
+        if opt == "-a":
+            append = True
+        elif opt == "-n":
+            imgName = val
+        elif opt == "-m":
+            maskClr = val
+        elif opt == "-i":
+            icon = True
+        elif opt == "-c":
+            catalog = True
+        elif opt == "-f":
+            compatible = True
+        elif opt == "-F":
+            compatible = False
+
+    if len(fileArgs) != 2:
+        print(__doc__)
+        return
+
+    image_file, python_file = fileArgs
+    img2py(image_file, python_file,
+           append, compressed, maskClr, imgName, icon, catalog, compatible)
+
+
+if __name__ == "__main__":
+    main(sys.argv[1:])

wx/tools/img2xpm.py

@@ -0,0 +1,54 @@
+#----------------------------------------------------------------------
+# Name:        wx.tools.img2xpm
+# Purpose:     Convert an image to XPM format
+#
+# Author:      Robin Dunn
+#
+# Copyright:   (c) 2002-2020 by Total Control Software
+# Licence:     wxWindows license
+#----------------------------------------------------------------------
+# 12/21/2003 - Jeff Grimmett (grimmtooth@softhome.net)
+#
+# o V2.5 compatibility update
+#
+
+"""
+img2xpm.py  -- convert several image formats to XPM.
+
+Usage:
+
+    img2xpm.py [options] image_files...
+
+Options:
+
+    -o <dir>       The directory to place the .xpm file(s), defaults to
+                   the current directory.
+
+    -m <#rrggbb>   If the original image has a mask or transparency defined
+                   it will be used by default.  You can use this option to
+                   override the default or provide a new mask by specifying
+                   a colour in the image to mark as transparent.
+
+    -n <name>      A filename to write the .xpm data to.  Defaults to the
+                   basename of the image file + '.xpm'  This option overrides
+                   the -o option.
+"""
+
+import  sys
+import  wx
+from wx.tools import img2img
+
+app = None
+def main():
+    # some bitmap related things need to have a wxApp initialized...
+    if wx.GetApp() is None:
+        global app
+        app = wx.App()
+    img2img.main(sys.argv[1:], wx.BITMAP_TYPE_XPM, ".xpm", __doc__)
+
+
+if __name__ == '__main__':
+    main()
+
+
+