Sugar Labs - User contributions [en]

User:Humitos/YumRepository

2012-11-12T18:24:07Z

Humitos: /* References */

= Create our own yum repository =

This will allow us to download just once the package needed to develop on our XO platform.

= Steps on the server =

sudo yum install nginx createrepo
mkdir -P /srv/repo/i686 /srv/repo/armv7hl /srv/repo/noarch
ln -s /srv/repo /usr/share/nginx/html
sudo service nginx start

= Download packages for all the architectures we want =

I did this by going to each XO (1.5 -i686- and 1.75 -ARM- in my case) and running:

sudo yum install --assumeyes --nogpg yum-utils

Download all the packages that you consider necessary here:

## Common utils that I use
sudo yumdownloader --resolve vim git htop emacs-nox multitail screen

## Those used to compile sugar / artwork / toolkit
sudo yumdownloader --resolve git make alsa-lib-devel gettext-devel \
gobject-introspection-devel gtk3-devel intltool libSM-devel \
librsvg2-devel pygobject2-devel pygtk2-codegen python-devel \
gtk2-devel icon-naming-utils icon-slicer python-empy \
xorg-x11-apps gnome-common GConf2-devel gtksourceview3-devel \
cairo-gobject

Copy all of the packages downloaded to the server:

scp *noarch* humitos@192.168.1.101:/srv/repo/noarch
scp *armv7hl* humitos@192.168.1.101:/srv/repo/armv7hl
scp *i686* humitos@192.168.1.101:/srv/repo/i686

= Create a yum configuration file =

Copy this into a file called: ''/etc/yum.repos.d/local.repo'' (in the XOs)

[SugarRepo]
name=Sugar Repository
baseurl=http://192.168.1.101/repo
gpgcheck=0

= Last step on the server =

createrepo /srv/repo

= References =

* http://ramblings.narrabilis.com/creating-a-yum-repository-repo-and-creating-a-yum-group-to-install-kickstart

Scripts

* http://git.sugarlabs.org/humitos/olpc/blobs/master/scripts/yum/install_local_repo.sh
* http://git.sugarlabs.org/humitos/olpc/blobs/master/scripts/yum/update_local_repo.sh

User:Humitos/YumRepository

2012-11-12T18:23:24Z

Humitos: /* Download packages for all the architectures we want */

User:Humitos/YumRepository

2012-11-12T18:09:54Z

Humitos: /* References */

= Create our own yum repository =

This will allow us to download just once the package needed to develop on our XO platform.

= Steps on the server =

sudo yum install nginx createrepo
mkdir -P /srv/repo/i686 /srv/repo/armv7hl /srv/repo/noarch
ln -s /srv/repo /usr/share/nginx/html
sudo service nginx start

= Download packages for all the architectures we want =

I did this by going to each XO (1.5 -i686- and 1.75 -ARM- in my case) and running:

sudo yum install --assumeyes --nogpg yumdownloader

Download all the packages that you consider necessary here:

## Common utils that I use
sudo yumdownloader --resolve vim git htop emacs-nox multitail screen

## Those used to compile sugar / artwork / toolkit
sudo yumdownloader --resolve git make alsa-lib-devel gettext-devel \
gobject-introspection-devel gtk3-devel intltool libSM-devel \
librsvg2-devel pygobject2-devel pygtk2-codegen python-devel \
gtk2-devel icon-naming-utils icon-slicer python-empy \
xorg-x11-apps gnome-common GConf2-devel gtksourceview3-devel \
cairo-gobject

Copy all of the packages downloaded to the server:

scp *noarch* humitos@192.168.1.101:/srv/repo/noarch
scp *armv7hl* humitos@192.168.1.101:/srv/repo/armv7hl
scp *i686* humitos@192.168.1.101:/srv/repo/i686

= Create a yum configuration file =

Copy this into a file called: ''/etc/yum.repos.d/local.repo'' (in the XOs)

[SugarRepo]
name=Sugar Repository
baseurl=http://192.168.1.101/repo
gpgcheck=0

= Last step on the server =

createrepo /srv/repo

= References =

* http://ramblings.narrabilis.com/creating-a-yum-repository-repo-and-creating-a-yum-group-to-install-kickstart

User:Humitos/YumRepository

2012-11-12T18:09:43Z

Humitos: /* Create a yum configuration file */

= Create our own yum repository =

This will allow us to download just once the package needed to develop on our XO platform.

= Steps on the server =

sudo yum install nginx createrepo
mkdir -P /srv/repo/i686 /srv/repo/armv7hl /srv/repo/noarch
ln -s /srv/repo /usr/share/nginx/html
sudo service nginx start

= Download packages for all the architectures we want =

I did this by going to each XO (1.5 -i686- and 1.75 -ARM- in my case) and running:

sudo yum install --assumeyes --nogpg yumdownloader

Download all the packages that you consider necessary here:

## Common utils that I use
sudo yumdownloader --resolve vim git htop emacs-nox multitail screen

## Those used to compile sugar / artwork / toolkit
sudo yumdownloader --resolve git make alsa-lib-devel gettext-devel \
gobject-introspection-devel gtk3-devel intltool libSM-devel \
librsvg2-devel pygobject2-devel pygtk2-codegen python-devel \
gtk2-devel icon-naming-utils icon-slicer python-empy \
xorg-x11-apps gnome-common GConf2-devel gtksourceview3-devel \
cairo-gobject

Copy all of the packages downloaded to the server:

scp *noarch* humitos@192.168.1.101:/srv/repo/noarch
scp *armv7hl* humitos@192.168.1.101:/srv/repo/armv7hl
scp *i686* humitos@192.168.1.101:/srv/repo/i686

= Create a yum configuration file =

Copy this into a file called: ''/etc/yum.repos.d/local.repo'' (in the XOs)

[SugarRepo]
name=Sugar Repository
baseurl=http://192.168.1.101/repo
gpgcheck=0

= Last step on the server =

createrepo /srv/repo

= References =

* http://ramblings.narrabilis.com/creating-a-yum-repository-repo-and-creating-a-yum-group-to-install-kickstart

User:Humitos/YumRepository

2012-11-12T18:08:42Z

Humitos: Created page with "= Create our own yum repository = This will allow us to download just once the package needed to develop on our XO platform. = Steps on the server = sudo yum install nginx..."

= Create our own yum repository =

This will allow us to download just once the package needed to develop on our XO platform.

= Steps on the server =

sudo yum install nginx createrepo
mkdir -P /srv/repo/i686 /srv/repo/armv7hl /srv/repo/noarch
ln -s /srv/repo /usr/share/nginx/html
sudo service nginx start

= Download packages for all the architectures we want =

I did this by going to each XO (1.5 -i686- and 1.75 -ARM- in my case) and running:

sudo yum install --assumeyes --nogpg yumdownloader

Download all the packages that you consider necessary here:

## Common utils that I use
sudo yumdownloader --resolve vim git htop emacs-nox multitail screen

## Those used to compile sugar / artwork / toolkit
sudo yumdownloader --resolve git make alsa-lib-devel gettext-devel \
gobject-introspection-devel gtk3-devel intltool libSM-devel \
librsvg2-devel pygobject2-devel pygtk2-codegen python-devel \
gtk2-devel icon-naming-utils icon-slicer python-empy \
xorg-x11-apps gnome-common GConf2-devel gtksourceview3-devel \
cairo-gobject

Copy all of the packages downloaded to the server:

scp *noarch* humitos@192.168.1.101:/srv/repo/noarch
scp *armv7hl* humitos@192.168.1.101:/srv/repo/armv7hl
scp *i686* humitos@192.168.1.101:/srv/repo/i686

= Create a yum configuration file =

Copy this into a file called: ''/etc/yum.repos.d/local.repo''

[SugarRepo]
name=Sugar Repository
baseurl=http://192.168.1.101/repo
gpgcheck=0

= Last step on the server =

createrepo /srv/repo

= References =

* http://ramblings.narrabilis.com/creating-a-yum-repository-repo-and-creating-a-yum-group-to-install-kickstart

User:Humitos/PortingImageViewer

2012-09-25T11:51:05Z

Humitos: Created page with "This page is being performed while I'm porting Image Viewer Activity to Gtk3. There is a [http://bugs.sugarlabs.org/ticket/3958 ticket] with some useful information that I'm ..."

This page is being performed while I'm porting Image Viewer Activity to Gtk3.

