Source code for pyworkflow.gui.widgets

# **************************************************************************
# *
# * Authors:     J.M. De la Rosa Trevin (delarosatrevin@scilifelab.se) [1]
# *
# * [1] SciLifeLab, Stockholm University
# *
# * This program is free software: you can redistribute it and/or modify
# * it under the terms of the GNU General Public License as published by
# * the Free Software Foundation, either version 3 of the License, or
# * (at your option) any later version.
# *
# * This program is distributed in the hope that it will be useful,
# * but WITHOUT ANY WARRANTY; without even the implied warranty of
# * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# * GNU General Public License for more details.
# *
# * You should have received a copy of the GNU General Public License
# * along with this program.  If not, see <https://www.gnu.org/licenses/>.
# *
# *  All comments concerning this program package may be sent to the
# *  e-mail address 'scipion@cnb.csic.es'
# *
# **************************************************************************
"""
Some basic GUI widgets are implemented in this module.
The widgets here are suppose to be used to build more complex 
elements.
"""

import tkinter as tk
import tkinter.ttk as ttk

from math import ceil

from pyworkflow import TK_GRAY_DEFAULT
from . import gui
from .tooltip import ToolTip


[docs]class Button(tk.Button): _images = {} def __init__(self, master, text, imagePath=None, tooltip=None, **opts): defaults = {} # Used to be {'font': gui.fontButton} but there is no such # definition in pyworkflow/gui. defaults.update(opts) if 'bg' in defaults and defaults['bg'] is None: del defaults['bg'] if imagePath is not None: btnImage = gui.getImage(imagePath, Button._images) else: btnImage = None if btnImage is not None: if 'compound' not in defaults: defaults['compound'] = tk.LEFT tk.Button.__init__(self, master, text=text, image=btnImage, **defaults) self.image = btnImage else: tk.Button.__init__(self, master, text=text, **defaults) if tooltip: ToolTip(self, tooltip, 500)
[docs] def setImage(self, imagePath): self.image = gui.getImage(imagePath) self.config(image=self.image)
[docs]class HotButton(Button): """ Button having the firebrick color and some other settings. """ def __init__(self, master, text, imagePath=None, tooltip=None, **opts): defaults = {'activebackground': gui.cfgButtonActiveBgColor, 'bg': gui.cfgButtonBgColor, 'fg': gui.cfgButtonFgColor, 'activeforeground': gui.cfgButtonActiveFgColor, 'compound': tk.LEFT} defaults.update(opts) Button.__init__(self, master, text, imagePath, tooltip, **defaults)
[docs]class IconButton(HotButton): """ Hot button, but only with image and no border """ def __init__(self, master, text, imagePath, tooltip=None, **opts): defaults = {'bd': 0, 'bg': 'white', 'compound': tk.NONE} defaults.update(opts) HotButton.__init__(self, master, text, imagePath, tooltip, **defaults)
[docs]class AutoScrollbar(tk.Scrollbar): """"A scrollbar that hides itself if it's not needed."""
[docs] def set(self, lo, hi): if float(lo) <= 0.0 and float(hi) >= 1.0: self.grid_remove() # self.tk.call("grid", "remove", self) else: self.grid() tk.Scrollbar.set(self, lo, hi)
[docs]class Scrollable(object): """This is a base class for all scrollable widgets. If it is enabled, it will wrap the widget with a frame and will add vertical and horizontal AutoScrollbar""" def __init__(self, master, WidgetClass, frame=True, **opts): if frame: self.frame = tk.Frame(master) self.frame.rowconfigure(0, weight=1) self.frame.columnconfigure(0, weight=1) self.vscroll = AutoScrollbar(self.frame) self.vscroll.grid(row=0, column=1, sticky='ns') self.hscroll = AutoScrollbar(self.frame, orient=tk.HORIZONTAL) self.hscroll.grid(row=1, column=0, sticky='ew') WidgetClass.__init__(self, self.frame, yscrollcommand=self.vscroll.set, xscrollcommand=self.hscroll.set, **opts) self.vscroll.config(command=self.yview) self.hscroll.config(command=self.xview) self.grid(row=0, column=0, sticky='news') self.grid = self.frame.grid self.grid_remove = self.frame.grid_remove else: WidgetClass.__init__(self, master, **opts) # Bind ourselves self.bindWidget(self)
[docs] def scroll(self, event): # print "scrolling, event.num", event.num, "delta", event.delta if event.num == 5 or event.delta < 0: count = 1 if event.num == 4 or event.delta > 0: count = -1 self.yview("scroll", count, "units")
[docs] def bindWidget(self, widget): """ Make the scroll in the widget, respond to this. Useful for child widgets. """ # with Windows OS widget.bind("<MouseWheel>", self.scroll) # with Linux OS widget.bind("<Button-4>", self.scroll) widget.bind("<Button-5>", self.scroll)
[docs] def getVScroll(self): return self.vscroll.get()
[docs] def getHScroll(self): return self.hscroll.get()
[docs]class ExplanationText(tk.Text): """Create an explanation text box""" def __init__(self, frame, text='', bg=TK_GRAY_DEFAULT, border=0, wrap='word'): self.text = tk.Text(frame, bg=bg, wrap=wrap, border=border) self.updateExpText(text)
[docs] def updateExpText(self, text, width=50): # Adapt textbox height to text length (width is in characters) n_lines = ceil(len(text) / width) self.text.config(state='normal', height=n_lines) # Make it editable self.text.insert(tk.END, text) self.text.config(state='disabled') # Disable text edit
[docs]class LabelSlider(ttk.Frame): """ Create a personalized frame that contains label, slider and label value it also keeps a variable with the value """ def __init__(self, master, label, from_=0, to=100, value=50, callback=None, step=0.01, length=None, labelWidth=None, tickinterval=None, showvalue=None): self.selectedLabelText = '=> {}'.format(label) self.labelText = ' {}'.format(label) self.var = tk.DoubleVar() self.var.set(float(value)) ttk.Frame.__init__(self, master) self.labelWidget = ttk.Label(self, text=self.labelText, width=labelWidth) self.slider = tk.Scale(self, from_=from_, to=to, variable=self.var, bigincrement=step, resolution=step, orient=tk.HORIZONTAL, length=length, tickinterval=tickinterval, showvalue=showvalue) if callback: self.var.trace('w', callback) self.labelWidget.grid(row=0, column=0, sticky='nes', padx=5, pady=5) self.slider.grid(row=0, column=1, sticky='news', padx=5, pady=5) self.columnconfigure(1, weight=3)
[docs] def get(self): return self.var.get()
[docs] def highlightLabel(self): self.labelWidget.config(text=self.selectedLabelText)
[docs] def removeHighlightFromLabel(self): self.labelWidget.config(text=self.labelText)
[docs]class ComboBox(ttk.Combobox): """ Extension of ttk.ComboBox to allow having different display text and values. Also adding some utils to getSelected index and value (same for set) """ def __init__(self, parent, choices, values=None, initial=None, onChange=None, **kwargs): """ Create a combobox from a list of choices. Params: parent: the parent widget (required by Tkinter) choices: a list with the options to be shown. values: if None, will enumerate from 0 to len(choices)-1 if a list is provided, should have the same length as choices. initial: if None, take the first choice onChange: provide a callback function to be used when change the selected value **kwargs: extra arguments passed to ttk.Combobox constructor. """ indexes = range(len(choices)) if values is None: values = indexes choices = [str(c) for c in choices] # Convert to a list of strings if initial is None: initial = choices[0] self._valuesDict = dict(zip(choices, values)) self._indexDict = dict(zip(choices, indexes)) self._var = tk.StringVar() self._var.set(initial) self._changeCallback = onChange self._var.trace('w', self._onChanged) ttk.Combobox.__init__(self, parent, textvariable=self._var, state='readonly', **kwargs) self['values'] = choices
[docs] def getValue(self): """ Return the selected value. """ return self._valuesDict[self._var.get()]
[docs] def getIndex(self): """ Return the selected value. """ return self._indexDict[self._var.get()]
[docs] def getText(self): """ Return the selected option text. """ return self._var.get()
[docs] def setChangeCallback(self, callback): self._changeCallback = callback
def _onChanged(self, *args): if self._changeCallback: self._changeCallback(self)
[docs]class GradientFrame(tk.Canvas): """A gradient frame which uses a canvas to draw the background Taken from: http://stackoverflow.com/questions/11892521/tkinter-custom-window """ def __init__(self, parent, **args): tk.Canvas.__init__(self, parent, **args) self._color1 = "#d2a7a7" self._color2 = "#820808" self.bind("<Configure>", self._draw_gradient) def _draw_gradient(self, event=None): self.delete("gradient") width = self.winfo_width() height = self.winfo_height() limit = width // 2 r1, g1, b1 = self.winfo_rgb(self._color1) r2, g2, b2 = self.winfo_rgb(self._color2) r_ratio = (r2 - r1) / limit g_ratio = (g2 - g1) / limit b_ratio = (b2 - b1) / limit for i in range(limit + 1): nr = int(r1 + (r_ratio * i)) ng = int(g1 + (g_ratio * i)) nb = int(b1 + (b_ratio * i)) color = "#%4.4x%4.4x%4.4x" % (nr, ng, nb) self.create_line(i, 0, i, height, tags=("gradient",), fill=color) self.create_line(width - i, 0, width - i, height, tags=("gradient",), fill=color) self.lower("gradient")