Welcome, guest | Sign In | My Account | Store | Cart
# Version: 0.18
# Author: Miguel Martinez Lopez
# Uncomment the next line to see my email
# print("Author's email: ", "61706c69636163696f6e616d656469646140676d61696c2e636f6d".decode("hex"))

try:
    from Tkinter import Canvas, Frame
    from ttk import Scrollbar
    
    from Tkconstants import *
except ImportError:
    from tkinter import Canvas, Frame
    from tkinter.ttk import Scrollbar
    
    from tkinter.constants import *

import platform

OS = platform.system()

def make_mouse_wheel_handler(widget, orient, factor = 1, what="units"):
    view_command = getattr(widget, orient+'view')
    
    if OS == 'Linux':
        def onMouseWheel(event):
            if event.num == 4:
                view_command("scroll",(-1)*factor, what)
            elif event.num == 5:
                view_command("scroll",factor, what) 
            
    elif OS == 'Windows':
        def onMouseWheel(event):        
            view_command("scroll",(-1)*int((event.delta/120)*factor), what) 
    
    elif OS == 'Darwin':
        def onMouseWheel(event):        
            view_command("scroll",event.delta, what)
    
    return onMouseWheel

class Mousewheel_Support(object):    

    # implemetnation of singleton pattern
    _instance = None
    def __new__(cls, *args, **kwargs):
        if not cls._instance:
            cls._instance = object.__new__(cls)
        return cls._instance

    def __init__(self, root, horizontal_factor = 2, vertical_factor=2):
        
        self._active_area = None
        
        if isinstance(horizontal_factor, int):
            self.horizontal_factor = horizontal_factor
        else:
            raise Exception("Vertical factor must be an integer.")

        if isinstance(vertical_factor, int):
            self.vertical_factor = vertical_factor
        else:
            raise Exception("Horizontal factor must be an integer.")

        if OS == "Linux" :
            root.bind_all('<4>', self._on_mouse_wheel,  add='+')
            root.bind_all('<5>', self._on_mouse_wheel,  add='+')
        else:
            # Windows and MacOS
            root.bind_all("<MouseWheel>", self._on_mouse_wheel,  add='+')

    def _on_mouse_wheel(self,event):
        if self._active_area:
            self._active_area.onMouseWheel(event)

    def _on_mouse_enter_scrolling_area(self, widget):
        self._active_area = widget

    def _on_mouse_leave_scrolling_area(self):
        self._active_area = None

    def add_support_to(self, widget=None, xscrollbar=None, yscrollbar=None, what="units", horizontal_factor=None, vertical_factor=None):
        if xscrollbar is not None and not hasattr(xscrollbar, 'onMouseWheel'):
            horizontal_factor = horizontal_factor or self.horizontal_factor

            xscrollbar.onMouseWheel = make_mouse_wheel_handler(widget,'x', self.horizontal_factor, what)
            xscrollbar.bind('<Enter>', lambda event, scrollbar=xscrollbar: self._on_mouse_enter_scrolling_area(scrollbar) )
            xscrollbar.bind('<Leave>', lambda event: self._on_mouse_leave_scrolling_area())

        if yscrollbar is not None and not hasattr(yscrollbar, 'onMouseWheel'):
            vertical_factor = vertical_factor or self.vertical_factor

            yscrollbar.onMouseWheel = make_mouse_wheel_handler(widget,'y', self.vertical_factor, what)
            yscrollbar.bind('<Enter>', lambda event, scrollbar=yscrollbar: self._on_mouse_enter_scrolling_area(scrollbar) )
            yscrollbar.bind('<Leave>', lambda event: self._on_mouse_leave_scrolling_area())

        main_scrollbar = yscrollbar if yscrollbar is not None else xscrollbar
        
        if widget is not None and main_scrollbar is not None:
            widget.bind('<Enter>',lambda event: self._on_mouse_enter_scrolling_area(widget))
            widget.bind('<Leave>', lambda event: self._on_mouse_leave_scrolling_area())

            widget.onMouseWheel = main_scrollbar.onMouseWheel