There is a [http://bugs.sugarlabs.org/ticket/3958 ticket] with some useful information that I'm using on the porting and to keep tracking this port. Besides, this wiki page will be useful to write some code snippets about what are the difficulties that I'm having on the port and maybe can be useful for someone else.

I will take [[User:Humitos/PortingGetBooks|this guide]] as reference on the Gtk3 porting.

Talk:Features/Display Device

2012-08-21T11:45:01Z

Humitos: Created page with "* How is going to be the interface for change the brightness? a slider? buttons? * How useful is for kids to take a screenshot?"

* How is going to be the interface for change the brightness? a slider? buttons?
* How useful is for kids to take a screenshot?

User:Humitos/TouchTips

2012-08-10T15:14:41Z

Humitos:

Work in progress page to write down some code snippets that I'm finding in the meanwhile.

= Touch and hold =

* '''Browse''': Touch and hold to trigger right click palette (for links, downloading, copy etc)
** http://developer.gnome.org/gdk3/stable/gdk3-Event-Structures.html#GdkEventTouch

I think we should use '''event.touch.sequence''' and look for the GDK_TOUCH_BEGIN and take its ''time''. After that, compare this time with the actual one comming from '''event.touch.time''' and show the palette if it is bigger than 1000 milliseconds for example.

The problem that I'm having is that '''event.touch.sequence''' doesn't tell me about the sequence itself. So, I don't know what was the GDK_TOUCH_BEGIN.

* from #gtk+

(20:46:07) Company: humitos3: you can compare them
(20:46:24) Company: sequence1 == sequence2
(20:46:36) Company: at least it works in C, but i sure hope it does in python, too

(20:54:08) Flyser__: humitos3: sounds like incomplete bindings. you might want to ask in #python or #introspection

User:Humitos/TouchTips

2012-08-10T15:14:26Z

Humitos:

Work in progress page to write down some code snippets that I'm finding in the meanwhile.

= Touch and hold =

* '''Browse''': Touch and hold to trigger right click palette (for links, downloading, copy etc)
** http://developer.gnome.org/gdk3/stable/gdk3-Event-Structures.html#GdkEventTouch

I think we should use '''event.touch.sequence''' and look for the GDK_TOUCH_BEGIN and take its ''time''. After that, compare this time with the actual one comming from '''event.touch.time''' and show the palette if it is bigger than 1000 milliseconds for example.

The problem that I'm having is that '''event.touch.sequence''' doesn't tell me about the sequence itself. So, I don't know what was the GDK_TOUCH_BEGIN.

** from #gtk+

(20:46:07) Company: humitos3: you can compare them
(20:46:24) Company: sequence1 == sequence2
(20:46:36) Company: at least it works in C, but i sure hope it does in python, too

(20:54:08) Flyser__: humitos3: sounds like incomplete bindings. you might want to ask in #python or #introspection

User:Humitos/TouchTips

2012-08-09T23:37:07Z

Humitos: Created page with "Work in progress page to write down some code snippets that I'm finding in the meanwhile. = Touch and hold = * '''Browse''': Touch and hold to trigger right click palette (f..."

Features/GTK3/Porting/Typing Turtle

2012-08-02T15:22:58Z

Humitos: /* Missing / problematic things */

This page is being performed while I'm porting Typing Turtle Activity to Gtk3.

There is a [http://bugs.sugarlabs.org/ticket/3772 ticket] with some useful information that I'm using on the porting and to keep tracking this port. Besides, this wiki page will be useful to write some code snippets about what are the difficulties that I'm having on the port and maybe can be useful for someone else.

I will take [[User:Humitos/PortingGetBooks|this guide]] as reference on the Gtk3 porting.

= Port to Cairo =

'''README''': before to port this activity to GTK3, we should port it to Cairo as the first step and then move to GTK3. Here is the [http://bugs.sugarlabs.org/attachment/ticket/3772/0001-Port-to-Cairo.2.patch PATCH]

== Code Snippets ==

=== Draw a rectangle ===

To draw a rectangle we used to do:

gc = self.window.new_gc()
gc.foreground = self.area.get_colormap().alloc_color(50000, 50000, 50000)
self.area.window.draw_rectangle(gc, True, x, y, w, h)

The arguments for ''alloc_color'' are between 0-65535 and the ''set_source_rgb'' method from cairo are between 0-1, so we have to convert these values as well:

cr.set_source_rgb(0.762, 0.762, 0.762)
cr.rectangle(x, y, w, h)
cr.fill()

Note that the second attributo of ''draw_rectangle'' tells us about if the rectangle is filled or not. In this case is True, so we use ''cr.fill()'' in the new way but if we want just the outside lines of the rectangle we should use ''cr.stroke()''

=== Write some text ===

This is the old way to do it:

title = _('You finished!')
layout = self.area.create_pango_layout(title)
layout.set_font_description(pango.FontDescription('Serif Bold 16'))
size = layout.get_size()
tx = x+w/2-(size[0]/pango.SCALE)/2
ty = y + 100
self.area.window.draw_layout(gc, tx, ty, layout)

and this is the way that I used to do it with pangocairo:

title = _('You finished!')
pango_cr = pangocairo.CairoContext(cr)
pango_cr.set_source_rgb(0, 0, 0)
pango_layout = cr.create_layout()
pango_layout.set_font_description(pango.FontDescription('Serif Bold 16'))
pango_layout.set_text(title)
size = pango_layout.get_size()
tx = x + (w / 2) - (size[0] / pango.SCALE) / 2
ty = y + 100
pango_cr.move_to(tx, ty)
pango_cr.show_layout(pango_layout)
pango_cr.stroke()

=== Draw a line ===

This is the old way:

gc.foreground = self.area.get_colormap().alloc_color(0, 0, 0)
self.area.window.draw_line(gc, int(b.x), int(b.y + b.size / 2),
int(b.x), int(b.y + b.size))

and should be replaced by this new way using cairo

cr.set_source_rgb(0, 0, 0)
cr.move_to(int(b.x), int(b.y + b.size / 2))
cr.line_to(int(b.x), int(b.y + b.size))
cr.stroke()

=== Draw an arc ===

Old way to do it (notice the second argument of ''draw_arc'': '''filled'''):

gc.foreground = self.area.get_colormap().alloc_color(b.color[0],b.color[1],b.color[2])
self.area.window.draw_arc(gc, True, x-b.size/2, y-b.size/2, b.size, b.size, 0, 360*64)

new way:

cr.set_source_rgb(b.color[0], b.color[1], b.color[2])
cr.arc(b.x, b.y, b.size / 2, 0, 2 * math.pi)
cr.fill()

== Tips & tricks ==

=== Convert cairo.Surface to GdkPixbuf ===

import StringIO

surface = cairo.ImageSurface(cairo.FORMAT_RGB24, w, h)
cr = cairo.Context(surface)

[... draw something into the surface ...]

pixbuf_data = StringIO.StringIO()
surface.write_to_png(pixbuf_data)
pxb_loader = gtk.gdk.PixbufLoader(image_type='png')
pxb_loader.write(pixbuf_data.getvalue())
temp_pix = pxb_loader.get_pixbuf()
pxb_loader.close()

=== Paint a GdkPixbuf into the canvas ===

cr.set_source_pixbuf(self.backgroundpixbuf, 0, 0)
cr.rectangle(x, 0, self.backgroundpixbuf.get_width(),
self.backgroundpixbuf.get_height())
cr.paint()

==== Gtk3 version ====

Gdk.cairo_set_source_pixbuf(cr, self.backgroundpixbuf, 0, 0)
cr.rectangle(x, 0, self.backgroundpixbuf.get_width(),
self.backgroundpixbuf.get_height())
cr.paint()

= Port to Gtk3 -> Code Snippets =

== Gtk.TextBuffer ==

self.lessonbuffer = gtk.TextBuffer(self.tagtable)
self.lessontext = gtk.TextView(self.lessonbuffer)

replaced by:

self.lessonbuffer = Gtk.TextBuffer.new(self.tagtable)
self.lessontext = Gtk.TextView.new_with_buffer(self.lessonbuffer)

== Gdk.Event ==

event.state

replaced by:

event.get_state()

== Rsvg ==

import rsvg
image = rsvg.Handle(file=filename)

replaced by:

from gi.repository import Rsvg
image = Rsvg.Handle.new_from_file(filename)

== Gtk.TextTag ==

instructions_tag = Gtk.TextTag('instructions')

replaced by:

instructions_tag = Gtk.TextTag.new('instructions')

== Gdk.Keymap ==

entries = self.keymap.get_entries_for_keyval(keyval)
for e in entries:
e[0], e[1], e[2]

replaced by:

valid, entries = self.keymap.get_entries_for_keyval(keyval)
for e in entries:
e.keycode, e.group, e.level

Every entry was a tuple of (keycode, group, level). Now, this is an object with those attributes.

== GdkPixbuf.PixbufLoader ==

Change this:

pxb_loader = gtk.gdk.PixbufLoader(image_type='png')

by:

pxb_loader = GdkPixbuf.PixbufLoader.new_with_type('png')

== KEY_PRESS ==

This should be done by the '''pygi-convert.sh''' script.

gtk.gdk.KEY_PRESS
gtk.gdk.KEY_RELEASE

replaced by

Gdk.EventType.KEY_PRESS
Gdk.EventType.KEY_RELEASE

== Gdk.Keymap.translate_keyboard_state ==

* http://developer.gnome.org/gdk/stable/gdk-Keyboard-Handling.html#gdk-keymap-translate-keyboard-state
* http://www.pygtk.org/docs/pygtk/class-gdkkeymap.html#method-gdkkeymap--translate-keyboard-state

Old way:

t = self.keymap.translate_keyboard_state(key['key-scan'], self.active_state, self.active_group)

New way:

success, keyval, effective_group, level, consumed_modifiers = \
self.keymap.translate_keyboard_state(key['key-scan'], self.active_state,
self.active_group)

== 'expose-event' & 'draw' event ==

The new ''draw'' event that refers to the old ''expose-event'' into a Gtk.DrawingArea now receive the widget and the context instead the widget and the event:

''expose-event''

def expose_cb(self, area, event):
self.draw()

''draw'' event

def draw_cb(self, area, cr):
self.draw(cr)

= Notes =

* I found this chunk of code in the source (''keyboard.py'' '''L515''') and I didn't understand what it means

# Hack to get the current modifier state - which will not be represented by the event.
state = gtk.gdk.device_get_core_pointer().get_state(self.window)[1]

* I used a HACK related to Pango fonts and DPI:

<pre>
# Set correct DPI for Rsvg and Screen
from gi.repository import PangoCairo

def _get_screen_dpi():
xft_dpi = Gtk.Settings.get_default().get_property('gtk-xft-dpi')
dpi = float(xft_dpi / 1024)
logging.debug('Setting dpi to: %f', dpi)
# HACK: if the DPI detected is 200.0 it seems we are on an XO, so
# we return 133 because the XO manage its resolution in a complex
# way. More information here:
# http://wiki.laptop.org/go/Display
if 200 == int(dpi):
return 133
return dpi

dpi = _get_screen_dpi()
font_map_default = PangoCairo.font_map_get_default()
font_map_default.set_resolution(dpi)
</pre>

= Missing / problematic things =

* [SOLVED] <del>This method, ''set_source_pixbuf'', is not available.</del>

* [SOLVED] <del>We should find the correct way to scale Left and Right hands that are drawn over the keyboard, because I just put values that I thought they were correct. We should calculate them according to the screen</del>

* [SOLVED] <del>PangoCairo fonts are not being drawn because of this: https://bugzilla.gnome.org/show_bug.cgi?id=680680</del>

* [SOLVED] <del>Font Scale is wrong: https://bugzilla.gnome.org/show_bug.cgi?id=680663</del>

* SHIFT and ALT GR keys do not show the correct keys

= Useful links =

* http://cairographics.org/documentation/pycairo/2/index.html
* http://www.pygtk.org/docs/pygtk/pangocairo-class-reference.html
* http://www.pygtk.org/docs/pygtk/class-gdkdrawable.html

Features/GTK3/Porting/Typing Turtle

2012-08-02T14:00:21Z

Humitos: /* Notes */

This page is being performed while I'm porting Typing Turtle Activity to Gtk3.

There is a [http://bugs.sugarlabs.org/ticket/3772 ticket] with some useful information that I'm using on the porting and to keep tracking this port. Besides, this wiki page will be useful to write some code snippets about what are the difficulties that I'm having on the port and maybe can be useful for someone else.

I will take [[User:Humitos/PortingGetBooks|this guide]] as reference on the Gtk3 porting.

= Port to Cairo =

'''README''': before to port this activity to GTK3, we should port it to Cairo as the first step and then move to GTK3. Here is the [http://bugs.sugarlabs.org/attachment/ticket/3772/0001-Port-to-Cairo.2.patch PATCH]

== Code Snippets ==

=== Draw a rectangle ===

To draw a rectangle we used to do:

gc = self.window.new_gc()
gc.foreground = self.area.get_colormap().alloc_color(50000, 50000, 50000)
self.area.window.draw_rectangle(gc, True, x, y, w, h)

The arguments for ''alloc_color'' are between 0-65535 and the ''set_source_rgb'' method from cairo are between 0-1, so we have to convert these values as well:

cr.set_source_rgb(0.762, 0.762, 0.762)
cr.rectangle(x, y, w, h)
cr.fill()

Note that the second attributo of ''draw_rectangle'' tells us about if the rectangle is filled or not. In this case is True, so we use ''cr.fill()'' in the new way but if we want just the outside lines of the rectangle we should use ''cr.stroke()''

=== Write some text ===

This is the old way to do it:

title = _('You finished!')
layout = self.area.create_pango_layout(title)
layout.set_font_description(pango.FontDescription('Serif Bold 16'))
size = layout.get_size()
tx = x+w/2-(size[0]/pango.SCALE)/2
ty = y + 100
self.area.window.draw_layout(gc, tx, ty, layout)

and this is the way that I used to do it with pangocairo:

title = _('You finished!')
pango_cr = pangocairo.CairoContext(cr)
pango_cr.set_source_rgb(0, 0, 0)
pango_layout = cr.create_layout()
pango_layout.set_font_description(pango.FontDescription('Serif Bold 16'))
pango_layout.set_text(title)
size = pango_layout.get_size()
tx = x + (w / 2) - (size[0] / pango.SCALE) / 2
ty = y + 100
pango_cr.move_to(tx, ty)
pango_cr.show_layout(pango_layout)
pango_cr.stroke()

=== Draw a line ===

This is the old way:

gc.foreground = self.area.get_colormap().alloc_color(0, 0, 0)
self.area.window.draw_line(gc, int(b.x), int(b.y + b.size / 2),
int(b.x), int(b.y + b.size))

and should be replaced by this new way using cairo

cr.set_source_rgb(0, 0, 0)
cr.move_to(int(b.x), int(b.y + b.size / 2))
cr.line_to(int(b.x), int(b.y + b.size))
cr.stroke()

=== Draw an arc ===

Old way to do it (notice the second argument of ''draw_arc'': '''filled'''):

gc.foreground = self.area.get_colormap().alloc_color(b.color[0],b.color[1],b.color[2])
self.area.window.draw_arc(gc, True, x-b.size/2, y-b.size/2, b.size, b.size, 0, 360*64)

new way:

cr.set_source_rgb(b.color[0], b.color[1], b.color[2])
cr.arc(b.x, b.y, b.size / 2, 0, 2 * math.pi)
cr.fill()

== Tips & tricks ==

=== Convert cairo.Surface to GdkPixbuf ===

import StringIO

surface = cairo.ImageSurface(cairo.FORMAT_RGB24, w, h)
cr = cairo.Context(surface)

[... draw something into the surface ...]

pixbuf_data = StringIO.StringIO()
surface.write_to_png(pixbuf_data)
pxb_loader = gtk.gdk.PixbufLoader(image_type='png')
pxb_loader.write(pixbuf_data.getvalue())
temp_pix = pxb_loader.get_pixbuf()
pxb_loader.close()

=== Paint a GdkPixbuf into the canvas ===

cr.set_source_pixbuf(self.backgroundpixbuf, 0, 0)
cr.rectangle(x, 0, self.backgroundpixbuf.get_width(),
self.backgroundpixbuf.get_height())
cr.paint()

==== Gtk3 version ====

Gdk.cairo_set_source_pixbuf(cr, self.backgroundpixbuf, 0, 0)
cr.rectangle(x, 0, self.backgroundpixbuf.get_width(),
self.backgroundpixbuf.get_height())
cr.paint()

= Port to Gtk3 -> Code Snippets =

== Gtk.TextBuffer ==

self.lessonbuffer = gtk.TextBuffer(self.tagtable)
self.lessontext = gtk.TextView(self.lessonbuffer)

replaced by:

self.lessonbuffer = Gtk.TextBuffer.new(self.tagtable)
self.lessontext = Gtk.TextView.new_with_buffer(self.lessonbuffer)

== Gdk.Event ==

event.state

replaced by:

event.get_state()

== Rsvg ==

import rsvg
image = rsvg.Handle(file=filename)

replaced by:

from gi.repository import Rsvg
image = Rsvg.Handle.new_from_file(filename)

== Gtk.TextTag ==

instructions_tag = Gtk.TextTag('instructions')

replaced by:

instructions_tag = Gtk.TextTag.new('instructions')

== Gdk.Keymap ==

entries = self.keymap.get_entries_for_keyval(keyval)
for e in entries:
e[0], e[1], e[2]

replaced by:

valid, entries = self.keymap.get_entries_for_keyval(keyval)
for e in entries:
e.keycode, e.group, e.level

Every entry was a tuple of (keycode, group, level). Now, this is an object with those attributes.

== GdkPixbuf.PixbufLoader ==

Change this:

pxb_loader = gtk.gdk.PixbufLoader(image_type='png')

by:

pxb_loader = GdkPixbuf.PixbufLoader.new_with_type('png')

== KEY_PRESS ==

This should be done by the '''pygi-convert.sh''' script.

gtk.gdk.KEY_PRESS
gtk.gdk.KEY_RELEASE

replaced by

Gdk.EventType.KEY_PRESS
Gdk.EventType.KEY_RELEASE

== Gdk.Keymap.translate_keyboard_state ==

* http://developer.gnome.org/gdk/stable/gdk-Keyboard-Handling.html#gdk-keymap-translate-keyboard-state
* http://www.pygtk.org/docs/pygtk/class-gdkkeymap.html#method-gdkkeymap--translate-keyboard-state

Old way:

t = self.keymap.translate_keyboard_state(key['key-scan'], self.active_state, self.active_group)

New way:

success, keyval, effective_group, level, consumed_modifiers = \
self.keymap.translate_keyboard_state(key['key-scan'], self.active_state,
self.active_group)

== 'expose-event' & 'draw' event ==

The new ''draw'' event that refers to the old ''expose-event'' into a Gtk.DrawingArea now receive the widget and the context instead the widget and the event:

''expose-event''

def expose_cb(self, area, event):
self.draw()

''draw'' event

def draw_cb(self, area, cr):
self.draw(cr)

= Notes =

* I found this chunk of code in the source (''keyboard.py'' '''L515''') and I didn't understand what it means

# Hack to get the current modifier state - which will not be represented by the event.
state = gtk.gdk.device_get_core_pointer().get_state(self.window)[1]

* I used a HACK related to Pango fonts and DPI:

<pre>
# Set correct DPI for Rsvg and Screen
from gi.repository import PangoCairo

def _get_screen_dpi():
xft_dpi = Gtk.Settings.get_default().get_property('gtk-xft-dpi')
dpi = float(xft_dpi / 1024)
logging.debug('Setting dpi to: %f', dpi)
# HACK: if the DPI detected is 200.0 it seems we are on an XO, so
# we return 133 because the XO manage its resolution in a complex
# way. More information here:
# http://wiki.laptop.org/go/Display
if 200 == int(dpi):
return 133
return dpi

dpi = _get_screen_dpi()
font_map_default = PangoCairo.font_map_get_default()
font_map_default.set_resolution(dpi)
</pre>

= Missing / problematic things =

* [SOLVED] <del>This method, ''set_source_pixbuf'', is not available.</del>

* [SOLVED] <del>We should find the correct way to scale Left and Right hands that are drawn over the keyboard, because I just put values that I thought they were correct. We should calculate them according to the screen</del>

* [SOLVED] <del>PangoCairo fonts are not being drawn because of this: https://bugzilla.gnome.org/show_bug.cgi?id=680680</del>

* [SOLVED] <del>Font Scale is wrong: https://bugzilla.gnome.org/show_bug.cgi?id=680663</del>

= Useful links =

* http://cairographics.org/documentation/pycairo/2/index.html
* http://www.pygtk.org/docs/pygtk/pangocairo-class-reference.html
* http://www.pygtk.org/docs/pygtk/class-gdkdrawable.html

Features/GTK3/Porting/Typing Turtle

2012-08-02T13:57:50Z

Humitos: /* Gdk.Keymap.translate_keyboard_state */

This page is being performed while I'm porting Typing Turtle Activity to Gtk3.

There is a [http://bugs.sugarlabs.org/ticket/3772 ticket] with some useful information that I'm using on the porting and to keep tracking this port. Besides, this wiki page will be useful to write some code snippets about what are the difficulties that I'm having on the port and maybe can be useful for someone else.

I will take [[User:Humitos/PortingGetBooks|this guide]] as reference on the Gtk3 porting.

= Port to Cairo =

'''README''': before to port this activity to GTK3, we should port it to Cairo as the first step and then move to GTK3. Here is the [http://bugs.sugarlabs.org/attachment/ticket/3772/0001-Port-to-Cairo.2.patch PATCH]

== Code Snippets ==

=== Draw a rectangle ===

To draw a rectangle we used to do:

gc = self.window.new_gc()
gc.foreground = self.area.get_colormap().alloc_color(50000, 50000, 50000)
self.area.window.draw_rectangle(gc, True, x, y, w, h)

The arguments for ''alloc_color'' are between 0-65535 and the ''set_source_rgb'' method from cairo are between 0-1, so we have to convert these values as well:

cr.set_source_rgb(0.762, 0.762, 0.762)
cr.rectangle(x, y, w, h)
cr.fill()

Note that the second attributo of ''draw_rectangle'' tells us about if the rectangle is filled or not. In this case is True, so we use ''cr.fill()'' in the new way but if we want just the outside lines of the rectangle we should use ''cr.stroke()''

=== Write some text ===

This is the old way to do it:

title = _('You finished!')
layout = self.area.create_pango_layout(title)
layout.set_font_description(pango.FontDescription('Serif Bold 16'))
size = layout.get_size()
tx = x+w/2-(size[0]/pango.SCALE)/2
ty = y + 100
self.area.window.draw_layout(gc, tx, ty, layout)

and this is the way that I used to do it with pangocairo:

title = _('You finished!')
pango_cr = pangocairo.CairoContext(cr)
pango_cr.set_source_rgb(0, 0, 0)
pango_layout = cr.create_layout()
pango_layout.set_font_description(pango.FontDescription('Serif Bold 16'))
pango_layout.set_text(title)
size = pango_layout.get_size()
tx = x + (w / 2) - (size[0] / pango.SCALE) / 2
ty = y + 100
pango_cr.move_to(tx, ty)
pango_cr.show_layout(pango_layout)
pango_cr.stroke()

=== Draw a line ===

This is the old way:

gc.foreground = self.area.get_colormap().alloc_color(0, 0, 0)
self.area.window.draw_line(gc, int(b.x), int(b.y + b.size / 2),
int(b.x), int(b.y + b.size))

and should be replaced by this new way using cairo

cr.set_source_rgb(0, 0, 0)
cr.move_to(int(b.x), int(b.y + b.size / 2))
cr.line_to(int(b.x), int(b.y + b.size))
cr.stroke()

=== Draw an arc ===

Old way to do it (notice the second argument of ''draw_arc'': '''filled'''):

gc.foreground = self.area.get_colormap().alloc_color(b.color[0],b.color[1],b.color[2])
self.area.window.draw_arc(gc, True, x-b.size/2, y-b.size/2, b.size, b.size, 0, 360*64)

new way:

cr.set_source_rgb(b.color[0], b.color[1], b.color[2])
cr.arc(b.x, b.y, b.size / 2, 0, 2 * math.pi)
cr.fill()

== Tips & tricks ==

=== Convert cairo.Surface to GdkPixbuf ===

import StringIO

surface = cairo.ImageSurface(cairo.FORMAT_RGB24, w, h)
cr = cairo.Context(surface)

[... draw something into the surface ...]

pixbuf_data = StringIO.StringIO()
surface.write_to_png(pixbuf_data)
pxb_loader = gtk.gdk.PixbufLoader(image_type='png')
pxb_loader.write(pixbuf_data.getvalue())
temp_pix = pxb_loader.get_pixbuf()
pxb_loader.close()

=== Paint a GdkPixbuf into the canvas ===

cr.set_source_pixbuf(self.backgroundpixbuf, 0, 0)
cr.rectangle(x, 0, self.backgroundpixbuf.get_width(),
self.backgroundpixbuf.get_height())
cr.paint()

==== Gtk3 version ====

Gdk.cairo_set_source_pixbuf(cr, self.backgroundpixbuf, 0, 0)
cr.rectangle(x, 0, self.backgroundpixbuf.get_width(),
self.backgroundpixbuf.get_height())
cr.paint()

= Port to Gtk3 -> Code Snippets =

== Gtk.TextBuffer ==

self.lessonbuffer = gtk.TextBuffer(self.tagtable)
self.lessontext = gtk.TextView(self.lessonbuffer)

replaced by:

self.lessonbuffer = Gtk.TextBuffer.new(self.tagtable)
self.lessontext = Gtk.TextView.new_with_buffer(self.lessonbuffer)

== Gdk.Event ==

event.state

replaced by:

event.get_state()

== Rsvg ==

import rsvg
image = rsvg.Handle(file=filename)

replaced by:

from gi.repository import Rsvg
image = Rsvg.Handle.new_from_file(filename)

== Gtk.TextTag ==

instructions_tag = Gtk.TextTag('instructions')

replaced by:

instructions_tag = Gtk.TextTag.new('instructions')

== Gdk.Keymap ==

entries = self.keymap.get_entries_for_keyval(keyval)
for e in entries:
e[0], e[1], e[2]

replaced by:

valid, entries = self.keymap.get_entries_for_keyval(keyval)
for e in entries:
e.keycode, e.group, e.level

Every entry was a tuple of (keycode, group, level). Now, this is an object with those attributes.

== GdkPixbuf.PixbufLoader ==

Change this:

pxb_loader = gtk.gdk.PixbufLoader(image_type='png')

by:

pxb_loader = GdkPixbuf.PixbufLoader.new_with_type('png')

== KEY_PRESS ==

This should be done by the '''pygi-convert.sh''' script.

gtk.gdk.KEY_PRESS
gtk.gdk.KEY_RELEASE

replaced by

Gdk.EventType.KEY_PRESS
Gdk.EventType.KEY_RELEASE

== Gdk.Keymap.translate_keyboard_state ==

* http://developer.gnome.org/gdk/stable/gdk-Keyboard-Handling.html#gdk-keymap-translate-keyboard-state
* http://www.pygtk.org/docs/pygtk/class-gdkkeymap.html#method-gdkkeymap--translate-keyboard-state

Old way:

t = self.keymap.translate_keyboard_state(key['key-scan'], self.active_state, self.active_group)

New way:

success, keyval, effective_group, level, consumed_modifiers = \
self.keymap.translate_keyboard_state(key['key-scan'], self.active_state,
self.active_group)

== 'expose-event' & 'draw' event ==

The new ''draw'' event that refers to the old ''expose-event'' into a Gtk.DrawingArea now receive the widget and the context instead the widget and the event:

''expose-event''

def expose_cb(self, area, event):
self.draw()

''draw'' event

def draw_cb(self, area, cr):
self.draw(cr)

= Notes =

* I found this chunk of code in the source (''keyboard.py'' '''L515''') and I didn't understand what it means

# Hack to get the current modifier state - which will not be represented by the event.
state = gtk.gdk.device_get_core_pointer().get_state(self.window)[1]

= Missing / problematic things =

* [SOLVED] <del>This method, ''set_source_pixbuf'', is not available.</del>

* [SOLVED] <del>We should find the correct way to scale Left and Right hands that are drawn over the keyboard, because I just put values that I thought they were correct. We should calculate them according to the screen</del>

* [SOLVED] <del>PangoCairo fonts are not being drawn because of this: https://bugzilla.gnome.org/show_bug.cgi?id=680680</del>

* [SOLVED] <del>Font Scale is wrong: https://bugzilla.gnome.org/show_bug.cgi?id=680663</del>

= Useful links =

* http://cairographics.org/documentation/pycairo/2/index.html
* http://www.pygtk.org/docs/pygtk/pangocairo-class-reference.html
* http://www.pygtk.org/docs/pygtk/class-gdkdrawable.html

Features/GTK3/Porting/Typing Turtle

2012-08-02T13:57:08Z

Humitos: /* Code Snippets */

This page is being performed while I'm porting Typing Turtle Activity to Gtk3.

There is a [http://bugs.sugarlabs.org/ticket/3772 ticket] with some useful information that I'm using on the porting and to keep tracking this port. Besides, this wiki page will be useful to write some code snippets about what are the difficulties that I'm having on the port and maybe can be useful for someone else.

I will take [[User:Humitos/PortingGetBooks|this guide]] as reference on the Gtk3 porting.

= Port to Cairo =

'''README''': before to port this activity to GTK3, we should port it to Cairo as the first step and then move to GTK3. Here is the [http://bugs.sugarlabs.org/attachment/ticket/3772/0001-Port-to-Cairo.2.patch PATCH]

== Code Snippets ==

=== Draw a rectangle ===

To draw a rectangle we used to do:

gc = self.window.new_gc()
gc.foreground = self.area.get_colormap().alloc_color(50000, 50000, 50000)
self.area.window.draw_rectangle(gc, True, x, y, w, h)

The arguments for ''alloc_color'' are between 0-65535 and the ''set_source_rgb'' method from cairo are between 0-1, so we have to convert these values as well:

cr.set_source_rgb(0.762, 0.762, 0.762)
cr.rectangle(x, y, w, h)
cr.fill()

Note that the second attributo of ''draw_rectangle'' tells us about if the rectangle is filled or not. In this case is True, so we use ''cr.fill()'' in the new way but if we want just the outside lines of the rectangle we should use ''cr.stroke()''

=== Write some text ===

This is the old way to do it:

title = _('You finished!')
layout = self.area.create_pango_layout(title)
layout.set_font_description(pango.FontDescription('Serif Bold 16'))
size = layout.get_size()
tx = x+w/2-(size[0]/pango.SCALE)/2
ty = y + 100
self.area.window.draw_layout(gc, tx, ty, layout)

and this is the way that I used to do it with pangocairo:

title = _('You finished!')
pango_cr = pangocairo.CairoContext(cr)
pango_cr.set_source_rgb(0, 0, 0)
pango_layout = cr.create_layout()
pango_layout.set_font_description(pango.FontDescription('Serif Bold 16'))
pango_layout.set_text(title)
size = pango_layout.get_size()
tx = x + (w / 2) - (size[0] / pango.SCALE) / 2
ty = y + 100
pango_cr.move_to(tx, ty)
pango_cr.show_layout(pango_layout)
pango_cr.stroke()

=== Draw a line ===

This is the old way:

gc.foreground = self.area.get_colormap().alloc_color(0, 0, 0)
self.area.window.draw_line(gc, int(b.x), int(b.y + b.size / 2),
int(b.x), int(b.y + b.size))

and should be replaced by this new way using cairo

cr.set_source_rgb(0, 0, 0)
cr.move_to(int(b.x), int(b.y + b.size / 2))
cr.line_to(int(b.x), int(b.y + b.size))
cr.stroke()

=== Draw an arc ===

Old way to do it (notice the second argument of ''draw_arc'': '''filled'''):

gc.foreground = self.area.get_colormap().alloc_color(b.color[0],b.color[1],b.color[2])
self.area.window.draw_arc(gc, True, x-b.size/2, y-b.size/2, b.size, b.size, 0, 360*64)

new way:

cr.set_source_rgb(b.color[0], b.color[1], b.color[2])
cr.arc(b.x, b.y, b.size / 2, 0, 2 * math.pi)
cr.fill()

== Tips & tricks ==

=== Convert cairo.Surface to GdkPixbuf ===

import StringIO

surface = cairo.ImageSurface(cairo.FORMAT_RGB24, w, h)
cr = cairo.Context(surface)

[... draw something into the surface ...]

pixbuf_data = StringIO.StringIO()
surface.write_to_png(pixbuf_data)
pxb_loader = gtk.gdk.PixbufLoader(image_type='png')
pxb_loader.write(pixbuf_data.getvalue())
temp_pix = pxb_loader.get_pixbuf()
pxb_loader.close()

=== Paint a GdkPixbuf into the canvas ===

cr.set_source_pixbuf(self.backgroundpixbuf, 0, 0)
cr.rectangle(x, 0, self.backgroundpixbuf.get_width(),
self.backgroundpixbuf.get_height())
cr.paint()

==== Gtk3 version ====

Gdk.cairo_set_source_pixbuf(cr, self.backgroundpixbuf, 0, 0)
cr.rectangle(x, 0, self.backgroundpixbuf.get_width(),
self.backgroundpixbuf.get_height())
cr.paint()

= Port to Gtk3 -> Code Snippets =

== Gtk.TextBuffer ==

self.lessonbuffer = gtk.TextBuffer(self.tagtable)
self.lessontext = gtk.TextView(self.lessonbuffer)

replaced by:

self.lessonbuffer = Gtk.TextBuffer.new(self.tagtable)
self.lessontext = Gtk.TextView.new_with_buffer(self.lessonbuffer)

== Gdk.Event ==

event.state

replaced by:

event.get_state()

== Rsvg ==

import rsvg
image = rsvg.Handle(file=filename)

replaced by:

from gi.repository import Rsvg
image = Rsvg.Handle.new_from_file(filename)

== Gtk.TextTag ==

instructions_tag = Gtk.TextTag('instructions')

replaced by:

instructions_tag = Gtk.TextTag.new('instructions')

== Gdk.Keymap ==

entries = self.keymap.get_entries_for_keyval(keyval)
for e in entries:
e[0], e[1], e[2]

replaced by:

valid, entries = self.keymap.get_entries_for_keyval(keyval)
for e in entries:
e.keycode, e.group, e.level

Every entry was a tuple of (keycode, group, level). Now, this is an object with those attributes.

== GdkPixbuf.PixbufLoader ==

Change this:

pxb_loader = gtk.gdk.PixbufLoader(image_type='png')

by:

pxb_loader = GdkPixbuf.PixbufLoader.new_with_type('png')

== KEY_PRESS ==

This should be done by the '''pygi-convert.sh''' script.

gtk.gdk.KEY_PRESS
gtk.gdk.KEY_RELEASE

replaced by

Gdk.EventType.KEY_PRESS
Gdk.EventType.KEY_RELEASE

== Gdk.Keymap.translate_keyboard_state ==

* http://developer.gnome.org/gdk/stable/gdk-Keyboard-Handling.html#gdk-keymap-translate-keyboard-state
* http://www.pygtk.org/docs/pygtk/class-gdkkeymap.html#method-gdkkeymap--translate-keyboard-state

Old way:

t = self.keymap.translate_keyboard_state(key['key-scan'], self.active_state, self.active_group)

New way:

success, keyval, effective_group, level, consumed_modifiers = self.keymap.translate_keyboard_state(key['key-scan'], self.active_state, self.active_group)

== 'expose-event' & 'draw' event ==

The new ''draw'' event that refers to the old ''expose-event'' into a Gtk.DrawingArea now receive the widget and the context instead the widget and the event:

''expose-event''

def expose_cb(self, area, event):
self.draw()

''draw'' event

def draw_cb(self, area, cr):
self.draw(cr)

= Notes =

* I found this chunk of code in the source (''keyboard.py'' '''L515''') and I didn't understand what it means

# Hack to get the current modifier state - which will not be represented by the event.
state = gtk.gdk.device_get_core_pointer().get_state(self.window)[1]

= Missing / problematic things =

* [SOLVED] <del>This method, ''set_source_pixbuf'', is not available.</del>

* [SOLVED] <del>We should find the correct way to scale Left and Right hands that are drawn over the keyboard, because I just put values that I thought they were correct. We should calculate them according to the screen</del>

* [SOLVED] <del>PangoCairo fonts are not being drawn because of this: https://bugzilla.gnome.org/show_bug.cgi?id=680680</del>

* [SOLVED] <del>Font Scale is wrong: https://bugzilla.gnome.org/show_bug.cgi?id=680663</del>

= Useful links =

* http://cairographics.org/documentation/pycairo/2/index.html
* http://www.pygtk.org/docs/pygtk/pangocairo-class-reference.html
* http://www.pygtk.org/docs/pygtk/class-gdkdrawable.html

Features/GTK3/Porting/Typing Turtle

2012-08-02T13:56:26Z

Humitos: /* Port to Cairo */

This page is being performed while I'm porting Typing Turtle Activity to Gtk3.

There is a [http://bugs.sugarlabs.org/ticket/3772 ticket] with some useful information that I'm using on the porting and to keep tracking this port. Besides, this wiki page will be useful to write some code snippets about what are the difficulties that I'm having on the port and maybe can be useful for someone else.

I will take [[User:Humitos/PortingGetBooks|this guide]] as reference on the Gtk3 porting.

= Port to Cairo =

'''README''': before to port this activity to GTK3, we should port it to Cairo as the first step and then move to GTK3. Here is the [http://bugs.sugarlabs.org/attachment/ticket/3772/0001-Port-to-Cairo.2.patch PATCH]

== Code Snippets ==

=== Draw a rectangle ===

To draw a rectangle we used to do:

gc = self.window.new_gc()
gc.foreground = self.area.get_colormap().alloc_color(50000, 50000, 50000)
self.area.window.draw_rectangle(gc, True, x, y, w, h)

The arguments for ''alloc_color'' are between 0-65535 and the ''set_source_rgb'' method from cairo are between 0-1, so we have to convert these values as well:

cr.set_source_rgb(0.762, 0.762, 0.762)
cr.rectangle(x, y, w, h)
cr.fill()

Note that the second attributo of ''draw_rectangle'' tells us about if the rectangle is filled or not. In this case is True, so we use ''cr.fill()'' in the new way but if we want just the outside lines of the rectangle we should use ''cr.stroke()''

=== Write some text ===

This is the old way to do it:

title = _('You finished!')
layout = self.area.create_pango_layout(title)
layout.set_font_description(pango.FontDescription('Serif Bold 16'))
size = layout.get_size()
tx = x+w/2-(size[0]/pango.SCALE)/2
ty = y + 100
self.area.window.draw_layout(gc, tx, ty, layout)

and this is the way that I used to do it with pangocairo:

title = _('You finished!')
pango_cr = pangocairo.CairoContext(cr)
pango_cr.set_source_rgb(0, 0, 0)
pango_layout = cr.create_layout()
pango_layout.set_font_description(pango.FontDescription('Serif Bold 16'))
pango_layout.set_text(title)
size = pango_layout.get_size()
tx = x + (w / 2) - (size[0] / pango.SCALE) / 2
ty = y + 100
pango_cr.move_to(tx, ty)
pango_cr.show_layout(pango_layout)
pango_cr.stroke()

=== Draw a line ===

This is the old way:

gc.foreground = self.area.get_colormap().alloc_color(0, 0, 0)
self.area.window.draw_line(gc, int(b.x), int(b.y + b.size / 2),
int(b.x), int(b.y + b.size))

and should be replaced by this new way using cairo

cr.set_source_rgb(0, 0, 0)
cr.move_to(int(b.x), int(b.y + b.size / 2))
cr.line_to(int(b.x), int(b.y + b.size))
cr.stroke()

=== Draw an arc ===

Old way to do it (notice the second argument of ''draw_arc'': '''filled'''):

gc.foreground = self.area.get_colormap().alloc_color(b.color[0],b.color[1],b.color[2])
self.area.window.draw_arc(gc, True, x-b.size/2, y-b.size/2, b.size, b.size, 0, 360*64)

new way:

cr.set_source_rgb(b.color[0], b.color[1], b.color[2])
cr.arc(b.x, b.y, b.size / 2, 0, 2 * math.pi)
cr.fill()

== Tips & tricks ==

=== Convert cairo.Surface to GdkPixbuf ===

import StringIO

surface = cairo.ImageSurface(cairo.FORMAT_RGB24, w, h)
cr = cairo.Context(surface)

[... draw something into the surface ...]

pixbuf_data = StringIO.StringIO()
surface.write_to_png(pixbuf_data)
pxb_loader = gtk.gdk.PixbufLoader(image_type='png')
pxb_loader.write(pixbuf_data.getvalue())
temp_pix = pxb_loader.get_pixbuf()
pxb_loader.close()

=== Paint a GdkPixbuf into the canvas ===

cr.set_source_pixbuf(self.backgroundpixbuf, 0, 0)
cr.rectangle(x, 0, self.backgroundpixbuf.get_width(),
self.backgroundpixbuf.get_height())
cr.paint()

==== Gtk3 version ====

Gdk.cairo_set_source_pixbuf(cr, self.backgroundpixbuf, 0, 0)
cr.rectangle(x, 0, self.backgroundpixbuf.get_width(),
self.backgroundpixbuf.get_height())
cr.paint()

= Code Snippets =

== Gtk.TextBuffer ==

self.lessonbuffer = gtk.TextBuffer(self.tagtable)
self.lessontext = gtk.TextView(self.lessonbuffer)

replaced by:

self.lessonbuffer = Gtk.TextBuffer.new(self.tagtable)
self.lessontext = Gtk.TextView.new_with_buffer(self.lessonbuffer)

== Gdk.Event ==

event.state

replaced by:

event.get_state()

== Rsvg ==

import rsvg
image = rsvg.Handle(file=filename)

replaced by:

from gi.repository import Rsvg
image = Rsvg.Handle.new_from_file(filename)

== Gtk.TextTag ==

instructions_tag = Gtk.TextTag('instructions')

replaced by:

instructions_tag = Gtk.TextTag.new('instructions')

== Gdk.Keymap ==

entries = self.keymap.get_entries_for_keyval(keyval)
for e in entries:
e[0], e[1], e[2]

replaced by:

valid, entries = self.keymap.get_entries_for_keyval(keyval)
for e in entries:
e.keycode, e.group, e.level

Every entry was a tuple of (keycode, group, level). Now, this is an object with those attributes.

== GdkPixbuf.PixbufLoader ==

Change this:

pxb_loader = gtk.gdk.PixbufLoader(image_type='png')

by:

pxb_loader = GdkPixbuf.PixbufLoader.new_with_type('png')

== KEY_PRESS ==

This should be done by the '''pygi-convert.sh''' script.

gtk.gdk.KEY_PRESS
gtk.gdk.KEY_RELEASE

replaced by

Gdk.EventType.KEY_PRESS
Gdk.EventType.KEY_RELEASE

== Gdk.Keymap.translate_keyboard_state ==

* http://developer.gnome.org/gdk/stable/gdk-Keyboard-Handling.html#gdk-keymap-translate-keyboard-state
* http://www.pygtk.org/docs/pygtk/class-gdkkeymap.html#method-gdkkeymap--translate-keyboard-state

Old way:

t = self.keymap.translate_keyboard_state(key['key-scan'], self.active_state, self.active_group)

New way:

success, keyval, effective_group, level, consumed_modifiers = self.keymap.translate_keyboard_state(key['key-scan'], self.active_state, self.active_group)

== 'expose-event' & 'draw' event ==

The new ''draw'' event that refers to the old ''expose-event'' into a Gtk.DrawingArea now receive the widget and the context instead the widget and the event:

''expose-event''

def expose_cb(self, area, event):
self.draw()

''draw'' event

def draw_cb(self, area, cr):
self.draw(cr)

= Notes =

* I found this chunk of code in the source (''keyboard.py'' '''L515''') and I didn't understand what it means

# Hack to get the current modifier state - which will not be represented by the event.
state = gtk.gdk.device_get_core_pointer().get_state(self.window)[1]

= Missing / problematic things =

* [SOLVED] <del>This method, ''set_source_pixbuf'', is not available.</del>

* [SOLVED] <del>We should find the correct way to scale Left and Right hands that are drawn over the keyboard, because I just put values that I thought they were correct. We should calculate them according to the screen</del>

* [SOLVED] <del>PangoCairo fonts are not being drawn because of this: https://bugzilla.gnome.org/show_bug.cgi?id=680680</del>

* [SOLVED] <del>Font Scale is wrong: https://bugzilla.gnome.org/show_bug.cgi?id=680663</del>

= Useful links =

* http://cairographics.org/documentation/pycairo/2/index.html
* http://www.pygtk.org/docs/pygtk/pangocairo-class-reference.html
* http://www.pygtk.org/docs/pygtk/class-gdkdrawable.html

Features/GTK3/Porting/Typing Turtle

2012-08-02T13:56:06Z

Humitos:

This page is being performed while I'm porting Typing Turtle Activity to Gtk3.

There is a [http://bugs.sugarlabs.org/ticket/3772 ticket] with some useful information that I'm using on the porting and to keep tracking this port. Besides, this wiki page will be useful to write some code snippets about what are the difficulties that I'm having on the port and maybe can be useful for someone else.

I will take [[User:Humitos/PortingGetBooks|this guide]] as reference on the Gtk3 porting.

= Port to Cairo =

'''README''': before to port this activity to GTK3, we should port it to Cairo as the first step and then move to GTK3. Here is the [PATCH http://bugs.sugarlabs.org/attachment/ticket/3772/0001-Port-to-Cairo.2.patch]

== Code Snippets ==

=== Draw a rectangle ===

To draw a rectangle we used to do:

gc = self.window.new_gc()
gc.foreground = self.area.get_colormap().alloc_color(50000, 50000, 50000)
self.area.window.draw_rectangle(gc, True, x, y, w, h)

The arguments for ''alloc_color'' are between 0-65535 and the ''set_source_rgb'' method from cairo are between 0-1, so we have to convert these values as well:

cr.set_source_rgb(0.762, 0.762, 0.762)
cr.rectangle(x, y, w, h)
cr.fill()

Note that the second attributo of ''draw_rectangle'' tells us about if the rectangle is filled or not. In this case is True, so we use ''cr.fill()'' in the new way but if we want just the outside lines of the rectangle we should use ''cr.stroke()''

=== Write some text ===

This is the old way to do it:

title = _('You finished!')
layout = self.area.create_pango_layout(title)
layout.set_font_description(pango.FontDescription('Serif Bold 16'))
size = layout.get_size()
tx = x+w/2-(size[0]/pango.SCALE)/2
ty = y + 100
self.area.window.draw_layout(gc, tx, ty, layout)

and this is the way that I used to do it with pangocairo:

title = _('You finished!')
pango_cr = pangocairo.CairoContext(cr)
pango_cr.set_source_rgb(0, 0, 0)
pango_layout = cr.create_layout()
pango_layout.set_font_description(pango.FontDescription('Serif Bold 16'))
pango_layout.set_text(title)
size = pango_layout.get_size()
tx = x + (w / 2) - (size[0] / pango.SCALE) / 2
ty = y + 100
pango_cr.move_to(tx, ty)
pango_cr.show_layout(pango_layout)
pango_cr.stroke()

=== Draw a line ===

This is the old way:

gc.foreground = self.area.get_colormap().alloc_color(0, 0, 0)
self.area.window.draw_line(gc, int(b.x), int(b.y + b.size / 2),
int(b.x), int(b.y + b.size))

and should be replaced by this new way using cairo

cr.set_source_rgb(0, 0, 0)
cr.move_to(int(b.x), int(b.y + b.size / 2))
cr.line_to(int(b.x), int(b.y + b.size))
cr.stroke()

=== Draw an arc ===

Old way to do it (notice the second argument of ''draw_arc'': '''filled'''):

gc.foreground = self.area.get_colormap().alloc_color(b.color[0],b.color[1],b.color[2])
self.area.window.draw_arc(gc, True, x-b.size/2, y-b.size/2, b.size, b.size, 0, 360*64)

new way:

cr.set_source_rgb(b.color[0], b.color[1], b.color[2])
cr.arc(b.x, b.y, b.size / 2, 0, 2 * math.pi)
cr.fill()

== Tips & tricks ==

=== Convert cairo.Surface to GdkPixbuf ===

import StringIO

surface = cairo.ImageSurface(cairo.FORMAT_RGB24, w, h)
cr = cairo.Context(surface)

[... draw something into the surface ...]

pixbuf_data = StringIO.StringIO()
surface.write_to_png(pixbuf_data)
pxb_loader = gtk.gdk.PixbufLoader(image_type='png')
pxb_loader.write(pixbuf_data.getvalue())
temp_pix = pxb_loader.get_pixbuf()
pxb_loader.close()

=== Paint a GdkPixbuf into the canvas ===

cr.set_source_pixbuf(self.backgroundpixbuf, 0, 0)
cr.rectangle(x, 0, self.backgroundpixbuf.get_width(),
self.backgroundpixbuf.get_height())
cr.paint()

==== Gtk3 version ====

Gdk.cairo_set_source_pixbuf(cr, self.backgroundpixbuf, 0, 0)
cr.rectangle(x, 0, self.backgroundpixbuf.get_width(),
self.backgroundpixbuf.get_height())
cr.paint()

= Code Snippets =

== Gtk.TextBuffer ==

self.lessonbuffer = gtk.TextBuffer(self.tagtable)
self.lessontext = gtk.TextView(self.lessonbuffer)

replaced by:

self.lessonbuffer = Gtk.TextBuffer.new(self.tagtable)
self.lessontext = Gtk.TextView.new_with_buffer(self.lessonbuffer)

== Gdk.Event ==

event.state

replaced by:

event.get_state()

== Rsvg ==

import rsvg
image = rsvg.Handle(file=filename)

replaced by:

from gi.repository import Rsvg
image = Rsvg.Handle.new_from_file(filename)

== Gtk.TextTag ==

instructions_tag = Gtk.TextTag('instructions')

replaced by:

instructions_tag = Gtk.TextTag.new('instructions')

== Gdk.Keymap ==

entries = self.keymap.get_entries_for_keyval(keyval)
for e in entries:
e[0], e[1], e[2]

replaced by:

valid, entries = self.keymap.get_entries_for_keyval(keyval)
for e in entries:
e.keycode, e.group, e.level

Every entry was a tuple of (keycode, group, level). Now, this is an object with those attributes.

== GdkPixbuf.PixbufLoader ==

Change this:

pxb_loader = gtk.gdk.PixbufLoader(image_type='png')

by:

pxb_loader = GdkPixbuf.PixbufLoader.new_with_type('png')

== KEY_PRESS ==

This should be done by the '''pygi-convert.sh''' script.

gtk.gdk.KEY_PRESS
gtk.gdk.KEY_RELEASE

replaced by

Gdk.EventType.KEY_PRESS
Gdk.EventType.KEY_RELEASE

== Gdk.Keymap.translate_keyboard_state ==

* http://developer.gnome.org/gdk/stable/gdk-Keyboard-Handling.html#gdk-keymap-translate-keyboard-state
* http://www.pygtk.org/docs/pygtk/class-gdkkeymap.html#method-gdkkeymap--translate-keyboard-state

Old way:

t = self.keymap.translate_keyboard_state(key['key-scan'], self.active_state, self.active_group)

New way:

success, keyval, effective_group, level, consumed_modifiers = self.keymap.translate_keyboard_state(key['key-scan'], self.active_state, self.active_group)

== 'expose-event' & 'draw' event ==

The new ''draw'' event that refers to the old ''expose-event'' into a Gtk.DrawingArea now receive the widget and the context instead the widget and the event:

''expose-event''

def expose_cb(self, area, event):
self.draw()

''draw'' event

def draw_cb(self, area, cr):
self.draw(cr)

= Notes =

* I found this chunk of code in the source (''keyboard.py'' '''L515''') and I didn't understand what it means

# Hack to get the current modifier state - which will not be represented by the event.
state = gtk.gdk.device_get_core_pointer().get_state(self.window)[1]

= Missing / problematic things =

* [SOLVED] <del>This method, ''set_source_pixbuf'', is not available.</del>

* [SOLVED] <del>We should find the correct way to scale Left and Right hands that are drawn over the keyboard, because I just put values that I thought they were correct. We should calculate them according to the screen</del>

* [SOLVED] <del>PangoCairo fonts are not being drawn because of this: https://bugzilla.gnome.org/show_bug.cgi?id=680680</del>

* [SOLVED] <del>Font Scale is wrong: https://bugzilla.gnome.org/show_bug.cgi?id=680663</del>

= Useful links =

* http://cairographics.org/documentation/pycairo/2/index.html
* http://www.pygtk.org/docs/pygtk/pangocairo-class-reference.html
* http://www.pygtk.org/docs/pygtk/class-gdkdrawable.html

Features/GTK3/Porting/Typing Turtle

2012-07-31T15:12:28Z

Humitos: /* KEY_PRESS */

This page is being performed while I'm porting Typing Turtle Activity to Gtk3.

There is a [http://bugs.sugarlabs.org/ticket/3772 ticket] with some useful information that I'm using on the porting and to keep tracking this port. Besides, this wiki page will be useful to write some code snippets about what are the difficulties that I'm having on the port and maybe can be useful for someone else.

I will take [[User:Humitos/PortingGetBooks|this guide]] as reference on the Gtk3 porting.

= Port to Cairo =

'''README''': before to port this activity to GTK3, we should port it to Cairo as the first step and then move to GTK3.

== Code Snippets ==

=== Draw a rectangle ===

To draw a rectangle we used to do:

gc = self.window.new_gc()
gc.foreground = self.area.get_colormap().alloc_color(50000, 50000, 50000)
self.area.window.draw_rectangle(gc, True, x, y, w, h)

The arguments for ''alloc_color'' are between 0-65535 and the ''set_source_rgb'' method from cairo are between 0-1, so we have to convert these values as well:

cr.set_source_rgb(0.762, 0.762, 0.762)
cr.rectangle(x, y, w, h)
cr.fill()

Note that the second attributo of ''draw_rectangle'' tells us about if the rectangle is filled or not. In this case is True, so we use ''cr.fill()'' in the new way but if we want just the outside lines of the rectangle we should use ''cr.stroke()''

=== Write some text ===

This is the old way to do it:

title = _('You finished!')
layout = self.area.create_pango_layout(title)
layout.set_font_description(pango.FontDescription('Serif Bold 16'))
size = layout.get_size()
tx = x+w/2-(size[0]/pango.SCALE)/2
ty = y + 100
self.area.window.draw_layout(gc, tx, ty, layout)

and this is the way that I used to do it with pangocairo:

title = _('You finished!')
pango_cr = pangocairo.CairoContext(cr)
pango_cr.set_source_rgb(0, 0, 0)
pango_layout = cr.create_layout()
pango_layout.set_font_description(pango.FontDescription('Serif Bold 16'))
pango_layout.set_text(title)
size = pango_layout.get_size()
tx = x + (w / 2) - (size[0] / pango.SCALE) / 2
ty = y + 100
pango_cr.move_to(tx, ty)
pango_cr.show_layout(pango_layout)
pango_cr.stroke()

=== Draw a line ===

This is the old way:

gc.foreground = self.area.get_colormap().alloc_color(0, 0, 0)
self.area.window.draw_line(gc, int(b.x), int(b.y + b.size / 2),
int(b.x), int(b.y + b.size))

and should be replaced by this new way using cairo

cr.set_source_rgb(0, 0, 0)
cr.move_to(int(b.x), int(b.y + b.size / 2))
cr.line_to(int(b.x), int(b.y + b.size))
cr.stroke()

=== Draw an arc ===

Old way to do it (notice the second argument of ''draw_arc'': '''filled'''):

gc.foreground = self.area.get_colormap().alloc_color(b.color[0],b.color[1],b.color[2])
self.area.window.draw_arc(gc, True, x-b.size/2, y-b.size/2, b.size, b.size, 0, 360*64)

new way:

cr.set_source_rgb(b.color[0], b.color[1], b.color[2])
cr.arc(b.x, b.y, b.size / 2, 0, 2 * math.pi)
cr.fill()

== Tips & tricks ==

=== Convert cairo.Surface to GdkPixbuf ===

import StringIO

surface = cairo.ImageSurface(cairo.FORMAT_RGB24, w, h)
cr = cairo.Context(surface)

[... draw something into the surface ...]

pixbuf_data = StringIO.StringIO()
surface.write_to_png(pixbuf_data)
pxb_loader = gtk.gdk.PixbufLoader(image_type='png')
pxb_loader.write(pixbuf_data.getvalue())
temp_pix = pxb_loader.get_pixbuf()
pxb_loader.close()

=== Paint a GdkPixbuf into the canvas ===

cr.set_source_pixbuf(self.backgroundpixbuf, 0, 0)
cr.rectangle(x, 0, self.backgroundpixbuf.get_width(),
self.backgroundpixbuf.get_height())
cr.paint()

= Code Snippets =

== Gtk.TextBuffer ==

self.lessonbuffer = gtk.TextBuffer(self.tagtable)
self.lessontext = gtk.TextView(self.lessonbuffer)

replaced by:

self.lessonbuffer = Gtk.TextBuffer.new(self.tagtable)
self.lessontext = Gtk.TextView.new_with_buffer(self.lessonbuffer)

== Gdk.Event ==

event.state

replaced by:

event.get_state()

== Rsvg ==

import rsvg
image = rsvg.Handle(file=filename)

replaced by:

from gi.repository import Rsvg
image = Rsvg.Handle.new_from_file(filename)

== Gtk.TextTag ==

instructions_tag = Gtk.TextTag('instructions')

replaced by:

instructions_tag = Gtk.TextTag.new('instructions')

== Gdk.Keymap ==

entries = self.keymap.get_entries_for_keyval(keyval)
for e in entries:
e[0], e[1], e[2]

replaced by:

valid, entries = self.keymap.get_entries_for_keyval(keyval)
for e in entries:
e.keycode, e.group, e.level

Every entry was a tuple of (keycode, group, level). Now, this is an object with those attributes.

== GdkPixbuf.PixbufLoader ==

Change this:

pxb_loader = gtk.gdk.PixbufLoader(image_type='png')

by:

pxb_loader = GdkPixbuf.PixbufLoader.new_with_type('png')

== KEY_PRESS ==

This should be done by the '''pygi-convert.sh''' script.

gtk.gdk.KEY_PRESS
gtk.gdk.KEY_RELEASE

replaced by

Gdk.EventType.KEY_PRESS
Gdk.EventType.KEY_RELEASE

----

* http://developer.gnome.org/gdk/stable/gdk-Keyboard-Handling.html#gdk-keymap-translate-keyboard-state
* http://www.pygtk.org/docs/pygtk/class-gdkkeymap.html#method-gdkkeymap--translate-keyboard-state

----

- def expose_cb(self, area, event):
- self.draw()
+ def draw_cb(self, area, cr):
+ self.draw(cr)

= Notes =

* I found this chunk of code in the source (''keyboard.py'' '''L515''') and I didn't understand what it means

# Hack to get the current modifier state - which will not be represented by the event.
state = gtk.gdk.device_get_core_pointer().get_state(self.window)[1]

= Missing / problematic things =

* [SOLVED] <del>This method, ''set_source_pixbuf'', is not available.</del>

cr = self.get_window().cairo_create()
# README: http://developer.gnome.org/gdk/stable/gdk-Cairo-Interaction.html#gdk-cairo-set-source-pixbuf
# Although this methos is not available in Python
cr.set_source_pixbuf(self.backgroundpixbuf, 0, 0)

Gdk.cairo_set_source_pixbuf(cr, self.backgroundpixbuf, 0, 0)

* We should find the correct way to scale Left and Right hands that are drawn over the keyboard, because I just put values that I thought they were correct. We should calculate them according to the screen

* PangoCairo fonts are not being drawn because of this: https://bugzilla.gnome.org/show_bug.cgi?id=680680

* Font Scale is wrong: https://bugzilla.gnome.org/show_bug.cgi?id=680663

= Useful links =

* http://cairographics.org/documentation/pycairo/2/index.html
* http://www.pygtk.org/docs/pygtk/pangocairo-class-reference.html
* http://www.pygtk.org/docs/pygtk/class-gdkdrawable.html

Features/GTK3/Porting/Typing Turtle

2012-07-31T10:44:52Z

Humitos: /* KEY_PRESS */

This page is being performed while I'm porting Typing Turtle Activity to Gtk3.

There is a [http://bugs.sugarlabs.org/ticket/3772 ticket] with some useful information that I'm using on the porting and to keep tracking this port. Besides, this wiki page will be useful to write some code snippets about what are the difficulties that I'm having on the port and maybe can be useful for someone else.

I will take [[User:Humitos/PortingGetBooks|this guide]] as reference on the Gtk3 porting.

= Port to Cairo =

'''README''': before to port this activity to GTK3, we should port it to Cairo as the first step and then move to GTK3.

== Code Snippets ==

=== Draw a rectangle ===

To draw a rectangle we used to do:

gc = self.window.new_gc()
gc.foreground = self.area.get_colormap().alloc_color(50000, 50000, 50000)
self.area.window.draw_rectangle(gc, True, x, y, w, h)

The arguments for ''alloc_color'' are between 0-65535 and the ''set_source_rgb'' method from cairo are between 0-1, so we have to convert these values as well:

cr.set_source_rgb(0.762, 0.762, 0.762)
cr.rectangle(x, y, w, h)
cr.fill()

Note that the second attributo of ''draw_rectangle'' tells us about if the rectangle is filled or not. In this case is True, so we use ''cr.fill()'' in the new way but if we want just the outside lines of the rectangle we should use ''cr.stroke()''

=== Write some text ===

This is the old way to do it:

title = _('You finished!')
layout = self.area.create_pango_layout(title)
layout.set_font_description(pango.FontDescription('Serif Bold 16'))
size = layout.get_size()
tx = x+w/2-(size[0]/pango.SCALE)/2
ty = y + 100
self.area.window.draw_layout(gc, tx, ty, layout)

and this is the way that I used to do it with pangocairo:

title = _('You finished!')
pango_cr = pangocairo.CairoContext(cr)
pango_cr.set_source_rgb(0, 0, 0)
pango_layout = cr.create_layout()
pango_layout.set_font_description(pango.FontDescription('Serif Bold 16'))
pango_layout.set_text(title)
size = pango_layout.get_size()
tx = x + (w / 2) - (size[0] / pango.SCALE) / 2
ty = y + 100
pango_cr.move_to(tx, ty)
pango_cr.show_layout(pango_layout)
pango_cr.stroke()

=== Draw a line ===

This is the old way:

gc.foreground = self.area.get_colormap().alloc_color(0, 0, 0)
self.area.window.draw_line(gc, int(b.x), int(b.y + b.size / 2),
int(b.x), int(b.y + b.size))

and should be replaced by this new way using cairo

cr.set_source_rgb(0, 0, 0)
cr.move_to(int(b.x), int(b.y + b.size / 2))
cr.line_to(int(b.x), int(b.y + b.size))
cr.stroke()

=== Draw an arc ===

Old way to do it (notice the second argument of ''draw_arc'': '''filled'''):

gc.foreground = self.area.get_colormap().alloc_color(b.color[0],b.color[1],b.color[2])
self.area.window.draw_arc(gc, True, x-b.size/2, y-b.size/2, b.size, b.size, 0, 360*64)

new way:

cr.set_source_rgb(b.color[0], b.color[1], b.color[2])
cr.arc(b.x, b.y, b.size / 2, 0, 2 * math.pi)
cr.fill()

== Tips & tricks ==

=== Convert cairo.Surface to GdkPixbuf ===

import StringIO

surface = cairo.ImageSurface(cairo.FORMAT_RGB24, w, h)
cr = cairo.Context(surface)

[... draw something into the surface ...]

pixbuf_data = StringIO.StringIO()
surface.write_to_png(pixbuf_data)
pxb_loader = gtk.gdk.PixbufLoader(image_type='png')
pxb_loader.write(pixbuf_data.getvalue())
temp_pix = pxb_loader.get_pixbuf()
pxb_loader.close()

=== Paint a GdkPixbuf into the canvas ===

cr.set_source_pixbuf(self.backgroundpixbuf, 0, 0)
cr.rectangle(x, 0, self.backgroundpixbuf.get_width(),
self.backgroundpixbuf.get_height())
cr.paint()

= Code Snippets =

== Gtk.TextBuffer ==

self.lessonbuffer = gtk.TextBuffer(self.tagtable)
self.lessontext = gtk.TextView(self.lessonbuffer)

replaced by:

self.lessonbuffer = Gtk.TextBuffer.new(self.tagtable)
self.lessontext = Gtk.TextView.new_with_buffer(self.lessonbuffer)

== Gdk.Event ==

event.state

replaced by:

event.get_state()

== Rsvg ==

import rsvg
image = rsvg.Handle(file=filename)

replaced by:

from gi.repository import Rsvg
image = Rsvg.Handle.new_from_file(filename)

== Gtk.TextTag ==

instructions_tag = Gtk.TextTag('instructions')

replaced by:

instructions_tag = Gtk.TextTag.new('instructions')

== Gdk.Keymap ==

entries = self.keymap.get_entries_for_keyval(keyval)
for e in entries:
e[0], e[1], e[2]

replaced by:

valid, entries = self.keymap.get_entries_for_keyval(keyval)
for e in entries:
e.keycode, e.group, e.level

Every entry was a tuple of (keycode, group, level). Now, this is an object with those attributes.

== GdkPixbuf.PixbufLoader ==

Change this:

pxb_loader = gtk.gdk.PixbufLoader(image_type='png')

by:

pxb_loader = GdkPixbuf.PixbufLoader.new_with_type('png')

== KEY_PRESS ==

This should be done by the '''pygi-convert.sh''' script.

gtk.gdk.KEY_PRESS
gtk.gdk.KEY_RELEASE

replaced by

Gdk.EventType.KEY_PRESS
Gdk.EventType.KEY_RELEASE

----

* http://developer.gnome.org/gdk/stable/gdk-Keyboard-Handling.html#gdk-keymap-translate-keyboard-state
* http://www.pygtk.org/docs/pygtk/class-gdkkeymap.html#method-gdkkeymap--translate-keyboard-state

= Notes =

* I found this chunk of code in the source (''keyboard.py'' '''L515''') and I didn't understand what it means

# Hack to get the current modifier state - which will not be represented by the event.
state = gtk.gdk.device_get_core_pointer().get_state(self.window)[1]

= Missing / problematic things =

* [SOLVED] <del>This method, ''set_source_pixbuf'', is not available.</del>

cr = self.get_window().cairo_create()
# README: http://developer.gnome.org/gdk/stable/gdk-Cairo-Interaction.html#gdk-cairo-set-source-pixbuf
# Although this methos is not available in Python
cr.set_source_pixbuf(self.backgroundpixbuf, 0, 0)

Gdk.cairo_set_source_pixbuf(cr, self.backgroundpixbuf, 0, 0)

* We should find the correct way to scale Left and Right hands that are drawn over the keyboard, because I just put values that I thought they were correct. We should calculate them according to the screen

* PangoCairo fonts are not being drawn because of this: https://bugzilla.gnome.org/show_bug.cgi?id=680680

* Font Scale is wrong: https://bugzilla.gnome.org/show_bug.cgi?id=680663

= Useful links =

* http://cairographics.org/documentation/pycairo/2/index.html
* http://www.pygtk.org/docs/pygtk/pangocairo-class-reference.html
* http://www.pygtk.org/docs/pygtk/class-gdkdrawable.html

User:Humitos/PyGObjectIssues

2012-07-27T18:24:17Z

Humitos:

Here are listed all the bugs that we fund into PyGObject while we were porting activities to Gtk3:

* DPI fonts in PangoCairo: https://bugzilla.gnome.org/show_bug.cgi?id=680663
** Daniel, Martin and I were working on this and Martin told me about trying 133 as the "magic" dpi number. It worked, but Daniel told us that it's not the right way to move on. So we are trying to change the way that we were creating the Pango Layout using:

cr = drawable.get_window().cairo_create()
drawable.create_pango_layout(cairo_context)

instead of:

cr = drawable.get_window().cairo_create()
pango_layout = PangoCairo.create_layout(cr)

I'm not sure if this is definetly solution.

* Reading an image from XPM data: https://bugzilla.gnome.org/show_bug.cgi?id=651962
* GtkTreeModelSort: https://bugzilla.gnome.org/show_bug.cgi?id=680009
* GtkTextIter: https://bugzilla.gnome.org/show_bug.cgi?id=680597
* Insert a GtkTreeView column with attributes: https://bugzilla.gnome.org/show_bug.cgi?id=679415
* Vte.get_text https://bugzilla.gnome.org/show_bug.cgi?id=676999 | https://bugzilla.gnome.org/show_bug.cgi?id=677000
* Webkit: Double scrollbar in Google Apps: https://bugzilla.gnome.org/show_bug.cgi?id=676982
* It's already solved but it is not applied on my F17 package (I think): https://bugzilla.gnome.org/show_bug.cgi?id=674968

User:Humitos/PyGObjectIssues

2012-07-27T18:21:07Z

Humitos: Created page with "Here are listed all the bugs that we fund into PyGObject while we were porting activities to Gtk3: * DPI fonts in PangoCairo: https://bugzilla.gnome.org/show_bug.cgi?id=68066..."

Features/GTK3/Porting/Typing Turtle

2012-07-27T11:48:59Z

Humitos: /* Missing / problematic things */

This page is being performed while I'm porting Typing Turtle Activity to Gtk3.

There is a [http://bugs.sugarlabs.org/ticket/3772 ticket] with some useful information that I'm using on the porting and to keep tracking this port. Besides, this wiki page will be useful to write some code snippets about what are the difficulties that I'm having on the port and maybe can be useful for someone else.

I will take [[User:Humitos/PortingGetBooks|this guide]] as reference on the Gtk3 porting.

= Port to Cairo =

'''README''': before to port this activity to GTK3, we should port it to Cairo as the first step and then move to GTK3.

== Code Snippets ==

=== Draw a rectangle ===

To draw a rectangle we used to do:

gc = self.window.new_gc()
gc.foreground = self.area.get_colormap().alloc_color(50000, 50000, 50000)
self.area.window.draw_rectangle(gc, True, x, y, w, h)

The arguments for ''alloc_color'' are between 0-65535 and the ''set_source_rgb'' method from cairo are between 0-1, so we have to convert these values as well:

cr.set_source_rgb(0.762, 0.762, 0.762)
cr.rectangle(x, y, w, h)
cr.fill()

Note that the second attributo of ''draw_rectangle'' tells us about if the rectangle is filled or not. In this case is True, so we use ''cr.fill()'' in the new way but if we want just the outside lines of the rectangle we should use ''cr.stroke()''

=== Write some text ===

This is the old way to do it:

title = _('You finished!')
layout = self.area.create_pango_layout(title)
layout.set_font_description(pango.FontDescription('Serif Bold 16'))
size = layout.get_size()
tx = x+w/2-(size[0]/pango.SCALE)/2
ty = y + 100
self.area.window.draw_layout(gc, tx, ty, layout)

and this is the way that I used to do it with pangocairo:

title = _('You finished!')
pango_cr = pangocairo.CairoContext(cr)
pango_cr.set_source_rgb(0, 0, 0)
pango_layout = cr.create_layout()
pango_layout.set_font_description(pango.FontDescription('Serif Bold 16'))
pango_layout.set_text(title)
size = pango_layout.get_size()
tx = x + (w / 2) - (size[0] / pango.SCALE) / 2
ty = y + 100
pango_cr.move_to(tx, ty)
pango_cr.show_layout(pango_layout)
pango_cr.stroke()

=== Draw a line ===

This is the old way:

gc.foreground = self.area.get_colormap().alloc_color(0, 0, 0)
self.area.window.draw_line(gc, int(b.x), int(b.y + b.size / 2),
int(b.x), int(b.y + b.size))

and should be replaced by this new way using cairo

cr.set_source_rgb(0, 0, 0)
cr.move_to(int(b.x), int(b.y + b.size / 2))
cr.line_to(int(b.x), int(b.y + b.size))
cr.stroke()

=== Draw an arc ===

Old way to do it (notice the second argument of ''draw_arc'': '''filled'''):

gc.foreground = self.area.get_colormap().alloc_color(b.color[0],b.color[1],b.color[2])
self.area.window.draw_arc(gc, True, x-b.size/2, y-b.size/2, b.size, b.size, 0, 360*64)

new way:

cr.set_source_rgb(b.color[0], b.color[1], b.color[2])
cr.arc(b.x, b.y, b.size / 2, 0, 2 * math.pi)
cr.fill()

== Tips & tricks ==

=== Convert cairo.Surface to GdkPixbuf ===

import StringIO

surface = cairo.ImageSurface(cairo.FORMAT_RGB24, w, h)
cr = cairo.Context(surface)

[... draw something into the surface ...]

pixbuf_data = StringIO.StringIO()
surface.write_to_png(pixbuf_data)
pxb_loader = gtk.gdk.PixbufLoader(image_type='png')
pxb_loader.write(pixbuf_data.getvalue())
temp_pix = pxb_loader.get_pixbuf()
pxb_loader.close()

=== Paint a GdkPixbuf into the canvas ===

cr.set_source_pixbuf(self.backgroundpixbuf, 0, 0)
cr.rectangle(x, 0, self.backgroundpixbuf.get_width(),
self.backgroundpixbuf.get_height())
cr.paint()

= Code Snippets =

== Gtk.TextBuffer ==

self.lessonbuffer = gtk.TextBuffer(self.tagtable)
self.lessontext = gtk.TextView(self.lessonbuffer)

replaced by:

self.lessonbuffer = Gtk.TextBuffer.new(self.tagtable)
self.lessontext = Gtk.TextView.new_with_buffer(self.lessonbuffer)

== Gdk.Event ==

event.state

replaced by:

event.get_state()

== Rsvg ==

import rsvg
image = rsvg.Handle(file=filename)

replaced by:

from gi.repository import Rsvg
image = Rsvg.Handle.new_from_file(filename)

== Gtk.TextTag ==

instructions_tag = Gtk.TextTag('instructions')

replaced by:

instructions_tag = Gtk.TextTag.new('instructions')

== Gdk.Keymap ==

entries = self.keymap.get_entries_for_keyval(keyval)
for e in entries:
e[0], e[1], e[2]

replaced by:

valid, entries = self.keymap.get_entries_for_keyval(keyval)
for e in entries:
e.keycode, e.group, e.level

Every entry was a tuple of (keycode, group, level). Now, this is an object with those attributes.

== GdkPixbuf.PixbufLoader ==

Change this:

pxb_loader = gtk.gdk.PixbufLoader(image_type='png')

by:

pxb_loader = GdkPixbuf.PixbufLoader.new_with_type('png')

== KEY_PRESS ==

This should be done by the '''pygi-convert.sh''' script.

gtk.gdk.KEY_PRESS
gtk.gdk.KEY_RELEASE

replaced by

Gdk.EventType.KEY_PRESS
Gdk.EventType.KEY_RELEASE

= Notes =

* I found this chunk of code in the source (''keyboard.py'' '''L515''') and I didn't understand what it means

# Hack to get the current modifier state - which will not be represented by the event.
state = gtk.gdk.device_get_core_pointer().get_state(self.window)[1]

= Missing / problematic things =

* [SOLVED] <del>This method, ''set_source_pixbuf'', is not available.</del>

cr = self.get_window().cairo_create()
# README: http://developer.gnome.org/gdk/stable/gdk-Cairo-Interaction.html#gdk-cairo-set-source-pixbuf
# Although this methos is not available in Python
cr.set_source_pixbuf(self.backgroundpixbuf, 0, 0)

Gdk.cairo_set_source_pixbuf(cr, self.backgroundpixbuf, 0, 0)

* We should find the correct way to scale Left and Right hands that are drawn over the keyboard, because I just put values that I thought they were correct. We should calculate them according to the screen

* PangoCairo fonts are not being drawn because of this: https://bugzilla.gnome.org/show_bug.cgi?id=680680

* Font Scale is wrong: https://bugzilla.gnome.org/show_bug.cgi?id=680663

= Useful links =

* http://cairographics.org/documentation/pycairo/2/index.html
* http://www.pygtk.org/docs/pygtk/pangocairo-class-reference.html
* http://www.pygtk.org/docs/pygtk/class-gdkdrawable.html

Features/GTK3/Porting/Typing Turtle

2012-07-27T11:42:29Z

Humitos: /* Missing / problematic things */

This page is being performed while I'm porting Typing Turtle Activity to Gtk3.

There is a [http://bugs.sugarlabs.org/ticket/3772 ticket] with some useful information that I'm using on the porting and to keep tracking this port. Besides, this wiki page will be useful to write some code snippets about what are the difficulties that I'm having on the port and maybe can be useful for someone else.

I will take [[User:Humitos/PortingGetBooks|this guide]] as reference on the Gtk3 porting.

= Port to Cairo =

'''README''': before to port this activity to GTK3, we should port it to Cairo as the first step and then move to GTK3.

== Code Snippets ==

=== Draw a rectangle ===

To draw a rectangle we used to do:

gc = self.window.new_gc()
gc.foreground = self.area.get_colormap().alloc_color(50000, 50000, 50000)
self.area.window.draw_rectangle(gc, True, x, y, w, h)

The arguments for ''alloc_color'' are between 0-65535 and the ''set_source_rgb'' method from cairo are between 0-1, so we have to convert these values as well:

cr.set_source_rgb(0.762, 0.762, 0.762)
cr.rectangle(x, y, w, h)
cr.fill()

Note that the second attributo of ''draw_rectangle'' tells us about if the rectangle is filled or not. In this case is True, so we use ''cr.fill()'' in the new way but if we want just the outside lines of the rectangle we should use ''cr.stroke()''

=== Write some text ===

This is the old way to do it:

title = _('You finished!')
layout = self.area.create_pango_layout(title)
layout.set_font_description(pango.FontDescription('Serif Bold 16'))
size = layout.get_size()
tx = x+w/2-(size[0]/pango.SCALE)/2
ty = y + 100
self.area.window.draw_layout(gc, tx, ty, layout)

and this is the way that I used to do it with pangocairo:

title = _('You finished!')
pango_cr = pangocairo.CairoContext(cr)
pango_cr.set_source_rgb(0, 0, 0)
pango_layout = cr.create_layout()
pango_layout.set_font_description(pango.FontDescription('Serif Bold 16'))
pango_layout.set_text(title)
size = pango_layout.get_size()
tx = x + (w / 2) - (size[0] / pango.SCALE) / 2
ty = y + 100
pango_cr.move_to(tx, ty)
pango_cr.show_layout(pango_layout)
pango_cr.stroke()

=== Draw a line ===

This is the old way:

gc.foreground = self.area.get_colormap().alloc_color(0, 0, 0)
self.area.window.draw_line(gc, int(b.x), int(b.y + b.size / 2),
int(b.x), int(b.y + b.size))

and should be replaced by this new way using cairo

cr.set_source_rgb(0, 0, 0)
cr.move_to(int(b.x), int(b.y + b.size / 2))
cr.line_to(int(b.x), int(b.y + b.size))
cr.stroke()

=== Draw an arc ===

Old way to do it (notice the second argument of ''draw_arc'': '''filled'''):

gc.foreground = self.area.get_colormap().alloc_color(b.color[0],b.color[1],b.color[2])
self.area.window.draw_arc(gc, True, x-b.size/2, y-b.size/2, b.size, b.size, 0, 360*64)

new way:

cr.set_source_rgb(b.color[0], b.color[1], b.color[2])
cr.arc(b.x, b.y, b.size / 2, 0, 2 * math.pi)
cr.fill()

== Tips & tricks ==

=== Convert cairo.Surface to GdkPixbuf ===

import StringIO

surface = cairo.ImageSurface(cairo.FORMAT_RGB24, w, h)
cr = cairo.Context(surface)

[... draw something into the surface ...]

pixbuf_data = StringIO.StringIO()
surface.write_to_png(pixbuf_data)
pxb_loader = gtk.gdk.PixbufLoader(image_type='png')
pxb_loader.write(pixbuf_data.getvalue())
temp_pix = pxb_loader.get_pixbuf()
pxb_loader.close()

=== Paint a GdkPixbuf into the canvas ===

cr.set_source_pixbuf(self.backgroundpixbuf, 0, 0)
cr.rectangle(x, 0, self.backgroundpixbuf.get_width(),
self.backgroundpixbuf.get_height())
cr.paint()

= Code Snippets =

== Gtk.TextBuffer ==

self.lessonbuffer = gtk.TextBuffer(self.tagtable)
self.lessontext = gtk.TextView(self.lessonbuffer)

replaced by:

self.lessonbuffer = Gtk.TextBuffer.new(self.tagtable)
self.lessontext = Gtk.TextView.new_with_buffer(self.lessonbuffer)

== Gdk.Event ==

event.state

replaced by:

event.get_state()

== Rsvg ==

import rsvg
image = rsvg.Handle(file=filename)

replaced by:

from gi.repository import Rsvg
image = Rsvg.Handle.new_from_file(filename)

== Gtk.TextTag ==

instructions_tag = Gtk.TextTag('instructions')

replaced by:

instructions_tag = Gtk.TextTag.new('instructions')

== Gdk.Keymap ==

entries = self.keymap.get_entries_for_keyval(keyval)
for e in entries:
e[0], e[1], e[2]

replaced by:

valid, entries = self.keymap.get_entries_for_keyval(keyval)
for e in entries:
e.keycode, e.group, e.level

Every entry was a tuple of (keycode, group, level). Now, this is an object with those attributes.

== GdkPixbuf.PixbufLoader ==

Change this:

pxb_loader = gtk.gdk.PixbufLoader(image_type='png')

by:

pxb_loader = GdkPixbuf.PixbufLoader.new_with_type('png')

== KEY_PRESS ==

This should be done by the '''pygi-convert.sh''' script.

gtk.gdk.KEY_PRESS
gtk.gdk.KEY_RELEASE

replaced by

Gdk.EventType.KEY_PRESS
Gdk.EventType.KEY_RELEASE

= Notes =

* I found this chunk of code in the source (''keyboard.py'' '''L515''') and I didn't understand what it means

# Hack to get the current modifier state - which will not be represented by the event.
state = gtk.gdk.device_get_core_pointer().get_state(self.window)[1]

= Missing / problematic things =

* This method, ''set_source_pixbuf'', is not available.

cr = self.get_window().cairo_create()
# README: http://developer.gnome.org/gdk/stable/gdk-Cairo-Interaction.html#gdk-cairo-set-source-pixbuf
# Although this methos is not available in Python
cr.set_source_pixbuf(self.backgroundpixbuf, 0, 0)

* We should find the correct way to scale Left and Right hands that are drawn over the keyboard, because I just put values that I thought they were correct. We should calculate them according to the screen

* PangoCairo fonts are not being drawn because of this: https://bugzilla.gnome.org/show_bug.cgi?id=680680

* Font Scale is wrong: https://bugzilla.gnome.org/show_bug.cgi?id=680663

= Useful links =

* http://cairographics.org/documentation/pycairo/2/index.html
* http://www.pygtk.org/docs/pygtk/pangocairo-class-reference.html
* http://www.pygtk.org/docs/pygtk/class-gdkdrawable.html

Features/GTK3/Porting/Typing Turtle

2012-07-27T11:35:48Z

Humitos:

This page is being performed while I'm porting Typing Turtle Activity to Gtk3.

There is a [http://bugs.sugarlabs.org/ticket/3772 ticket] with some useful information that I'm using on the porting and to keep tracking this port. Besides, this wiki page will be useful to write some code snippets about what are the difficulties that I'm having on the port and maybe can be useful for someone else.

I will take [[User:Humitos/PortingGetBooks|this guide]] as reference on the Gtk3 porting.

= Port to Cairo =

'''README''': before to port this activity to GTK3, we should port it to Cairo as the first step and then move to GTK3.

== Code Snippets ==

=== Draw a rectangle ===

To draw a rectangle we used to do:

gc = self.window.new_gc()
gc.foreground = self.area.get_colormap().alloc_color(50000, 50000, 50000)
self.area.window.draw_rectangle(gc, True, x, y, w, h)

The arguments for ''alloc_color'' are between 0-65535 and the ''set_source_rgb'' method from cairo are between 0-1, so we have to convert these values as well:

cr.set_source_rgb(0.762, 0.762, 0.762)
cr.rectangle(x, y, w, h)
cr.fill()

Note that the second attributo of ''draw_rectangle'' tells us about if the rectangle is filled or not. In this case is True, so we use ''cr.fill()'' in the new way but if we want just the outside lines of the rectangle we should use ''cr.stroke()''

=== Write some text ===

This is the old way to do it:

title = _('You finished!')
layout = self.area.create_pango_layout(title)
layout.set_font_description(pango.FontDescription('Serif Bold 16'))
size = layout.get_size()
tx = x+w/2-(size[0]/pango.SCALE)/2
ty = y + 100
self.area.window.draw_layout(gc, tx, ty, layout)

and this is the way that I used to do it with pangocairo:

title = _('You finished!')
pango_cr = pangocairo.CairoContext(cr)
pango_cr.set_source_rgb(0, 0, 0)
pango_layout = cr.create_layout()
pango_layout.set_font_description(pango.FontDescription('Serif Bold 16'))
pango_layout.set_text(title)
size = pango_layout.get_size()
tx = x + (w / 2) - (size[0] / pango.SCALE) / 2
ty = y + 100
pango_cr.move_to(tx, ty)
pango_cr.show_layout(pango_layout)
pango_cr.stroke()

=== Draw a line ===

This is the old way:

gc.foreground = self.area.get_colormap().alloc_color(0, 0, 0)
self.area.window.draw_line(gc, int(b.x), int(b.y + b.size / 2),
int(b.x), int(b.y + b.size))

and should be replaced by this new way using cairo

cr.set_source_rgb(0, 0, 0)
cr.move_to(int(b.x), int(b.y + b.size / 2))
cr.line_to(int(b.x), int(b.y + b.size))
cr.stroke()

=== Draw an arc ===

Old way to do it (notice the second argument of ''draw_arc'': '''filled'''):

gc.foreground = self.area.get_colormap().alloc_color(b.color[0],b.color[1],b.color[2])
self.area.window.draw_arc(gc, True, x-b.size/2, y-b.size/2, b.size, b.size, 0, 360*64)

new way:

cr.set_source_rgb(b.color[0], b.color[1], b.color[2])
cr.arc(b.x, b.y, b.size / 2, 0, 2 * math.pi)
cr.fill()

== Tips & tricks ==

=== Convert cairo.Surface to GdkPixbuf ===

import StringIO

surface = cairo.ImageSurface(cairo.FORMAT_RGB24, w, h)
cr = cairo.Context(surface)

[... draw something into the surface ...]

pixbuf_data = StringIO.StringIO()
surface.write_to_png(pixbuf_data)
pxb_loader = gtk.gdk.PixbufLoader(image_type='png')
pxb_loader.write(pixbuf_data.getvalue())
temp_pix = pxb_loader.get_pixbuf()
pxb_loader.close()

=== Paint a GdkPixbuf into the canvas ===

cr.set_source_pixbuf(self.backgroundpixbuf, 0, 0)
cr.rectangle(x, 0, self.backgroundpixbuf.get_width(),
self.backgroundpixbuf.get_height())
cr.paint()

= Code Snippets =

== Gtk.TextBuffer ==

self.lessonbuffer = gtk.TextBuffer(self.tagtable)
self.lessontext = gtk.TextView(self.lessonbuffer)

replaced by:

self.lessonbuffer = Gtk.TextBuffer.new(self.tagtable)
self.lessontext = Gtk.TextView.new_with_buffer(self.lessonbuffer)

== Gdk.Event ==

event.state

replaced by:

event.get_state()

== Rsvg ==

import rsvg
image = rsvg.Handle(file=filename)

replaced by:

from gi.repository import Rsvg
image = Rsvg.Handle.new_from_file(filename)

== Gtk.TextTag ==

instructions_tag = Gtk.TextTag('instructions')

replaced by:

instructions_tag = Gtk.TextTag.new('instructions')

== Gdk.Keymap ==

entries = self.keymap.get_entries_for_keyval(keyval)
for e in entries:
e[0], e[1], e[2]

replaced by:

valid, entries = self.keymap.get_entries_for_keyval(keyval)
for e in entries:
e.keycode, e.group, e.level

Every entry was a tuple of (keycode, group, level). Now, this is an object with those attributes.

== GdkPixbuf.PixbufLoader ==

Change this:

pxb_loader = gtk.gdk.PixbufLoader(image_type='png')

by:

pxb_loader = GdkPixbuf.PixbufLoader.new_with_type('png')

== KEY_PRESS ==

This should be done by the '''pygi-convert.sh''' script.

gtk.gdk.KEY_PRESS
gtk.gdk.KEY_RELEASE

replaced by

Gdk.EventType.KEY_PRESS
Gdk.EventType.KEY_RELEASE

= Notes =

* I found this chunk of code in the source (''keyboard.py'' '''L515''') and I didn't understand what it means

# Hack to get the current modifier state - which will not be represented by the event.
state = gtk.gdk.device_get_core_pointer().get_state(self.window)[1]

= Missing / problematic things =

* This method, ''set_source_pixbuf'', is not available.

cr = self.get_window().cairo_create()
# README: http://developer.gnome.org/gdk/stable/gdk-Cairo-Interaction.html#gdk-cairo-set-source-pixbuf
# Although this methos is not available in Python
cr.set_source_pixbuf(self.backgroundpixbuf, 0, 0)

= Useful links =

* http://cairographics.org/documentation/pycairo/2/index.html
* http://www.pygtk.org/docs/pygtk/pangocairo-class-reference.html
* http://www.pygtk.org/docs/pygtk/class-gdkdrawable.html

User:Humitos/PortingTypingTurtle

2012-07-27T11:25:29Z

Humitos: moved User:Humitos/PortingTypingTurtle to Features/GTK3/Porting/TypingTurtle

#REDIRECT [[Features/GTK3/Porting/TypingTurtle]]

Features/GTK3/Porting/Typing Turtle

2012-07-27T11:25:29Z

Humitos: moved User:Humitos/PortingTypingTurtle to Features/GTK3/Porting/TypingTurtle

Features/GTK3/Porting/Typing Turtle

2012-07-27T11:21:40Z

Humitos: /* Code Snippets */

Features/GTK3/Porting/Typing Turtle

2012-07-27T11:13:51Z

Humitos:

Features/GTK3/Porting/Typing Turtle

2012-07-27T11:09:11Z

Humitos: /* Code Snippets */

Features/GTK3/Porting

2012-07-27T01:07:48Z

Humitos: /* Going from Cairo in GTK-2 to Cairo in GTK-3 */

=Porting an existing activity to GTK3=
This is a guide to porting an existing activity from GTK2 to [http://developer.gnome.org/gtk3/stable/ GTK3]. It also shows the changes to use the new Sugar toolkit that also now uses [[Features/GTK3|GTK3]]. This guide uses the [http://git.sugarlabs.org/hello-world hello-world] activity as a simple example.

There is another guide written from scratch that uses this one as reference. I was done porting GetBooks Activity [[Features/GTK3/Porting/GetBooks]]

==Preparation==
Before you start porting your activity you are encouraged to branch off a stable branch. This will allow you to keep on doing stable releases on the stable branch and new releases on the master branch. We highly recommend that you use the 'sugar-0.94' as the stable branch name because this will keep the repositories consistent and eases the development work. Let's step through this with a real life example:

The latest release of hello-world was version 3 (commit 04fb9beb708f1078aae93995da3ec06bac7aa433). We want to branch off at that point. If you did not do any changes after the last stable commit simply create a branch with:
git branch sugar-0.94

If you have already made commits after that, you need to go to that commit first and create a branch at that specific point in our case commit 04fb9beb708f1078aae93995da3ec06bac7aa433, there is a command to do that in one go:
git checkout -b sugar-0.94 04fb9beb708f1078aae93995da3ec06bac7aa433

In both cases this has created a local branch, as you can see by running 'git branch'; you should see the following (if you did the second command you will have sugar-0.94 already selected):

<pre>
[erikos@T61 helloworld]$ git branch
* master
sugar-0.94
</pre>

The 'sugar-0.94' branch is only available locally, as you can see by running 'git branch -r' which shows the remote branches:

<pre>
[erikos@T61 helloworld]$ git branch -r
origin/HEAD -> origin/master
origin/master
origin/sucrose-0.84
</pre>

The only branch available besides the master branch is the 'sucrose-0.84' branch. Let's push now our new branch to the remote repository to make it available for others:
<pre>
git push origin sugar-0.94
</pre>

The branch is now listed as a remote branch. You can verify as well on your [http://git.sugarlabs.org/hello-world/mainline gitorious page].
<pre>
[erikos@T61 helloworld]$ git branch -r
origin/HEAD -> origin/master
origin/master
origin/sucrose-0.84
origin/sugar-0.94
</pre>

You can switch now between those branches using 'git checkout <branch>'. And you can use 'git branch' to see which branch you are on (the one with the * before is the branch you are currently on).
<pre>
git checkout sugar-0.94
git checkout master
</pre>

==Cleanup, adopt to API changes in sugar-toolkit-gtk3 ==
''This should be done only on the master branch''! In the new sugar-toolkit-gtk3 we have removed old API, you should adjust your activity accordingly:
* the keep button has been removed completely
* the old-style toolbar has been removed
* do not use set_toolbox anymore use set_toolbar_box instead (see in [http://git.sugarlabs.org/~walter/abacus/walter-cairo/commit/6871dd340a89ade3b5361457e1bd1d58276a8efc Abacus])
* remove import of deprecated ActivityToolbox (see [http://git.sugarlabs.org/hello-world/mainline/commit/22060a3063b2d6fd38d6b1cd8d44946170255af3 hello-world])
* support for 'service_name' and 'class' has been removed from the activity.info make sure you are using: 'bundle_id' instead of 'service_name' and 'exec' instead of 'class' (see in [http://git.sugarlabs.org/record/mainline/commit/6e8968c71e474e2d8d86886badf5cf7d70217dc5 Record])

==Port the activity from GTK2 to GTK3==
To start, change the importing instruction for GTK from
import gtk
to
from gi.repository import Gtk
Then you have to change each call that involves Gtk, for example creating a button will look now like this:
button = Gtk.Button()

A simple hello world program in GTK3 looks like this:
<pre>
from gi.repository import Gtk

def _destroy_cb(widget, data=None):
Gtk.main_quit()

w = Gtk.Window()
w.connect("destroy", _destroy_cb)
label = Gtk.Label('Hello World!')
w.add(label)
w.show_all()

Gtk.main()
</pre>

For porting your activity you do have to change your calls for accessing widgets and services in the new GTK3 sugar-toolkit as well. The new namespace is called sugar3, trying to reflect that GTK3 is the underlying technology. For example the import of the base activity class has to be changed from
from sugar.activity import activity
to
from sugar3.activity import activity

Make sure you change the setup.py in your activity to point to the new toolkit as well:
from sugar3.activity import bundlebuilder

The changes that were needed to port the hello-world activity can be seen in [http://git.sugarlabs.org/hello-world/mainline/commit/508e1c518b56cbde5508e560c8a2ff38a3518583 this commit].

Ok, let's do these changes now for your activity. Make sure you are in your master branch using the 'git branch' command (the master branch should have a '*' before it). Make your changes, commit them ('git commit -a') and push them to the remote repository ('git push origin master').

===Tools===
There are tools to help you do the porting. There is a script in the pygobject repository for porting called [http://git.gnome.org/browse/pygobject/tree/pygi-convert.sh pygi-convert.sh], more info about the script can be found in [http://live.gnome.org/PyGObject/IntrospectionPorting the PyGObject Introspection Porting guide].

Here is a script to automate the rename of the imports '''sugar''' to '''sugar3''': [http://dev.laptop.org/~manuq/sugar-convert.sh sugar-convert.sh].

If you are having trouble finding how a particular GTK class/method/constant has been named in PyGI, run [http://dev.laptop.org/~dsd/20110806/pygi-enumerate.py pygi-enumerate.py] and grep the output. (this app lists all identified methods and constants). Usage example:

<pre>
$ python pygi-enumerate.py | grep get_selection
Gtk.AccelLabel.get_selection_bounds() (instance method)
Gtk.Editable.get_selection_bounds() (instance method)
Gtk.Entry.get_selection_bounds() (instance method)
Gtk.IconView.get_selection_mode() (instance method)
Gtk.Label.get_selection_bounds() (instance method)
Gtk.SelectionData.get_selection() (instance method)
Gtk.SpinButton.get_selection_bounds() (instance method)
Gtk.TextBuffer.get_selection_bound() (instance method)
Gtk.TextBuffer.get_selection_bounds() (instance method)
Gtk.TreeView.get_selection() (instance method)
</pre>

=== Constructor considerations ===

With PyGI it is possible to use Python-like constructors, or "new" functions e.g. the following are (usually) equivalent:
label = Gtk.Button()
label = Gtk.Button.new()

However, the first form is preferred: it is more Python-like. Internally, the difference is that Gtk.Label.new() translates to a call to gtk_label_new(), whereas Gtk.Label() (the preferred form) will directly construct an instance of GtkLabel at the GObject level.

If the constructor takes parameters, they '''must''' be named. The parameters correspond to GObject properties in the API documentation which are usually marked as "Construct". For example, the following code will not work:

expander = Gtk.Expander("my expander")

The (confusing) error is:
TypeError: GObject.__init__() takes exactly 0 arguments (1 given)

The solution is to go to the [http://developer.gnome.org/gtk3/3.2/GtkExpander.html#GtkExpander.properties GtkExpander API documentation] and find the appropriate property that we wish to set. In this case it is label (which is a Construct property, further increasing our confidence of success), so the code should be:

expander = Gtk.Expander(label="my expander")

Combining the two points above, if you wish to call a construct-like function such as gtk_button_new_with_label(), you do have the option of calling Gtk.Button.new_with_label(), however if we check the [http://developer.gnome.org/gtk3/3.2/GtkButton.html#GtkButton.properties GtkButton properties] we see one called "label" which is equivalent. Therefore gtk_button_new_with_label("foo") should be called as:
button = Gtk.Button(label="foo")

=== HBox, VBox, pack_start and pack_end ===

GtkHBox and GtkVBox, commonly used containers in GTK2 code, have pack_start and pack_end methods. These take 4 parameters:
# The widget to pack into the container
# '''expand''': Whether the child should receive extra space when the container grows (default True)
# '''fill''': True if space given to child by the expand option is actually allocated to child, rather than just padding it. This parameter has no effect if expand is set to False. A child is always allocated the full height of a gtk.HBox and the full width of a gtk.VBox. This option affects the other dimension. (default True)
# '''padding''': extra space in pixels to put between child and its neighbor (default 0)

In PyGTK, the expand, fill and padding parameters were optional: if unspecified, the default values above were used. In PyGI, these parameters are '''not''' optional: all 4 must be specified. Hence the rules for adding in the extra parameters are:

# If '''expand''' was not set, use value True
# If '''fill''' was not set, use value True. (however, if expand is False, this parameter gets ignored so False is an equally acceptable option when expand=False)
# If '''padding''' was not set, use value 0.

These parameters can be specified either as positional arguments or as named keyword arguments, however all 4 must always be specified. Some developers prefer keyword arguments, arguing that the following:
<pre>box.pack_start(widget, expand=True, fill=False, padding=4)</pre>
is much more readable than:
<pre>box.pack_start(widget, True, False, 4)</pre>

However, these functions are called extremely often; any mildly seasoned GTK developer will have memorized the order and meaning of the parameters. Some developers therefore prefer to avoid the extra work of dropping in hundreds of keyword arguments throughout the code and just use the positional ones. This is really up to you.

If you are using pack_start with the default values (expand=True, fill=True and padding=0), you can avoid using pack_start (and the parameter pain that it brings with it) by just using .add for some added cleanliness, e.g.
<pre>box.pack_start(widget, True, True, 0)</pre>
can be replaced with:
<pre>box.add(widget)</pre>

This is as far as you need to go for now. However, in GTK3, GtkVBox and GtkHBox have been deprecated, which means they might be removed in GTK4. The replacement is to use GtkBox directly, and you may wish to make this change now. e.g.:
<pre>vbox = Gtk.Box(orientation=Gtk.Orientation.VERTICAL)</pre>
<pre>hbox = Gtk.Box(orientation=Gtk.Orientation.HORIZONTAL, homogeneous=True, spacing=8)</pre>
However, it must be noted that if GtkBox is used directly (instead of using GtkHBox/GtkVBox), the default value of '''expand''' is now '''False'''. The implications of this are:
# You need to check your .add() calls, as previously they would behave as pack_start with expand=True, but now they will behave as expand=False (you need to change them to use pack_start with expand=True to retain the old behaviour)
# Every single pack_start call that has expand=False and padding=0 (and any value of fill) can be converted to .add() for cleanliness

=== GtkAlignment considerations ===

In PyGTK, the gtk.Alignment constructor takes four optional parameters:
# xalign: the fraction of horizontal free space to the left of the child widget. Ranges from 0.0 to 1.0. Default value 0.0.
# yalign: the fraction of vertical free space above the child widget. Ranges from 0.0 to 1.0. Default value 0.0.
# xscale: the fraction of horizontal free space that the child widget absorbs, from 0.0 to 1.0. Default value 0.0.
# yscale: the fraction of vertical free space that the child widget absorbs, from 0.0 to 1.0. Default value 0.0

In PyGI/GTK3, these parameters are still optional when used in the Gtk.Alignment constructor (as keyword arguments, as explained above). However, the default values have changed. They are now:
# xalign: default value 0.5
# yalign: default value 0.5
# xscale: default value 1
# yscale: default value 1

If your code was relying on the default value of 0 for any of these parameters in PyGTK, you will now need to explicitly specify that in your constructor. Similarly, if you were previously using construction parameters to select the now-default values, those parameters can be dropped.

Additionally, PyGTK accepted these construction parameters as positional arguments. As explained above, they must now be converted to keyword arguments.

=== Other considerations ===

''self.allocation'' property is no longer available. Please search your code for "self.allocation" and replace it for "self.get_allocation()".

So to get the allocation size:

self.allocation.width
self.allocation.height

should be replaced by:

self.get_allocated_width()
self.get_allocated_height()

==Make a release==
===Versioning===
If you do new releases the versioning of the GTK2 and GTK3 release should be different. For GTK2 releases you should use dotted versions for new development releases major versions. Let's have a look at hello-world as an example. The latest release of hello-world was version 3. Bug fix releases should be named 3.1 then 3.2 and so on. The new releases for the new development branch should be starting with a major number, in the case of hello-world version 4.

To minimise the maintainer overload we highly encourage you to only do bug-fix releases for the GTK2 branch. New features should only go into the new branch that is based on gobject-introspection and GTK3.

== Tips to Activity Developers ==

===Changes to the Clipboard===
Two things to note:

1. You need to specify a clipboard using get()
clipboard = Gtk.Clipboard.get(Gdk.SELECTION_CLIPBOARD)
2. You need to pass a length to set_text()
clipboard.set_text(string, len(string))

See [http://python-gtk-3-tutorial.readthedocs.org/en/latest/clipboard.html] for more details.

===Changes to Drag-and-Drop===
Slightly different syntax:
self.drag_dest_set(Gtk.DestDefaults.ALL, [],
Gdk.DragAction.COPY)
self.drag_dest_set_target_list(None)
self.drag_dest_add_text_targets()
self.connect('drag_data_received', self._drag_data_received)

and:
data.get_text()
or:
data.get_image()

See [http://python-gtk-3-tutorial.readthedocs.org/en/latest/drag_and_drop.html] for more details.

===Going from Drawable to Cairo===

GTK-3 does not support gtk Drawable objects, so the first step is to get your activity running under Cairo.

<pre>
import cairo

# From activity.Activity, you inherit a canvas.
# Create a Cairo context from the window.
cairo_context = self.canvas.get_window().cairo_create()

# Create an XLib surface to be used for drawing
xlib_surface = surface.create_similar(cairo.CONTENT_COLOR,
gtk.gdk.screen_width(),
gtk.gdk.screen_height())

# You'll need a Cairo context from which you'll build a GTK Cairo context
cairo_context = cairo.Context(xlib_surface)
cairo_context = gtk.gdk.CairoContext(cairo_context)

# Use this context as you would a Drawable, substituting Cairo commands
# for gtk commands, e.g.,
cairo_context.move_to(0, 0)
cairo_context.line_to(100, 100)
# Cairo uses floats from 0 to 1 for RGB values
cairo_context.set_source_rgb(r, g, b)
cairo_context.rectangle(x, y, w, h)
cairo_context.fill()

# To invalidate a region to force a refresh, use:
self.canvas.queue_draw_area(x, y, w, h)

# Handle the expose event
def do_expose_event(self, event):
# Create the cairo context
cairo_context = self.canvas.get_window().cairo_create()
cairo_context.rectangle(event.area.x, event.area.y,
event.area.width, event.area.height)
cairo_context.clip()
cairo_context.set_source_surface(xlib_surface)
cairo_context.paint()
</pre>

Pango is a bit different when used with Cairo:

<pre>
import pango, pangocairo

# Again, from the xlib_surface...
cairo_context = cairo.Context(xlib_surface)

# Create a PangoCairo context
cairo_context = pangocairo.CairoContext(cairo_context)

# The pango layout is created from the Cairo context
pango_layout = cairo_context.create_layout()

# You still use pango to set up font descriptions.
fd = pango.FontDescription('Sans')
fd.set_size(12 * pango.SCALE)

# Tell your pango layout about your font description
pango_layout.set_font_description(fd)

# Write text to your pango layout
pango_layout.set_text('Hello world')

# Position it within the Cairo context
cairo_context.save()
cairo_context.translate(x, y)
cairo_context.rotate(pi / 3) # You can rotate text and images in Cairo
cairo_context.set_source_rgb(1, 0, 0)

# Finally, draw the text
cairo_context.update_layout(pango_layout)
cairo_context.show_layout(pango_layout)
cairo_context.restore()
</pre>

To draw a bitmap...

<pre>
# Again, from the xlib_surface...
cairo_context = cairo.Context(xlib_surface)

# Create a gtk context
cairo_context = gtk.gdk.CairoContext(cairo_context)
cairo_context.set_source_pixbuf(pixbuf, x, y)
cairo_context.rectangle(x, y, w, h)
cairo_context.fill()
</pre>

To read a pixel from the xlib surface...

<pre>
# create a new 1x1 cairo surface
cairo_surface = cairo.ImageSurface(cairo.FORMAT_RGB24, 1, 1);
cairo_context = cairo.Context(cairo_surface)
# translate xlib_surface so that target pixel is at 0, 0
cairo_context.set_source_surface(xlib_surface, -x, -y)
cairo_context.rectangle(0,0,1,1)
cairo_context.set_operator(cairo.OPERATOR_SOURCE)
cairo_context.fill()
cairo_surface.flush() # ensure all writing is done
# Read the pixel
return (ord(pixels[2]), ord(pixels[1]), ord(pixels[0]), 0)
</pre>

===Going from Cairo in GTK-2 to Cairo in GTK-3===

Not much changes, but...

The Cairo/Pango interaction is a little different:
<pre>
from gi.repository import Pango, PangoCairo

cairo_context = ...
pango_layout = PangoCairo.create_layout(cairo_context)
fd = Pango.FontDescription('Sans')
fd.set_size(12 * Pango.SCALE)
pango_layout.set_font_description(fd)
pango_layout.set_text('Hello World', -1)
cairo_context.set_source_rgb(1, 0, 0)
PangoCairo.update_layout(cairo_context, pango_layout)
PangoCairo.show_layout(cairo_context, pango_layout)
</pre>

===Taking a screenshot and making a thumbnail===
To make a screenshot of the window:
<pre>
width, height = window.get_width(), window.get_height()
thumb_surface = Gdk.Window.create_similar_surface(window,
cairo.CONTENT_COLOR,
width, height)

thumb_width, thumb_height = style.zoom(100), style.zoom(80)
cairo_context = cairo.Context(thumb_surface)
thumb_scale_w = thumb_width * 1.0 / width
thumb_scale_h = thumb_height * 1.0 / height
cairo_context.scale(thumb_scale_w, thumb_scale_h)
Gdk.cairo_set_source_window(cairo_context, window, 0, 0)
cairo_context.paint()
thumb_surface.write_to_png(png_path_or_filelike_object)
</pre>

===Creating a video widget===

Haven't gotten this working yet, but some necessary changes include:

Instead of
window.xid
use
get_property('window').get_xid()

Instead of
unset_flags(gtk.DOUBLE_BUFFERED)
set_flags(gtk.APP_PAINTABLE)
use
set_double_buffered(False)
set_app_paintable(True)

A more basic question is whether or not we migrate to gstreamer-1.0. If we do, some helpful documentation is found here [https://wiki.ubuntu.com/Novacut/GStreamer1.0].

== Resources ==
* PyGtk documentation
** Gtk3: http://python-gtk-3-tutorial.readthedocs.org
** gtk2: http://www.pygtk.org/docs/pygtk/
* Reference Manual
** Gtk3: http://developer.gnome.org/gtk3/3.4/
* Gdk documentation:
** Gdk3: http://developer.gnome.org/gdk/2.24/

[[Category:Developer]]

= More porting wiki pages =

{{Special:PrefixIndex/Features/GTK3/Porting}}

Features/GTK3/Porting/Log

2012-07-25T16:20:45Z

Humitos: /* Code Snippets */

This page is being performed while I'm porting Log Activity to Gtk3.

There is a [http://bugs.sugarlabs.org/ticket/3761 ticket] with some useful information that I'm using on the porting and to keep tracking this port. Besides, this wiki page will be useful to write some code snippets about what are the difficulties that I'm having on the port and maybe can be useful for someone else.

I will take [[User:Humitos/PortingGetBooks|this guide]] as reference on the Gtk3 porting.

= Code Snippets =

== Gtk.TextView ==

* gtk2: http://www.pygtk.org/docs/pygtk/class-gtktextview.html#method-gtktextview--scroll-to-mark
* Gtk3: http://developer.gnome.org/gtk3/3.5/GtkTextView.html#gtk-text-view-scroll-to-mark

Gtk.TextView.scroll_to_mark needs all the arguments. In gtk2 version three of them were optional (use_align, xalign, yalign)

self._textview.scroll_to_mark(log.get_insert(), 0)

replaced with:

self._textview.scroll_to_mark(log.get_insert(), 0, use_align=False, xalign=0.5, yalign=0.5)

== Gtk.TreeSortable.set_sort_func ==

* http://python-gtk-3-tutorial.readthedocs.org/en/latest/treeview.html#Gtk.TreeSortable.set_sort_func

This function sometimes receives ''user_data'' so we need to add an optional argument to the definition.

def _sort_logfile(self, treemodel, itera, iterb):

replaced by:

def _sort_logfile(self, treemodel, itera, iterb, user_data=None):

== Gtk.TreeModelSort.convert_child_iter_to_iter ==

* http://developer.gnome.org/gtk3/3.5/GtkTreeModelSort.html#gtk-tree-model-sort-convert-child-iter-to-iter

The old way to do this:

log_iter = \
self._treeview.get_model().convert_child_iter_to_iter(None,
log.iter)

replaced by:

success, log_iter = \
self._treeview.get_model().convert_child_iter_to_iter(log.iter)

= Clipboard =

* Gtk3: http://python-gtk-3-tutorial.readthedocs.org/en/latest/clipboard.html
** http://developer.gnome.org/gtk3/3.5/GtkTextBuffer.html#gtk-text-buffer-copy-clipboard

To integrate the clipboard of the activity with the ''MAIN'' clipboard (the Sugar one) we should obtain that clipboard:

# Clipboard of the activity
self.clipboard = Gtk.Clipboard.get(Gdk.SELECTION_CLIPBOARD)

And then, when the ''Copy'' button is pressed we should call this function (in the callback). The ''self.viewer.'''''active_log''' is a Gtk.TextBuffer

self.viewer.active_log.copy_clipboard(self.clipboard)

= Missing things =

* Look for '''FIXME'''s and '''README'''s in the code (logviewer.py)
* Searching in the log is not working due to this bug: https://bugzilla.gnome.org/show_bug.cgi?id=680597

= Useful Links =

* http://developer.gnome.org/gtk3/3.5/GtkTextIter.html#gtk-text-iter-forward-search
* http://developer.gnome.org/gtk3/3.5/GtkTreeModelSort.html#gtk-tree-model-filter-convert-child-iter-to-iter

Features/GTK3/Porting/Log

2012-07-25T16:17:33Z

Humitos: /* Missing things */

This page is being performed while I'm porting Log Activity to Gtk3.

There is a [http://bugs.sugarlabs.org/ticket/3761 ticket] with some useful information that I'm using on the porting and to keep tracking this port. Besides, this wiki page will be useful to write some code snippets about what are the difficulties that I'm having on the port and maybe can be useful for someone else.

I will take [[User:Humitos/PortingGetBooks|this guide]] as reference on the Gtk3 porting.

= Code Snippets =

== Gtk.TextView ==

* gtk2: http://www.pygtk.org/docs/pygtk/class-gtktextview.html#method-gtktextview--scroll-to-mark
* Gtk3: http://developer.gnome.org/gtk3/3.5/GtkTextView.html#gtk-text-view-scroll-to-mark

Gtk.TextView.scroll_to_mark needs all the arguments. In gtk2 version three of them were optional (use_align, xalign, yalign)

self._textview.scroll_to_mark(log.get_insert(), 0)

replaced with:

self._textview.scroll_to_mark(log.get_insert(), 0, use_align=False, xalign=0.5, yalign=0.5)

== Gtk.TreeSortable.set_sort_func ==

* http://python-gtk-3-tutorial.readthedocs.org/en/latest/treeview.html#Gtk.TreeSortable.set_sort_func

This function sometimes receives ''user_data'' so we need to add an optional argument to the definition.

def _sort_logfile(self, treemodel, itera, iterb):

replaced by:

def _sort_logfile(self, treemodel, itera, iterb, user_data=None):

= Clipboard =

* Gtk3: http://python-gtk-3-tutorial.readthedocs.org/en/latest/clipboard.html
** http://developer.gnome.org/gtk3/3.5/GtkTextBuffer.html#gtk-text-buffer-copy-clipboard

To integrate the clipboard of the activity with the ''MAIN'' clipboard (the Sugar one) we should obtain that clipboard:

# Clipboard of the activity
self.clipboard = Gtk.Clipboard.get(Gdk.SELECTION_CLIPBOARD)

And then, when the ''Copy'' button is pressed we should call this function (in the callback). The ''self.viewer.'''''active_log''' is a Gtk.TextBuffer

self.viewer.active_log.copy_clipboard(self.clipboard)

= Missing things =

* Look for '''FIXME'''s and '''README'''s in the code (logviewer.py)
* Searching in the log is not working due to this bug: https://bugzilla.gnome.org/show_bug.cgi?id=680597

= Useful Links =

* http://developer.gnome.org/gtk3/3.5/GtkTextIter.html#gtk-text-iter-forward-search
* http://developer.gnome.org/gtk3/3.5/GtkTreeModelSort.html#gtk-tree-model-filter-convert-child-iter-to-iter

Features/GTK3/Porting/Log

2012-07-25T15:18:16Z

Humitos: /* Missing things */

This page is being performed while I'm porting Log Activity to Gtk3.

There is a [http://bugs.sugarlabs.org/ticket/3761 ticket] with some useful information that I'm using on the porting and to keep tracking this port. Besides, this wiki page will be useful to write some code snippets about what are the difficulties that I'm having on the port and maybe can be useful for someone else.

I will take [[User:Humitos/PortingGetBooks|this guide]] as reference on the Gtk3 porting.

= Code Snippets =

== Gtk.TextView ==

* gtk2: http://www.pygtk.org/docs/pygtk/class-gtktextview.html#method-gtktextview--scroll-to-mark
* Gtk3: http://developer.gnome.org/gtk3/3.5/GtkTextView.html#gtk-text-view-scroll-to-mark

Gtk.TextView.scroll_to_mark needs all the arguments. In gtk2 version three of them were optional (use_align, xalign, yalign)

self._textview.scroll_to_mark(log.get_insert(), 0)

replaced with:

self._textview.scroll_to_mark(log.get_insert(), 0, use_align=False, xalign=0.5, yalign=0.5)

== Gtk.TreeSortable.set_sort_func ==

* http://python-gtk-3-tutorial.readthedocs.org/en/latest/treeview.html#Gtk.TreeSortable.set_sort_func

This function sometimes receives ''user_data'' so we need to add an optional argument to the definition.

def _sort_logfile(self, treemodel, itera, iterb):

replaced by:

def _sort_logfile(self, treemodel, itera, iterb, user_data=None):

= Clipboard =

* Gtk3: http://python-gtk-3-tutorial.readthedocs.org/en/latest/clipboard.html
** http://developer.gnome.org/gtk3/3.5/GtkTextBuffer.html#gtk-text-buffer-copy-clipboard

To integrate the clipboard of the activity with the ''MAIN'' clipboard (the Sugar one) we should obtain that clipboard:

# Clipboard of the activity
self.clipboard = Gtk.Clipboard.get(Gdk.SELECTION_CLIPBOARD)

And then, when the ''Copy'' button is pressed we should call this function (in the callback). The ''self.viewer.'''''active_log''' is a Gtk.TextBuffer

self.viewer.active_log.copy_clipboard(self.clipboard)

= Missing things =

* Look for a '''FIXME''' in the code (logviewer.py)

= Useful Links =

* http://developer.gnome.org/gtk3/3.5/GtkTextIter.html#gtk-text-iter-forward-search
* http://developer.gnome.org/gtk3/3.5/GtkTreeModelSort.html#gtk-tree-model-filter-convert-child-iter-to-iter

Features/GTK3/Porting/Typing Turtle

2012-07-25T13:28:03Z

Humitos: /* Code Snippets */

Features/GTK3/Porting/Typing Turtle

2012-07-25T13:17:14Z

Humitos: /* Port to Cairo */

Features/GTK3/Porting/Typing Turtle

2012-07-25T13:09:11Z

Humitos:

Features/GTK3/Porting/Typing Turtle

2012-07-23T13:05:19Z

Humitos:

This page is being performed while I'm porting Typing Turtle Activity to Gtk3.

There is a [ticket] with some useful information that I'm using on the porting and to keep tracking this port. Besides, this wiki page will be useful to write some code snippets about what are the difficulties that I'm having on the port and maybe can be useful for someone else.

I will take [[User:Humitos/PortingGetBooks|this guide]] as reference on the Gtk3 porting.

'''README''': before to port this activity to GTK3, we should port it to Cairo as the first step and then move to GTK3.

= Code Snippets =

== Gtk.Style.fg_gc ==

gc = self.get_style().fg_gc[Gtk.StateType.NORMAL]

replaced by:

gc = self.get_style().fg[Gtk.StateType.NORMAL]

== Gtk.DrawingArea ==

self.layout = self.create_pango_layout('')
self.layout.set_text(self.title_original)

replaced by:

self.layout = self.create_pango_layout('')
self.layout.set_text(self.title_original, len(self.title_original)

----

self.lessonbuffer = Gtk.TextBuffer.new(self.tagtable)
self.lessontext = Gtk.TextView.new_with_buffer(self.lessonbuffer)

= Gtk.TextTag =

instructions_tag = Gtk.TextTag('instructions')

replaced by:

instructions_tag = Gtk.TextTag.new('instructions')

= Gdk.Keymap =

entries = self.keymap.get_entries_for_keyval(keyval)

replaced by:

valid, entries = self.keymap.get_entries_for_keyval(keyval)

Every entry was a tuple of (keycode, group, level). Now, this is an object with those attributes.

Features/GTK3/Porting/Typing Turtle

2012-07-23T12:30:15Z

Humitos:

This page is being performed while I'm porting Typing Turtle Activity to Gtk3.

There is a [ticket] with some useful information that I'm using on the porting and to keep tracking this port. Besides, this wiki page will be useful to write some code snippets about what are the difficulties that I'm having on the port and maybe can be useful for someone else.

I will take [[User:Humitos/PortingGetBooks|this guide]] as reference on the Gtk3 porting.

= Code Snippets =

== Gtk.Style.fg_gc ==

gc = self.get_style().fg_gc[Gtk.StateType.NORMAL]

replaced by:

gc = self.get_style().fg[Gtk.StateType.NORMAL]

== Gtk.DrawingArea ==

self.layout = self.create_pango_layout('')
self.layout.set_text(self.title_original)

replaced by:

self.layout = self.create_pango_layout('')
self.layout.set_text(self.title_original, len(self.title_original)

----

self.lessonbuffer = Gtk.TextBuffer.new(self.tagtable)
self.lessontext = Gtk.TextView.new_with_buffer(self.lessonbuffer)

= Gtk.TextTag =

instructions_tag = Gtk.TextTag('instructions')

replaced by:

instructions_tag = Gtk.TextTag.new('instructions')

= Gdk.Keymap =

entries = self.keymap.get_entries_for_keyval(keyval)

replaced by:

valid, entries = self.keymap.get_entries_for_keyval(keyval)

Every entry was a tuple of (keycode, group, level). Now, this is an object with those attributes.

Features/GTK3/Porting/Typing Turtle

2012-07-19T14:25:12Z

Humitos: /* Code Snippets */

This page is being performed while I'm porting Typing Turtle Activity to Gtk3.

There is a [ticket] with some useful information that I'm using on the porting and to keep tracking this port. Besides, this wiki page will be useful to write some code snippets about what are the difficulties that I'm having on the port and maybe can be useful for someone else.

I will take [[User:Humitos/PortingGetBooks|this guide]] as reference on the Gtk3 porting.

= Code Snippets =

== Gtk.Style.fg_gc ==

gc = self.get_style().fg_gc[Gtk.StateType.NORMAL]

replaced by:

gc = self.get_style().fg[Gtk.StateType.NORMAL]

== Gtk.DrawingArea ==

self.layout = self.create_pango_layout('')
self.layout.set_text(self.title_original)

replaced by:

self.layout = self.create_pango_layout('')
self.layout.set_text(self.title_original, len(self.title_original)

----

self.lessonbuffer = Gtk.TextBuffer.new(self.tagtable)
self.lessontext = Gtk.TextView.new_with_buffer(self.lessonbuffer)

= Gtk.TextTag =

instructions_tag = Gtk.TextTag('instructions')

replaced by:

instructions_tag = Gtk.TextTag.new('instructions')

Features/GTK3/Porting/Typing Turtle

2012-07-19T14:22:30Z

Humitos: /* Code Snippets */

Features/GTK3/Porting/Typing Turtle

2012-07-19T14:17:12Z

Humitos: /* Code Snippets */

Features/GTK3/Porting/Typing Turtle

2012-07-19T14:05:32Z

Humitos:

Features/GTK3/Porting/Typing Turtle

2012-07-19T14:04:13Z

Humitos: Created page with "This page is being performed while I'm porting Typing Turtle Activity to Gtk3. There is a [ticket] with some useful information that I'm using on the porting and to keep trac..."

User:Humitos/PortingLog

2012-07-18T14:33:25Z

Humitos: moved User:Humitos/PortingLog to Features/GTK3/Porting/Log

#REDIRECT [[Features/GTK3/Porting/Log]]

Features/GTK3/Porting/Log

2012-07-18T14:33:25Z

Humitos: moved User:Humitos/PortingLog to Features/GTK3/Porting/Log

This page is being performed while I'm porting Log Activity to Gtk3.

There is a [http://bugs.sugarlabs.org/ticket/3761 ticket] with some useful information that I'm using on the porting and to keep tracking this port. Besides, this wiki page will be useful to write some code snippets about what are the difficulties that I'm having on the port and maybe can be useful for someone else.

I will take [[User:Humitos/PortingGetBooks|this guide]] as reference on the Gtk3 porting.

= Code Snippets =

== Gtk.TextView ==

* gtk2: http://www.pygtk.org/docs/pygtk/class-gtktextview.html#method-gtktextview--scroll-to-mark
* Gtk3: http://developer.gnome.org/gtk3/3.5/GtkTextView.html#gtk-text-view-scroll-to-mark

Gtk.TextView.scroll_to_mark needs all the arguments. In gtk2 version three of them were optional (use_align, xalign, yalign)

self._textview.scroll_to_mark(log.get_insert(), 0)

replaced with:

self._textview.scroll_to_mark(log.get_insert(), 0, use_align=False, xalign=0.5, yalign=0.5)

== Gtk.TreeSortable.set_sort_func ==

* http://python-gtk-3-tutorial.readthedocs.org/en/latest/treeview.html#Gtk.TreeSortable.set_sort_func

This function sometimes receives ''user_data'' so we need to add an optional argument to the definition.

def _sort_logfile(self, treemodel, itera, iterb):

replaced by:

def _sort_logfile(self, treemodel, itera, iterb, user_data=None):

= Clipboard =

* Gtk3: http://python-gtk-3-tutorial.readthedocs.org/en/latest/clipboard.html
** http://developer.gnome.org/gtk3/3.5/GtkTextBuffer.html#gtk-text-buffer-copy-clipboard

To integrate the clipboard of the activity with the ''MAIN'' clipboard (the Sugar one) we should obtain that clipboard:

# Clipboard of the activity
self.clipboard = Gtk.Clipboard.get(Gdk.SELECTION_CLIPBOARD)

And then, when the ''Copy'' button is pressed we should call this function (in the callback). The ''self.viewer.'''''active_log''' is a Gtk.TextBuffer

self.viewer.active_log.copy_clipboard(self.clipboard)

= Missing things =

* Look for a '''FIXME''' in the code (logviewer.py)

Features/GTK3/Porting/Log

2012-07-18T14:15:44Z

Humitos: /* Missing things */

This page is being performed while I'm porting Log Activity to Gtk3.

There is a [http://bugs.sugarlabs.org/ticket/3761 ticket] with some useful information that I'm using on the porting and to keep tracking this port. Besides, this wiki page will be useful to write some code snippets about what are the difficulties that I'm having on the port and maybe can be useful for someone else.

I will take [[User:Humitos/PortingGetBooks|this guide]] as reference on the Gtk3 porting.

= Code Snippets =

== Gtk.TextView ==

* gtk2: http://www.pygtk.org/docs/pygtk/class-gtktextview.html#method-gtktextview--scroll-to-mark
* Gtk3: http://developer.gnome.org/gtk3/3.5/GtkTextView.html#gtk-text-view-scroll-to-mark

Gtk.TextView.scroll_to_mark needs all the arguments. In gtk2 version three of them were optional (use_align, xalign, yalign)

self._textview.scroll_to_mark(log.get_insert(), 0)

replaced with:

self._textview.scroll_to_mark(log.get_insert(), 0, use_align=False, xalign=0.5, yalign=0.5)

== Gtk.TreeSortable.set_sort_func ==

* http://python-gtk-3-tutorial.readthedocs.org/en/latest/treeview.html#Gtk.TreeSortable.set_sort_func

This function sometimes receives ''user_data'' so we need to add an optional argument to the definition.

def _sort_logfile(self, treemodel, itera, iterb):

replaced by:

def _sort_logfile(self, treemodel, itera, iterb, user_data=None):

= Clipboard =

* Gtk3: http://python-gtk-3-tutorial.readthedocs.org/en/latest/clipboard.html
** http://developer.gnome.org/gtk3/3.5/GtkTextBuffer.html#gtk-text-buffer-copy-clipboard

To integrate the clipboard of the activity with the ''MAIN'' clipboard (the Sugar one) we should obtain that clipboard:

# Clipboard of the activity
self.clipboard = Gtk.Clipboard.get(Gdk.SELECTION_CLIPBOARD)

And then, when the ''Copy'' button is pressed we should call this function (in the callback). The ''self.viewer.'''''active_log''' is a Gtk.TextBuffer

self.viewer.active_log.copy_clipboard(self.clipboard)

= Missing things =

* Look for a '''FIXME''' in the code (logviewer.py)

Features/GTK3/Porting/Log

2012-07-18T14:08:02Z

Humitos: /* Clipboard */

This page is being performed while I'm porting Log Activity to Gtk3.

There is a [http://bugs.sugarlabs.org/ticket/3761 ticket] with some useful information that I'm using on the porting and to keep tracking this port. Besides, this wiki page will be useful to write some code snippets about what are the difficulties that I'm having on the port and maybe can be useful for someone else.

I will take [[User:Humitos/PortingGetBooks|this guide]] as reference on the Gtk3 porting.

= Code Snippets =

== Gtk.TextView ==

* gtk2: http://www.pygtk.org/docs/pygtk/class-gtktextview.html#method-gtktextview--scroll-to-mark
* Gtk3: http://developer.gnome.org/gtk3/3.5/GtkTextView.html#gtk-text-view-scroll-to-mark

Gtk.TextView.scroll_to_mark needs all the arguments. In gtk2 version three of them were optional (use_align, xalign, yalign)

self._textview.scroll_to_mark(log.get_insert(), 0)

replaced with:

self._textview.scroll_to_mark(log.get_insert(), 0, use_align=False, xalign=0.5, yalign=0.5)

== Gtk.TreeSortable.set_sort_func ==

* http://python-gtk-3-tutorial.readthedocs.org/en/latest/treeview.html#Gtk.TreeSortable.set_sort_func

This function sometimes receives ''user_data'' so we need to add an optional argument to the definition.

def _sort_logfile(self, treemodel, itera, iterb):

replaced by:

def _sort_logfile(self, treemodel, itera, iterb, user_data=None):

= Clipboard =

* Gtk3: http://python-gtk-3-tutorial.readthedocs.org/en/latest/clipboard.html
** http://developer.gnome.org/gtk3/3.5/GtkTextBuffer.html#gtk-text-buffer-copy-clipboard

To integrate the clipboard of the activity with the ''MAIN'' clipboard (the Sugar one) we should obtain that clipboard:

# Clipboard of the activity
self.clipboard = Gtk.Clipboard.get(Gdk.SELECTION_CLIPBOARD)

And then, when the ''Copy'' button is pressed we should call this function (in the callback). The ''self.viewer.'''''active_log''' is a Gtk.TextBuffer

self.viewer.active_log.copy_clipboard(self.clipboard)

= Missing things =

* Copy button doesn't work
* Look for a '''FIXME''' in the code (logviewer.py)

Features/GTK3/Porting/Log

2012-07-18T14:07:43Z

Humitos:

This page is being performed while I'm porting Log Activity to Gtk3.

There is a [http://bugs.sugarlabs.org/ticket/3761 ticket] with some useful information that I'm using on the porting and to keep tracking this port. Besides, this wiki page will be useful to write some code snippets about what are the difficulties that I'm having on the port and maybe can be useful for someone else.

I will take [[User:Humitos/PortingGetBooks|this guide]] as reference on the Gtk3 porting.

= Code Snippets =

== Gtk.TextView ==

* gtk2: http://www.pygtk.org/docs/pygtk/class-gtktextview.html#method-gtktextview--scroll-to-mark
* Gtk3: http://developer.gnome.org/gtk3/3.5/GtkTextView.html#gtk-text-view-scroll-to-mark

Gtk.TextView.scroll_to_mark needs all the arguments. In gtk2 version three of them were optional (use_align, xalign, yalign)

self._textview.scroll_to_mark(log.get_insert(), 0)

replaced with:

self._textview.scroll_to_mark(log.get_insert(), 0, use_align=False, xalign=0.5, yalign=0.5)

== Gtk.TreeSortable.set_sort_func ==

* http://python-gtk-3-tutorial.readthedocs.org/en/latest/treeview.html#Gtk.TreeSortable.set_sort_func

This function sometimes receives ''user_data'' so we need to add an optional argument to the definition.

def _sort_logfile(self, treemodel, itera, iterb):

replaced by:

def _sort_logfile(self, treemodel, itera, iterb, user_data=None):

= Clipboard =

* Gtk3: http://python-gtk-3-tutorial.readthedocs.org/en/latest/clipboard.html
** http://developer.gnome.org/gtk3/3.5/GtkTextBuffer.html#gtk-text-buffer-copy-clipboard

To integrate the clipboard of the activity with the ''MAIN'' clipboard (the Sugar one) we should obtain that clipboard:

# Clipboard of the activity
self.clipboard = Gtk.Clipboard.get(Gdk.SELECTION_CLIPBOARD)

And then, when the ''Copy'' button is pressed we should call this function (in the callback). The ''self.viewer.'''''active_log'' is a Gtk.TextBuffer

self.viewer.active_log.copy_clipboard(self.clipboard)

= Missing things =

* Copy button doesn't work
* Look for a '''FIXME''' in the code (logviewer.py)

Features/GTK3/Porting/Log

2012-07-18T13:29:14Z

Humitos: /* Code Snippets */

Features/GTK3/Porting/Log

2012-07-18T13:22:42Z

Humitos:

Features/GTK3/Porting/Log

2012-07-18T13:07:30Z

Humitos: