Source code for timelinelib.wxgui.components.propertyeditors.descriptioneditor

# Copyright (C) 2009, 2010, 2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018  Rickard Lindberg, Roger Lindberg
#
# This file is part of Timeline.
#
# Timeline 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.
#
# Timeline 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 Timeline.  If not, see <http://www.gnu.org/licenses/>.


import wx

from timelinelib.wxgui.components.propertyeditors.baseeditor import BaseEditor



[docs]class DescriptionEditorGuiCreator(wx.Panel):


[docs]    def __init__(self, parent):
        wx.Panel.__init__(self, parent)



[docs]    def create_sizer(self):
        return wx.BoxSizer()



[docs]    def create_controls(self):
        text = self._create_text_control()
        return (text,)



[docs]    def put_controls_in_sizer(self, sizer, controls):
        text, = controls
        sizer.Add(text, 1, wx.ALL | wx.EXPAND, 0)


    def _create_text_control(self):
        self.data = wx.TextCtrl(self, style=wx.TE_MULTILINE)
        self.data.Bind(wx.EVT_CHAR, self._on_char)
        self.data.Bind(wx.EVT_KEY_DOWN, self._on_key_down)
        return self.data

    def _on_char(self, evt):
        if self._ctrl_a(evt):
            self.data.SetSelection(-1, -1)
        else:
            evt.Skip()

    def _on_key_down(self, evt):
        if self._ctrl_plus(evt):
            self._increase_font()
        elif self._ctrl_minus(evt):
            self._decrease_font()
        else:
            evt.Skip()
        
    def _increase_font(self):
        font = self.data.GetFont()
        font.MakeLarger()
        self.data.SetFont(font)

    def _decrease_font(self):
        font = self.data.GetFont()
        font.MakeSmaller()
        self.data.SetFont(font)
        
    def _ctrl_a(self, evt):
        KEY_CODE_A = 1
        return evt.ControlDown() and evt.KeyCode == KEY_CODE_A

    def _ctrl_plus(self, evt):
        KEY_CODE_PLUS = 43
        return evt.ControlDown() and evt.KeyCode == KEY_CODE_PLUS

    def _ctrl_minus(self, evt):
        KEY_CODE_MINUS = 45
        return evt.ControlDown() and evt.KeyCode == KEY_CODE_MINUS




[docs]class DescriptionEditor(BaseEditor, DescriptionEditorGuiCreator):


[docs]    def __init__(self, parent, editor, name=""):
        BaseEditor.__init__(self, parent, editor)
        DescriptionEditorGuiCreator.__init__(self, parent)
        self.create_gui()



[docs]    def get_data(self):
        description = self.data.GetValue().strip()
        if description != "":
            return description
        return None



[docs]    def clear_data(self):
        self.data.SetValue("")