class Scrolling_Area(Frame, object):

    def __init__(self, master, width=None, height=None, mousewheel_speed = 2, scroll_horizontally=True, xscrollbar=None, scroll_vertically=True, yscrollbar=None, outer_background=None, inner_frame=Frame, window_minwidth=None, window_minheight = None, **kw):
        Frame.__init__(self, master, class_=self.__class__)

        if outer_background:
            self.configure(background=outer_background)

        self._width = width
        self._height = height

        self.grid_columnconfigure(0, weight=1)
        self.grid_rowconfigure(0, weight=1)

        self.canvas = Canvas(self, background=outer_background, highlightthickness=0, width=width, height=height)
        self.canvas.grid(row=0, column=0, sticky=N+E+W+S)

        self._window_minwidth = window_minwidth
        self._window_minheight = window_minheight

        if scroll_vertically:
            if yscrollbar is not None:
                self.yscrollbar = yscrollbar
            else:
                self.yscrollbar = Scrollbar(self, orient=VERTICAL)
                self.yscrollbar.grid(row=0, column=1,sticky=N+S)
        
            self.canvas.configure(yscrollcommand=self.yscrollbar.set)
            self.yscrollbar['command']=self.canvas.yview
        else:
            self.yscrollbar = None

        if scroll_horizontally:
            if xscrollbar is not None:
                self.xscrollbar = xscrollbar
            else:
                self.xscrollbar = Scrollbar(self, orient=HORIZONTAL)
                self.xscrollbar.grid(row=1, column=0, sticky=E+W)
            
            self.canvas.configure(xscrollcommand=self.xscrollbar.set)
            self.xscrollbar['command']=self.canvas.xview
        else:
            self.xscrollbar = None

        self.rowconfigure(0, weight=1)
        self.columnconfigure(0, weight=1)

        self.innerFrame= inner_frame(self.canvas, **kw)
        self.innerFrame.pack()
        
        self.canvas.create_window(0, 0, window=self.innerFrame, anchor='nw', tags="inner_frame")

        self.canvas.bind('<Configure>', self._on_configure)

        Mousewheel_Support(self).add_support_to(self.canvas, xscrollbar=self.xscrollbar, yscrollbar=self.yscrollbar)

    @property
    def width(self):
        return self._width
        
    @property
    def window_minwidth(self):
        return self._window_minwidth
        
    @window_minwidth.setter
    def window_minwidth(self, window_minwidth):
        self._window_minwidth = window_minwidth

    @property
    def window_minheight(self):
        return self._window_minheight
        
    @window_minheight.setter
    def window_minheight(self, window_minheight):
        self._window_minheight = window_minheight

    @width.setter
    def width(self, width):
        self._width = width
        self.canvas.configure(width= width)

    @property
    def height(self):
        return self._height
        
    @height.setter
    def height(self, height):
        self._height = height
        self.canvas.configure(height = height)

    def _on_configure(self, event):
        if self._window_minwidth is not None:
            width = max(event.width, self._window_minwidth)
        else:
            width = max(self.innerFrame.winfo_reqwidth(), event.width)
            
        if self._window_minheight is not None:
            height = max(event.height, self._window_minheight)
        else:
            height = max(self.innerFrame.winfo_reqheight(), event.height)


        self.update_viewport(width, height)

    def update_viewport(self, width, height):
        self.canvas.configure(scrollregion="0 0 %s %s" % (width, height))
        self.canvas.itemconfigure("inner_frame", width=width, height=height)
        
if __name__== '__main__':
    try:
        from Tkinter import Tk, Label
    except ImportError:
        from tkinter import Tk, Label
    
    root = Tk()
    
    scrolling_area = Scrolling_Area(root)
    scrolling_area.pack(expand=1, fill=BOTH)
    
    for i in range(20):
        rowFrame = Frame(scrolling_area.innerFrame)
        rowFrame.pack()
        for j in range(8):
            Label(rowFrame, text="Label %s, %s" % (str(i), str(j))).pack(side="left")

    root.mainloop()

Diff to Previous Revision

--- revision 18 2017-05-01 20:33:06
+++ revision 19 2017-05-04 14:34:33
@@ -1,4 +1,4 @@
-# Version: 0.16
+# Version: 0.18
 # Author: Miguel Martinez Lopez
 # Uncomment the next line to see my email
 # print("Author's email: ", "61706c69636163696f6e616d656469646140676d61696c2e636f6d".decode("hex"))
@@ -78,7 +78,7 @@
     def _on_mouse_leave_scrolling_area(self):
         self._active_area = None
 
-    def add_support_to(self, widget, xscrollbar=None, yscrollbar=None, what="units", horizontal_factor=None, vertical_factor=None):
+    def add_support_to(self, widget=None, xscrollbar=None, yscrollbar=None, what="units", horizontal_factor=None, vertical_factor=None):
         if xscrollbar is not None and not hasattr(xscrollbar, 'onMouseWheel'):
             horizontal_factor = horizontal_factor or self.horizontal_factor
 
@@ -95,7 +95,7 @@
 
         main_scrollbar = yscrollbar if yscrollbar is not None else xscrollbar
         
-        if main_scrollbar is not None:
+        if widget is not None and main_scrollbar is not None:
             widget.bind('<Enter>',lambda event: self._on_mouse_enter_scrolling_area(widget))
             widget.bind('<Leave>', lambda event: self._on_mouse_leave_scrolling_area())
 
@@ -103,17 +103,20 @@
 
 class Scrolling_Area(Frame, object):
 
-    def __init__(self, master, width=None, height=None, mousewheel_speed = 2, scroll_horizontally=True, xscrollbar=None, scroll_vertically=True, yscrollbar=None, outer_background=None, inner_frame=Frame, window_minwidth=0, window_minheight = 0, **kw):
-        Frame.__init__(self, master)
-        
+    def __init__(self, master, width=None, height=None, mousewheel_speed = 2, scroll_horizontally=True, xscrollbar=None, scroll_vertically=True, yscrollbar=None, outer_background=None, inner_frame=Frame, window_minwidth=None, window_minheight = None, **kw):
+        Frame.__init__(self, master, class_=self.__class__)
+
         if outer_background:
             self.configure(background=outer_background)
 
         self._width = width
         self._height = height
 
