~glitter-team/glitter/trunk

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
# !/usr/bin/python
# -*- coding: utf-8 -*-

# Glitter Toolkit

__authors__ = ["Jan Jokela <janjokela@gmail.com>"]
__licenses__ = ["LICENSE.LGPL"]
__description__ = "List widget"

import gobject
import clutter

from widget import *
from container import Container
from box import VBox
from image import Image
from scroll_area import ScrollArea
from scrollable import Scrollable

class List(Container, Scrollable):
    """
    A list widget offers an item list where any item can have a combination of 
    text and icon. There is also support for a selector of the current item 
    for non-touch interfaces.
    
    The list widget implements the scrollable interface.
    
    """

    __gsignals__ = {
        'selection-changed': (gobject.SIGNAL_RUN_LAST, gobject.TYPE_BOOLEAN, 
                             (gobject.TYPE_PYOBJECT,)),
        'view-changed': (gobject.SIGNAL_RUN_LAST, gobject.TYPE_BOOLEAN, 
                        (gobject.TYPE_PYOBJECT, gobject.TYPE_PYOBJECT,))
    }
    
    def __init__(self):
        """ Initialize list """
        
        super(List, self).__init__()
        super(Scrollable, self).__init__()
        
        self._stage = None
        
        self.set_reactive(True)
        self.connect('button-release-event', self.on_release_event)
        self.connect('scroll-event', self.on_scroll_event)
        
        self.items = []
        self._show_selection = None
        self._selected = None
        self._init_elements()
        self._init_animations()
        
        self._update_style(self.style)

    def _init_elements(self):
        """ Initializes graphical elements """
        
        self._background_image = Image()
        self.add(self._background_image)
        
        self._vbox = VBox()
        self.add(self._vbox)
        
        self._selection_image = None
        
    def _init_animations(self):
        """ Initializes animations """
        
        self._timeline = None
        
    def _update_style(self, props=None):
        """ Updates style """
        
        super(List, self)._update_style(props)
        
        for key, value in props:        
            if key == 'background-image':
                self.background_image = value
                self._background_image.set_source(self.background_image)
                self._background_image._update_layout()
            elif key == 'selection-image':
                self.selection_image = value
                if not self._selection_image:
                    self._selection_image = Image()
                    self._vbox.add(self._selection_image)
                self._selection_image.set_source(self.selection_image)
                self._selection_image._update_layout()

    def _update_layout(self):
        """ Updates layout """
        
        super(List, self)._update_layout()
        
        # Subscribe to key-press events
        if not self._stage:
            self._stage = self.get_stage()
            self._stage.connect('key-press-event', self.on_key_press_event) 
        
        # Update list background image and vbox
        self._background_image._update_layout()
        self._vbox._update_layout()
        
        # Update selection image size and position
        if self._selection_image:
            if not self.selected:
                if self._vbox.get_item_natural_height(0) > 0:
                    self._selection_image.natural_height = self._vbox.get_item_natural_height(0)
                    self._selection_image._update_layout()
            else:
                self._selection_image.natural_height = self._vbox.get_item_natural_height(self.selected)
                self._selection_image._update_layout()
                self._selection_image.set_y(self._vbox.get_item(self.selected).get_y())
                
        # Update childs
        for item in self.items:
            item._update_layout()
            
        # Set clip
        self.set_clipu(0, 0, self.get_widthu(), self.get_heightu())
    
    def append(self, item):
        """ Appends an item to the list """
        
        self.items.append(item)
        self._vbox.pack(item)
        if self.selected == None:
            self.selected = 0
        self._update_layout()
        
    def remove(self):
        """ Remove item from list """
        
        self.items.remove(item)
        self._vbox.unpack(item)
        self._update_layout()
    
    def get_show_selection(self):
        """ Retrieve whether selection is to be displayed """
        
        return self._show_selection
        
    def set_show_selection(self, value):
        """ Sets whether selection is to be displayed
        
        value -- (boolean) whether to display selection or not
        """
        
        self._show_selection = value
        
    show_selection = property(get_show_selection, set_show_selection)
    
    def get_selected(self):
        """ Retrieve selected item """
        
        return self._selected
    
    def set_selected(self, item):
        """ Sets item as selected
        
        item -- (widget) a widget
        """
        
        self._selected = item
        self.emit("selection-changed", self._vbox.get_item(item))
        
        # Emit a signal and change selector position case we have one
        if self._selection_image:
            
            # The new allocation box for the reference widget
            new_alloc_boxu = (
              -1,
              self._vbox.get_item(item).get_y(),
              -1,
              self._selection_image.get_heightu()
            )    
            self.emit("view-changed", new_alloc_boxu, 0.1)
        
            # Animation for switching between selected items in list 
            if not self._timeline:
                self._timeline = clutter.Timeline(fps=60, duration=200)
            if self._timeline.is_playing():
                self._timeline.stop()
            self._timeline = clutter.Timeline(fps=60, duration=200)
            alpha = clutter.Alpha(self._timeline, clutter.sine_inc_func)
            self._behaviour = clutter.BehaviourPath(alpha)
            self._behaviour.append_knots(
              (0, self._selection_image.get_y()),
              (0, self._vbox.get_item(item).get_y())
            )
            self._behaviour.apply(self._selection_image)
            self._timeline.start()
    
    selected = property(get_selected, set_selected)
    
    def on_release_event(self, widget, event):
        """ Button release event """
        
        print widget
        
    def on_scroll_event(self, widget, event):
        """ Scroll event """
    
        if event.direction == clutter.SCROLL_UP:
            if self.selected > 0:
                self.selected -= 1
                #self.get_parent().get_parent()._scroll_down(px=self._vbox.get_item(self.selected).get_y())
            else:
                return True
        elif event.direction == clutter.SCROLL_DOWN:
            if self.selected < len(self.items)-1:
                self.selected += 1
                #self.get_parent().get_parent()._scroll_up(px=self._vbox.get_item(self.selected).get_y())
            else:
                return True
        elif event.direction == clutter.SCROLL_LEFT:
            pass
        elif event.direction == clutter.SCROLL_RIGHT:
            pass
            
        return True
            
    def on_key_press_event(self, widget, event):
        """ Key event """
        
        if event.keyval == clutter.keysyms.Up:
            if self.selected > 0:
                self.selected -= 1
        elif event.keyval == clutter.keysyms.Down:
            if self.selected < len(self.items)-1:
                self.selected += 1