#!/usr/bin/env python
#
# ColourPickerPanel.py
"""
Based on StylePickerPanel, a Panel for selecting a list of colours, and their order
"""
#
# Copyright 2019-2020 Dominic Davis-Foster <dominic@davis-foster.co.uk>
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU Lesser 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 Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
# MA 02110-1301, USA.
#
#
# generated by wxGlade 0.9.3 on Tue Apr 9 18:07:58 2019
#
# stdlib
from typing import List, Optional
# 3rd party
import matplotlib # type: ignore
import wx # type: ignore
from matplotlib.backends.backend_wxagg import FigureCanvasWxAgg as FigureCanvas # type: ignore
from matplotlib.figure import Figure # type: ignore
# this package
from domdf_wxpython_tools.StylePickerPanel import StylePickerPanel
__all__ = ["ColourPickerPanel"]
# begin wxGlade: dependencies
# end wxGlade
# begin wxGlade: extracode
# end wxGlade
default_colours = [
"#1f77b4",
"#ff7f0e",
"#2ca02c",
"#d62728",
"#9467bd",
"#8c564b",
"#e377c2",
"#7f7f7f",
"#bcbd22",
"#17becf",
]
default_picker_choices = [
"#000000",
"#ff0000",
"#ffa500",
"#00ff00",
"#0000ff",
"#551a8b",
"#008080",
]
[docs]class ColourPickerPanel(StylePickerPanel):
"""
Based on StylePickerPanel, a Panel for selecting a list of colours, and their order.
:param parent: The parent window.
:param id: An identifier for the panel. wx.ID_ANY is taken to mean a default.
:param pos: The panel position. The value ``wx.DefaultPosition`` indicates a default position, chosen by either the windowing system or wxWidgets, depending on platform.
:param size: The panel size. The value ``wx.DefaultSize`` indicates a default size, chosen by either the windowing system or wxWidgets, depending on platform.
:param style: The window style. See wxPanel.
:param name: The window name.
:param label: Label for the panel
:param picker_choices: A list of hex value choices to populate the 'picker' side of the panel with
:param selection_choices: A list of hex value choices to populate the 'selection' side of the panel with
"""
def __init__(
self,
parent: wx.Window,
id: int = wx.ID_ANY, # noqa: A002 # pylint: disable=redefined-builtin
pos: wx.Point = wx.DefaultPosition,
size: wx.Size = wx.DefaultSize,
style: int = wx.TAB_TRAVERSAL,
name: str = wx.PanelNameStr,
label: str = "Choose Colours: ",
picker_choices: Optional[List[str]] = None,
selection_choices: Optional[List[str]] = None,
):
args = (parent, id, pos, size)
kwds = {"style": style, "name": name}
if picker_choices is None:
picker_choices = default_picker_choices
if selection_choices is None:
selection_choices = default_colours[:]
self.label = label
self.picker_choices = picker_choices
self.selection_choices = selection_choices
# begin wxGlade: ColourPickerPanel.__init__
kwds["style"] = kwds.get("style", 0) | wx.TAB_TRAVERSAL
wx.Panel.__init__(self, *args, **kwds)
self.main_panel = wx.Panel(self, wx.ID_ANY)
self.move_panel = wx.Panel(self.main_panel, wx.ID_ANY)
self.picker_list_box = wx.ListBox(self.main_panel, wx.ID_ANY, choices=[])
self.picker_figure = Figure()
self.picker_canvas = FigureCanvas(self.main_panel, wx.ID_ANY, self.picker_figure)
self.add_btn = wx.Button(self.main_panel, wx.ID_ANY, "Add 🡲")
self.remove_btn = wx.Button(self.main_panel, wx.ID_ANY, "🡰 Remove")
self.selection_list_box = wx.ListBox(self.main_panel, wx.ID_ANY, choices=[])
self.up_btn = wx.Button(self.main_panel, wx.ID_ANY, "🡱 Up")
self.down_btn = wx.Button(self.main_panel, wx.ID_ANY, "🡳 Down")
self.selection_figure = Figure()
self.selection_canvas = FigureCanvas(self.main_panel, wx.ID_ANY, self.selection_figure)
self.__set_properties()
self.__do_layout()
# end wxGlade
self.Bind(wx.EVT_LISTBOX, self.update_picker_preview, self.picker_list_box)
self.Bind(wx.EVT_LISTBOX_DCLICK, self.add, self.picker_list_box)
self.Bind(wx.EVT_BUTTON, self.add, self.add_btn)
self.Bind(wx.EVT_BUTTON, self.remove, self.remove_btn)
self.Bind(wx.EVT_LISTBOX, self.update_selection_preview, self.selection_list_box)
self.Bind(wx.EVT_BUTTON, self.move_up, self.up_btn)
self.Bind(wx.EVT_BUTTON, self.move_down, self.down_btn)
self.Bind(wx.EVT_LISTBOX_DCLICK, self.remove, self.selection_list_box)
self.remove_btn.SetLabel("Remove")
self.selection_list_box.Clear()
self.selection_list_box.AppendItems(self.selection_choices)
if not self.selection_list_box.IsEmpty():
self.selection_list_box.SetSelection(0)
self.picker_list_box.Clear()
self.picker_list_box.AppendItems(self.picker_choices)
if not self.picker_list_box.IsEmpty():
self.picker_list_box.SetSelection(0)
self.picker_axes = self.picker_figure.add_subplot(111)
self.selection_axes = self.selection_figure.add_subplot(111)
self.update_picker_preview()
self.update_selection_preview()
def __set_properties(self):
# begin wxGlade: ColourPickerPanel.__set_properties
self.move_panel.SetMinSize((170, -1))
self.picker_list_box.SetMinSize((170, 256))
self.picker_canvas.SetMinSize((64, 64))
self.selection_list_box.SetMinSize((170, 256))
self.up_btn.SetMinSize((80, -1))
self.down_btn.SetMinSize((80, -1))
self.selection_canvas.SetMinSize((64, 64))
self.main_panel.SetMinSize((450, -1))
# end wxGlade
def __do_layout(self):
# begin wxGlade: ColourPickerPanel.__do_layout
parent_sizer = wx.BoxSizer(wx.HORIZONTAL)
main_sizer = wx.BoxSizer(wx.VERTICAL)
list_grid_sizer = wx.BoxSizer(wx.HORIZONTAL)
sizer_4 = wx.BoxSizer(wx.VERTICAL)
selection_preview_sizer = wx.BoxSizer(wx.HORIZONTAL)
move_grid = wx.GridSizer(1, 2, 0, 5)
sizer_3 = wx.BoxSizer(wx.VERTICAL)
sizer_2 = wx.BoxSizer(wx.VERTICAL)
picker_preview_sizer = wx.BoxSizer(wx.HORIZONTAL)
grid_sizer = wx.GridSizer(1, 3, 10, 10)
borders_label = wx.StaticText(self.main_panel, wx.ID_ANY, "Choose Styles: ")
borders_label.SetMinSize((128, 20))
borders_label.SetFont(wx.Font(12, wx.FONTFAMILY_DEFAULT, wx.FONTSTYLE_NORMAL, wx.FONTWEIGHT_BOLD, 0, ''))
grid_sizer.Add(borders_label, 0, wx.BOTTOM, 7)
grid_sizer.Add(self.move_panel, 1, wx.ALIGN_CENTER | wx.EXPAND, 0)
main_sizer.Add(grid_sizer, 0, 0, 0)
sizer_2.Add(self.picker_list_box, 5, wx.EXPAND, 0)
sizer_2.Add((0, 0), 0, 0, 0)
preview_label = wx.StaticText(self.main_panel, wx.ID_ANY, "Preview: ")
picker_preview_sizer.Add(preview_label, 0, 0, 0)
picker_preview_sizer.Add(self.picker_canvas, 1, wx.EXPAND, 0)
sizer_2.Add(picker_preview_sizer, 0, wx.EXPAND | wx.TOP, 5)
list_grid_sizer.Add(sizer_2, 1, wx.EXPAND, 0)
sizer_3.Add(self.add_btn, 0, wx.ALIGN_CENTER | wx.BOTTOM, 10)
sizer_3.Add(self.remove_btn, 0, wx.ALIGN_CENTER, 0)
list_grid_sizer.Add(sizer_3, 5, wx.ALIGN_CENTER | wx.BOTTOM, 64)
sizer_4.Add(self.selection_list_box, 5, wx.EXPAND, 0)
move_grid.Add(self.up_btn, 0, wx.ALIGN_CENTER, 0)
move_grid.Add(self.down_btn, 0, wx.ALIGN_CENTER, 0)
sizer_4.Add(move_grid, 0, wx.EXPAND, 0)
preview_label_1 = wx.StaticText(self.main_panel, wx.ID_ANY, "Preview: ")
selection_preview_sizer.Add(preview_label_1, 0, 0, 0)
selection_preview_sizer.Add(self.selection_canvas, 1, wx.EXPAND, 0)
sizer_4.Add(selection_preview_sizer, 0, wx.EXPAND | wx.TOP, 5)
list_grid_sizer.Add(sizer_4, 1, wx.EXPAND, 0)
main_sizer.Add(list_grid_sizer, 0, 0, 0)
static_line_11 = wx.StaticLine(self.main_panel, wx.ID_ANY)
main_sizer.Add(static_line_11, 0, wx.BOTTOM | wx.EXPAND | wx.TOP, 5)
self.main_panel.SetSizer(main_sizer)
parent_sizer.Add(self.main_panel, 0, wx.ALL, 10)
self.SetSizer(parent_sizer)
parent_sizer.Fit(self)
self.Layout()
# end wxGlade
borders_label.SetLabel(self.label)
[docs] def add(self, event): # wxGlade: ColourPickerPanel.<event_handler>
"""
Event handler for adding the colour currently selected in the 'picker' to the 'selection'
"""
selection = self.picker_list_box.GetSelection()
if selection == -1:
return
selection_string = self.picker_list_box.GetString(selection)
if selection_string == '':
return
self.selection_list_box.Append(selection_string)
self.update_picker_preview()
self.selection_list_box.SetSelection(self.selection_list_box.GetCount() - 1)
self.update_selection_preview()
event.Skip()
[docs] def remove(self, event): # wxGlade: ColourPickerPanel.<event_handler>
"""
Event handler for removing the colour currently selected in the 'selection'
"""
selection = self.selection_list_box.GetSelection()
if selection == -1:
return
selection_string = self.selection_list_box.GetString(selection)
if selection_string == '':
return
self.selection_list_box.Delete(self.selection_list_box.GetSelection())
self.update_selection_preview()
event.Skip()
[docs] def update_preview(self, list_obj: wx.ListBox, axes: matplotlib.axes.Axes):
"""
Update the preview from the given list.
:param list_obj: The list to update the preview for.
:param axes: The preview axes to update.
"""
axes.clear()
axes.axis("off")
selection_string = list_obj.GetStringSelection()
if selection_string == '':
return
axes.scatter(1, 1, s=400, color=selection_string, marker='s')
[docs] def pick(self, *args):
"""
Open a :py:class:`wx.ColourDialog` to edit the colour currently selected in the picker.
"""
selection = self.selection_list_box.GetSelection()
if selection == -1:
return
selection_string = self.selection_list_box.GetString(selection)
if selection_string == '':
return
colour = wx.ColourData()
colour.SetColour(selection_string)
dlg = wx.ColourDialog(self, data=colour)
res = dlg.ShowModal()
if res == wx.ID_OK:
self.selection_list_box.Delete(selection)
self.selection_list_box.InsertItems(
[dlg.GetColourData().GetColour().GetAsString(wx.C2S_HTML_SYNTAX)],
selection) # yapf: disable
self.selection_list_box.SetSelection(selection)
self.update_selection_preview()
dlg.Destroy()
[docs] def GetSelection(self) -> List[str]:
"""
Returns a list of the currently selected colours
"""
return [self.selection_list_box.GetString(item) for item in range(self.selection_list_box.GetCount())]
get_selection = GetSelection
# end of class ColourPickerPanel