1
# -*- coding: UTF-8 -*-
2
"""Cell renderer for directed graph.
4
This module contains the implementation of a custom GtkCellRenderer that
5
draws part of the directed graph based on the lines suggested by the code
8
Because we're shiny, we use Cairo to do this, and because we're naughty
9
we cheat and draw over the bits of the TreeViewColumn that are supposed to
10
just be for the background.
13
__copyright__ = "Copyright © 2005-2011 Canonical Ltd."
14
__author__ = "Scott James Remnant <scott@ubuntu.com>"
19
from gi.repository import Gtk
20
from gi.repository import GObject
21
from gi.repository import Pango
22
from gi.repository import PangoCairo
25
# Cairo constants are not exported yet. These are taken from documentation.
26
CAIRO_LINE_CAP_BUTT = 0
27
CAIRO_LINE_CAP_ROUND = 1
28
CAIRO_LINE_CAP_SQUARE = 2
31
CAIRO_FILL_RULE_WINDING = 0
32
CAIRO_FILL_RULE_EVEN_ODD = 1
35
# Macro from Pango header.
37
return (d + 512) / 1000
40
class CellRendererGraph(Gtk.CellRendererPixbuf):
41
"""Cell renderer for directed graph.
44
node (column, colour) tuple to draw revision node,
45
in_lines (start, end, colour) tuple list to draw inward lines,
46
out_lines (start, end, colour) tuple list to draw outward lines.
52
"node": ( GObject.TYPE_PYOBJECT, "node",
53
"revision node instruction",
54
GObject.PARAM_WRITABLE
56
"tags": ( GObject.TYPE_PYOBJECT, "tags",
57
"list of tags associated with the node",
58
GObject.PARAM_WRITABLE
60
"in-lines": ( GObject.TYPE_PYOBJECT, "in-lines",
61
"instructions to draw lines into the cell",
62
GObject.PARAM_WRITABLE
64
"out-lines": ( GObject.TYPE_PYOBJECT, "out-lines",
65
"instructions to draw lines out of the cell",
66
GObject.PARAM_WRITABLE
70
def do_set_property(self, property, value):
71
"""Set properties from GObject properties."""
72
if property.name == "node":
74
elif property.name == "tags":
76
elif property.name == "in-lines":
78
elif property.name == "out-lines":
79
self.out_lines = value
81
raise AttributeError, "no such property: '%s'" % property.name
83
def box_size(self, widget):
84
"""Calculate box size based on widget's font.
86
Cache this as it's probably expensive to get. It ensures that we
87
draw the graph at least as large as the text.
91
except AttributeError:
92
pango_ctx = widget.get_pango_context()
93
font_desc = widget.get_style().font_desc
94
metrics = pango_ctx.get_metrics(font_desc, None)
95
ascent = PANGO_PIXELS(metrics.get_ascent())
96
descent = PANGO_PIXELS(metrics.get_descent())
97
self._box_size = ascent + descent + 6
100
def set_colour(self, ctx, colour, bg, fg):
101
"""Set the context source colour.
103
Picks a distinct colour based on an internal wheel; the bg
104
parameter provides the value that should be assigned to the 'zero'
105
colours and the fg parameter provides the multiplier that should be
106
applied to the foreground colours.
108
mainline_color = ( 0.0, 0.0, 0.0 )
119
colour_rgb = mainline_color
121
colour_rgb = colours[colour % len(colours)]
123
red = (colour_rgb[0] * fg) or bg
124
green = (colour_rgb[1] * fg) or bg
125
blue = (colour_rgb[2] * fg) or bg
127
ctx.set_source_rgb(red, green, blue)
129
def do_activate(event, widget, path, bg_area, cell_area, flags):
130
"""Renderers cannot be activated; always return True."""
133
def do_editing_started(event, widget, path, fb_area, cell_area, flags):
134
"""Renderers cannot be edited; always return None."""
137
def do_get_size(self, widget, cell_area):
138
"""Return the size we need for this cell.
140
Each cell is drawn individually and is only as wide as it needs
141
to be, we let the TreeViewColumn take care of making them all
144
box_size = self.box_size(widget) + 1
146
width = box_size * (self.columns_len + 1)
149
# FIXME I have no idea how to use cell_area properly
150
return (0, 0, width, height)
152
def do_render(self, ctx, widget, bg_area, cell_area, flags):
153
"""Render an individual cell.
155
Draws the cell contents using cairo, taking care to clip what we
156
do to within the background area so we don't draw over other cells.
157
Note that we're a bit naughty there and should really be drawing
158
in the cell_area (or even the exposed area), but we explicitly don't
161
We try and be a little clever, if the line we need to draw is going
162
to cross other columns we actually draw it as in the .---' style
163
instead of a pure diagonal ... this reduces confusion by an
166
ctx.rectangle(bg_area.x, bg_area.y, bg_area.width, bg_area.height)
169
box_size = self.box_size(widget)
171
ctx.set_line_width(box_size / 8)
173
# Draw lines into the cell
174
for start, end, colour in self.in_lines:
175
self.render_line (ctx, cell_area, box_size,
176
bg_area.y, bg_area.height,
177
start, end, colour, flags)
179
# Draw lines out of the cell
180
for start, end, colour in self.out_lines:
181
self.render_line (ctx, cell_area, box_size,
182
bg_area.y + bg_area.height, bg_area.height,
183
start, end, colour, flags)
185
# Draw the revision node in the right column
186
(column, colour) = self.node
187
ctx.arc(cell_area.x + box_size * column + box_size / 2,
188
cell_area.y + cell_area.height / 2,
189
box_size / 4, 0, 2 * math.pi)
191
if flags & Gtk.CellRendererState.SELECTED:
192
ctx.set_source_rgb(1.0, 1.0, 1.0)
193
ctx.set_line_width(box_size / 4)
194
ctx.stroke_preserve()
195
ctx.set_line_width(box_size / 8)
197
self.set_colour(ctx, colour, 0.0, 0.5)
198
ctx.stroke_preserve()
200
self.set_colour(ctx, colour, 0.5, 1.0)
203
self.render_tags(ctx, widget.create_pango_context(), cell_area, box_size)
205
def render_line(self, ctx, cell_area, box_size,
206
mid, height, start, end, colour, flags):
208
ctx.set_line_cap(CAIRO_LINE_CAP_ROUND)
209
x = cell_area.x + box_size * end + box_size / 2
210
ctx.move_to(x, mid + height / 3)
211
ctx.line_to(x, mid + height / 3)
212
ctx.move_to(x, mid + height / 6)
213
ctx.line_to(x, mid + height / 6)
216
ctx.set_line_cap(CAIRO_LINE_CAP_ROUND)
217
x = cell_area.x + box_size * start + box_size / 2
218
ctx.move_to(x, mid - height / 3)
219
ctx.line_to(x, mid - height / 3)
220
ctx.move_to(x, mid - height / 6)
221
ctx.line_to(x, mid - height / 6)
224
ctx.set_line_cap(CAIRO_LINE_CAP_BUTT)
225
startx = cell_area.x + box_size * start + box_size / 2
226
endx = cell_area.x + box_size * end + box_size / 2
228
ctx.move_to(startx, mid - height / 2)
230
if start - end == 0 :
231
ctx.line_to(endx, mid + height / 2 + 1)
233
ctx.curve_to(startx, mid - height / 5,
234
startx, mid - height / 5,
235
startx + (endx - startx) / 2, mid)
237
ctx.curve_to(endx, mid + height / 5,
238
endx, mid + height / 5 ,
239
endx, mid + height / 2 + 1)
241
if flags & Gtk.CellRendererState.SELECTED:
242
ctx.set_source_rgb(1.0, 1.0, 1.0)
243
ctx.set_line_width(box_size / 5)
244
ctx.stroke_preserve()
245
ctx.set_line_width(box_size / 8)
247
self.set_colour(ctx, colour, 0.0, 0.65)
251
def render_tags(self, ctx, pango_ctx, cell_area, box_size):
252
# colour ID used in self.set_colour on the tags
255
(column, colour) = self.node
257
font_desc = Pango.FontDescription()
258
font_desc.set_size(Pango.SCALE * 7)
260
tag_layout = Pango.Layout(pango_ctx)
261
tag_layout.set_font_description(font_desc)
263
# The width of the tag label stack
266
for tag_idx, tag in enumerate(self.tags):
267
tag_layout.set_text(" " + tag + " ", -1)
268
text_width, text_height = tag_layout.get_pixel_size()
271
box_size * (column + 1.3) + width
274
cell_area.height / 2 - \
277
width += text_width + 5
279
# Draw the tag border
280
ctx.move_to(x0 - box_size / 3, y0 + text_height / 2)
282
ctx.line_to(x0 + text_width, y0)
283
ctx.line_to(x0 + text_width, y0 + text_height)
284
ctx.line_to(x0, y0 + text_height)
285
ctx.line_to(x0 - box_size / 3, y0 + text_height / 2)
288
ctx.arc(x0 - box_size / 12,
289
y0 + text_height / 2,
293
self.set_colour(ctx, TAG_COLOUR_ID, 0.0, 0.5)
294
ctx.stroke_preserve()
296
ctx.set_fill_rule (CAIRO_FILL_RULE_EVEN_ODD)
297
self.set_colour(ctx, TAG_COLOUR_ID, 0.5, 1.0)
301
self.set_colour(ctx, 0, 0.0, 0.0)
303
PangoCairo.show_layout(ctx, tag_layout)
added
removed
branchview/graphcell.py
