Create SvgImage and tests, update license

Author: RedFantom

LICENSE.md

@@ -0,0 +1,46 @@
+# Tcl License
+```
+Copyright (C) 2002-2004 Maxim Shemanarev http://antigrain.com
+Copyright (c) 2013-14 Mikko Mononen [email protected]
+Copyright (c) 2018 Christian Gollwitzer [email protected]
+Copyright (c) 2018 Christian Werner https://www.androwish.org/
+Copyright (c) 2018 Rene Zaumseil [email protected]
+Copyright (c) 2020 Juliette Monsel 
+Copyright (c) 2021 RedFantom <[email protected]>
+
+The authors hereby grant permission to use, copy, modify, distribute,
+and license this software and its documentation for any purpose, provided
+that existing copyright notices are retained in all copies and that this
+notice is included verbatim in any distributions. No written agreement,
+license, or royalty fee is required for any of the authorized uses.
+Modifications to this software may be copyrighted by their authors
+and need not follow the licensing terms described here, provided that
+the new terms are clearly indicated on the first page of each file where
+they apply.
+
+IN NO EVENT SHALL THE AUTHORS OR DISTRIBUTORS BE LIABLE TO ANY PARTY
+FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
+ARISING OUT OF THE USE OF THIS SOFTWARE, ITS DOCUMENTATION, OR ANY
+DERIVATIVES THEREOF, EVEN IF THE AUTHORS HAVE BEEN ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGE.
+
+THE AUTHORS AND DISTRIBUTORS SPECIFICALLY DISCLAIM ANY WARRANTIES,
+INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE, AND NON-INFRINGEMENT.  THIS SOFTWARE
+IS PROVIDED ON AN "AS IS" BASIS, AND THE AUTHORS AND DISTRIBUTORS HAVE
+NO OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR
+MODIFICATIONS.
+
+GOVERNMENT USE: If you are acquiring this software on behalf of the
+U.S. government, the Government shall have only "Restricted Rights"
+in the software and related documentation as defined in the Federal
+Acquisition Regulations (FARs) in Clause 52.227.19 (c) (2).  If you
+are acquiring the software on behalf of the Department of Defense, the
+software shall be classified as "Commercial Computer Software" and the
+Government shall have only "Restricted Rights" as defined in Clause
+252.227-7014 (b) (3) of DFARs.  Notwithstanding the foregoing, the
+authors grant the U.S. Government and others acting in its behalf
+permission to use and distribute the software in accordance with the
+terms specified in this license.
+```
+

README.md

@@ -1,12 +1,8 @@
-tksvg
-======
+# tksvg for Python's Tkinter
+[tksvg](https://github.com/oehhar/tksvg) is a package for Tcl/Tk that
+adds support for SVG image files. Tkinter makes use of Tcl/Tk under the
+hood, and thus can benefit from this addition. Note that SVG support 
+has been included in Tk 8.7 and thus this package can be made obsolete 
+in the future when Python gets distributed with Tk 8.7.
 
-This package adds support to read the SVG image format from Tk.
-The actual code to parse and raster the SVG comes from nanosvg.
 
-Example usage:
-
-	package require tksvg
-	set img [image create photo -file orb.svg]
-	pack [label .l -image $img]
- 

generic/tkImgSVG.c

@@ -8,7 +8,7 @@
  * Copyright (c) 2018 Christian Werner https://www.androwish.org/
  * Copyright (c) 2018 Rene Zaumseil [email protected]
  *
- * See the file "license.terms" for information on usage and redistribution of
+ * See the file "LICENSE.md" for information on usage and redistribution of
  * this file, and for a DISCLAIMER OF ALL WARRANTIES.
  *
  * This handler is build using the original nanosvg library files from

tests/test_tksvg.py

@@ -16,3 +16,16 @@ def test_tksvg_load(self):
         tksvg.load(self.window)
         # Create test PhotoImage
         tk.PhotoImage(file="tests/orb.svg")
+
+    def test_svg_image(self):
+        tksvg.load(self.window)
+        image = tksvg.SvgImage(file="tests/orb.svg", scale=0.5)
+        self.assertEqual(image.cget("scale"), 0.5)
+        self.assertEqual(image.cget("scale"), image["scale"])
+
+        label = tk.Label(self.window, image=image)
+        label.pack()
+        self.window.update()
+
+    def tearDown(self):
+        self.window.destroy()

tksvg/__init__.py

@@ -24,3 +24,57 @@ def load(window: tk.Tk):
     with chdir(local):
         window.tk.eval("source pkgIndex.tcl")
         window.tk.eval("package require tksvg")
+        window._tksvg_loaded = True
+
+
+class SvgImage(tk.PhotoImage):
+    """
+    Sub-class of tk.PhotoImage with support for SVG image options
+
+    tksvg provides some options to control the rastering of SVG images.
+    These are accessible when the images is created with this class.
+
+    This implementation is inspired by GitHub @j4321:
+    <https://stackoverflow.com/a/64829808>
+    """
+    _tksvg_loaded = False
+    _svg_options = [("scale", float), ("scaletowidth", int), ("scaletoheight", int)]
+
+    def __init__(self, name=None, cnf={}, master=None, **kwargs):
+        self._svg_options_current = dict()
+        # Load TkSVG package if not yet loaded
+        master = master or tk._default_root
+        if master is None:
+            raise tk.TclError("No Tk instance available to get interpreter from")
+        if not getattr(master, "_tksvg_loaded", False) and not self._tksvg_loaded:
+            load(master)
+            self._tksvg_loaded = True
+        # Pop SvgImage keyword arguments
+        svg_options = {key: t(kwargs.pop(key)) for (key, t) in self._svg_options if key in kwargs}
+        # Initialize as a PhotoImage
+        tk.PhotoImage.__init__(self, name, cnf, master, **kwargs)
+        self.configure(**svg_options)
+
+    def configure(self, **kwargs):
+        """Configure the image with SVG options and pass to PhotoImage.configure"""
+        svg_options = {key: t(kwargs.pop(key)) for (key, t) in self._svg_options if key in kwargs}
+        if kwargs:  # len(kwargs) > 0
+            tk.PhotoImage.configure(self, **kwargs)
+        options = tuple()
+        for key, value in svg_options.items():
+            if value is not None:
+                options += ("-"+key, str(value))
+        self.tk.eval("%s configure -format {svg %s}" % (self.name, " ".join(options)))
+        self._svg_options_current.update(svg_options)
+
+    def cget(self, option):
+        """Return the option set for an SVG property or pass to PhotoImage.cget"""
+        if option in (k for k, _ in self._svg_options):
+            return self._svg_options_current.get(option, None)
+        return tk.PhotoImage.cget(self, option)
+
+    def __getitem__(self, key):
+        return self.cget(key)
+
+    def __setitem__(self, key, value):
+        return self.configure(**{key: value})