-        self._canvas = Canvas(self, highlightthickness=0, width=width, height=height)
-        self._canvas.grid(row=0, column=0, sticky=N+E+W+S)
+        self.grid_columnconfigure(0, weight=1)
+        self.grid_rowconfigure(0, weight=1)
+
+        self.canvas = Canvas(self, background=outer_background, highlightthickness=0, width=width, height=height)
+        self.canvas.grid(row=0, column=0, sticky=N+E+W+S)
 
         self._window_minwidth = window_minwidth
         self._window_minheight = window_minheight
@@ -125,8 +128,8 @@
                 self.yscrollbar = Scrollbar(self, orient=VERTICAL)
                 self.yscrollbar.grid(row=0, column=1,sticky=N+S)
         
-            self._canvas.configure(yscrollcommand=self.yscrollbar.set)
-            self.yscrollbar['command']=self._canvas.yview
+            self.canvas.configure(yscrollcommand=self.yscrollbar.set)
+            self.yscrollbar['command']=self.canvas.yview
         else:
             self.yscrollbar = None
 
@@ -137,46 +140,74 @@
                 self.xscrollbar = Scrollbar(self, orient=HORIZONTAL)
                 self.xscrollbar.grid(row=1, column=0, sticky=E+W)
             
-            self._canvas.configure(xscrollcommand=self.xscrollbar.set)
-            self.xscrollbar['command']=self._canvas.xview
+            self.canvas.configure(xscrollcommand=self.xscrollbar.set)
+            self.xscrollbar['command']=self.canvas.xview
         else:
             self.xscrollbar = None
 
         self.rowconfigure(0, weight=1)
         self.columnconfigure(0, weight=1)
 
-        self.innerFrame= inner_frame(self._canvas, **kw)
+        self.innerFrame= inner_frame(self.canvas, **kw)
         self.innerFrame.pack()
         
-        self._canvas.create_window(0, 0, window=self.innerFrame, anchor='nw', tags="inner_frame")
-
-        self._canvas.bind('<Configure>', self._on_configure)
-
-        Mousewheel_Support(self).add_support_to(self._canvas, xscrollbar=self.xscrollbar, yscrollbar=self.yscrollbar)
+        self.canvas.create_window(0, 0, window=self.innerFrame, anchor='nw', tags="inner_frame")
+
+        self.canvas.bind('<Configure>', self._on_configure)
+
+        Mousewheel_Support(self).add_support_to(self.canvas, xscrollbar=self.xscrollbar, yscrollbar=self.yscrollbar)
+
+    @property
+    def width(self):
+        return self._width
+        
+    @property
+    def window_minwidth(self):
+        return self._window_minwidth
+        
+    @window_minwidth.setter
+    def window_minwidth(self, window_minwidth):
+        self._window_minwidth = window_minwidth
+
+    @property
+    def window_minheight(self):
+        return self._window_minheight
+        
+    @window_minheight.setter
+    def window_minheight(self, window_minheight):
+        self._window_minheight = window_minheight
+
+    @width.setter
+    def width(self, width):
+        self._width = width
+        self.canvas.configure(width= width)
+
+    @property
+    def height(self):
+        return self._height
+        
+    @height.setter
+    def height(self, height):
+        self._height = height
+        self.canvas.configure(height = height)
 
     def _on_configure(self, event):
-        width = max(self.innerFrame.winfo_reqwidth(), event.width, self._window_minwidth)
-        height = max(self.innerFrame.winfo_reqheight(), event.height, self._window_minheight)
-
-        self._canvas.configure(scrollregion="0 0 %s %s" % (width, height))
-        self._canvas.itemconfigure("inner_frame", width=width, height=height)
-
-    def update_viewport(self):
-        self.update()
-
-        height = self.innerFrame.winfo_reqheight()
-        width = self.innerFrame.winfo_reqwidth()
-
-        canvas_width = self._width
-        if canvas_width is None:
-            canvas_width = width
-
-        canvas_height = self._height
-        if canvas_height is None:
-            canvas_height = height
-
-        self._canvas.configure(width=canvas_width, height=canvas_height, scrollregion="0 0 %s %s" % (width, height))
-        self._canvas.itemconfigure("inner_frame", width=width, height=height)
+        if self._window_minwidth is not None:
+            width = max(event.width, self._window_minwidth)
+        else:
+            width = max(self.innerFrame.winfo_reqwidth(), event.width)
+            
+        if self._window_minheight is not None:
+            height = max(event.height, self._window_minheight)
+        else:
+            height = max(self.innerFrame.winfo_reqheight(), event.height)
+
+
+        self.update_viewport(width, height)
+
+    def update_viewport(self, width, height):
+        self.canvas.configure(scrollregion="0 0 %s %s" % (width, height))
+        self.canvas.itemconfigure("inner_frame", width=width, height=height)
         
 if __name__== '__main__':
     try:

History