Source code for timelinelib.wxgui.components.maincanvas.scrollbase

# 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/>.


from timelinelib.wxgui.components.maincanvas.inputhandler import InputHandler


# dragscroll timer interval in milliseconds
DRAGSCROLL_TIMER_MSINTERVAL = 300
# timeline. The scroll zone areas are found at the beginning and at the
# end of the timeline.
SCROLL_ZONE_WIDTH = 20



[docs]class ScrollViewInputHandler(InputHandler):


[docs]    def __init__(self, timeline_canvas):
        InputHandler.__init__(self, timeline_canvas)
        self.timer_running = False



[docs]    def mouse_moved(self, cursor, keyboard):
        self.last_x = cursor.x
        if self._in_scroll_zone(cursor.x) and not self.timer_running:
            self.timeline_canvas.start_dragscroll_timer(milliseconds=DRAGSCROLL_TIMER_MSINTERVAL)
            self.timer_running = True



[docs]    def left_mouse_up(self):
        self.timeline_canvas.stop_dragscroll_timer()



[docs]    def dragscroll_timer_fired(self):
        if self._in_scroll_zone(self.last_x):
            if self.last_x < SCROLL_ZONE_WIDTH:
                direction = 1
            else:
                direction = -1
            self.timeline_canvas.Scroll(direction * 0.1)
            self.view_scrolled()



[docs]    def view_scrolled(self):
        raise Exception("view_scrolled not implemented in subclass.")


    def _in_scroll_zone(self, x):
        """
        Return True if x is within the left hand or right hand area
        where timed scrolling shall start/continue.
        """
        width, _ = self.timeline_canvas.GetSize()
        if width - x < SCROLL_ZONE_WIDTH or x < SCROLL_ZONE_WIDTH:
            return True
        return False