Sugar Labs - User contributions [en]

Development Team/Almanac/lang-es

2009-09-01T20:21:17Z

Fede: /* How do i remove an specific button from the toolbar? */

{{translation
| source = Development_Team/Almanac
| lang = es
| status = {{translation/incomplete/}}
}}

{{Almanac}}
{{Almanac TOC}}
== ¿Cómo puedo obtener ayuda adicional más allá de este almanaque? ==
* ¿Quieres comenzar con los básico del desarrollo para Sugar? Puedes visitar el [http://wiki.sugarlabs.org/images/5/51/Activity_Handbook_200805_online.pdf Activity Handbook] de OLPC Austria (''Ten en cuenta que este manual fue actualizado por última vez en mayo del 2008, las capturas de tienen el diseño pre-8.2. En términos de código en sí, las cosas deberían funcionar como están descriptas. Si encuentra algún problema por favor póngase en contacto con [[User:ChristophD|ChristophD]].'')
* Ver también [[Development Team/Almanac/Code Snippets]]

Ahora, vamos con el almanaque actual...

== ¿Dónde puedo ver los cambios de la API? ==
API changes between OLPC releases can be seen here: [[Development Team/Almanac/API Changes|API Changes]]

== Comenzando ==
=== ¿Cómo estructuro mis archivos para que sean una actividad de válido en Sugar? ===
Puedes encontrar información sobre la estructura de la actividad aquí: [[Development Team/Almanac/Activity Bundles|Activity Bundles]]

=== ¿Cómo puedo hacer un icono para mi actividad? ===
La información sobre lo que debe hacer se puede encontrar aquí: [[Development Team/Almanac/Making Icons|Making Icons]]

== Paquete: sugar ==
* [[Development Team/Almanac/sugar.env|sugar.env]]
* [[Development Team/Almanac/sugar.profile|sugar.profile]]
* [[Development Team/Almanac/sugar.mime|sugar.mime]]
* [[Development Team/Almanac/sugar.logger|sugar.logger]]

== Paquete: sugar.activity ==
* [[Development Team/Almanac/sugar.activity.activity|sugar.activity.activity]]
* [[Development Team/Almanac/sugar.activity.activityfactory|sugar.activity.activityfactory]]
* [[Development Team/Almanac/sugar.activity.registry|sugar.activity.registry]]

== Paquete: sugar.datastore ==
* [[Development Team/Almanac/sugar.datastore.datastore|sugar.datastore.datastore]]

== Paquete: sugar.graphics ==
* [[Development Team/Almanac/sugar.graphics.alert|sugar.graphics.alert]]
* [[Development Team/Almanac/sugar.graphics.icon|sugar.graphics.icon]]
* [[Development Team/Almanac/sugar.graphics.notebook|sugar.graphics.notebook]]
* [[Development Team/Almanac/sugar.graphics.toolbutton|sugar.graphics.toolbutton]]
* [[Development Team/Almanac/sugar.graphics.toolbox|sugar.graphics.toolbox]]
* [[Development Team/Almanac/sugar.graphics.style|sugar.graphics.style]]

== Paquete: sugar.presence ==
* [[Development Team/Almanac/Sugar.presence|Sugar.presence]]
* [[Development Team/Almanac/Sugar.presence.activity|Sugar.presence.activity]]
* [[Development Team/Almanac/Sugar.presence.buddy|Sugar.presence.buddy]]
* [[Development Team/Almanac/Sugar.presence.presenceservice|Sugar.presence.presenceservice]]

== Clipboard ==
* Notas sobre el uso del [[Development Team/Almanac/GTK's Clipboard Module|módulo Clipboard de GTK ]]

== Logging ==
* [[Development Team/Almanac/sugar.logger|sugar.logger]]
* Notas sobre el uso del [[Development Team/Almanac/Python Standard Logging|standard de Logging en Python]]

== Internacionalización ==
*[[Development Team/Almanac/Internationalization|Internationalization]]

== Texto y gráficos para las actividades de Sugar ==
* [[Development Team/Almanac/Pango|Pango]]
=== ¿Cómo puedo crear un cuadro de texto para la edición de código? ===
Puedes usar gtksourceview2
<pre>
import gtk
import gtksourceview2
from sugar.graphics import style

...

# Configuramos el buffer
buffer = gtksourceview2.Buffer()
if hasattr(buffer, 'set_highlight'): # handle different API versions
buffer.set_highlight(True)
else:
buffer.set_highlight_syntax(True)

# Configuramos el tipo MIME para el buffer
lang_manager = gtksourceview2.language_manager_get_default()
if hasattr(lang_manager, 'list_languages'): # again, handle different APIs
langs = lang_manager.list_languages()
else:
lang_ids = lang_manager.get_language_ids()
langs = [lang_manager.get_language(lang_id)
for lang_id in lang_ids]
for lang in langs:
for m in lang.get_mime_types():
if m == mime_type: # <-- this is the mime type you want
buffer.set_language(lang)

# Establecemos el objeto para la vista, usarlo como gtk.TextView
view = gtksourceview2.View(buffer)
view.set_size_request(300, 450)
view.set_editable(True)
view.set_cursor_visible(True)
view.set_show_line_numbers(True)
view.set_wrap_mode(gtk.WRAP_CHAR)
view.set_right_margin_position(80)
#view.set_highlight_current_line(True) #FIXME: Ugly color
view.set_auto_indent(True)
view.modify_font(pango.FontDescription("Monospace " +
str(style.FONT_SIZE)))
...

</pre>

Para agregar texto al buffer:
<pre>
buffer.set_text(text)
</pre>
Para obtener todo el texto:
<pre>
text = buffer.get_text(buffer.get_start_iter(), buffer.get_end_iter())
</pre>

Probablemente quieras poner la view(vista) en un gtk.ScrolledWindow
<pre>
sw = gtk.ScrolledWindow()
sw.add(view)
sw.set_policy(gtk.POLICY_AUTOMATIC, gtk.POLICY_AUTOMATIC)
</pre>
y agregar el el objeto sw en vez de la view(vista).

Puedes encotnrar más en el código fuete de Pippyy en jarabe.view.sourceview.

== Audio y Video ==
* [[Development Team/Almanac/GStreamer|GStreamer]]

== Ratón ==
=== ¿Cómo puedo cambiar el cursor del ratón por el cursor de espera en mi actividad? ===
En la subclase de tu actividad:

<pre>
self.window.set_cursor( gtk.gdk.Cursor(gtk.gdk.WATCH) )
</pre>

y para volver al que está por defecto:

<pre>
self.window.set_cursor( None );
</pre>

=== ¿Cómo puedo rastrear la posición del ratón? ===
Existen varias razones por las que te puede interesar controlar la posición del ratón, que van desde el entretenimiento ([[http://en.wikipedia.org/wiki/Xeyes]]) a lo funcional (ocultar ciertas ventanas cuando el ratón no se ha movido por un par de segundos y volver a hacer aparecer esos elementos cuando este se mueva nuevamente). Esta es una manera en la cual se puede implementar esta funcionalidad:
<pre>

...
self.hideWidgetsTime = time.time()
self.mx = -1
self.my = -1
self.HIDE_WIDGET_TIMEOUT_ID = gobject.timeout_add( 500, self.mouseMightHaveMovedCb )

def _mouseMightHaveMovedCb( self ):
x, y = self.get_pointer()
passedTime = 0

if (x != self.mx or y != self.my):
self.hideWidgetsTime = time.time()
if (self.hiddenWidgets):
self.showWidgets()
self.hiddenWidgets = False
else:
passedTime = time.time() - self.hideWidgetsTime

if (passedTime >= 3):
if (not self.hiddenWidgets):
self.hideWidgets()
self.hiddenWidgets = True

self.mx = x
self.my = y
return True

</pre>

== Varios ==

Las tareas que aparecen más abajo son técnicas útiles que he encontrado mientras escribía código y documentación para esta referencia. No ha sido categorizadas aún.

=== ¿Cómo se si mi actividad está "activa" o no? ===

Puedes configurar un evento usando la constante VISIBILITY_NOTIFY_MASK para saber cuando se cambia la visibilidad. Luego en el callback para este evento lo que debes hacer es comprar el estado del evento con las variables gtk definidas para la visibilidad de tu actividad. Puedes ver [http://www.pygtk.org/docs/pygtk/gdk-constants.html#gdk-visibility-state-constants la sección de Constantes de Estado de Visibilidad de GDK] gtk.gdk.Constants para más información.

<pre>
# Notify when the visibility state changes by calling self.__visibility_notify_cb
# (PUT THIS IN YOUR ACTIVITY CODE - EG. THE __init__() METHOD)
self.add_events(gtk.gdk.VISIBILITY_NOTIFY_MASK)
self.connect("visibility-notify-event", self.__visibility_notify_cb)
...
# Callback method for when the activity's visibility changes
def __visibility_notify_cb(self, window, event):
if event.state == gtk.gdk.VISIBILITY_FULLY_OBSCURED:
print "I am not visible"
elif event.state in [gtk.gdk.VISIBILITY_UNOBSCURED, gtk.gdk.VISIBILITY_PARTIAL]:
print "I am visible"
</pre>

=== ¿Cómo puedo obtener la cantidad de espacio libre disponible dentro del directorio /home? ===
La siguiente función usa el módulo [http://docs.python.org/lib/module-statvfs.html statvfs]. El código siguiente muestra cómo obtener la cantidad total de espacio libre en /home.

<pre>
#### Método getFreespaceKb: devuelve el espacio disponible en kilobytes.
def getFreespaceKb(self):
stat = os.statvfs("/home")
freebytes = stat[statvfs.F_BSIZE] * stat[statvfs.F_BAVAIL]
freekb = freebytes / 1024
return freekb
</pre>

Ten en cuenta que asumir cosas acerca de "/home" no es una buena idea, es mejor usar os.environ['HOME']. Rainbow pondrá los archivos actuales en otros lugares, algunos en el ramdisk, otros en la flash.
Ten claro que espacio libre en el sistema de archivos realmente te importa.

=== ¿Cómo puedo saber si mi actividad se está ejecutando en una XO? ===
Sugar corre en PCs comunes, así como en XO. Aunque tu actuvidad probablemente corra en una XO real, algunas personas necesitan utilizarla en otros lados. Normalmente no deberías escribir una actividad que le importe si es una XO o no donde se está ejecutando. Si por alguna extraña razón necesitas saber, la forma más fácil es verificar si /sys/power/olpc-pm (el manejador de poder de la XO) existe.

[http://lists.laptop.org/pipermail/devel/2008-June/015923.html reliably detecting if running on an XO]
[[olpc:Power Management Interface]]</ref>

<pre>
import os
...
#Devuelve un valor booleano que nos dice si estamos en una XO o no.
print os.path.exists('/sys/power/olpc-pm')
</pre>

=== ¿Cómo puedo saber la configuración actual del lenguage en mi XO? ===
La variable 'LANG' te dice que lenguaje está actualmente activo en el XO. El código siguiente muestra cómo buscar en el valor de esta variable.

<pre>
import os
...
_logger.debug(os.environ['LANG'])
</pre>

=== ¿Cómo llamar repetidamente a un método específico después de un número N de segundos? ===
La función gobject.timeout_add() te permite invocar un método después de un período de tiempo determinado. Si quieres llamar a un método en varias ocasiones, simplemente sigue llamando a la función de gobject.timeout_add desde tu función.
El código de abajo es un ejemplo simple en donde la función que implementa el timeout se llama repeatedly_call. Nota que la sincronización entre las llamadas son aproximadas. Para que esto funcione debes llamar a repeatedly_call() desde alguna parte de tu código.

Puedes ver un mejor ejemplo de este patrón en uso [[olpc:Pango#How_do_I_dynamically_set_the_text_in_a_pango_layout.3F | aquí]].

<pre>

#Este método se llama a sí mismo aproximadamente cada 1 segundo
def repeatedly_call(self):
now = datetime.datetime.now()
gobject.timeout_add(self.repeat_period_msec, self.repeatedly_update_time)
</pre>

=== ¿Cómo puedo actualizar la build que se ejecuta en mi XO? ===

Hay varias páginas que te dan instrucciones sobre cómo instalar / actualizar la build actual.

* Si usted ya tiene una build instalada y una conexión a Internet, primero pruebe usar [[OLPC: OLPC-update]].
* Si eso no funciona, puedes mirar las instrucciones para una [[OLPC: Activated upgrade]] que se puede hacer a través de un USB]

Como mencionan las instrucciones en las páginas más arriba, asegurate de instalar tus actividades por separado luego de que actualices a una build específica.

=== Estoy desarrollando en una XO pero mi teclado y la configuración de idioma no son ideales. ¿Cómo puedo cambiarlos? ===

Las laptops intenacionalizadas tienen configuraciones que te pueden retrazar mientras estás desarrollando. Para cambiar las configuraciones de idioma usa el [[olpc:Sugar Control Panel]]

Keyboard settings on internationalized laptops<ref>[[olpc:Keyboard layouts#OLPC keyboard layouts]]</ref> can also be suboptimal, especially as characters like "-" and "/" are in unfamiliar positions. You can use the <tt>setxkbmap</tt> command in the [[olpc:Terminal Activity]] to reset the type of keyboard input used and then attach a standard U.S. keyboard that will allow you to type normally. The command below sets the keyboard to the US mapping (it will reset to the default internationalized mapping upon restart).

setxkbmap us

=== My Python activity wants to use threads; how do I do that? ===

A question that has been answered with limited success is which threading patterns are most appropriate for use in Sugar. The following pattern of code to work fine in basic instances:

<pre>
#### Method: __init__, initialize this AnnotateActivity instance
def __init__(self, handle):
...
self.sample_thread = Thread(target=self.announce_thread, args=())
self.sample_thread.setDaemon(0)
self.sample_thread.start()
...

def announce_thread(self):
while (self.Running):
time.sleep(1)
print "thread running"
self._update_chat_text("Thread", "In here")
</pre>

This is the basic series of steps that most online documentation on python suggests to use when trying to work with threads in python. The problem is that it is unclear how this pattern relates to code that worked in the SimCity activity:

<pre>
import gobject
gobject.threads_init()
#import dbus.mainloop.glib
#dbus.mainloop.glib.threads_init()
</pre>

It should be noted that in the SimCity activity the pygame sound player would not produce sound reliably unless this setup was done.



Should the two patterns always be used in tandem? It seems that the latter code is mainly to initiate gobject and other libraries to work with threading, but it is unclear what restrictions there are with using threading with these libraries. Does one take precedence over the other? It is not clear if there is any problem with using the standard python threading code on the sugar technology stack.





In fact, experiments with threading on sugar leads to several different problems. For one thing, thread termination was tricky - using the can_close() method for sugar activities to terminate an activity only killed threads in some circumstances. It did not properly handle terminating threads in the case of CTRL-C or terminal interrupts. You can try to catch signals (SIGINT, SIGTERM or SIGHUP), but you will still be running in to errors in terminating child threads using these as well.





Another set of errors with threading comes up when trying to combine with stream tubes. The bottom line is that it is unclear what the scope of threading in a Sugar activity should be - should it simply work if you do the standard python threading pattern, is the use of the glib.threads_init and gobject.threads_init calls necessary, are there other interactions with threads and dbus that need to be accounted for? With more clarity from sugar developers on how the platform envisions threading to work in an activity, we can be more comfortable writing entries in the Almanac to help developers write error-free code.



=== How do I customize the title that is displayed for each instance of my activity? ===

By default, activity titles are just the generic activity names that you specify in your activity.info file. In some applications, you may want the activity title to be more dynamic.

For example, it makes sense to set the title for different browser sessions to the active web page being visited. That way, when you look back in the journal at the different browser sessions you have run in the previous few days, you can identify unique sessions based on the website you happened to be visiting at the time.

The code below shows how you can set the metadata for your activity to reflect a dynamic title based on whatever session criteria you feel is important. This example is adapted from the Browse activity, which sets activity instance titles based on the title of the current web page being visited.

<pre>
if self.metadata['mime_type'] == 'text/plain':
if not self._jobject.metadata['title_set_by_user'] == '1':
if self._browser.props.title:
# Set the title of this activity to be the current
# title of the page being visited by the browser.
self.metadata['title'] = self._browser.props.title
</pre>

=== ¿Qué paquetes están disponibles dentro de Sugar para el desarrollo de juegos? ===

Si tu actividad requiere herramientas para desarrollar juegos robustos y límpios deberías utilizar [http://www.pygame.org/ pygame]. Puedes importar el paquete para usarlo con cualqueir actividad de la siguiente forma:

<pre>
import pygame
...
</pre>

=== How do I detect when one of the game buttons on the laptop have been pressed? ===

The laptop game buttons (the circle, square, x, and check buttons next to the LCD) are encoded as page up, home, page down and end respectively. So, you can detect their press by listening for these specific events. For example, the code below listens for button presses and then just writes to an output widget which button was pressed.

<pre>
...
#### Initialize this activity.
def __init__(self, handle):
...
self.connect('key-press-event', self._keyPressCb)
...

#### Method _keyPressCb, which catches any presses of the game buttons.
def _keyPressCb(self, widget, event):

keyname = gtk.gdk.keyval_name(event.keyval)

if (keyname == 'KP_Page_Up'):
self._chat += "\nCircle Pressed!"
self._chat_buffer.set_text(self._chat)
elif (keyname == 'KP_Page_Down'):
self._chat += "\nX Pressed!"
self._chat_buffer.set_text(self._chat)
elif (keyname == 'KP_Home'):
self._chat += "\nSquare Pressed!"
self._chat_buffer.set_text(self._chat)
elif (keyname == 'KP_End'):
self._chat += "\nCheck Pressed!"
self._chat_buffer.set_text(self._chat)

return False
</pre>

=== How do I detect if one of the joystick buttons has been pressed? ===

This is the same process as detecting game buttons, except with different names for the keys. Again, you listen for "key-press-event" signals and then in your callback you check to see if the pressed button was one of the joystick keys.

<pre>
#### Initialize this activity.
def __init__(self, handle):
...
self.connect('key-press-event', self._keyPressCb)
...

#### Method _keyPressCb, which catches any presses of the game buttons.
def _keyPressCb(self, widget, event):

keyname = gtk.gdk.keyval_name(event.keyval)

if (keyname == 'KP_Up'):
self._chat += "\nUp Pressed!"
self._chat_buffer.set_text(self._chat)
elif (keyname == 'KP_Down'):
self._chat += "\nDown Pressed!"
self._chat_buffer.set_text(self._chat)
elif (keyname == 'KP_Left'):
self._chat += "\nLeft Pressed!"
self._chat_buffer.set_text(self._chat)
elif (keyname == 'KP_Right'):
self._chat += "\nRight Pressed!"
self._chat_buffer.set_text(self._chat)

return False
</pre>

=== ¿Cómo elimino un botón específico de la barra de herramientas? ===

Aquí hay un ejemplo de como borrar el botón de compartir:

<pre>
activity_toolbar = toolbox.get_activity_toolbar()
activity_toolbar.remove(activity_toolbar.share)
activity_toolbar.share = None
</pre>

== Notes ==
<references />

[[Category:Documentation]]
[[Category:Development Team]]

Development Team/Almanac/lang-es

2009-09-01T20:20:08Z

Fede: /* ¿Qué paquetes están disponibles dentro de Sugar que soportan el desarrollo de juegos? */

{{translation
| source = Development_Team/Almanac
| lang = es
| status = {{translation/incomplete/}}
}}

{{Almanac}}
{{Almanac TOC}}
== ¿Cómo puedo obtener ayuda adicional más allá de este almanaque? ==
* ¿Quieres comenzar con los básico del desarrollo para Sugar? Puedes visitar el [http://wiki.sugarlabs.org/images/5/51/Activity_Handbook_200805_online.pdf Activity Handbook] de OLPC Austria (''Ten en cuenta que este manual fue actualizado por última vez en mayo del 2008, las capturas de tienen el diseño pre-8.2. En términos de código en sí, las cosas deberían funcionar como están descriptas. Si encuentra algún problema por favor póngase en contacto con [[User:ChristophD|ChristophD]].'')
* Ver también [[Development Team/Almanac/Code Snippets]]

Ahora, vamos con el almanaque actual...

== ¿Dónde puedo ver los cambios de la API? ==
API changes between OLPC releases can be seen here: [[Development Team/Almanac/API Changes|API Changes]]

== Comenzando ==
=== ¿Cómo estructuro mis archivos para que sean una actividad de válido en Sugar? ===
Puedes encontrar información sobre la estructura de la actividad aquí: [[Development Team/Almanac/Activity Bundles|Activity Bundles]]

=== ¿Cómo puedo hacer un icono para mi actividad? ===
La información sobre lo que debe hacer se puede encontrar aquí: [[Development Team/Almanac/Making Icons|Making Icons]]

== Paquete: sugar ==
* [[Development Team/Almanac/sugar.env|sugar.env]]
* [[Development Team/Almanac/sugar.profile|sugar.profile]]
* [[Development Team/Almanac/sugar.mime|sugar.mime]]
* [[Development Team/Almanac/sugar.logger|sugar.logger]]

== Paquete: sugar.activity ==
* [[Development Team/Almanac/sugar.activity.activity|sugar.activity.activity]]
* [[Development Team/Almanac/sugar.activity.activityfactory|sugar.activity.activityfactory]]
* [[Development Team/Almanac/sugar.activity.registry|sugar.activity.registry]]

== Paquete: sugar.datastore ==
* [[Development Team/Almanac/sugar.datastore.datastore|sugar.datastore.datastore]]

== Paquete: sugar.graphics ==
* [[Development Team/Almanac/sugar.graphics.alert|sugar.graphics.alert]]
* [[Development Team/Almanac/sugar.graphics.icon|sugar.graphics.icon]]
* [[Development Team/Almanac/sugar.graphics.notebook|sugar.graphics.notebook]]
* [[Development Team/Almanac/sugar.graphics.toolbutton|sugar.graphics.toolbutton]]
* [[Development Team/Almanac/sugar.graphics.toolbox|sugar.graphics.toolbox]]
* [[Development Team/Almanac/sugar.graphics.style|sugar.graphics.style]]

== Paquete: sugar.presence ==
* [[Development Team/Almanac/Sugar.presence|Sugar.presence]]
* [[Development Team/Almanac/Sugar.presence.activity|Sugar.presence.activity]]
* [[Development Team/Almanac/Sugar.presence.buddy|Sugar.presence.buddy]]
* [[Development Team/Almanac/Sugar.presence.presenceservice|Sugar.presence.presenceservice]]

== Clipboard ==
* Notas sobre el uso del [[Development Team/Almanac/GTK's Clipboard Module|módulo Clipboard de GTK ]]

== Logging ==
* [[Development Team/Almanac/sugar.logger|sugar.logger]]
* Notas sobre el uso del [[Development Team/Almanac/Python Standard Logging|standard de Logging en Python]]

== Internacionalización ==
*[[Development Team/Almanac/Internationalization|Internationalization]]

== Texto y gráficos para las actividades de Sugar ==
* [[Development Team/Almanac/Pango|Pango]]
=== ¿Cómo puedo crear un cuadro de texto para la edición de código? ===
Puedes usar gtksourceview2
<pre>
import gtk
import gtksourceview2
from sugar.graphics import style

...

# Configuramos el buffer
buffer = gtksourceview2.Buffer()
if hasattr(buffer, 'set_highlight'): # handle different API versions
buffer.set_highlight(True)
else:
buffer.set_highlight_syntax(True)

# Configuramos el tipo MIME para el buffer
lang_manager = gtksourceview2.language_manager_get_default()
if hasattr(lang_manager, 'list_languages'): # again, handle different APIs
langs = lang_manager.list_languages()
else:
lang_ids = lang_manager.get_language_ids()
langs = [lang_manager.get_language(lang_id)
for lang_id in lang_ids]
for lang in langs:
for m in lang.get_mime_types():
if m == mime_type: # <-- this is the mime type you want
buffer.set_language(lang)

# Establecemos el objeto para la vista, usarlo como gtk.TextView
view = gtksourceview2.View(buffer)
view.set_size_request(300, 450)
view.set_editable(True)
view.set_cursor_visible(True)
view.set_show_line_numbers(True)
view.set_wrap_mode(gtk.WRAP_CHAR)
view.set_right_margin_position(80)
#view.set_highlight_current_line(True) #FIXME: Ugly color
view.set_auto_indent(True)
view.modify_font(pango.FontDescription("Monospace " +
str(style.FONT_SIZE)))
...

</pre>

Para agregar texto al buffer:
<pre>
buffer.set_text(text)
</pre>
Para obtener todo el texto:
<pre>
text = buffer.get_text(buffer.get_start_iter(), buffer.get_end_iter())
</pre>

Probablemente quieras poner la view(vista) en un gtk.ScrolledWindow
<pre>
sw = gtk.ScrolledWindow()
sw.add(view)
sw.set_policy(gtk.POLICY_AUTOMATIC, gtk.POLICY_AUTOMATIC)
</pre>
y agregar el el objeto sw en vez de la view(vista).

Puedes encotnrar más en el código fuete de Pippyy en jarabe.view.sourceview.

== Audio y Video ==
* [[Development Team/Almanac/GStreamer|GStreamer]]

== Ratón ==
=== ¿Cómo puedo cambiar el cursor del ratón por el cursor de espera en mi actividad? ===
En la subclase de tu actividad:

<pre>
self.window.set_cursor( gtk.gdk.Cursor(gtk.gdk.WATCH) )
</pre>

y para volver al que está por defecto:

<pre>
self.window.set_cursor( None );
</pre>

=== ¿Cómo puedo rastrear la posición del ratón? ===
Existen varias razones por las que te puede interesar controlar la posición del ratón, que van desde el entretenimiento ([[http://en.wikipedia.org/wiki/Xeyes]]) a lo funcional (ocultar ciertas ventanas cuando el ratón no se ha movido por un par de segundos y volver a hacer aparecer esos elementos cuando este se mueva nuevamente). Esta es una manera en la cual se puede implementar esta funcionalidad:
<pre>

...
self.hideWidgetsTime = time.time()
self.mx = -1
self.my = -1
self.HIDE_WIDGET_TIMEOUT_ID = gobject.timeout_add( 500, self.mouseMightHaveMovedCb )

def _mouseMightHaveMovedCb( self ):
x, y = self.get_pointer()
passedTime = 0

if (x != self.mx or y != self.my):
self.hideWidgetsTime = time.time()
if (self.hiddenWidgets):
self.showWidgets()
self.hiddenWidgets = False
else:
passedTime = time.time() - self.hideWidgetsTime

if (passedTime >= 3):
if (not self.hiddenWidgets):
self.hideWidgets()
self.hiddenWidgets = True

self.mx = x
self.my = y
return True

</pre>

== Varios ==

Las tareas que aparecen más abajo son técnicas útiles que he encontrado mientras escribía código y documentación para esta referencia. No ha sido categorizadas aún.

=== ¿Cómo se si mi actividad está "activa" o no? ===

Puedes configurar un evento usando la constante VISIBILITY_NOTIFY_MASK para saber cuando se cambia la visibilidad. Luego en el callback para este evento lo que debes hacer es comprar el estado del evento con las variables gtk definidas para la visibilidad de tu actividad. Puedes ver [http://www.pygtk.org/docs/pygtk/gdk-constants.html#gdk-visibility-state-constants la sección de Constantes de Estado de Visibilidad de GDK] gtk.gdk.Constants para más información.

<pre>
# Notify when the visibility state changes by calling self.__visibility_notify_cb
# (PUT THIS IN YOUR ACTIVITY CODE - EG. THE __init__() METHOD)
self.add_events(gtk.gdk.VISIBILITY_NOTIFY_MASK)
self.connect("visibility-notify-event", self.__visibility_notify_cb)
...
# Callback method for when the activity's visibility changes
def __visibility_notify_cb(self, window, event):
if event.state == gtk.gdk.VISIBILITY_FULLY_OBSCURED:
print "I am not visible"
elif event.state in [gtk.gdk.VISIBILITY_UNOBSCURED, gtk.gdk.VISIBILITY_PARTIAL]:
print "I am visible"
</pre>

=== ¿Cómo puedo obtener la cantidad de espacio libre disponible dentro del directorio /home? ===
La siguiente función usa el módulo [http://docs.python.org/lib/module-statvfs.html statvfs]. El código siguiente muestra cómo obtener la cantidad total de espacio libre en /home.

<pre>
#### Método getFreespaceKb: devuelve el espacio disponible en kilobytes.
def getFreespaceKb(self):
stat = os.statvfs("/home")
freebytes = stat[statvfs.F_BSIZE] * stat[statvfs.F_BAVAIL]
freekb = freebytes / 1024
return freekb
</pre>

Ten en cuenta que asumir cosas acerca de "/home" no es una buena idea, es mejor usar os.environ['HOME']. Rainbow pondrá los archivos actuales en otros lugares, algunos en el ramdisk, otros en la flash.
Ten claro que espacio libre en el sistema de archivos realmente te importa.

=== ¿Cómo puedo saber si mi actividad se está ejecutando en una XO? ===
Sugar corre en PCs comunes, así como en XO. Aunque tu actuvidad probablemente corra en una XO real, algunas personas necesitan utilizarla en otros lados. Normalmente no deberías escribir una actividad que le importe si es una XO o no donde se está ejecutando. Si por alguna extraña razón necesitas saber, la forma más fácil es verificar si /sys/power/olpc-pm (el manejador de poder de la XO) existe.

[http://lists.laptop.org/pipermail/devel/2008-June/015923.html reliably detecting if running on an XO]
[[olpc:Power Management Interface]]</ref>

<pre>
import os
...
#Devuelve un valor booleano que nos dice si estamos en una XO o no.
print os.path.exists('/sys/power/olpc-pm')
</pre>

=== ¿Cómo puedo saber la configuración actual del lenguage en mi XO? ===
La variable 'LANG' te dice que lenguaje está actualmente activo en el XO. El código siguiente muestra cómo buscar en el valor de esta variable.

<pre>
import os
...
_logger.debug(os.environ['LANG'])
</pre>

=== ¿Cómo llamar repetidamente a un método específico después de un número N de segundos? ===
La función gobject.timeout_add() te permite invocar un método después de un período de tiempo determinado. Si quieres llamar a un método en varias ocasiones, simplemente sigue llamando a la función de gobject.timeout_add desde tu función.
El código de abajo es un ejemplo simple en donde la función que implementa el timeout se llama repeatedly_call. Nota que la sincronización entre las llamadas son aproximadas. Para que esto funcione debes llamar a repeatedly_call() desde alguna parte de tu código.

Puedes ver un mejor ejemplo de este patrón en uso [[olpc:Pango#How_do_I_dynamically_set_the_text_in_a_pango_layout.3F | aquí]].

<pre>

#Este método se llama a sí mismo aproximadamente cada 1 segundo
def repeatedly_call(self):
now = datetime.datetime.now()
gobject.timeout_add(self.repeat_period_msec, self.repeatedly_update_time)
</pre>

=== ¿Cómo puedo actualizar la build que se ejecuta en mi XO? ===

Hay varias páginas que te dan instrucciones sobre cómo instalar / actualizar la build actual.

* Si usted ya tiene una build instalada y una conexión a Internet, primero pruebe usar [[OLPC: OLPC-update]].
* Si eso no funciona, puedes mirar las instrucciones para una [[OLPC: Activated upgrade]] que se puede hacer a través de un USB]

Como mencionan las instrucciones en las páginas más arriba, asegurate de instalar tus actividades por separado luego de que actualices a una build específica.

=== Estoy desarrollando en una XO pero mi teclado y la configuración de idioma no son ideales. ¿Cómo puedo cambiarlos? ===

Las laptops intenacionalizadas tienen configuraciones que te pueden retrazar mientras estás desarrollando. Para cambiar las configuraciones de idioma usa el [[olpc:Sugar Control Panel]]

Keyboard settings on internationalized laptops<ref>[[olpc:Keyboard layouts#OLPC keyboard layouts]]</ref> can also be suboptimal, especially as characters like "-" and "/" are in unfamiliar positions. You can use the <tt>setxkbmap</tt> command in the [[olpc:Terminal Activity]] to reset the type of keyboard input used and then attach a standard U.S. keyboard that will allow you to type normally. The command below sets the keyboard to the US mapping (it will reset to the default internationalized mapping upon restart).

setxkbmap us

=== My Python activity wants to use threads; how do I do that? ===

A question that has been answered with limited success is which threading patterns are most appropriate for use in Sugar. The following pattern of code to work fine in basic instances:

<pre>
#### Method: __init__, initialize this AnnotateActivity instance
def __init__(self, handle):
...
self.sample_thread = Thread(target=self.announce_thread, args=())
self.sample_thread.setDaemon(0)
self.sample_thread.start()
...

def announce_thread(self):
while (self.Running):
time.sleep(1)
print "thread running"
self._update_chat_text("Thread", "In here")
</pre>

This is the basic series of steps that most online documentation on python suggests to use when trying to work with threads in python. The problem is that it is unclear how this pattern relates to code that worked in the SimCity activity:

<pre>
import gobject
gobject.threads_init()
#import dbus.mainloop.glib
#dbus.mainloop.glib.threads_init()
</pre>

It should be noted that in the SimCity activity the pygame sound player would not produce sound reliably unless this setup was done.



Should the two patterns always be used in tandem? It seems that the latter code is mainly to initiate gobject and other libraries to work with threading, but it is unclear what restrictions there are with using threading with these libraries. Does one take precedence over the other? It is not clear if there is any problem with using the standard python threading code on the sugar technology stack.





In fact, experiments with threading on sugar leads to several different problems. For one thing, thread termination was tricky - using the can_close() method for sugar activities to terminate an activity only killed threads in some circumstances. It did not properly handle terminating threads in the case of CTRL-C or terminal interrupts. You can try to catch signals (SIGINT, SIGTERM or SIGHUP), but you will still be running in to errors in terminating child threads using these as well.





Another set of errors with threading comes up when trying to combine with stream tubes. The bottom line is that it is unclear what the scope of threading in a Sugar activity should be - should it simply work if you do the standard python threading pattern, is the use of the glib.threads_init and gobject.threads_init calls necessary, are there other interactions with threads and dbus that need to be accounted for? With more clarity from sugar developers on how the platform envisions threading to work in an activity, we can be more comfortable writing entries in the Almanac to help developers write error-free code.



=== How do I customize the title that is displayed for each instance of my activity? ===

By default, activity titles are just the generic activity names that you specify in your activity.info file. In some applications, you may want the activity title to be more dynamic.

For example, it makes sense to set the title for different browser sessions to the active web page being visited. That way, when you look back in the journal at the different browser sessions you have run in the previous few days, you can identify unique sessions based on the website you happened to be visiting at the time.

The code below shows how you can set the metadata for your activity to reflect a dynamic title based on whatever session criteria you feel is important. This example is adapted from the Browse activity, which sets activity instance titles based on the title of the current web page being visited.

<pre>
if self.metadata['mime_type'] == 'text/plain':
if not self._jobject.metadata['title_set_by_user'] == '1':
if self._browser.props.title:
# Set the title of this activity to be the current
# title of the page being visited by the browser.
self.metadata['title'] = self._browser.props.title
</pre>

=== ¿Qué paquetes están disponibles dentro de Sugar para el desarrollo de juegos? ===

Si tu actividad requiere herramientas para desarrollar juegos robustos y límpios deberías utilizar [http://www.pygame.org/ pygame]. Puedes importar el paquete para usarlo con cualqueir actividad de la siguiente forma:

<pre>
import pygame
...
</pre>

=== How do I detect when one of the game buttons on the laptop have been pressed? ===

The laptop game buttons (the circle, square, x, and check buttons next to the LCD) are encoded as page up, home, page down and end respectively. So, you can detect their press by listening for these specific events. For example, the code below listens for button presses and then just writes to an output widget which button was pressed.

<pre>
...
#### Initialize this activity.
def __init__(self, handle):
...
self.connect('key-press-event', self._keyPressCb)
...

#### Method _keyPressCb, which catches any presses of the game buttons.
def _keyPressCb(self, widget, event):

keyname = gtk.gdk.keyval_name(event.keyval)

if (keyname == 'KP_Page_Up'):
self._chat += "\nCircle Pressed!"
self._chat_buffer.set_text(self._chat)
elif (keyname == 'KP_Page_Down'):
self._chat += "\nX Pressed!"
self._chat_buffer.set_text(self._chat)
elif (keyname == 'KP_Home'):
self._chat += "\nSquare Pressed!"
self._chat_buffer.set_text(self._chat)
elif (keyname == 'KP_End'):
self._chat += "\nCheck Pressed!"
self._chat_buffer.set_text(self._chat)

return False
</pre>

=== How do I detect if one of the joystick buttons has been pressed? ===

This is the same process as detecting game buttons, except with different names for the keys. Again, you listen for "key-press-event" signals and then in your callback you check to see if the pressed button was one of the joystick keys.

<pre>
#### Initialize this activity.
def __init__(self, handle):
...
self.connect('key-press-event', self._keyPressCb)
...

#### Method _keyPressCb, which catches any presses of the game buttons.
def _keyPressCb(self, widget, event):

keyname = gtk.gdk.keyval_name(event.keyval)

if (keyname == 'KP_Up'):
self._chat += "\nUp Pressed!"
self._chat_buffer.set_text(self._chat)
elif (keyname == 'KP_Down'):
self._chat += "\nDown Pressed!"
self._chat_buffer.set_text(self._chat)
elif (keyname == 'KP_Left'):
self._chat += "\nLeft Pressed!"
self._chat_buffer.set_text(self._chat)
elif (keyname == 'KP_Right'):
self._chat += "\nRight Pressed!"
self._chat_buffer.set_text(self._chat)

return False
</pre>

=== How do i remove an specific button from the toolbar? ===

This is an example of the share button is removed:

<pre>
activity_toolbar = toolbox.get_activity_toolbar()
activity_toolbar.remove(activity_toolbar.share)
activity_toolbar.share = None
</pre>

== Notes ==
<references />

[[Category:Documentation]]
[[Category:Development Team]]

Development Team/Almanac/lang-es

2009-09-01T20:19:29Z

Fede: /* What packages are available on sugar to support game development? */

{{translation
| source = Development_Team/Almanac
| lang = es
| status = {{translation/incomplete/}}
}}

{{Almanac}}
{{Almanac TOC}}
== ¿Cómo puedo obtener ayuda adicional más allá de este almanaque? ==
* ¿Quieres comenzar con los básico del desarrollo para Sugar? Puedes visitar el [http://wiki.sugarlabs.org/images/5/51/Activity_Handbook_200805_online.pdf Activity Handbook] de OLPC Austria (''Ten en cuenta que este manual fue actualizado por última vez en mayo del 2008, las capturas de tienen el diseño pre-8.2. En términos de código en sí, las cosas deberían funcionar como están descriptas. Si encuentra algún problema por favor póngase en contacto con [[User:ChristophD|ChristophD]].'')
* Ver también [[Development Team/Almanac/Code Snippets]]

Ahora, vamos con el almanaque actual...

== ¿Dónde puedo ver los cambios de la API? ==
API changes between OLPC releases can be seen here: [[Development Team/Almanac/API Changes|API Changes]]

== Comenzando ==
=== ¿Cómo estructuro mis archivos para que sean una actividad de válido en Sugar? ===
Puedes encontrar información sobre la estructura de la actividad aquí: [[Development Team/Almanac/Activity Bundles|Activity Bundles]]

=== ¿Cómo puedo hacer un icono para mi actividad? ===
La información sobre lo que debe hacer se puede encontrar aquí: [[Development Team/Almanac/Making Icons|Making Icons]]

== Paquete: sugar ==
* [[Development Team/Almanac/sugar.env|sugar.env]]
* [[Development Team/Almanac/sugar.profile|sugar.profile]]
* [[Development Team/Almanac/sugar.mime|sugar.mime]]
* [[Development Team/Almanac/sugar.logger|sugar.logger]]

== Paquete: sugar.activity ==
* [[Development Team/Almanac/sugar.activity.activity|sugar.activity.activity]]
* [[Development Team/Almanac/sugar.activity.activityfactory|sugar.activity.activityfactory]]
* [[Development Team/Almanac/sugar.activity.registry|sugar.activity.registry]]

== Paquete: sugar.datastore ==
* [[Development Team/Almanac/sugar.datastore.datastore|sugar.datastore.datastore]]

== Paquete: sugar.graphics ==
* [[Development Team/Almanac/sugar.graphics.alert|sugar.graphics.alert]]
* [[Development Team/Almanac/sugar.graphics.icon|sugar.graphics.icon]]
* [[Development Team/Almanac/sugar.graphics.notebook|sugar.graphics.notebook]]
* [[Development Team/Almanac/sugar.graphics.toolbutton|sugar.graphics.toolbutton]]
* [[Development Team/Almanac/sugar.graphics.toolbox|sugar.graphics.toolbox]]
* [[Development Team/Almanac/sugar.graphics.style|sugar.graphics.style]]

== Paquete: sugar.presence ==
* [[Development Team/Almanac/Sugar.presence|Sugar.presence]]
* [[Development Team/Almanac/Sugar.presence.activity|Sugar.presence.activity]]
* [[Development Team/Almanac/Sugar.presence.buddy|Sugar.presence.buddy]]
* [[Development Team/Almanac/Sugar.presence.presenceservice|Sugar.presence.presenceservice]]

== Clipboard ==
* Notas sobre el uso del [[Development Team/Almanac/GTK's Clipboard Module|módulo Clipboard de GTK ]]

== Logging ==
* [[Development Team/Almanac/sugar.logger|sugar.logger]]
* Notas sobre el uso del [[Development Team/Almanac/Python Standard Logging|standard de Logging en Python]]

== Internacionalización ==
*[[Development Team/Almanac/Internationalization|Internationalization]]

== Texto y gráficos para las actividades de Sugar ==
* [[Development Team/Almanac/Pango|Pango]]
=== ¿Cómo puedo crear un cuadro de texto para la edición de código? ===
Puedes usar gtksourceview2
<pre>
import gtk
import gtksourceview2
from sugar.graphics import style

...

# Configuramos el buffer
buffer = gtksourceview2.Buffer()
if hasattr(buffer, 'set_highlight'): # handle different API versions
buffer.set_highlight(True)
else:
buffer.set_highlight_syntax(True)

# Configuramos el tipo MIME para el buffer
lang_manager = gtksourceview2.language_manager_get_default()
if hasattr(lang_manager, 'list_languages'): # again, handle different APIs
langs = lang_manager.list_languages()
else:
lang_ids = lang_manager.get_language_ids()
langs = [lang_manager.get_language(lang_id)
for lang_id in lang_ids]
for lang in langs:
for m in lang.get_mime_types():
if m == mime_type: # <-- this is the mime type you want
buffer.set_language(lang)

# Establecemos el objeto para la vista, usarlo como gtk.TextView
view = gtksourceview2.View(buffer)
view.set_size_request(300, 450)
view.set_editable(True)
view.set_cursor_visible(True)
view.set_show_line_numbers(True)
view.set_wrap_mode(gtk.WRAP_CHAR)
view.set_right_margin_position(80)
#view.set_highlight_current_line(True) #FIXME: Ugly color
view.set_auto_indent(True)
view.modify_font(pango.FontDescription("Monospace " +
str(style.FONT_SIZE)))
...

</pre>

Para agregar texto al buffer:
<pre>
buffer.set_text(text)
</pre>
Para obtener todo el texto:
<pre>
text = buffer.get_text(buffer.get_start_iter(), buffer.get_end_iter())
</pre>

Probablemente quieras poner la view(vista) en un gtk.ScrolledWindow
<pre>
sw = gtk.ScrolledWindow()
sw.add(view)
sw.set_policy(gtk.POLICY_AUTOMATIC, gtk.POLICY_AUTOMATIC)
</pre>
y agregar el el objeto sw en vez de la view(vista).

Puedes encotnrar más en el código fuete de Pippyy en jarabe.view.sourceview.

== Audio y Video ==
* [[Development Team/Almanac/GStreamer|GStreamer]]

== Ratón ==
=== ¿Cómo puedo cambiar el cursor del ratón por el cursor de espera en mi actividad? ===
En la subclase de tu actividad:

<pre>
self.window.set_cursor( gtk.gdk.Cursor(gtk.gdk.WATCH) )
</pre>

y para volver al que está por defecto:

<pre>
self.window.set_cursor( None );
</pre>

=== ¿Cómo puedo rastrear la posición del ratón? ===
Existen varias razones por las que te puede interesar controlar la posición del ratón, que van desde el entretenimiento ([[http://en.wikipedia.org/wiki/Xeyes]]) a lo funcional (ocultar ciertas ventanas cuando el ratón no se ha movido por un par de segundos y volver a hacer aparecer esos elementos cuando este se mueva nuevamente). Esta es una manera en la cual se puede implementar esta funcionalidad:
<pre>

...
self.hideWidgetsTime = time.time()
self.mx = -1
self.my = -1
self.HIDE_WIDGET_TIMEOUT_ID = gobject.timeout_add( 500, self.mouseMightHaveMovedCb )

def _mouseMightHaveMovedCb( self ):
x, y = self.get_pointer()
passedTime = 0

if (x != self.mx or y != self.my):
self.hideWidgetsTime = time.time()
if (self.hiddenWidgets):
self.showWidgets()
self.hiddenWidgets = False
else:
passedTime = time.time() - self.hideWidgetsTime

if (passedTime >= 3):
if (not self.hiddenWidgets):
self.hideWidgets()
self.hiddenWidgets = True

self.mx = x
self.my = y
return True

</pre>

== Varios ==

Las tareas que aparecen más abajo son técnicas útiles que he encontrado mientras escribía código y documentación para esta referencia. No ha sido categorizadas aún.

=== ¿Cómo se si mi actividad está "activa" o no? ===

Puedes configurar un evento usando la constante VISIBILITY_NOTIFY_MASK para saber cuando se cambia la visibilidad. Luego en el callback para este evento lo que debes hacer es comprar el estado del evento con las variables gtk definidas para la visibilidad de tu actividad. Puedes ver [http://www.pygtk.org/docs/pygtk/gdk-constants.html#gdk-visibility-state-constants la sección de Constantes de Estado de Visibilidad de GDK] gtk.gdk.Constants para más información.

<pre>
# Notify when the visibility state changes by calling self.__visibility_notify_cb
# (PUT THIS IN YOUR ACTIVITY CODE - EG. THE __init__() METHOD)
self.add_events(gtk.gdk.VISIBILITY_NOTIFY_MASK)
self.connect("visibility-notify-event", self.__visibility_notify_cb)
...
# Callback method for when the activity's visibility changes
def __visibility_notify_cb(self, window, event):
if event.state == gtk.gdk.VISIBILITY_FULLY_OBSCURED:
print "I am not visible"
elif event.state in [gtk.gdk.VISIBILITY_UNOBSCURED, gtk.gdk.VISIBILITY_PARTIAL]:
print "I am visible"
</pre>

=== ¿Cómo puedo obtener la cantidad de espacio libre disponible dentro del directorio /home? ===
La siguiente función usa el módulo [http://docs.python.org/lib/module-statvfs.html statvfs]. El código siguiente muestra cómo obtener la cantidad total de espacio libre en /home.

<pre>
#### Método getFreespaceKb: devuelve el espacio disponible en kilobytes.
def getFreespaceKb(self):
stat = os.statvfs("/home")
freebytes = stat[statvfs.F_BSIZE] * stat[statvfs.F_BAVAIL]
freekb = freebytes / 1024
return freekb
</pre>

Ten en cuenta que asumir cosas acerca de "/home" no es una buena idea, es mejor usar os.environ['HOME']. Rainbow pondrá los archivos actuales en otros lugares, algunos en el ramdisk, otros en la flash.
Ten claro que espacio libre en el sistema de archivos realmente te importa.

=== ¿Cómo puedo saber si mi actividad se está ejecutando en una XO? ===
Sugar corre en PCs comunes, así como en XO. Aunque tu actuvidad probablemente corra en una XO real, algunas personas necesitan utilizarla en otros lados. Normalmente no deberías escribir una actividad que le importe si es una XO o no donde se está ejecutando. Si por alguna extraña razón necesitas saber, la forma más fácil es verificar si /sys/power/olpc-pm (el manejador de poder de la XO) existe.

[http://lists.laptop.org/pipermail/devel/2008-June/015923.html reliably detecting if running on an XO]
[[olpc:Power Management Interface]]</ref>

<pre>
import os
...
#Devuelve un valor booleano que nos dice si estamos en una XO o no.
print os.path.exists('/sys/power/olpc-pm')
</pre>

=== ¿Cómo puedo saber la configuración actual del lenguage en mi XO? ===
La variable 'LANG' te dice que lenguaje está actualmente activo en el XO. El código siguiente muestra cómo buscar en el valor de esta variable.

<pre>
import os
...
_logger.debug(os.environ['LANG'])
</pre>

=== ¿Cómo llamar repetidamente a un método específico después de un número N de segundos? ===
La función gobject.timeout_add() te permite invocar un método después de un período de tiempo determinado. Si quieres llamar a un método en varias ocasiones, simplemente sigue llamando a la función de gobject.timeout_add desde tu función.
El código de abajo es un ejemplo simple en donde la función que implementa el timeout se llama repeatedly_call. Nota que la sincronización entre las llamadas son aproximadas. Para que esto funcione debes llamar a repeatedly_call() desde alguna parte de tu código.

Puedes ver un mejor ejemplo de este patrón en uso [[olpc:Pango#How_do_I_dynamically_set_the_text_in_a_pango_layout.3F | aquí]].

<pre>

#Este método se llama a sí mismo aproximadamente cada 1 segundo
def repeatedly_call(self):
now = datetime.datetime.now()
gobject.timeout_add(self.repeat_period_msec, self.repeatedly_update_time)
</pre>

=== ¿Cómo puedo actualizar la build que se ejecuta en mi XO? ===

Hay varias páginas que te dan instrucciones sobre cómo instalar / actualizar la build actual.

* Si usted ya tiene una build instalada y una conexión a Internet, primero pruebe usar [[OLPC: OLPC-update]].
* Si eso no funciona, puedes mirar las instrucciones para una [[OLPC: Activated upgrade]] que se puede hacer a través de un USB]

Como mencionan las instrucciones en las páginas más arriba, asegurate de instalar tus actividades por separado luego de que actualices a una build específica.

=== Estoy desarrollando en una XO pero mi teclado y la configuración de idioma no son ideales. ¿Cómo puedo cambiarlos? ===

Las laptops intenacionalizadas tienen configuraciones que te pueden retrazar mientras estás desarrollando. Para cambiar las configuraciones de idioma usa el [[olpc:Sugar Control Panel]]

Keyboard settings on internationalized laptops<ref>[[olpc:Keyboard layouts#OLPC keyboard layouts]]</ref> can also be suboptimal, especially as characters like "-" and "/" are in unfamiliar positions. You can use the <tt>setxkbmap</tt> command in the [[olpc:Terminal Activity]] to reset the type of keyboard input used and then attach a standard U.S. keyboard that will allow you to type normally. The command below sets the keyboard to the US mapping (it will reset to the default internationalized mapping upon restart).

setxkbmap us

=== My Python activity wants to use threads; how do I do that? ===

A question that has been answered with limited success is which threading patterns are most appropriate for use in Sugar. The following pattern of code to work fine in basic instances:

<pre>
#### Method: __init__, initialize this AnnotateActivity instance
def __init__(self, handle):
...
self.sample_thread = Thread(target=self.announce_thread, args=())
self.sample_thread.setDaemon(0)
self.sample_thread.start()
...

def announce_thread(self):
while (self.Running):
time.sleep(1)
print "thread running"
self._update_chat_text("Thread", "In here")
</pre>

This is the basic series of steps that most online documentation on python suggests to use when trying to work with threads in python. The problem is that it is unclear how this pattern relates to code that worked in the SimCity activity:

<pre>
import gobject
gobject.threads_init()
#import dbus.mainloop.glib
#dbus.mainloop.glib.threads_init()
</pre>

It should be noted that in the SimCity activity the pygame sound player would not produce sound reliably unless this setup was done.



Should the two patterns always be used in tandem? It seems that the latter code is mainly to initiate gobject and other libraries to work with threading, but it is unclear what restrictions there are with using threading with these libraries. Does one take precedence over the other? It is not clear if there is any problem with using the standard python threading code on the sugar technology stack.





In fact, experiments with threading on sugar leads to several different problems. For one thing, thread termination was tricky - using the can_close() method for sugar activities to terminate an activity only killed threads in some circumstances. It did not properly handle terminating threads in the case of CTRL-C or terminal interrupts. You can try to catch signals (SIGINT, SIGTERM or SIGHUP), but you will still be running in to errors in terminating child threads using these as well.





Another set of errors with threading comes up when trying to combine with stream tubes. The bottom line is that it is unclear what the scope of threading in a Sugar activity should be - should it simply work if you do the standard python threading pattern, is the use of the glib.threads_init and gobject.threads_init calls necessary, are there other interactions with threads and dbus that need to be accounted for? With more clarity from sugar developers on how the platform envisions threading to work in an activity, we can be more comfortable writing entries in the Almanac to help developers write error-free code.



=== How do I customize the title that is displayed for each instance of my activity? ===

By default, activity titles are just the generic activity names that you specify in your activity.info file. In some applications, you may want the activity title to be more dynamic.

For example, it makes sense to set the title for different browser sessions to the active web page being visited. That way, when you look back in the journal at the different browser sessions you have run in the previous few days, you can identify unique sessions based on the website you happened to be visiting at the time.

The code below shows how you can set the metadata for your activity to reflect a dynamic title based on whatever session criteria you feel is important. This example is adapted from the Browse activity, which sets activity instance titles based on the title of the current web page being visited.

<pre>
if self.metadata['mime_type'] == 'text/plain':
if not self._jobject.metadata['title_set_by_user'] == '1':
if self._browser.props.title:
# Set the title of this activity to be the current
# title of the page being visited by the browser.
self.metadata['title'] = self._browser.props.title
</pre>

=== ¿Qué paquetes están disponibles dentro de Sugar que soportan el desarrollo de juegos? ===

Si tu actividad requiere herramientas para desarrollar juegos robustos y límpios deberías utilizar [http://www.pygame.org/ pygame]. Puedes importar el paquete para usarlo con cualqueir actividad de la siguiente forma:

<pre>
import pygame
...
</pre>

=== How do I detect when one of the game buttons on the laptop have been pressed? ===

The laptop game buttons (the circle, square, x, and check buttons next to the LCD) are encoded as page up, home, page down and end respectively. So, you can detect their press by listening for these specific events. For example, the code below listens for button presses and then just writes to an output widget which button was pressed.

<pre>
...
#### Initialize this activity.
def __init__(self, handle):
...
self.connect('key-press-event', self._keyPressCb)
...

#### Method _keyPressCb, which catches any presses of the game buttons.
def _keyPressCb(self, widget, event):

keyname = gtk.gdk.keyval_name(event.keyval)

if (keyname == 'KP_Page_Up'):
self._chat += "\nCircle Pressed!"
self._chat_buffer.set_text(self._chat)
elif (keyname == 'KP_Page_Down'):
self._chat += "\nX Pressed!"
self._chat_buffer.set_text(self._chat)
elif (keyname == 'KP_Home'):
self._chat += "\nSquare Pressed!"
self._chat_buffer.set_text(self._chat)
elif (keyname == 'KP_End'):
self._chat += "\nCheck Pressed!"
self._chat_buffer.set_text(self._chat)

return False
</pre>

=== How do I detect if one of the joystick buttons has been pressed? ===

This is the same process as detecting game buttons, except with different names for the keys. Again, you listen for "key-press-event" signals and then in your callback you check to see if the pressed button was one of the joystick keys.

<pre>
#### Initialize this activity.
def __init__(self, handle):
...
self.connect('key-press-event', self._keyPressCb)
...

#### Method _keyPressCb, which catches any presses of the game buttons.
def _keyPressCb(self, widget, event):

keyname = gtk.gdk.keyval_name(event.keyval)

if (keyname == 'KP_Up'):
self._chat += "\nUp Pressed!"
self._chat_buffer.set_text(self._chat)
elif (keyname == 'KP_Down'):
self._chat += "\nDown Pressed!"
self._chat_buffer.set_text(self._chat)
elif (keyname == 'KP_Left'):
self._chat += "\nLeft Pressed!"
self._chat_buffer.set_text(self._chat)
elif (keyname == 'KP_Right'):
self._chat += "\nRight Pressed!"
self._chat_buffer.set_text(self._chat)

return False
</pre>

=== How do i remove an specific button from the toolbar? ===

This is an example of the share button is removed:

<pre>
activity_toolbar = toolbox.get_activity_toolbar()
activity_toolbar.remove(activity_toolbar.share)
activity_toolbar.share = None
</pre>

== Notes ==
<references />

[[Category:Documentation]]
[[Category:Development Team]]

Development Team/Almanac/lang-es

2009-08-31T22:11:35Z

Fede: /* I am developing on an XO laptop, but my keyboard and language settings are not ideal. How can I change them? */

{{translation
| source = Development_Team/Almanac
| lang = es
| status = {{translation/incomplete/}}
}}

{{Almanac}}
{{Almanac TOC}}
== ¿Cómo puedo obtener ayuda adicional más allá de este almanaque? ==
* ¿Quieres comenzar con los básico del desarrollo para Sugar? Puedes visitar el [http://wiki.sugarlabs.org/images/5/51/Activity_Handbook_200805_online.pdf Activity Handbook] de OLPC Austria (''Ten en cuenta que este manual fue actualizado por última vez en mayo del 2008, las capturas de tienen el diseño pre-8.2. En términos de código en sí, las cosas deberían funcionar como están descriptas. Si encuentra algún problema por favor póngase en contacto con [[User:ChristophD|ChristophD]].'')
* Ver también [[Development Team/Almanac/Code Snippets]]

Ahora, vamos con el almanaque actual...

== ¿Dónde puedo ver los cambios de la API? ==
API changes between OLPC releases can be seen here: [[Development Team/Almanac/API Changes|API Changes]]

== Comenzando ==
=== ¿Cómo estructuro mis archivos para que sean una actividad de válido en Sugar? ===
Puedes encontrar información sobre la estructura de la actividad aquí: [[Development Team/Almanac/Activity Bundles|Activity Bundles]]

=== ¿Cómo puedo hacer un icono para mi actividad? ===
La información sobre lo que debe hacer se puede encontrar aquí: [[Development Team/Almanac/Making Icons|Making Icons]]

== Paquete: sugar ==
* [[Development Team/Almanac/sugar.env|sugar.env]]
* [[Development Team/Almanac/sugar.profile|sugar.profile]]
* [[Development Team/Almanac/sugar.mime|sugar.mime]]
* [[Development Team/Almanac/sugar.logger|sugar.logger]]

== Paquete: sugar.activity ==
* [[Development Team/Almanac/sugar.activity.activity|sugar.activity.activity]]
* [[Development Team/Almanac/sugar.activity.activityfactory|sugar.activity.activityfactory]]
* [[Development Team/Almanac/sugar.activity.registry|sugar.activity.registry]]

== Paquete: sugar.datastore ==
* [[Development Team/Almanac/sugar.datastore.datastore|sugar.datastore.datastore]]

== Paquete: sugar.graphics ==
* [[Development Team/Almanac/sugar.graphics.alert|sugar.graphics.alert]]
* [[Development Team/Almanac/sugar.graphics.icon|sugar.graphics.icon]]
* [[Development Team/Almanac/sugar.graphics.notebook|sugar.graphics.notebook]]
* [[Development Team/Almanac/sugar.graphics.toolbutton|sugar.graphics.toolbutton]]
* [[Development Team/Almanac/sugar.graphics.toolbox|sugar.graphics.toolbox]]
* [[Development Team/Almanac/sugar.graphics.style|sugar.graphics.style]]

== Paquete: sugar.presence ==
* [[Development Team/Almanac/Sugar.presence|Sugar.presence]]
* [[Development Team/Almanac/Sugar.presence.activity|Sugar.presence.activity]]
* [[Development Team/Almanac/Sugar.presence.buddy|Sugar.presence.buddy]]
* [[Development Team/Almanac/Sugar.presence.presenceservice|Sugar.presence.presenceservice]]

== Clipboard ==
* Notas sobre el uso del [[Development Team/Almanac/GTK's Clipboard Module|módulo Clipboard de GTK ]]

== Logging ==
* [[Development Team/Almanac/sugar.logger|sugar.logger]]
* Notas sobre el uso del [[Development Team/Almanac/Python Standard Logging|standard de Logging en Python]]

== Internacionalización ==
*[[Development Team/Almanac/Internationalization|Internationalization]]

== Texto y gráficos para las actividades de Sugar ==
* [[Development Team/Almanac/Pango|Pango]]
=== ¿Cómo puedo crear un cuadro de texto para la edición de código? ===
Puedes usar gtksourceview2
<pre>
import gtk
import gtksourceview2
from sugar.graphics import style

...

# Configuramos el buffer
buffer = gtksourceview2.Buffer()
if hasattr(buffer, 'set_highlight'): # handle different API versions
buffer.set_highlight(True)
else:
buffer.set_highlight_syntax(True)

# Configuramos el tipo MIME para el buffer
lang_manager = gtksourceview2.language_manager_get_default()
if hasattr(lang_manager, 'list_languages'): # again, handle different APIs
langs = lang_manager.list_languages()
else:
lang_ids = lang_manager.get_language_ids()
langs = [lang_manager.get_language(lang_id)
for lang_id in lang_ids]
for lang in langs:
for m in lang.get_mime_types():
if m == mime_type: # <-- this is the mime type you want
buffer.set_language(lang)

# Establecemos el objeto para la vista, usarlo como gtk.TextView
view = gtksourceview2.View(buffer)
view.set_size_request(300, 450)
view.set_editable(True)
view.set_cursor_visible(True)
view.set_show_line_numbers(True)
view.set_wrap_mode(gtk.WRAP_CHAR)
view.set_right_margin_position(80)
#view.set_highlight_current_line(True) #FIXME: Ugly color
view.set_auto_indent(True)
view.modify_font(pango.FontDescription("Monospace " +
str(style.FONT_SIZE)))
...

</pre>

Para agregar texto al buffer:
<pre>
buffer.set_text(text)
</pre>
Para obtener todo el texto:
<pre>
text = buffer.get_text(buffer.get_start_iter(), buffer.get_end_iter())
</pre>

Probablemente quieras poner la view(vista) en un gtk.ScrolledWindow
<pre>
sw = gtk.ScrolledWindow()
sw.add(view)
sw.set_policy(gtk.POLICY_AUTOMATIC, gtk.POLICY_AUTOMATIC)
</pre>
y agregar el el objeto sw en vez de la view(vista).

Puedes encotnrar más en el código fuete de Pippyy en jarabe.view.sourceview.

== Audio y Video ==
* [[Development Team/Almanac/GStreamer|GStreamer]]

== Ratón ==
=== ¿Cómo puedo cambiar el cursor del ratón por el cursor de espera en mi actividad? ===
En la subclase de tu actividad:

<pre>
self.window.set_cursor( gtk.gdk.Cursor(gtk.gdk.WATCH) )
</pre>

y para volver al que está por defecto:

<pre>
self.window.set_cursor( None );
</pre>

=== ¿Cómo puedo rastrear la posición del ratón? ===
Existen varias razones por las que te puede interesar controlar la posición del ratón, que van desde el entretenimiento ([[http://en.wikipedia.org/wiki/Xeyes]]) a lo funcional (ocultar ciertas ventanas cuando el ratón no se ha movido por un par de segundos y volver a hacer aparecer esos elementos cuando este se mueva nuevamente). Esta es una manera en la cual se puede implementar esta funcionalidad:
<pre>

...
self.hideWidgetsTime = time.time()
self.mx = -1
self.my = -1
self.HIDE_WIDGET_TIMEOUT_ID = gobject.timeout_add( 500, self.mouseMightHaveMovedCb )

def _mouseMightHaveMovedCb( self ):
x, y = self.get_pointer()
passedTime = 0

if (x != self.mx or y != self.my):
self.hideWidgetsTime = time.time()
if (self.hiddenWidgets):
self.showWidgets()
self.hiddenWidgets = False
else:
passedTime = time.time() - self.hideWidgetsTime

if (passedTime >= 3):
if (not self.hiddenWidgets):
self.hideWidgets()
self.hiddenWidgets = True

self.mx = x
self.my = y
return True

</pre>

== Varios ==

Las tareas que aparecen más abajo son técnicas útiles que he encontrado mientras escribía código y documentación para esta referencia. No ha sido categorizadas aún.

=== ¿Cómo se si mi actividad está "activa" o no? ===

Puedes configurar un evento usando la constante VISIBILITY_NOTIFY_MASK para saber cuando se cambia la visibilidad. Luego en el callback para este evento lo que debes hacer es comprar el estado del evento con las variables gtk definidas para la visibilidad de tu actividad. Puedes ver [http://www.pygtk.org/docs/pygtk/gdk-constants.html#gdk-visibility-state-constants la sección de Constantes de Estado de Visibilidad de GDK] gtk.gdk.Constants para más información.

<pre>
# Notify when the visibility state changes by calling self.__visibility_notify_cb
# (PUT THIS IN YOUR ACTIVITY CODE - EG. THE __init__() METHOD)
self.add_events(gtk.gdk.VISIBILITY_NOTIFY_MASK)
self.connect("visibility-notify-event", self.__visibility_notify_cb)
...
# Callback method for when the activity's visibility changes
def __visibility_notify_cb(self, window, event):
if event.state == gtk.gdk.VISIBILITY_FULLY_OBSCURED:
print "I am not visible"
elif event.state in [gtk.gdk.VISIBILITY_UNOBSCURED, gtk.gdk.VISIBILITY_PARTIAL]:
print "I am visible"
</pre>

=== ¿Cómo puedo obtener la cantidad de espacio libre disponible dentro del directorio /home? ===
La siguiente función usa el módulo [http://docs.python.org/lib/module-statvfs.html statvfs]. El código siguiente muestra cómo obtener la cantidad total de espacio libre en /home.

<pre>
#### Método getFreespaceKb: devuelve el espacio disponible en kilobytes.
def getFreespaceKb(self):
stat = os.statvfs("/home")
freebytes = stat[statvfs.F_BSIZE] * stat[statvfs.F_BAVAIL]
freekb = freebytes / 1024
return freekb
</pre>

Ten en cuenta que asumir cosas acerca de "/home" no es una buena idea, es mejor usar os.environ['HOME']. Rainbow pondrá los archivos actuales en otros lugares, algunos en el ramdisk, otros en la flash.
Ten claro que espacio libre en el sistema de archivos realmente te importa.

=== ¿Cómo puedo saber si mi actividad se está ejecutando en una XO? ===
Sugar corre en PCs comunes, así como en XO. Aunque tu actuvidad probablemente corra en una XO real, algunas personas necesitan utilizarla en otros lados. Normalmente no deberías escribir una actividad que le importe si es una XO o no donde se está ejecutando. Si por alguna extraña razón necesitas saber, la forma más fácil es verificar si /sys/power/olpc-pm (el manejador de poder de la XO) existe.

[http://lists.laptop.org/pipermail/devel/2008-June/015923.html reliably detecting if running on an XO]
[[olpc:Power Management Interface]]</ref>

<pre>
import os
...
#Devuelve un valor booleano que nos dice si estamos en una XO o no.
print os.path.exists('/sys/power/olpc-pm')
</pre>

=== ¿Cómo puedo saber la configuración actual del lenguage en mi XO? ===
La variable 'LANG' te dice que lenguaje está actualmente activo en el XO. El código siguiente muestra cómo buscar en el valor de esta variable.

<pre>
import os
...
_logger.debug(os.environ['LANG'])
</pre>

=== ¿Cómo llamar repetidamente a un método específico después de un número N de segundos? ===
La función gobject.timeout_add() te permite invocar un método después de un período de tiempo determinado. Si quieres llamar a un método en varias ocasiones, simplemente sigue llamando a la función de gobject.timeout_add desde tu función.
El código de abajo es un ejemplo simple en donde la función que implementa el timeout se llama repeatedly_call. Nota que la sincronización entre las llamadas son aproximadas. Para que esto funcione debes llamar a repeatedly_call() desde alguna parte de tu código.

Puedes ver un mejor ejemplo de este patrón en uso [[olpc:Pango#How_do_I_dynamically_set_the_text_in_a_pango_layout.3F | aquí]].

<pre>

#Este método se llama a sí mismo aproximadamente cada 1 segundo
def repeatedly_call(self):
now = datetime.datetime.now()
gobject.timeout_add(self.repeat_period_msec, self.repeatedly_update_time)
</pre>

=== ¿Cómo puedo actualizar la build que se ejecuta en mi XO? ===

Hay varias páginas que te dan instrucciones sobre cómo instalar / actualizar la build actual.

* Si usted ya tiene una build instalada y una conexión a Internet, primero pruebe usar [[OLPC: OLPC-update]].
* Si eso no funciona, puedes mirar las instrucciones para una [[OLPC: Activated upgrade]] que se puede hacer a través de un USB]

Como mencionan las instrucciones en las páginas más arriba, asegurate de instalar tus actividades por separado luego de que actualices a una build específica.

=== Estoy desarrollando en una XO pero mi teclado y la configuración de idioma no son ideales. ¿Cómo puedo cambiarlos? ===

Las laptops intenacionalizadas tienen configuraciones que te pueden retrazar mientras estás desarrollando. Para cambiar las configuraciones de idioma usa el [[olpc:Sugar Control Panel]]

Keyboard settings on internationalized laptops<ref>[[olpc:Keyboard layouts#OLPC keyboard layouts]]</ref> can also be suboptimal, especially as characters like "-" and "/" are in unfamiliar positions. You can use the <tt>setxkbmap</tt> command in the [[olpc:Terminal Activity]] to reset the type of keyboard input used and then attach a standard U.S. keyboard that will allow you to type normally. The command below sets the keyboard to the US mapping (it will reset to the default internationalized mapping upon restart).

setxkbmap us

=== My Python activity wants to use threads; how do I do that? ===

A question that has been answered with limited success is which threading patterns are most appropriate for use in Sugar. The following pattern of code to work fine in basic instances:

<pre>
#### Method: __init__, initialize this AnnotateActivity instance
def __init__(self, handle):
...
self.sample_thread = Thread(target=self.announce_thread, args=())
self.sample_thread.setDaemon(0)
self.sample_thread.start()
...

def announce_thread(self):
while (self.Running):
time.sleep(1)
print "thread running"
self._update_chat_text("Thread", "In here")
</pre>

This is the basic series of steps that most online documentation on python suggests to use when trying to work with threads in python. The problem is that it is unclear how this pattern relates to code that worked in the SimCity activity:

<pre>
import gobject
gobject.threads_init()
#import dbus.mainloop.glib
#dbus.mainloop.glib.threads_init()
</pre>

It should be noted that in the SimCity activity the pygame sound player would not produce sound reliably unless this setup was done.



Should the two patterns always be used in tandem? It seems that the latter code is mainly to initiate gobject and other libraries to work with threading, but it is unclear what restrictions there are with using threading with these libraries. Does one take precedence over the other? It is not clear if there is any problem with using the standard python threading code on the sugar technology stack.





In fact, experiments with threading on sugar leads to several different problems. For one thing, thread termination was tricky - using the can_close() method for sugar activities to terminate an activity only killed threads in some circumstances. It did not properly handle terminating threads in the case of CTRL-C or terminal interrupts. You can try to catch signals (SIGINT, SIGTERM or SIGHUP), but you will still be running in to errors in terminating child threads using these as well.





Another set of errors with threading comes up when trying to combine with stream tubes. The bottom line is that it is unclear what the scope of threading in a Sugar activity should be - should it simply work if you do the standard python threading pattern, is the use of the glib.threads_init and gobject.threads_init calls necessary, are there other interactions with threads and dbus that need to be accounted for? With more clarity from sugar developers on how the platform envisions threading to work in an activity, we can be more comfortable writing entries in the Almanac to help developers write error-free code.



=== How do I customize the title that is displayed for each instance of my activity? ===

By default, activity titles are just the generic activity names that you specify in your activity.info file. In some applications, you may want the activity title to be more dynamic.

For example, it makes sense to set the title for different browser sessions to the active web page being visited. That way, when you look back in the journal at the different browser sessions you have run in the previous few days, you can identify unique sessions based on the website you happened to be visiting at the time.

The code below shows how you can set the metadata for your activity to reflect a dynamic title based on whatever session criteria you feel is important. This example is adapted from the Browse activity, which sets activity instance titles based on the title of the current web page being visited.

<pre>
if self.metadata['mime_type'] == 'text/plain':
if not self._jobject.metadata['title_set_by_user'] == '1':
if self._browser.props.title:
# Set the title of this activity to be the current
# title of the page being visited by the browser.
self.metadata['title'] = self._browser.props.title
</pre>

=== What packages are available on sugar to support game development? ===

If your activity will require tools that are typically needed to develop robust and clean video games, then you should utilize the [http://www.pygame.org/ pygame package]. It can be readily imported into any activity:

<pre>
import pygame
...
</pre>

=== How do I detect when one of the game buttons on the laptop have been pressed? ===

The laptop game buttons (the circle, square, x, and check buttons next to the LCD) are encoded as page up, home, page down and end respectively. So, you can detect their press by listening for these specific events. For example, the code below listens for button presses and then just writes to an output widget which button was pressed.

<pre>
...
#### Initialize this activity.
def __init__(self, handle):
...
self.connect('key-press-event', self._keyPressCb)
...

#### Method _keyPressCb, which catches any presses of the game buttons.
def _keyPressCb(self, widget, event):

keyname = gtk.gdk.keyval_name(event.keyval)

if (keyname == 'KP_Page_Up'):
self._chat += "\nCircle Pressed!"
self._chat_buffer.set_text(self._chat)
elif (keyname == 'KP_Page_Down'):
self._chat += "\nX Pressed!"
self._chat_buffer.set_text(self._chat)
elif (keyname == 'KP_Home'):
self._chat += "\nSquare Pressed!"
self._chat_buffer.set_text(self._chat)
elif (keyname == 'KP_End'):
self._chat += "\nCheck Pressed!"
self._chat_buffer.set_text(self._chat)

return False
</pre>

=== How do I detect if one of the joystick buttons has been pressed? ===

This is the same process as detecting game buttons, except with different names for the keys. Again, you listen for "key-press-event" signals and then in your callback you check to see if the pressed button was one of the joystick keys.

<pre>
#### Initialize this activity.
def __init__(self, handle):
...
self.connect('key-press-event', self._keyPressCb)
...

#### Method _keyPressCb, which catches any presses of the game buttons.
def _keyPressCb(self, widget, event):

keyname = gtk.gdk.keyval_name(event.keyval)

if (keyname == 'KP_Up'):
self._chat += "\nUp Pressed!"
self._chat_buffer.set_text(self._chat)
elif (keyname == 'KP_Down'):
self._chat += "\nDown Pressed!"
self._chat_buffer.set_text(self._chat)
elif (keyname == 'KP_Left'):
self._chat += "\nLeft Pressed!"
self._chat_buffer.set_text(self._chat)
elif (keyname == 'KP_Right'):
self._chat += "\nRight Pressed!"
self._chat_buffer.set_text(self._chat)

return False
</pre>

=== How do i remove an specific button from the toolbar? ===

This is an example of the share button is removed:

<pre>
activity_toolbar = toolbox.get_activity_toolbar()
activity_toolbar.remove(activity_toolbar.share)
activity_toolbar.share = None
</pre>

== Notes ==
<references />

[[Category:Documentation]]
[[Category:Development Team]]

Development Team/Almanac/lang-es

2009-08-31T21:54:19Z

Fede: /* How do I update the current build version of code that is running on my XO? */

{{translation
| source = Development_Team/Almanac
| lang = es
| status = {{translation/incomplete/}}
}}

{{Almanac}}
{{Almanac TOC}}
== ¿Cómo puedo obtener ayuda adicional más allá de este almanaque? ==
* ¿Quieres comenzar con los básico del desarrollo para Sugar? Puedes visitar el [http://wiki.sugarlabs.org/images/5/51/Activity_Handbook_200805_online.pdf Activity Handbook] de OLPC Austria (''Ten en cuenta que este manual fue actualizado por última vez en mayo del 2008, las capturas de tienen el diseño pre-8.2. En términos de código en sí, las cosas deberían funcionar como están descriptas. Si encuentra algún problema por favor póngase en contacto con [[User:ChristophD|ChristophD]].'')
* Ver también [[Development Team/Almanac/Code Snippets]]

Ahora, vamos con el almanaque actual...

== ¿Dónde puedo ver los cambios de la API? ==
API changes between OLPC releases can be seen here: [[Development Team/Almanac/API Changes|API Changes]]

== Comenzando ==
=== ¿Cómo estructuro mis archivos para que sean una actividad de válido en Sugar? ===
Puedes encontrar información sobre la estructura de la actividad aquí: [[Development Team/Almanac/Activity Bundles|Activity Bundles]]

=== ¿Cómo puedo hacer un icono para mi actividad? ===
La información sobre lo que debe hacer se puede encontrar aquí: [[Development Team/Almanac/Making Icons|Making Icons]]

== Paquete: sugar ==
* [[Development Team/Almanac/sugar.env|sugar.env]]
* [[Development Team/Almanac/sugar.profile|sugar.profile]]
* [[Development Team/Almanac/sugar.mime|sugar.mime]]
* [[Development Team/Almanac/sugar.logger|sugar.logger]]

== Paquete: sugar.activity ==
* [[Development Team/Almanac/sugar.activity.activity|sugar.activity.activity]]
* [[Development Team/Almanac/sugar.activity.activityfactory|sugar.activity.activityfactory]]
* [[Development Team/Almanac/sugar.activity.registry|sugar.activity.registry]]

== Paquete: sugar.datastore ==
* [[Development Team/Almanac/sugar.datastore.datastore|sugar.datastore.datastore]]

== Paquete: sugar.graphics ==
* [[Development Team/Almanac/sugar.graphics.alert|sugar.graphics.alert]]
* [[Development Team/Almanac/sugar.graphics.icon|sugar.graphics.icon]]
* [[Development Team/Almanac/sugar.graphics.notebook|sugar.graphics.notebook]]
* [[Development Team/Almanac/sugar.graphics.toolbutton|sugar.graphics.toolbutton]]
* [[Development Team/Almanac/sugar.graphics.toolbox|sugar.graphics.toolbox]]
* [[Development Team/Almanac/sugar.graphics.style|sugar.graphics.style]]

== Paquete: sugar.presence ==
* [[Development Team/Almanac/Sugar.presence|Sugar.presence]]
* [[Development Team/Almanac/Sugar.presence.activity|Sugar.presence.activity]]
* [[Development Team/Almanac/Sugar.presence.buddy|Sugar.presence.buddy]]
* [[Development Team/Almanac/Sugar.presence.presenceservice|Sugar.presence.presenceservice]]

== Clipboard ==
* Notas sobre el uso del [[Development Team/Almanac/GTK's Clipboard Module|módulo Clipboard de GTK ]]

== Logging ==
* [[Development Team/Almanac/sugar.logger|sugar.logger]]
* Notas sobre el uso del [[Development Team/Almanac/Python Standard Logging|standard de Logging en Python]]

== Internacionalización ==
*[[Development Team/Almanac/Internationalization|Internationalization]]

== Texto y gráficos para las actividades de Sugar ==
* [[Development Team/Almanac/Pango|Pango]]
=== ¿Cómo puedo crear un cuadro de texto para la edición de código? ===
Puedes usar gtksourceview2
<pre>
import gtk
import gtksourceview2
from sugar.graphics import style

...

# Configuramos el buffer
buffer = gtksourceview2.Buffer()
if hasattr(buffer, 'set_highlight'): # handle different API versions
buffer.set_highlight(True)
else:
buffer.set_highlight_syntax(True)

# Configuramos el tipo MIME para el buffer
lang_manager = gtksourceview2.language_manager_get_default()
if hasattr(lang_manager, 'list_languages'): # again, handle different APIs
langs = lang_manager.list_languages()
else:
lang_ids = lang_manager.get_language_ids()
langs = [lang_manager.get_language(lang_id)
for lang_id in lang_ids]
for lang in langs:
for m in lang.get_mime_types():
if m == mime_type: # <-- this is the mime type you want
buffer.set_language(lang)

# Establecemos el objeto para la vista, usarlo como gtk.TextView
view = gtksourceview2.View(buffer)
view.set_size_request(300, 450)
view.set_editable(True)
view.set_cursor_visible(True)
view.set_show_line_numbers(True)
view.set_wrap_mode(gtk.WRAP_CHAR)
view.set_right_margin_position(80)
#view.set_highlight_current_line(True) #FIXME: Ugly color
view.set_auto_indent(True)
view.modify_font(pango.FontDescription("Monospace " +
str(style.FONT_SIZE)))
...

</pre>

Para agregar texto al buffer:
<pre>
buffer.set_text(text)
</pre>
Para obtener todo el texto:
<pre>
text = buffer.get_text(buffer.get_start_iter(), buffer.get_end_iter())
</pre>

Probablemente quieras poner la view(vista) en un gtk.ScrolledWindow
<pre>
sw = gtk.ScrolledWindow()
sw.add(view)
sw.set_policy(gtk.POLICY_AUTOMATIC, gtk.POLICY_AUTOMATIC)
</pre>
y agregar el el objeto sw en vez de la view(vista).

Puedes encotnrar más en el código fuete de Pippyy en jarabe.view.sourceview.

== Audio y Video ==
* [[Development Team/Almanac/GStreamer|GStreamer]]

== Ratón ==
=== ¿Cómo puedo cambiar el cursor del ratón por el cursor de espera en mi actividad? ===
En la subclase de tu actividad:

<pre>
self.window.set_cursor( gtk.gdk.Cursor(gtk.gdk.WATCH) )
</pre>

y para volver al que está por defecto:

<pre>
self.window.set_cursor( None );
</pre>

=== ¿Cómo puedo rastrear la posición del ratón? ===
Existen varias razones por las que te puede interesar controlar la posición del ratón, que van desde el entretenimiento ([[http://en.wikipedia.org/wiki/Xeyes]]) a lo funcional (ocultar ciertas ventanas cuando el ratón no se ha movido por un par de segundos y volver a hacer aparecer esos elementos cuando este se mueva nuevamente). Esta es una manera en la cual se puede implementar esta funcionalidad:
<pre>

...
self.hideWidgetsTime = time.time()
self.mx = -1
self.my = -1
self.HIDE_WIDGET_TIMEOUT_ID = gobject.timeout_add( 500, self.mouseMightHaveMovedCb )

def _mouseMightHaveMovedCb( self ):
x, y = self.get_pointer()
passedTime = 0

if (x != self.mx or y != self.my):
self.hideWidgetsTime = time.time()
if (self.hiddenWidgets):
self.showWidgets()
self.hiddenWidgets = False
else:
passedTime = time.time() - self.hideWidgetsTime

if (passedTime >= 3):
if (not self.hiddenWidgets):
self.hideWidgets()
self.hiddenWidgets = True

self.mx = x
self.my = y
return True

</pre>

== Varios ==

Las tareas que aparecen más abajo son técnicas útiles que he encontrado mientras escribía código y documentación para esta referencia. No ha sido categorizadas aún.

=== ¿Cómo se si mi actividad está "activa" o no? ===

Puedes configurar un evento usando la constante VISIBILITY_NOTIFY_MASK para saber cuando se cambia la visibilidad. Luego en el callback para este evento lo que debes hacer es comprar el estado del evento con las variables gtk definidas para la visibilidad de tu actividad. Puedes ver [http://www.pygtk.org/docs/pygtk/gdk-constants.html#gdk-visibility-state-constants la sección de Constantes de Estado de Visibilidad de GDK] gtk.gdk.Constants para más información.

<pre>
# Notify when the visibility state changes by calling self.__visibility_notify_cb
# (PUT THIS IN YOUR ACTIVITY CODE - EG. THE __init__() METHOD)
self.add_events(gtk.gdk.VISIBILITY_NOTIFY_MASK)
self.connect("visibility-notify-event", self.__visibility_notify_cb)
...
# Callback method for when the activity's visibility changes
def __visibility_notify_cb(self, window, event):
if event.state == gtk.gdk.VISIBILITY_FULLY_OBSCURED:
print "I am not visible"
elif event.state in [gtk.gdk.VISIBILITY_UNOBSCURED, gtk.gdk.VISIBILITY_PARTIAL]:
print "I am visible"
</pre>

=== ¿Cómo puedo obtener la cantidad de espacio libre disponible dentro del directorio /home? ===
La siguiente función usa el módulo [http://docs.python.org/lib/module-statvfs.html statvfs]. El código siguiente muestra cómo obtener la cantidad total de espacio libre en /home.

<pre>
#### Método getFreespaceKb: devuelve el espacio disponible en kilobytes.
def getFreespaceKb(self):
stat = os.statvfs("/home")
freebytes = stat[statvfs.F_BSIZE] * stat[statvfs.F_BAVAIL]
freekb = freebytes / 1024
return freekb
</pre>

Ten en cuenta que asumir cosas acerca de "/home" no es una buena idea, es mejor usar os.environ['HOME']. Rainbow pondrá los archivos actuales en otros lugares, algunos en el ramdisk, otros en la flash.
Ten claro que espacio libre en el sistema de archivos realmente te importa.

=== ¿Cómo puedo saber si mi actividad se está ejecutando en una XO? ===
Sugar corre en PCs comunes, así como en XO. Aunque tu actuvidad probablemente corra en una XO real, algunas personas necesitan utilizarla en otros lados. Normalmente no deberías escribir una actividad que le importe si es una XO o no donde se está ejecutando. Si por alguna extraña razón necesitas saber, la forma más fácil es verificar si /sys/power/olpc-pm (el manejador de poder de la XO) existe.

[http://lists.laptop.org/pipermail/devel/2008-June/015923.html reliably detecting if running on an XO]
[[olpc:Power Management Interface]]</ref>

<pre>
import os
...
#Devuelve un valor booleano que nos dice si estamos en una XO o no.
print os.path.exists('/sys/power/olpc-pm')
</pre>

=== ¿Cómo puedo saber la configuración actual del lenguage en mi XO? ===
La variable 'LANG' te dice que lenguaje está actualmente activo en el XO. El código siguiente muestra cómo buscar en el valor de esta variable.

<pre>
import os
...
_logger.debug(os.environ['LANG'])
</pre>

=== ¿Cómo llamar repetidamente a un método específico después de un número N de segundos? ===
La función gobject.timeout_add() te permite invocar un método después de un período de tiempo determinado. Si quieres llamar a un método en varias ocasiones, simplemente sigue llamando a la función de gobject.timeout_add desde tu función.
El código de abajo es un ejemplo simple en donde la función que implementa el timeout se llama repeatedly_call. Nota que la sincronización entre las llamadas son aproximadas. Para que esto funcione debes llamar a repeatedly_call() desde alguna parte de tu código.

Puedes ver un mejor ejemplo de este patrón en uso [[olpc:Pango#How_do_I_dynamically_set_the_text_in_a_pango_layout.3F | aquí]].

<pre>

#Este método se llama a sí mismo aproximadamente cada 1 segundo
def repeatedly_call(self):
now = datetime.datetime.now()
gobject.timeout_add(self.repeat_period_msec, self.repeatedly_update_time)
</pre>

=== ¿Cómo puedo actualizar la build que se ejecuta en mi XO? ===

Hay varias páginas que te dan instrucciones sobre cómo instalar / actualizar la build actual.

* Si usted ya tiene una build instalada y una conexión a Internet, primero pruebe usar [[OLPC: OLPC-update]].
* Si eso no funciona, puedes mirar las instrucciones para una [[OLPC: Activated upgrade]] que se puede hacer a través de un USB]

Como mencionan las instrucciones en las páginas más arriba, asegurate de instalar tus actividades por separado luego de que actualices a una build específica.

=== I am developing on an XO laptop, but my keyboard and language settings are not ideal. How can I change them? ===

Internationalized laptops will often have settings that might slow you down while developing. To change around the language settings so you can better understand environment messages, use the [[olpc:Sugar Control Panel]]

Keyboard settings on internationalized laptops<ref>[[olpc:Keyboard layouts#OLPC keyboard layouts]]</ref> can also be suboptimal, especially as characters like "-" and "/" are in unfamiliar positions. You can use the <tt>setxkbmap</tt> command in the [[olpc:Terminal Activity]] to reset the type of keyboard input used and then attach a standard U.S. keyboard that will allow you to type normally. The command below sets the keyboard to the US mapping (it will reset to the default internationalized mapping upon restart).

setxkbmap us

=== My Python activity wants to use threads; how do I do that? ===

A question that has been answered with limited success is which threading patterns are most appropriate for use in Sugar. The following pattern of code to work fine in basic instances:

<pre>
#### Method: __init__, initialize this AnnotateActivity instance
def __init__(self, handle):
...
self.sample_thread = Thread(target=self.announce_thread, args=())
self.sample_thread.setDaemon(0)
self.sample_thread.start()
...

def announce_thread(self):
while (self.Running):
time.sleep(1)
print "thread running"
self._update_chat_text("Thread", "In here")
</pre>

This is the basic series of steps that most online documentation on python suggests to use when trying to work with threads in python. The problem is that it is unclear how this pattern relates to code that worked in the SimCity activity:

<pre>
import gobject
gobject.threads_init()
#import dbus.mainloop.glib
#dbus.mainloop.glib.threads_init()
</pre>

It should be noted that in the SimCity activity the pygame sound player would not produce sound reliably unless this setup was done.



Should the two patterns always be used in tandem? It seems that the latter code is mainly to initiate gobject and other libraries to work with threading, but it is unclear what restrictions there are with using threading with these libraries. Does one take precedence over the other? It is not clear if there is any problem with using the standard python threading code on the sugar technology stack.





In fact, experiments with threading on sugar leads to several different problems. For one thing, thread termination was tricky - using the can_close() method for sugar activities to terminate an activity only killed threads in some circumstances. It did not properly handle terminating threads in the case of CTRL-C or terminal interrupts. You can try to catch signals (SIGINT, SIGTERM or SIGHUP), but you will still be running in to errors in terminating child threads using these as well.





Another set of errors with threading comes up when trying to combine with stream tubes. The bottom line is that it is unclear what the scope of threading in a Sugar activity should be - should it simply work if you do the standard python threading pattern, is the use of the glib.threads_init and gobject.threads_init calls necessary, are there other interactions with threads and dbus that need to be accounted for? With more clarity from sugar developers on how the platform envisions threading to work in an activity, we can be more comfortable writing entries in the Almanac to help developers write error-free code.



=== How do I customize the title that is displayed for each instance of my activity? ===

By default, activity titles are just the generic activity names that you specify in your activity.info file. In some applications, you may want the activity title to be more dynamic.

For example, it makes sense to set the title for different browser sessions to the active web page being visited. That way, when you look back in the journal at the different browser sessions you have run in the previous few days, you can identify unique sessions based on the website you happened to be visiting at the time.

The code below shows how you can set the metadata for your activity to reflect a dynamic title based on whatever session criteria you feel is important. This example is adapted from the Browse activity, which sets activity instance titles based on the title of the current web page being visited.

<pre>
if self.metadata['mime_type'] == 'text/plain':
if not self._jobject.metadata['title_set_by_user'] == '1':
if self._browser.props.title:
# Set the title of this activity to be the current
# title of the page being visited by the browser.
self.metadata['title'] = self._browser.props.title
</pre>

=== What packages are available on sugar to support game development? ===

If your activity will require tools that are typically needed to develop robust and clean video games, then you should utilize the [http://www.pygame.org/ pygame package]. It can be readily imported into any activity:

<pre>
import pygame
...
</pre>

=== How do I detect when one of the game buttons on the laptop have been pressed? ===

The laptop game buttons (the circle, square, x, and check buttons next to the LCD) are encoded as page up, home, page down and end respectively. So, you can detect their press by listening for these specific events. For example, the code below listens for button presses and then just writes to an output widget which button was pressed.

<pre>
...
#### Initialize this activity.
def __init__(self, handle):
...
self.connect('key-press-event', self._keyPressCb)
...

#### Method _keyPressCb, which catches any presses of the game buttons.
def _keyPressCb(self, widget, event):

keyname = gtk.gdk.keyval_name(event.keyval)

if (keyname == 'KP_Page_Up'):
self._chat += "\nCircle Pressed!"
self._chat_buffer.set_text(self._chat)
elif (keyname == 'KP_Page_Down'):
self._chat += "\nX Pressed!"
self._chat_buffer.set_text(self._chat)
elif (keyname == 'KP_Home'):
self._chat += "\nSquare Pressed!"
self._chat_buffer.set_text(self._chat)
elif (keyname == 'KP_End'):
self._chat += "\nCheck Pressed!"
self._chat_buffer.set_text(self._chat)

return False
</pre>

=== How do I detect if one of the joystick buttons has been pressed? ===

This is the same process as detecting game buttons, except with different names for the keys. Again, you listen for "key-press-event" signals and then in your callback you check to see if the pressed button was one of the joystick keys.

<pre>
#### Initialize this activity.
def __init__(self, handle):
...
self.connect('key-press-event', self._keyPressCb)
...

#### Method _keyPressCb, which catches any presses of the game buttons.
def _keyPressCb(self, widget, event):

keyname = gtk.gdk.keyval_name(event.keyval)

if (keyname == 'KP_Up'):
self._chat += "\nUp Pressed!"
self._chat_buffer.set_text(self._chat)
elif (keyname == 'KP_Down'):
self._chat += "\nDown Pressed!"
self._chat_buffer.set_text(self._chat)
elif (keyname == 'KP_Left'):
self._chat += "\nLeft Pressed!"
self._chat_buffer.set_text(self._chat)
elif (keyname == 'KP_Right'):
self._chat += "\nRight Pressed!"
self._chat_buffer.set_text(self._chat)

return False
</pre>

=== How do i remove an specific button from the toolbar? ===

This is an example of the share button is removed:

<pre>
activity_toolbar = toolbox.get_activity_toolbar()
activity_toolbar.remove(activity_toolbar.share)
activity_toolbar.share = None
</pre>

== Notes ==
<references />

[[Category:Documentation]]
[[Category:Development Team]]

Development Team/Almanac/lang-es

2009-08-31T21:40:41Z

Fede: /* How do I repeatedly call a specific method after N number of seconds? */

{{translation
| source = Development_Team/Almanac
| lang = es
| status = {{translation/incomplete/}}
}}

{{Almanac}}
{{Almanac TOC}}
== ¿Cómo puedo obtener ayuda adicional más allá de este almanaque? ==
* ¿Quieres comenzar con los básico del desarrollo para Sugar? Puedes visitar el [http://wiki.sugarlabs.org/images/5/51/Activity_Handbook_200805_online.pdf Activity Handbook] de OLPC Austria (''Ten en cuenta que este manual fue actualizado por última vez en mayo del 2008, las capturas de tienen el diseño pre-8.2. En términos de código en sí, las cosas deberían funcionar como están descriptas. Si encuentra algún problema por favor póngase en contacto con [[User:ChristophD|ChristophD]].'')
* Ver también [[Development Team/Almanac/Code Snippets]]

Ahora, vamos con el almanaque actual...

== ¿Dónde puedo ver los cambios de la API? ==
API changes between OLPC releases can be seen here: [[Development Team/Almanac/API Changes|API Changes]]

== Comenzando ==
=== ¿Cómo estructuro mis archivos para que sean una actividad de válido en Sugar? ===
Puedes encontrar información sobre la estructura de la actividad aquí: [[Development Team/Almanac/Activity Bundles|Activity Bundles]]

=== ¿Cómo puedo hacer un icono para mi actividad? ===
La información sobre lo que debe hacer se puede encontrar aquí: [[Development Team/Almanac/Making Icons|Making Icons]]

== Paquete: sugar ==
* [[Development Team/Almanac/sugar.env|sugar.env]]
* [[Development Team/Almanac/sugar.profile|sugar.profile]]
* [[Development Team/Almanac/sugar.mime|sugar.mime]]
* [[Development Team/Almanac/sugar.logger|sugar.logger]]

== Paquete: sugar.activity ==
* [[Development Team/Almanac/sugar.activity.activity|sugar.activity.activity]]
* [[Development Team/Almanac/sugar.activity.activityfactory|sugar.activity.activityfactory]]
* [[Development Team/Almanac/sugar.activity.registry|sugar.activity.registry]]

== Paquete: sugar.datastore ==
* [[Development Team/Almanac/sugar.datastore.datastore|sugar.datastore.datastore]]

== Paquete: sugar.graphics ==
* [[Development Team/Almanac/sugar.graphics.alert|sugar.graphics.alert]]
* [[Development Team/Almanac/sugar.graphics.icon|sugar.graphics.icon]]
* [[Development Team/Almanac/sugar.graphics.notebook|sugar.graphics.notebook]]
* [[Development Team/Almanac/sugar.graphics.toolbutton|sugar.graphics.toolbutton]]
* [[Development Team/Almanac/sugar.graphics.toolbox|sugar.graphics.toolbox]]
* [[Development Team/Almanac/sugar.graphics.style|sugar.graphics.style]]

== Paquete: sugar.presence ==
* [[Development Team/Almanac/Sugar.presence|Sugar.presence]]
* [[Development Team/Almanac/Sugar.presence.activity|Sugar.presence.activity]]
* [[Development Team/Almanac/Sugar.presence.buddy|Sugar.presence.buddy]]
* [[Development Team/Almanac/Sugar.presence.presenceservice|Sugar.presence.presenceservice]]

== Clipboard ==
* Notas sobre el uso del [[Development Team/Almanac/GTK's Clipboard Module|módulo Clipboard de GTK ]]

== Logging ==
* [[Development Team/Almanac/sugar.logger|sugar.logger]]
* Notas sobre el uso del [[Development Team/Almanac/Python Standard Logging|standard de Logging en Python]]

== Internacionalización ==
*[[Development Team/Almanac/Internationalization|Internationalization]]

== Texto y gráficos para las actividades de Sugar ==
* [[Development Team/Almanac/Pango|Pango]]
=== ¿Cómo puedo crear un cuadro de texto para la edición de código? ===
Puedes usar gtksourceview2
<pre>
import gtk
import gtksourceview2
from sugar.graphics import style

...

# Configuramos el buffer
buffer = gtksourceview2.Buffer()
if hasattr(buffer, 'set_highlight'): # handle different API versions
buffer.set_highlight(True)
else:
buffer.set_highlight_syntax(True)

# Configuramos el tipo MIME para el buffer
lang_manager = gtksourceview2.language_manager_get_default()
if hasattr(lang_manager, 'list_languages'): # again, handle different APIs
langs = lang_manager.list_languages()
else:
lang_ids = lang_manager.get_language_ids()
langs = [lang_manager.get_language(lang_id)
for lang_id in lang_ids]
for lang in langs:
for m in lang.get_mime_types():
if m == mime_type: # <-- this is the mime type you want
buffer.set_language(lang)

# Establecemos el objeto para la vista, usarlo como gtk.TextView
view = gtksourceview2.View(buffer)
view.set_size_request(300, 450)
view.set_editable(True)
view.set_cursor_visible(True)
view.set_show_line_numbers(True)
view.set_wrap_mode(gtk.WRAP_CHAR)
view.set_right_margin_position(80)
#view.set_highlight_current_line(True) #FIXME: Ugly color
view.set_auto_indent(True)
view.modify_font(pango.FontDescription("Monospace " +
str(style.FONT_SIZE)))
...

</pre>

Para agregar texto al buffer:
<pre>
buffer.set_text(text)
</pre>
Para obtener todo el texto:
<pre>
text = buffer.get_text(buffer.get_start_iter(), buffer.get_end_iter())
</pre>

Probablemente quieras poner la view(vista) en un gtk.ScrolledWindow
<pre>
sw = gtk.ScrolledWindow()
sw.add(view)
sw.set_policy(gtk.POLICY_AUTOMATIC, gtk.POLICY_AUTOMATIC)
</pre>
y agregar el el objeto sw en vez de la view(vista).

Puedes encotnrar más en el código fuete de Pippyy en jarabe.view.sourceview.

== Audio y Video ==
* [[Development Team/Almanac/GStreamer|GStreamer]]

== Ratón ==
=== ¿Cómo puedo cambiar el cursor del ratón por el cursor de espera en mi actividad? ===
En la subclase de tu actividad:

<pre>
self.window.set_cursor( gtk.gdk.Cursor(gtk.gdk.WATCH) )
</pre>

y para volver al que está por defecto:

<pre>
self.window.set_cursor( None );
</pre>

=== ¿Cómo puedo rastrear la posición del ratón? ===
Existen varias razones por las que te puede interesar controlar la posición del ratón, que van desde el entretenimiento ([[http://en.wikipedia.org/wiki/Xeyes]]) a lo funcional (ocultar ciertas ventanas cuando el ratón no se ha movido por un par de segundos y volver a hacer aparecer esos elementos cuando este se mueva nuevamente). Esta es una manera en la cual se puede implementar esta funcionalidad:
<pre>

...
self.hideWidgetsTime = time.time()
self.mx = -1
self.my = -1
self.HIDE_WIDGET_TIMEOUT_ID = gobject.timeout_add( 500, self.mouseMightHaveMovedCb )

def _mouseMightHaveMovedCb( self ):
x, y = self.get_pointer()
passedTime = 0

if (x != self.mx or y != self.my):
self.hideWidgetsTime = time.time()
if (self.hiddenWidgets):
self.showWidgets()
self.hiddenWidgets = False
else:
passedTime = time.time() - self.hideWidgetsTime

if (passedTime >= 3):
if (not self.hiddenWidgets):
self.hideWidgets()
self.hiddenWidgets = True

self.mx = x
self.my = y
return True

</pre>

== Varios ==

Las tareas que aparecen más abajo son técnicas útiles que he encontrado mientras escribía código y documentación para esta referencia. No ha sido categorizadas aún.

=== ¿Cómo se si mi actividad está "activa" o no? ===

Puedes configurar un evento usando la constante VISIBILITY_NOTIFY_MASK para saber cuando se cambia la visibilidad. Luego en el callback para este evento lo que debes hacer es comprar el estado del evento con las variables gtk definidas para la visibilidad de tu actividad. Puedes ver [http://www.pygtk.org/docs/pygtk/gdk-constants.html#gdk-visibility-state-constants la sección de Constantes de Estado de Visibilidad de GDK] gtk.gdk.Constants para más información.

<pre>
# Notify when the visibility state changes by calling self.__visibility_notify_cb
# (PUT THIS IN YOUR ACTIVITY CODE - EG. THE __init__() METHOD)
self.add_events(gtk.gdk.VISIBILITY_NOTIFY_MASK)
self.connect("visibility-notify-event", self.__visibility_notify_cb)
...
# Callback method for when the activity's visibility changes
def __visibility_notify_cb(self, window, event):
if event.state == gtk.gdk.VISIBILITY_FULLY_OBSCURED:
print "I am not visible"
elif event.state in [gtk.gdk.VISIBILITY_UNOBSCURED, gtk.gdk.VISIBILITY_PARTIAL]:
print "I am visible"
</pre>

=== ¿Cómo puedo obtener la cantidad de espacio libre disponible dentro del directorio /home? ===
La siguiente función usa el módulo [http://docs.python.org/lib/module-statvfs.html statvfs]. El código siguiente muestra cómo obtener la cantidad total de espacio libre en /home.

<pre>
#### Método getFreespaceKb: devuelve el espacio disponible en kilobytes.
def getFreespaceKb(self):
stat = os.statvfs("/home")
freebytes = stat[statvfs.F_BSIZE] * stat[statvfs.F_BAVAIL]
freekb = freebytes / 1024
return freekb
</pre>

Ten en cuenta que asumir cosas acerca de "/home" no es una buena idea, es mejor usar os.environ['HOME']. Rainbow pondrá los archivos actuales en otros lugares, algunos en el ramdisk, otros en la flash.
Ten claro que espacio libre en el sistema de archivos realmente te importa.

=== ¿Cómo puedo saber si mi actividad se está ejecutando en una XO? ===
Sugar corre en PCs comunes, así como en XO. Aunque tu actuvidad probablemente corra en una XO real, algunas personas necesitan utilizarla en otros lados. Normalmente no deberías escribir una actividad que le importe si es una XO o no donde se está ejecutando. Si por alguna extraña razón necesitas saber, la forma más fácil es verificar si /sys/power/olpc-pm (el manejador de poder de la XO) existe.

[http://lists.laptop.org/pipermail/devel/2008-June/015923.html reliably detecting if running on an XO]
[[olpc:Power Management Interface]]</ref>

<pre>
import os
...
#Devuelve un valor booleano que nos dice si estamos en una XO o no.
print os.path.exists('/sys/power/olpc-pm')
</pre>

=== ¿Cómo puedo saber la configuración actual del lenguage en mi XO? ===
La variable 'LANG' te dice que lenguaje está actualmente activo en el XO. El código siguiente muestra cómo buscar en el valor de esta variable.

<pre>
import os
...
_logger.debug(os.environ['LANG'])
</pre>

=== ¿Cómo llamar repetidamente a un método específico después de un número N de segundos? ===
La función gobject.timeout_add() te permite invocar un método después de un período de tiempo determinado. Si quieres llamar a un método en varias ocasiones, simplemente sigue llamando a la función de gobject.timeout_add desde tu función.
El código de abajo es un ejemplo simple en donde la función que implementa el timeout se llama repeatedly_call. Nota que la sincronización entre las llamadas son aproximadas. Para que esto funcione debes llamar a repeatedly_call() desde alguna parte de tu código.

Puedes ver un mejor ejemplo de este patrón en uso [[olpc:Pango#How_do_I_dynamically_set_the_text_in_a_pango_layout.3F | aquí]].

<pre>

#Este método se llama a sí mismo aproximadamente cada 1 segundo
def repeatedly_call(self):
now = datetime.datetime.now()
gobject.timeout_add(self.repeat_period_msec, self.repeatedly_update_time)
</pre>

=== How do I update the current build version of code that is running on my XO? ===

There are several pages that give you instructions on how to install/update your current build.

* If you already have a working build installed and an internet connection, first try [[olpc:olpc-update]].
* If that doesn't work, you can look at instructions for an [[olpc:Activated upgrade]] that can be done via USB] boot.

As the instructions on the pages linked above note, make sure to install your activities separately after you have upgraded to a specific base build.

=== I am developing on an XO laptop, but my keyboard and language settings are not ideal. How can I change them? ===

Internationalized laptops will often have settings that might slow you down while developing. To change around the language settings so you can better understand environment messages, use the [[olpc:Sugar Control Panel]]

Keyboard settings on internationalized laptops<ref>[[olpc:Keyboard layouts#OLPC keyboard layouts]]</ref> can also be suboptimal, especially as characters like "-" and "/" are in unfamiliar positions. You can use the <tt>setxkbmap</tt> command in the [[olpc:Terminal Activity]] to reset the type of keyboard input used and then attach a standard U.S. keyboard that will allow you to type normally. The command below sets the keyboard to the US mapping (it will reset to the default internationalized mapping upon restart).

setxkbmap us

=== My Python activity wants to use threads; how do I do that? ===

A question that has been answered with limited success is which threading patterns are most appropriate for use in Sugar. The following pattern of code to work fine in basic instances:

<pre>
#### Method: __init__, initialize this AnnotateActivity instance
def __init__(self, handle):
...
self.sample_thread = Thread(target=self.announce_thread, args=())
self.sample_thread.setDaemon(0)
self.sample_thread.start()
...

def announce_thread(self):
while (self.Running):
time.sleep(1)
print "thread running"
self._update_chat_text("Thread", "In here")
</pre>

This is the basic series of steps that most online documentation on python suggests to use when trying to work with threads in python. The problem is that it is unclear how this pattern relates to code that worked in the SimCity activity:

<pre>
import gobject
gobject.threads_init()
#import dbus.mainloop.glib
#dbus.mainloop.glib.threads_init()
</pre>

It should be noted that in the SimCity activity the pygame sound player would not produce sound reliably unless this setup was done.



Should the two patterns always be used in tandem? It seems that the latter code is mainly to initiate gobject and other libraries to work with threading, but it is unclear what restrictions there are with using threading with these libraries. Does one take precedence over the other? It is not clear if there is any problem with using the standard python threading code on the sugar technology stack.





In fact, experiments with threading on sugar leads to several different problems. For one thing, thread termination was tricky - using the can_close() method for sugar activities to terminate an activity only killed threads in some circumstances. It did not properly handle terminating threads in the case of CTRL-C or terminal interrupts. You can try to catch signals (SIGINT, SIGTERM or SIGHUP), but you will still be running in to errors in terminating child threads using these as well.





Another set of errors with threading comes up when trying to combine with stream tubes. The bottom line is that it is unclear what the scope of threading in a Sugar activity should be - should it simply work if you do the standard python threading pattern, is the use of the glib.threads_init and gobject.threads_init calls necessary, are there other interactions with threads and dbus that need to be accounted for? With more clarity from sugar developers on how the platform envisions threading to work in an activity, we can be more comfortable writing entries in the Almanac to help developers write error-free code.



=== How do I customize the title that is displayed for each instance of my activity? ===

By default, activity titles are just the generic activity names that you specify in your activity.info file. In some applications, you may want the activity title to be more dynamic.

For example, it makes sense to set the title for different browser sessions to the active web page being visited. That way, when you look back in the journal at the different browser sessions you have run in the previous few days, you can identify unique sessions based on the website you happened to be visiting at the time.

The code below shows how you can set the metadata for your activity to reflect a dynamic title based on whatever session criteria you feel is important. This example is adapted from the Browse activity, which sets activity instance titles based on the title of the current web page being visited.

<pre>
if self.metadata['mime_type'] == 'text/plain':
if not self._jobject.metadata['title_set_by_user'] == '1':
if self._browser.props.title:
# Set the title of this activity to be the current
# title of the page being visited by the browser.
self.metadata['title'] = self._browser.props.title
</pre>

=== What packages are available on sugar to support game development? ===

If your activity will require tools that are typically needed to develop robust and clean video games, then you should utilize the [http://www.pygame.org/ pygame package]. It can be readily imported into any activity:

<pre>
import pygame
...
</pre>

=== How do I detect when one of the game buttons on the laptop have been pressed? ===

The laptop game buttons (the circle, square, x, and check buttons next to the LCD) are encoded as page up, home, page down and end respectively. So, you can detect their press by listening for these specific events. For example, the code below listens for button presses and then just writes to an output widget which button was pressed.

<pre>
...
#### Initialize this activity.
def __init__(self, handle):
...
self.connect('key-press-event', self._keyPressCb)
...

#### Method _keyPressCb, which catches any presses of the game buttons.
def _keyPressCb(self, widget, event):

keyname = gtk.gdk.keyval_name(event.keyval)

if (keyname == 'KP_Page_Up'):
self._chat += "\nCircle Pressed!"
self._chat_buffer.set_text(self._chat)
elif (keyname == 'KP_Page_Down'):
self._chat += "\nX Pressed!"
self._chat_buffer.set_text(self._chat)
elif (keyname == 'KP_Home'):
self._chat += "\nSquare Pressed!"
self._chat_buffer.set_text(self._chat)
elif (keyname == 'KP_End'):
self._chat += "\nCheck Pressed!"
self._chat_buffer.set_text(self._chat)

return False
</pre>

=== How do I detect if one of the joystick buttons has been pressed? ===

This is the same process as detecting game buttons, except with different names for the keys. Again, you listen for "key-press-event" signals and then in your callback you check to see if the pressed button was one of the joystick keys.

<pre>
#### Initialize this activity.
def __init__(self, handle):
...
self.connect('key-press-event', self._keyPressCb)
...

#### Method _keyPressCb, which catches any presses of the game buttons.
def _keyPressCb(self, widget, event):

keyname = gtk.gdk.keyval_name(event.keyval)

if (keyname == 'KP_Up'):
self._chat += "\nUp Pressed!"
self._chat_buffer.set_text(self._chat)
elif (keyname == 'KP_Down'):
self._chat += "\nDown Pressed!"
self._chat_buffer.set_text(self._chat)
elif (keyname == 'KP_Left'):
self._chat += "\nLeft Pressed!"
self._chat_buffer.set_text(self._chat)
elif (keyname == 'KP_Right'):
self._chat += "\nRight Pressed!"
self._chat_buffer.set_text(self._chat)

return False
</pre>

=== How do i remove an specific button from the toolbar? ===

This is an example of the share button is removed:

<pre>
activity_toolbar = toolbox.get_activity_toolbar()
activity_toolbar.remove(activity_toolbar.share)
activity_toolbar.share = None
</pre>

== Notes ==
<references />

[[Category:Documentation]]
[[Category:Development Team]]

Development Team/Almanac/lang-es

2009-08-31T16:57:17Z

Fede: /* How do I know the current language setting on my XO? */

{{translation
| source = Development_Team/Almanac
| lang = es
| status = {{translation/incomplete/}}
}}

{{Almanac}}
{{Almanac TOC}}
== ¿Cómo puedo obtener ayuda adicional más allá de este almanaque? ==
* ¿Quieres comenzar con los básico del desarrollo para Sugar? Puedes visitar el [http://wiki.sugarlabs.org/images/5/51/Activity_Handbook_200805_online.pdf Activity Handbook] de OLPC Austria (''Ten en cuenta que este manual fue actualizado por última vez en mayo del 2008, las capturas de tienen el diseño pre-8.2. En términos de código en sí, las cosas deberían funcionar como están descriptas. Si encuentra algún problema por favor póngase en contacto con [[User:ChristophD|ChristophD]].'')
* Ver también [[Development Team/Almanac/Code Snippets]]

Ahora, vamos con el almanaque actual...

== ¿Dónde puedo ver los cambios de la API? ==
API changes between OLPC releases can be seen here: [[Development Team/Almanac/API Changes|API Changes]]

== Comenzando ==
=== ¿Cómo estructuro mis archivos para que sean una actividad de válido en Sugar? ===
Puedes encontrar información sobre la estructura de la actividad aquí: [[Development Team/Almanac/Activity Bundles|Activity Bundles]]

=== ¿Cómo puedo hacer un icono para mi actividad? ===
La información sobre lo que debe hacer se puede encontrar aquí: [[Development Team/Almanac/Making Icons|Making Icons]]

== Paquete: sugar ==
* [[Development Team/Almanac/sugar.env|sugar.env]]
* [[Development Team/Almanac/sugar.profile|sugar.profile]]
* [[Development Team/Almanac/sugar.mime|sugar.mime]]
* [[Development Team/Almanac/sugar.logger|sugar.logger]]

== Paquete: sugar.activity ==
* [[Development Team/Almanac/sugar.activity.activity|sugar.activity.activity]]
* [[Development Team/Almanac/sugar.activity.activityfactory|sugar.activity.activityfactory]]
* [[Development Team/Almanac/sugar.activity.registry|sugar.activity.registry]]

== Paquete: sugar.datastore ==
* [[Development Team/Almanac/sugar.datastore.datastore|sugar.datastore.datastore]]

== Paquete: sugar.graphics ==
* [[Development Team/Almanac/sugar.graphics.alert|sugar.graphics.alert]]
* [[Development Team/Almanac/sugar.graphics.icon|sugar.graphics.icon]]
* [[Development Team/Almanac/sugar.graphics.notebook|sugar.graphics.notebook]]
* [[Development Team/Almanac/sugar.graphics.toolbutton|sugar.graphics.toolbutton]]
* [[Development Team/Almanac/sugar.graphics.toolbox|sugar.graphics.toolbox]]
* [[Development Team/Almanac/sugar.graphics.style|sugar.graphics.style]]

== Paquete: sugar.presence ==
* [[Development Team/Almanac/Sugar.presence|Sugar.presence]]
* [[Development Team/Almanac/Sugar.presence.activity|Sugar.presence.activity]]
* [[Development Team/Almanac/Sugar.presence.buddy|Sugar.presence.buddy]]
* [[Development Team/Almanac/Sugar.presence.presenceservice|Sugar.presence.presenceservice]]

== Clipboard ==
* Notas sobre el uso del [[Development Team/Almanac/GTK's Clipboard Module|módulo Clipboard de GTK ]]

== Logging ==
* [[Development Team/Almanac/sugar.logger|sugar.logger]]
* Notas sobre el uso del [[Development Team/Almanac/Python Standard Logging|standard de Logging en Python]]

== Internacionalización ==
*[[Development Team/Almanac/Internationalization|Internationalization]]

== Texto y gráficos para las actividades de Sugar ==
* [[Development Team/Almanac/Pango|Pango]]
=== ¿Cómo puedo crear un cuadro de texto para la edición de código? ===
Puedes usar gtksourceview2
<pre>
import gtk
import gtksourceview2
from sugar.graphics import style

...

# Configuramos el buffer
buffer = gtksourceview2.Buffer()
if hasattr(buffer, 'set_highlight'): # handle different API versions
buffer.set_highlight(True)
else:
buffer.set_highlight_syntax(True)

# Configuramos el tipo MIME para el buffer
lang_manager = gtksourceview2.language_manager_get_default()
if hasattr(lang_manager, 'list_languages'): # again, handle different APIs
langs = lang_manager.list_languages()
else:
lang_ids = lang_manager.get_language_ids()
langs = [lang_manager.get_language(lang_id)
for lang_id in lang_ids]
for lang in langs:
for m in lang.get_mime_types():
if m == mime_type: # <-- this is the mime type you want
buffer.set_language(lang)

# Establecemos el objeto para la vista, usarlo como gtk.TextView
view = gtksourceview2.View(buffer)
view.set_size_request(300, 450)
view.set_editable(True)
view.set_cursor_visible(True)
view.set_show_line_numbers(True)
view.set_wrap_mode(gtk.WRAP_CHAR)
view.set_right_margin_position(80)
#view.set_highlight_current_line(True) #FIXME: Ugly color
view.set_auto_indent(True)
view.modify_font(pango.FontDescription("Monospace " +
str(style.FONT_SIZE)))
...

</pre>

Para agregar texto al buffer:
<pre>
buffer.set_text(text)
</pre>
Para obtener todo el texto:
<pre>
text = buffer.get_text(buffer.get_start_iter(), buffer.get_end_iter())
</pre>

Probablemente quieras poner la view(vista) en un gtk.ScrolledWindow
<pre>
sw = gtk.ScrolledWindow()
sw.add(view)
sw.set_policy(gtk.POLICY_AUTOMATIC, gtk.POLICY_AUTOMATIC)
</pre>
y agregar el el objeto sw en vez de la view(vista).

Puedes encotnrar más en el código fuete de Pippyy en jarabe.view.sourceview.

== Audio y Video ==
* [[Development Team/Almanac/GStreamer|GStreamer]]

== Ratón ==
=== ¿Cómo puedo cambiar el cursor del ratón por el cursor de espera en mi actividad? ===
En la subclase de tu actividad:

<pre>
self.window.set_cursor( gtk.gdk.Cursor(gtk.gdk.WATCH) )
</pre>

y para volver al que está por defecto:

<pre>
self.window.set_cursor( None );
</pre>

=== ¿Cómo puedo rastrear la posición del ratón? ===
Existen varias razones por las que te puede interesar controlar la posición del ratón, que van desde el entretenimiento ([[http://en.wikipedia.org/wiki/Xeyes]]) a lo funcional (ocultar ciertas ventanas cuando el ratón no se ha movido por un par de segundos y volver a hacer aparecer esos elementos cuando este se mueva nuevamente). Esta es una manera en la cual se puede implementar esta funcionalidad:
<pre>

...
self.hideWidgetsTime = time.time()
self.mx = -1
self.my = -1
self.HIDE_WIDGET_TIMEOUT_ID = gobject.timeout_add( 500, self.mouseMightHaveMovedCb )

def _mouseMightHaveMovedCb( self ):
x, y = self.get_pointer()
passedTime = 0

if (x != self.mx or y != self.my):
self.hideWidgetsTime = time.time()
if (self.hiddenWidgets):
self.showWidgets()
self.hiddenWidgets = False
else:
passedTime = time.time() - self.hideWidgetsTime

if (passedTime >= 3):
if (not self.hiddenWidgets):
self.hideWidgets()
self.hiddenWidgets = True

self.mx = x
self.my = y
return True

</pre>

== Varios ==

Las tareas que aparecen más abajo son técnicas útiles que he encontrado mientras escribía código y documentación para esta referencia. No ha sido categorizadas aún.

=== ¿Cómo se si mi actividad está "activa" o no? ===

Puedes configurar un evento usando la constante VISIBILITY_NOTIFY_MASK para saber cuando se cambia la visibilidad. Luego en el callback para este evento lo que debes hacer es comprar el estado del evento con las variables gtk definidas para la visibilidad de tu actividad. Puedes ver [http://www.pygtk.org/docs/pygtk/gdk-constants.html#gdk-visibility-state-constants la sección de Constantes de Estado de Visibilidad de GDK] gtk.gdk.Constants para más información.

<pre>
# Notify when the visibility state changes by calling self.__visibility_notify_cb
# (PUT THIS IN YOUR ACTIVITY CODE - EG. THE __init__() METHOD)
self.add_events(gtk.gdk.VISIBILITY_NOTIFY_MASK)
self.connect("visibility-notify-event", self.__visibility_notify_cb)
...
# Callback method for when the activity's visibility changes
def __visibility_notify_cb(self, window, event):
if event.state == gtk.gdk.VISIBILITY_FULLY_OBSCURED:
print "I am not visible"
elif event.state in [gtk.gdk.VISIBILITY_UNOBSCURED, gtk.gdk.VISIBILITY_PARTIAL]:
print "I am visible"
</pre>

=== ¿Cómo puedo obtener la cantidad de espacio libre disponible dentro del directorio /home? ===
La siguiente función usa el módulo [http://docs.python.org/lib/module-statvfs.html statvfs]. El código siguiente muestra cómo obtener la cantidad total de espacio libre en /home.

<pre>
#### Método getFreespaceKb: devuelve el espacio disponible en kilobytes.
def getFreespaceKb(self):
stat = os.statvfs("/home")
freebytes = stat[statvfs.F_BSIZE] * stat[statvfs.F_BAVAIL]
freekb = freebytes / 1024
return freekb
</pre>

Ten en cuenta que asumir cosas acerca de "/home" no es una buena idea, es mejor usar os.environ['HOME']. Rainbow pondrá los archivos actuales en otros lugares, algunos en el ramdisk, otros en la flash.
Ten claro que espacio libre en el sistema de archivos realmente te importa.

=== ¿Cómo puedo saber si mi actividad se está ejecutando en una XO? ===
Sugar corre en PCs comunes, así como en XO. Aunque tu actuvidad probablemente corra en una XO real, algunas personas necesitan utilizarla en otros lados. Normalmente no deberías escribir una actividad que le importe si es una XO o no donde se está ejecutando. Si por alguna extraña razón necesitas saber, la forma más fácil es verificar si /sys/power/olpc-pm (el manejador de poder de la XO) existe.

[http://lists.laptop.org/pipermail/devel/2008-June/015923.html reliably detecting if running on an XO]
[[olpc:Power Management Interface]]</ref>

<pre>
import os
...
#Devuelve un valor booleano que nos dice si estamos en una XO o no.
print os.path.exists('/sys/power/olpc-pm')
</pre>

=== ¿Cómo puedo saber la configuración actual del lenguage en mi XO? ===
La variable 'LANG' te dice que lenguaje está actualmente activo en el XO. El código siguiente muestra cómo buscar en el valor de esta variable.

<pre>
import os
...
_logger.debug(os.environ['LANG'])
</pre>

=== How do I repeatedly call a specific method after N number of seconds? ===
The gobject.timeout_add() function allows you to invoke a callback method after a certain amount of time. If you want to repeatedly call a method, simply keep invoking the gobject.timeout_add function in your callback itself. The code below is a simple example, where the callback function is named repeatedly_call. Note that the timing of the callbacks are approximate. To get the process going, you should make an initial call to repeatedly_call() somewhere in your code.

You can see a more substantive example of this pattern in use when we [[olpc:Pango#How_do_I_dynamically_set_the_text_in_a_pango_layout.3F | regularly update the time displayed on a pango layout object]].

<pre>

#This method calls itself ROUGHLY every 1 second
def repeatedly_call(self):
now = datetime.datetime.now()
gobject.timeout_add(self.repeat_period_msec, self.repeatedly_update_time)
</pre>

=== How do I update the current build version of code that is running on my XO? ===

There are several pages that give you instructions on how to install/update your current build.

* If you already have a working build installed and an internet connection, first try [[olpc:olpc-update]].
* If that doesn't work, you can look at instructions for an [[olpc:Activated upgrade]] that can be done via USB] boot.

As the instructions on the pages linked above note, make sure to install your activities separately after you have upgraded to a specific base build.

=== I am developing on an XO laptop, but my keyboard and language settings are not ideal. How can I change them? ===

Internationalized laptops will often have settings that might slow you down while developing. To change around the language settings so you can better understand environment messages, use the [[olpc:Sugar Control Panel]]

Keyboard settings on internationalized laptops<ref>[[olpc:Keyboard layouts#OLPC keyboard layouts]]</ref> can also be suboptimal, especially as characters like "-" and "/" are in unfamiliar positions. You can use the <tt>setxkbmap</tt> command in the [[olpc:Terminal Activity]] to reset the type of keyboard input used and then attach a standard U.S. keyboard that will allow you to type normally. The command below sets the keyboard to the US mapping (it will reset to the default internationalized mapping upon restart).

setxkbmap us

=== My Python activity wants to use threads; how do I do that? ===

A question that has been answered with limited success is which threading patterns are most appropriate for use in Sugar. The following pattern of code to work fine in basic instances:

<pre>
#### Method: __init__, initialize this AnnotateActivity instance
def __init__(self, handle):
...
self.sample_thread = Thread(target=self.announce_thread, args=())
self.sample_thread.setDaemon(0)
self.sample_thread.start()
...

def announce_thread(self):
while (self.Running):
time.sleep(1)
print "thread running"
self._update_chat_text("Thread", "In here")
</pre>

This is the basic series of steps that most online documentation on python suggests to use when trying to work with threads in python. The problem is that it is unclear how this pattern relates to code that worked in the SimCity activity:

<pre>
import gobject
gobject.threads_init()
#import dbus.mainloop.glib
#dbus.mainloop.glib.threads_init()
</pre>

It should be noted that in the SimCity activity the pygame sound player would not produce sound reliably unless this setup was done.



Should the two patterns always be used in tandem? It seems that the latter code is mainly to initiate gobject and other libraries to work with threading, but it is unclear what restrictions there are with using threading with these libraries. Does one take precedence over the other? It is not clear if there is any problem with using the standard python threading code on the sugar technology stack.





In fact, experiments with threading on sugar leads to several different problems. For one thing, thread termination was tricky - using the can_close() method for sugar activities to terminate an activity only killed threads in some circumstances. It did not properly handle terminating threads in the case of CTRL-C or terminal interrupts. You can try to catch signals (SIGINT, SIGTERM or SIGHUP), but you will still be running in to errors in terminating child threads using these as well.





Another set of errors with threading comes up when trying to combine with stream tubes. The bottom line is that it is unclear what the scope of threading in a Sugar activity should be - should it simply work if you do the standard python threading pattern, is the use of the glib.threads_init and gobject.threads_init calls necessary, are there other interactions with threads and dbus that need to be accounted for? With more clarity from sugar developers on how the platform envisions threading to work in an activity, we can be more comfortable writing entries in the Almanac to help developers write error-free code.



=== How do I customize the title that is displayed for each instance of my activity? ===

By default, activity titles are just the generic activity names that you specify in your activity.info file. In some applications, you may want the activity title to be more dynamic.

For example, it makes sense to set the title for different browser sessions to the active web page being visited. That way, when you look back in the journal at the different browser sessions you have run in the previous few days, you can identify unique sessions based on the website you happened to be visiting at the time.

The code below shows how you can set the metadata for your activity to reflect a dynamic title based on whatever session criteria you feel is important. This example is adapted from the Browse activity, which sets activity instance titles based on the title of the current web page being visited.

<pre>
if self.metadata['mime_type'] == 'text/plain':
if not self._jobject.metadata['title_set_by_user'] == '1':
if self._browser.props.title:
# Set the title of this activity to be the current
# title of the page being visited by the browser.
self.metadata['title'] = self._browser.props.title
</pre>

=== What packages are available on sugar to support game development? ===

If your activity will require tools that are typically needed to develop robust and clean video games, then you should utilize the [http://www.pygame.org/ pygame package]. It can be readily imported into any activity:

<pre>
import pygame
...
</pre>

=== How do I detect when one of the game buttons on the laptop have been pressed? ===

The laptop game buttons (the circle, square, x, and check buttons next to the LCD) are encoded as page up, home, page down and end respectively. So, you can detect their press by listening for these specific events. For example, the code below listens for button presses and then just writes to an output widget which button was pressed.

<pre>
...
#### Initialize this activity.
def __init__(self, handle):
...
self.connect('key-press-event', self._keyPressCb)
...

#### Method _keyPressCb, which catches any presses of the game buttons.
def _keyPressCb(self, widget, event):

keyname = gtk.gdk.keyval_name(event.keyval)

if (keyname == 'KP_Page_Up'):
self._chat += "\nCircle Pressed!"
self._chat_buffer.set_text(self._chat)
elif (keyname == 'KP_Page_Down'):
self._chat += "\nX Pressed!"
self._chat_buffer.set_text(self._chat)
elif (keyname == 'KP_Home'):
self._chat += "\nSquare Pressed!"
self._chat_buffer.set_text(self._chat)
elif (keyname == 'KP_End'):
self._chat += "\nCheck Pressed!"
self._chat_buffer.set_text(self._chat)

return False
</pre>

=== How do I detect if one of the joystick buttons has been pressed? ===

This is the same process as detecting game buttons, except with different names for the keys. Again, you listen for "key-press-event" signals and then in your callback you check to see if the pressed button was one of the joystick keys.

<pre>
#### Initialize this activity.
def __init__(self, handle):
...
self.connect('key-press-event', self._keyPressCb)
...

#### Method _keyPressCb, which catches any presses of the game buttons.
def _keyPressCb(self, widget, event):

keyname = gtk.gdk.keyval_name(event.keyval)

if (keyname == 'KP_Up'):
self._chat += "\nUp Pressed!"
self._chat_buffer.set_text(self._chat)
elif (keyname == 'KP_Down'):
self._chat += "\nDown Pressed!"
self._chat_buffer.set_text(self._chat)
elif (keyname == 'KP_Left'):
self._chat += "\nLeft Pressed!"
self._chat_buffer.set_text(self._chat)
elif (keyname == 'KP_Right'):
self._chat += "\nRight Pressed!"
self._chat_buffer.set_text(self._chat)

return False
</pre>

=== How do i remove an specific button from the toolbar? ===

This is an example of the share button is removed:

<pre>
activity_toolbar = toolbox.get_activity_toolbar()
activity_toolbar.remove(activity_toolbar.share)
activity_toolbar.share = None
</pre>

== Notes ==
<references />

[[Category:Documentation]]
[[Category:Development Team]]

Development Team/Almanac/lang-es

2009-08-31T16:48:50Z

Fede: /* How do I know whether my activity is running on a physical XO? */

{{translation
| source = Development_Team/Almanac
| lang = es
| status = {{translation/incomplete/}}
}}

{{Almanac}}
{{Almanac TOC}}
== ¿Cómo puedo obtener ayuda adicional más allá de este almanaque? ==
* ¿Quieres comenzar con los básico del desarrollo para Sugar? Puedes visitar el [http://wiki.sugarlabs.org/images/5/51/Activity_Handbook_200805_online.pdf Activity Handbook] de OLPC Austria (''Ten en cuenta que este manual fue actualizado por última vez en mayo del 2008, las capturas de tienen el diseño pre-8.2. En términos de código en sí, las cosas deberían funcionar como están descriptas. Si encuentra algún problema por favor póngase en contacto con [[User:ChristophD|ChristophD]].'')
* Ver también [[Development Team/Almanac/Code Snippets]]

Ahora, vamos con el almanaque actual...

== ¿Dónde puedo ver los cambios de la API? ==
API changes between OLPC releases can be seen here: [[Development Team/Almanac/API Changes|API Changes]]

== Comenzando ==
=== ¿Cómo estructuro mis archivos para que sean una actividad de válido en Sugar? ===
Puedes encontrar información sobre la estructura de la actividad aquí: [[Development Team/Almanac/Activity Bundles|Activity Bundles]]

=== ¿Cómo puedo hacer un icono para mi actividad? ===
La información sobre lo que debe hacer se puede encontrar aquí: [[Development Team/Almanac/Making Icons|Making Icons]]

== Paquete: sugar ==
* [[Development Team/Almanac/sugar.env|sugar.env]]
* [[Development Team/Almanac/sugar.profile|sugar.profile]]
* [[Development Team/Almanac/sugar.mime|sugar.mime]]
* [[Development Team/Almanac/sugar.logger|sugar.logger]]

== Paquete: sugar.activity ==
* [[Development Team/Almanac/sugar.activity.activity|sugar.activity.activity]]
* [[Development Team/Almanac/sugar.activity.activityfactory|sugar.activity.activityfactory]]
* [[Development Team/Almanac/sugar.activity.registry|sugar.activity.registry]]

== Paquete: sugar.datastore ==
* [[Development Team/Almanac/sugar.datastore.datastore|sugar.datastore.datastore]]

== Paquete: sugar.graphics ==
* [[Development Team/Almanac/sugar.graphics.alert|sugar.graphics.alert]]
* [[Development Team/Almanac/sugar.graphics.icon|sugar.graphics.icon]]
* [[Development Team/Almanac/sugar.graphics.notebook|sugar.graphics.notebook]]
* [[Development Team/Almanac/sugar.graphics.toolbutton|sugar.graphics.toolbutton]]
* [[Development Team/Almanac/sugar.graphics.toolbox|sugar.graphics.toolbox]]
* [[Development Team/Almanac/sugar.graphics.style|sugar.graphics.style]]

== Paquete: sugar.presence ==
* [[Development Team/Almanac/Sugar.presence|Sugar.presence]]
* [[Development Team/Almanac/Sugar.presence.activity|Sugar.presence.activity]]
* [[Development Team/Almanac/Sugar.presence.buddy|Sugar.presence.buddy]]
* [[Development Team/Almanac/Sugar.presence.presenceservice|Sugar.presence.presenceservice]]

== Clipboard ==
* Notas sobre el uso del [[Development Team/Almanac/GTK's Clipboard Module|módulo Clipboard de GTK ]]

== Logging ==
* [[Development Team/Almanac/sugar.logger|sugar.logger]]
* Notas sobre el uso del [[Development Team/Almanac/Python Standard Logging|standard de Logging en Python]]

== Internacionalización ==
*[[Development Team/Almanac/Internationalization|Internationalization]]

== Texto y gráficos para las actividades de Sugar ==
* [[Development Team/Almanac/Pango|Pango]]
=== ¿Cómo puedo crear un cuadro de texto para la edición de código? ===
Puedes usar gtksourceview2
<pre>
import gtk
import gtksourceview2
from sugar.graphics import style

...

# Configuramos el buffer
buffer = gtksourceview2.Buffer()
if hasattr(buffer, 'set_highlight'): # handle different API versions
buffer.set_highlight(True)
else:
buffer.set_highlight_syntax(True)

# Configuramos el tipo MIME para el buffer
lang_manager = gtksourceview2.language_manager_get_default()
if hasattr(lang_manager, 'list_languages'): # again, handle different APIs
langs = lang_manager.list_languages()
else:
lang_ids = lang_manager.get_language_ids()
langs = [lang_manager.get_language(lang_id)
for lang_id in lang_ids]
for lang in langs:
for m in lang.get_mime_types():
if m == mime_type: # <-- this is the mime type you want
buffer.set_language(lang)

# Establecemos el objeto para la vista, usarlo como gtk.TextView
view = gtksourceview2.View(buffer)
view.set_size_request(300, 450)
view.set_editable(True)
view.set_cursor_visible(True)
view.set_show_line_numbers(True)
view.set_wrap_mode(gtk.WRAP_CHAR)
view.set_right_margin_position(80)
#view.set_highlight_current_line(True) #FIXME: Ugly color
view.set_auto_indent(True)
view.modify_font(pango.FontDescription("Monospace " +
str(style.FONT_SIZE)))
...

</pre>

Para agregar texto al buffer:
<pre>
buffer.set_text(text)
</pre>
Para obtener todo el texto:
<pre>
text = buffer.get_text(buffer.get_start_iter(), buffer.get_end_iter())
</pre>

Probablemente quieras poner la view(vista) en un gtk.ScrolledWindow
<pre>
sw = gtk.ScrolledWindow()
sw.add(view)
sw.set_policy(gtk.POLICY_AUTOMATIC, gtk.POLICY_AUTOMATIC)
</pre>
y agregar el el objeto sw en vez de la view(vista).

Puedes encotnrar más en el código fuete de Pippyy en jarabe.view.sourceview.

== Audio y Video ==
* [[Development Team/Almanac/GStreamer|GStreamer]]

== Ratón ==
=== ¿Cómo puedo cambiar el cursor del ratón por el cursor de espera en mi actividad? ===
En la subclase de tu actividad:

<pre>
self.window.set_cursor( gtk.gdk.Cursor(gtk.gdk.WATCH) )
</pre>

y para volver al que está por defecto:

<pre>
self.window.set_cursor( None );
</pre>

=== ¿Cómo puedo rastrear la posición del ratón? ===
Existen varias razones por las que te puede interesar controlar la posición del ratón, que van desde el entretenimiento ([[http://en.wikipedia.org/wiki/Xeyes]]) a lo funcional (ocultar ciertas ventanas cuando el ratón no se ha movido por un par de segundos y volver a hacer aparecer esos elementos cuando este se mueva nuevamente). Esta es una manera en la cual se puede implementar esta funcionalidad:
<pre>

...
self.hideWidgetsTime = time.time()
self.mx = -1
self.my = -1
self.HIDE_WIDGET_TIMEOUT_ID = gobject.timeout_add( 500, self.mouseMightHaveMovedCb )

def _mouseMightHaveMovedCb( self ):
x, y = self.get_pointer()
passedTime = 0

if (x != self.mx or y != self.my):
self.hideWidgetsTime = time.time()
if (self.hiddenWidgets):
self.showWidgets()
self.hiddenWidgets = False
else:
passedTime = time.time() - self.hideWidgetsTime

if (passedTime >= 3):
if (not self.hiddenWidgets):
self.hideWidgets()
self.hiddenWidgets = True

self.mx = x
self.my = y
return True

</pre>

== Varios ==

Las tareas que aparecen más abajo son técnicas útiles que he encontrado mientras escribía código y documentación para esta referencia. No ha sido categorizadas aún.

=== ¿Cómo se si mi actividad está "activa" o no? ===

Puedes configurar un evento usando la constante VISIBILITY_NOTIFY_MASK para saber cuando se cambia la visibilidad. Luego en el callback para este evento lo que debes hacer es comprar el estado del evento con las variables gtk definidas para la visibilidad de tu actividad. Puedes ver [http://www.pygtk.org/docs/pygtk/gdk-constants.html#gdk-visibility-state-constants la sección de Constantes de Estado de Visibilidad de GDK] gtk.gdk.Constants para más información.

<pre>
# Notify when the visibility state changes by calling self.__visibility_notify_cb
# (PUT THIS IN YOUR ACTIVITY CODE - EG. THE __init__() METHOD)
self.add_events(gtk.gdk.VISIBILITY_NOTIFY_MASK)
self.connect("visibility-notify-event", self.__visibility_notify_cb)
...
# Callback method for when the activity's visibility changes
def __visibility_notify_cb(self, window, event):
if event.state == gtk.gdk.VISIBILITY_FULLY_OBSCURED:
print "I am not visible"
elif event.state in [gtk.gdk.VISIBILITY_UNOBSCURED, gtk.gdk.VISIBILITY_PARTIAL]:
print "I am visible"
</pre>

=== ¿Cómo puedo obtener la cantidad de espacio libre disponible dentro del directorio /home? ===
La siguiente función usa el módulo [http://docs.python.org/lib/module-statvfs.html statvfs]. El código siguiente muestra cómo obtener la cantidad total de espacio libre en /home.

<pre>
#### Método getFreespaceKb: devuelve el espacio disponible en kilobytes.
def getFreespaceKb(self):
stat = os.statvfs("/home")
freebytes = stat[statvfs.F_BSIZE] * stat[statvfs.F_BAVAIL]
freekb = freebytes / 1024
return freekb
</pre>

Ten en cuenta que asumir cosas acerca de "/home" no es una buena idea, es mejor usar os.environ['HOME']. Rainbow pondrá los archivos actuales en otros lugares, algunos en el ramdisk, otros en la flash.
Ten claro que espacio libre en el sistema de archivos realmente te importa.

=== ¿Cómo puedo saber si mi actividad se está ejecutando en una XO? ===
Sugar corre en PCs comunes, así como en XO. Aunque tu actuvidad probablemente corra en una XO real, algunas personas necesitan utilizarla en otros lados. Normalmente no deberías escribir una actividad que le importe si es una XO o no donde se está ejecutando. Si por alguna extraña razón necesitas saber, la forma más fácil es verificar si /sys/power/olpc-pm (el manejador de poder de la XO) existe.

[http://lists.laptop.org/pipermail/devel/2008-June/015923.html reliably detecting if running on an XO]
[[olpc:Power Management Interface]]</ref>

<pre>
import os
...
#Devuelve un valor booleano que nos dice si estamos en una XO o no.
print os.path.exists('/sys/power/olpc-pm')
</pre>

=== How do I know the current language setting on my XO? ===
The system variable 'LANG' tells you which language is currently active on the XO. The following code shows how to look at the value of this variable.

<pre>
import os
...
_logger.debug(os.environ['LANG'])
</pre>

=== How do I repeatedly call a specific method after N number of seconds? ===
The gobject.timeout_add() function allows you to invoke a callback method after a certain amount of time. If you want to repeatedly call a method, simply keep invoking the gobject.timeout_add function in your callback itself. The code below is a simple example, where the callback function is named repeatedly_call. Note that the timing of the callbacks are approximate. To get the process going, you should make an initial call to repeatedly_call() somewhere in your code.

You can see a more substantive example of this pattern in use when we [[olpc:Pango#How_do_I_dynamically_set_the_text_in_a_pango_layout.3F | regularly update the time displayed on a pango layout object]].

<pre>

#This method calls itself ROUGHLY every 1 second
def repeatedly_call(self):
now = datetime.datetime.now()
gobject.timeout_add(self.repeat_period_msec, self.repeatedly_update_time)
</pre>

=== How do I update the current build version of code that is running on my XO? ===

There are several pages that give you instructions on how to install/update your current build.

* If you already have a working build installed and an internet connection, first try [[olpc:olpc-update]].
* If that doesn't work, you can look at instructions for an [[olpc:Activated upgrade]] that can be done via USB] boot.

As the instructions on the pages linked above note, make sure to install your activities separately after you have upgraded to a specific base build.

=== I am developing on an XO laptop, but my keyboard and language settings are not ideal. How can I change them? ===

Internationalized laptops will often have settings that might slow you down while developing. To change around the language settings so you can better understand environment messages, use the [[olpc:Sugar Control Panel]]

Keyboard settings on internationalized laptops<ref>[[olpc:Keyboard layouts#OLPC keyboard layouts]]</ref> can also be suboptimal, especially as characters like "-" and "/" are in unfamiliar positions. You can use the <tt>setxkbmap</tt> command in the [[olpc:Terminal Activity]] to reset the type of keyboard input used and then attach a standard U.S. keyboard that will allow you to type normally. The command below sets the keyboard to the US mapping (it will reset to the default internationalized mapping upon restart).

setxkbmap us

=== My Python activity wants to use threads; how do I do that? ===

A question that has been answered with limited success is which threading patterns are most appropriate for use in Sugar. The following pattern of code to work fine in basic instances:

<pre>
#### Method: __init__, initialize this AnnotateActivity instance
def __init__(self, handle):
...
self.sample_thread = Thread(target=self.announce_thread, args=())
self.sample_thread.setDaemon(0)
self.sample_thread.start()
...

def announce_thread(self):
while (self.Running):
time.sleep(1)
print "thread running"
self._update_chat_text("Thread", "In here")
</pre>

This is the basic series of steps that most online documentation on python suggests to use when trying to work with threads in python. The problem is that it is unclear how this pattern relates to code that worked in the SimCity activity:

<pre>
import gobject
gobject.threads_init()
#import dbus.mainloop.glib
#dbus.mainloop.glib.threads_init()
</pre>

It should be noted that in the SimCity activity the pygame sound player would not produce sound reliably unless this setup was done.



Should the two patterns always be used in tandem? It seems that the latter code is mainly to initiate gobject and other libraries to work with threading, but it is unclear what restrictions there are with using threading with these libraries. Does one take precedence over the other? It is not clear if there is any problem with using the standard python threading code on the sugar technology stack.





In fact, experiments with threading on sugar leads to several different problems. For one thing, thread termination was tricky - using the can_close() method for sugar activities to terminate an activity only killed threads in some circumstances. It did not properly handle terminating threads in the case of CTRL-C or terminal interrupts. You can try to catch signals (SIGINT, SIGTERM or SIGHUP), but you will still be running in to errors in terminating child threads using these as well.





Another set of errors with threading comes up when trying to combine with stream tubes. The bottom line is that it is unclear what the scope of threading in a Sugar activity should be - should it simply work if you do the standard python threading pattern, is the use of the glib.threads_init and gobject.threads_init calls necessary, are there other interactions with threads and dbus that need to be accounted for? With more clarity from sugar developers on how the platform envisions threading to work in an activity, we can be more comfortable writing entries in the Almanac to help developers write error-free code.



=== How do I customize the title that is displayed for each instance of my activity? ===

By default, activity titles are just the generic activity names that you specify in your activity.info file. In some applications, you may want the activity title to be more dynamic.

For example, it makes sense to set the title for different browser sessions to the active web page being visited. That way, when you look back in the journal at the different browser sessions you have run in the previous few days, you can identify unique sessions based on the website you happened to be visiting at the time.

The code below shows how you can set the metadata for your activity to reflect a dynamic title based on whatever session criteria you feel is important. This example is adapted from the Browse activity, which sets activity instance titles based on the title of the current web page being visited.

<pre>
if self.metadata['mime_type'] == 'text/plain':
if not self._jobject.metadata['title_set_by_user'] == '1':
if self._browser.props.title:
# Set the title of this activity to be the current
# title of the page being visited by the browser.
self.metadata['title'] = self._browser.props.title
</pre>

=== What packages are available on sugar to support game development? ===

If your activity will require tools that are typically needed to develop robust and clean video games, then you should utilize the [http://www.pygame.org/ pygame package]. It can be readily imported into any activity:

<pre>
import pygame
...
</pre>

=== How do I detect when one of the game buttons on the laptop have been pressed? ===

The laptop game buttons (the circle, square, x, and check buttons next to the LCD) are encoded as page up, home, page down and end respectively. So, you can detect their press by listening for these specific events. For example, the code below listens for button presses and then just writes to an output widget which button was pressed.

<pre>
...
#### Initialize this activity.
def __init__(self, handle):
...
self.connect('key-press-event', self._keyPressCb)
...

#### Method _keyPressCb, which catches any presses of the game buttons.
def _keyPressCb(self, widget, event):

keyname = gtk.gdk.keyval_name(event.keyval)

if (keyname == 'KP_Page_Up'):
self._chat += "\nCircle Pressed!"
self._chat_buffer.set_text(self._chat)
elif (keyname == 'KP_Page_Down'):
self._chat += "\nX Pressed!"
self._chat_buffer.set_text(self._chat)
elif (keyname == 'KP_Home'):
self._chat += "\nSquare Pressed!"
self._chat_buffer.set_text(self._chat)
elif (keyname == 'KP_End'):
self._chat += "\nCheck Pressed!"
self._chat_buffer.set_text(self._chat)

return False
</pre>

=== How do I detect if one of the joystick buttons has been pressed? ===

This is the same process as detecting game buttons, except with different names for the keys. Again, you listen for "key-press-event" signals and then in your callback you check to see if the pressed button was one of the joystick keys.

<pre>
#### Initialize this activity.
def __init__(self, handle):
...
self.connect('key-press-event', self._keyPressCb)
...

#### Method _keyPressCb, which catches any presses of the game buttons.
def _keyPressCb(self, widget, event):

keyname = gtk.gdk.keyval_name(event.keyval)

if (keyname == 'KP_Up'):
self._chat += "\nUp Pressed!"
self._chat_buffer.set_text(self._chat)
elif (keyname == 'KP_Down'):
self._chat += "\nDown Pressed!"
self._chat_buffer.set_text(self._chat)
elif (keyname == 'KP_Left'):
self._chat += "\nLeft Pressed!"
self._chat_buffer.set_text(self._chat)
elif (keyname == 'KP_Right'):
self._chat += "\nRight Pressed!"
self._chat_buffer.set_text(self._chat)

return False
</pre>

=== How do i remove an specific button from the toolbar? ===

This is an example of the share button is removed:

<pre>
activity_toolbar = toolbox.get_activity_toolbar()
activity_toolbar.remove(activity_toolbar.share)
activity_toolbar.share = None
</pre>

== Notes ==
<references />

[[Category:Documentation]]
[[Category:Development Team]]

Development Team/Almanac/lang-es

2009-08-31T16:41:45Z

Fede: /* ¿Cómo puedo obtener la cantidad de espacio libre disponible dentro del directorio /home? */

{{translation
| source = Development_Team/Almanac
| lang = es
| status = {{translation/incomplete/}}
}}

{{Almanac}}
{{Almanac TOC}}
== ¿Cómo puedo obtener ayuda adicional más allá de este almanaque? ==
* ¿Quieres comenzar con los básico del desarrollo para Sugar? Puedes visitar el [http://wiki.sugarlabs.org/images/5/51/Activity_Handbook_200805_online.pdf Activity Handbook] de OLPC Austria (''Ten en cuenta que este manual fue actualizado por última vez en mayo del 2008, las capturas de tienen el diseño pre-8.2. En términos de código en sí, las cosas deberían funcionar como están descriptas. Si encuentra algún problema por favor póngase en contacto con [[User:ChristophD|ChristophD]].'')
* Ver también [[Development Team/Almanac/Code Snippets]]

Ahora, vamos con el almanaque actual...

== ¿Dónde puedo ver los cambios de la API? ==
API changes between OLPC releases can be seen here: [[Development Team/Almanac/API Changes|API Changes]]

== Comenzando ==
=== ¿Cómo estructuro mis archivos para que sean una actividad de válido en Sugar? ===
Puedes encontrar información sobre la estructura de la actividad aquí: [[Development Team/Almanac/Activity Bundles|Activity Bundles]]

=== ¿Cómo puedo hacer un icono para mi actividad? ===
La información sobre lo que debe hacer se puede encontrar aquí: [[Development Team/Almanac/Making Icons|Making Icons]]

== Paquete: sugar ==
* [[Development Team/Almanac/sugar.env|sugar.env]]
* [[Development Team/Almanac/sugar.profile|sugar.profile]]
* [[Development Team/Almanac/sugar.mime|sugar.mime]]
* [[Development Team/Almanac/sugar.logger|sugar.logger]]

== Paquete: sugar.activity ==
* [[Development Team/Almanac/sugar.activity.activity|sugar.activity.activity]]
* [[Development Team/Almanac/sugar.activity.activityfactory|sugar.activity.activityfactory]]
* [[Development Team/Almanac/sugar.activity.registry|sugar.activity.registry]]

== Paquete: sugar.datastore ==
* [[Development Team/Almanac/sugar.datastore.datastore|sugar.datastore.datastore]]

== Paquete: sugar.graphics ==
* [[Development Team/Almanac/sugar.graphics.alert|sugar.graphics.alert]]
* [[Development Team/Almanac/sugar.graphics.icon|sugar.graphics.icon]]
* [[Development Team/Almanac/sugar.graphics.notebook|sugar.graphics.notebook]]
* [[Development Team/Almanac/sugar.graphics.toolbutton|sugar.graphics.toolbutton]]
* [[Development Team/Almanac/sugar.graphics.toolbox|sugar.graphics.toolbox]]
* [[Development Team/Almanac/sugar.graphics.style|sugar.graphics.style]]

== Paquete: sugar.presence ==
* [[Development Team/Almanac/Sugar.presence|Sugar.presence]]
* [[Development Team/Almanac/Sugar.presence.activity|Sugar.presence.activity]]
* [[Development Team/Almanac/Sugar.presence.buddy|Sugar.presence.buddy]]
* [[Development Team/Almanac/Sugar.presence.presenceservice|Sugar.presence.presenceservice]]

== Clipboard ==
* Notas sobre el uso del [[Development Team/Almanac/GTK's Clipboard Module|módulo Clipboard de GTK ]]

== Logging ==
* [[Development Team/Almanac/sugar.logger|sugar.logger]]
* Notas sobre el uso del [[Development Team/Almanac/Python Standard Logging|standard de Logging en Python]]

== Internacionalización ==
*[[Development Team/Almanac/Internationalization|Internationalization]]

== Texto y gráficos para las actividades de Sugar ==
* [[Development Team/Almanac/Pango|Pango]]
=== ¿Cómo puedo crear un cuadro de texto para la edición de código? ===
Puedes usar gtksourceview2
<pre>
import gtk
import gtksourceview2
from sugar.graphics import style

...

# Configuramos el buffer
buffer = gtksourceview2.Buffer()
if hasattr(buffer, 'set_highlight'): # handle different API versions
buffer.set_highlight(True)
else:
buffer.set_highlight_syntax(True)

# Configuramos el tipo MIME para el buffer
lang_manager = gtksourceview2.language_manager_get_default()
if hasattr(lang_manager, 'list_languages'): # again, handle different APIs
langs = lang_manager.list_languages()
else:
lang_ids = lang_manager.get_language_ids()
langs = [lang_manager.get_language(lang_id)
for lang_id in lang_ids]
for lang in langs:
for m in lang.get_mime_types():
if m == mime_type: # <-- this is the mime type you want
buffer.set_language(lang)

# Establecemos el objeto para la vista, usarlo como gtk.TextView
view = gtksourceview2.View(buffer)
view.set_size_request(300, 450)
view.set_editable(True)
view.set_cursor_visible(True)
view.set_show_line_numbers(True)
view.set_wrap_mode(gtk.WRAP_CHAR)
view.set_right_margin_position(80)
#view.set_highlight_current_line(True) #FIXME: Ugly color
view.set_auto_indent(True)
view.modify_font(pango.FontDescription("Monospace " +
str(style.FONT_SIZE)))
...

</pre>

Para agregar texto al buffer:
<pre>
buffer.set_text(text)
</pre>
Para obtener todo el texto:
<pre>
text = buffer.get_text(buffer.get_start_iter(), buffer.get_end_iter())
</pre>

Probablemente quieras poner la view(vista) en un gtk.ScrolledWindow
<pre>
sw = gtk.ScrolledWindow()
sw.add(view)
sw.set_policy(gtk.POLICY_AUTOMATIC, gtk.POLICY_AUTOMATIC)
</pre>
y agregar el el objeto sw en vez de la view(vista).

Puedes encotnrar más en el código fuete de Pippyy en jarabe.view.sourceview.

== Audio y Video ==
* [[Development Team/Almanac/GStreamer|GStreamer]]

== Ratón ==
=== ¿Cómo puedo cambiar el cursor del ratón por el cursor de espera en mi actividad? ===
En la subclase de tu actividad:

<pre>
self.window.set_cursor( gtk.gdk.Cursor(gtk.gdk.WATCH) )
</pre>

y para volver al que está por defecto:

<pre>
self.window.set_cursor( None );
</pre>

=== ¿Cómo puedo rastrear la posición del ratón? ===
Existen varias razones por las que te puede interesar controlar la posición del ratón, que van desde el entretenimiento ([[http://en.wikipedia.org/wiki/Xeyes]]) a lo funcional (ocultar ciertas ventanas cuando el ratón no se ha movido por un par de segundos y volver a hacer aparecer esos elementos cuando este se mueva nuevamente). Esta es una manera en la cual se puede implementar esta funcionalidad:
<pre>

...
self.hideWidgetsTime = time.time()
self.mx = -1
self.my = -1
self.HIDE_WIDGET_TIMEOUT_ID = gobject.timeout_add( 500, self.mouseMightHaveMovedCb )

def _mouseMightHaveMovedCb( self ):
x, y = self.get_pointer()
passedTime = 0

if (x != self.mx or y != self.my):
self.hideWidgetsTime = time.time()
if (self.hiddenWidgets):
self.showWidgets()
self.hiddenWidgets = False
else:
passedTime = time.time() - self.hideWidgetsTime

if (passedTime >= 3):
if (not self.hiddenWidgets):
self.hideWidgets()
self.hiddenWidgets = True

self.mx = x
self.my = y
return True

</pre>

== Varios ==

Las tareas que aparecen más abajo son técnicas útiles que he encontrado mientras escribía código y documentación para esta referencia. No ha sido categorizadas aún.

=== ¿Cómo se si mi actividad está "activa" o no? ===

Puedes configurar un evento usando la constante VISIBILITY_NOTIFY_MASK para saber cuando se cambia la visibilidad. Luego en el callback para este evento lo que debes hacer es comprar el estado del evento con las variables gtk definidas para la visibilidad de tu actividad. Puedes ver [http://www.pygtk.org/docs/pygtk/gdk-constants.html#gdk-visibility-state-constants la sección de Constantes de Estado de Visibilidad de GDK] gtk.gdk.Constants para más información.

<pre>
# Notify when the visibility state changes by calling self.__visibility_notify_cb
# (PUT THIS IN YOUR ACTIVITY CODE - EG. THE __init__() METHOD)
self.add_events(gtk.gdk.VISIBILITY_NOTIFY_MASK)
self.connect("visibility-notify-event", self.__visibility_notify_cb)
...
# Callback method for when the activity's visibility changes
def __visibility_notify_cb(self, window, event):
if event.state == gtk.gdk.VISIBILITY_FULLY_OBSCURED:
print "I am not visible"
elif event.state in [gtk.gdk.VISIBILITY_UNOBSCURED, gtk.gdk.VISIBILITY_PARTIAL]:
print "I am visible"
</pre>

=== ¿Cómo puedo obtener la cantidad de espacio libre disponible dentro del directorio /home? ===
La siguiente función usa el módulo [http://docs.python.org/lib/module-statvfs.html statvfs]. El código siguiente muestra cómo obtener la cantidad total de espacio libre en /home.

<pre>
#### Método getFreespaceKb: devuelve el espacio disponible en kilobytes.
def getFreespaceKb(self):
stat = os.statvfs("/home")
freebytes = stat[statvfs.F_BSIZE] * stat[statvfs.F_BAVAIL]
freekb = freebytes / 1024
return freekb
</pre>

Ten en cuenta que asumir cosas acerca de "/home" no es una buena idea, es mejor usar os.environ['HOME']. Rainbow pondrá los archivos actuales en otros lugares, algunos en el ramdisk, otros en la flash.
Ten claro que espacio libre en el sistema de archivos realmente te importa.

=== How do I know whether my activity is running on a physical XO? ===
Sugar runs on ordinary computers as well as on XO's. While your activity is typically going to be run on a real XO, some people will indeed run it elsewhere. Normally you shouldn't write your activity to care whether it's on an XO or not. If for some odd reason, you need to care, the easiest way to tell if you are on a physical XO is to check whether /sys/power/olpc-pm, an essential power management file for the XO, exists. <ref>[http://lists.laptop.org/pipermail/devel/2008-June/015923.html reliably detecting if running on an XO]</ref> <ref>OLPC [[olpc:Power Management Interface]]</ref>

<pre>
import os
...
#Print out a boolean value that tells us whether we are on an XO or not.
print os.path.exists('/sys/power/olpc-pm')
</pre>

=== How do I know the current language setting on my XO? ===
The system variable 'LANG' tells you which language is currently active on the XO. The following code shows how to look at the value of this variable.

<pre>
import os
...
_logger.debug(os.environ['LANG'])
</pre>

=== How do I repeatedly call a specific method after N number of seconds? ===
The gobject.timeout_add() function allows you to invoke a callback method after a certain amount of time. If you want to repeatedly call a method, simply keep invoking the gobject.timeout_add function in your callback itself. The code below is a simple example, where the callback function is named repeatedly_call. Note that the timing of the callbacks are approximate. To get the process going, you should make an initial call to repeatedly_call() somewhere in your code.

You can see a more substantive example of this pattern in use when we [[olpc:Pango#How_do_I_dynamically_set_the_text_in_a_pango_layout.3F | regularly update the time displayed on a pango layout object]].

<pre>

#This method calls itself ROUGHLY every 1 second
def repeatedly_call(self):
now = datetime.datetime.now()
gobject.timeout_add(self.repeat_period_msec, self.repeatedly_update_time)
</pre>

=== How do I update the current build version of code that is running on my XO? ===

There are several pages that give you instructions on how to install/update your current build.

* If you already have a working build installed and an internet connection, first try [[olpc:olpc-update]].
* If that doesn't work, you can look at instructions for an [[olpc:Activated upgrade]] that can be done via USB] boot.

As the instructions on the pages linked above note, make sure to install your activities separately after you have upgraded to a specific base build.

=== I am developing on an XO laptop, but my keyboard and language settings are not ideal. How can I change them? ===

Internationalized laptops will often have settings that might slow you down while developing. To change around the language settings so you can better understand environment messages, use the [[olpc:Sugar Control Panel]]

Keyboard settings on internationalized laptops<ref>[[olpc:Keyboard layouts#OLPC keyboard layouts]]</ref> can also be suboptimal, especially as characters like "-" and "/" are in unfamiliar positions. You can use the <tt>setxkbmap</tt> command in the [[olpc:Terminal Activity]] to reset the type of keyboard input used and then attach a standard U.S. keyboard that will allow you to type normally. The command below sets the keyboard to the US mapping (it will reset to the default internationalized mapping upon restart).

setxkbmap us

=== My Python activity wants to use threads; how do I do that? ===

A question that has been answered with limited success is which threading patterns are most appropriate for use in Sugar. The following pattern of code to work fine in basic instances:

<pre>
#### Method: __init__, initialize this AnnotateActivity instance
def __init__(self, handle):
...
self.sample_thread = Thread(target=self.announce_thread, args=())
self.sample_thread.setDaemon(0)
self.sample_thread.start()
...

def announce_thread(self):
while (self.Running):
time.sleep(1)
print "thread running"
self._update_chat_text("Thread", "In here")
</pre>

This is the basic series of steps that most online documentation on python suggests to use when trying to work with threads in python. The problem is that it is unclear how this pattern relates to code that worked in the SimCity activity:

<pre>
import gobject
gobject.threads_init()
#import dbus.mainloop.glib
#dbus.mainloop.glib.threads_init()
</pre>

It should be noted that in the SimCity activity the pygame sound player would not produce sound reliably unless this setup was done.



Should the two patterns always be used in tandem? It seems that the latter code is mainly to initiate gobject and other libraries to work with threading, but it is unclear what restrictions there are with using threading with these libraries. Does one take precedence over the other? It is not clear if there is any problem with using the standard python threading code on the sugar technology stack.





In fact, experiments with threading on sugar leads to several different problems. For one thing, thread termination was tricky - using the can_close() method for sugar activities to terminate an activity only killed threads in some circumstances. It did not properly handle terminating threads in the case of CTRL-C or terminal interrupts. You can try to catch signals (SIGINT, SIGTERM or SIGHUP), but you will still be running in to errors in terminating child threads using these as well.





Another set of errors with threading comes up when trying to combine with stream tubes. The bottom line is that it is unclear what the scope of threading in a Sugar activity should be - should it simply work if you do the standard python threading pattern, is the use of the glib.threads_init and gobject.threads_init calls necessary, are there other interactions with threads and dbus that need to be accounted for? With more clarity from sugar developers on how the platform envisions threading to work in an activity, we can be more comfortable writing entries in the Almanac to help developers write error-free code.



=== How do I customize the title that is displayed for each instance of my activity? ===

By default, activity titles are just the generic activity names that you specify in your activity.info file. In some applications, you may want the activity title to be more dynamic.

For example, it makes sense to set the title for different browser sessions to the active web page being visited. That way, when you look back in the journal at the different browser sessions you have run in the previous few days, you can identify unique sessions based on the website you happened to be visiting at the time.

The code below shows how you can set the metadata for your activity to reflect a dynamic title based on whatever session criteria you feel is important. This example is adapted from the Browse activity, which sets activity instance titles based on the title of the current web page being visited.

<pre>
if self.metadata['mime_type'] == 'text/plain':
if not self._jobject.metadata['title_set_by_user'] == '1':
if self._browser.props.title:
# Set the title of this activity to be the current
# title of the page being visited by the browser.
self.metadata['title'] = self._browser.props.title
</pre>

=== What packages are available on sugar to support game development? ===

If your activity will require tools that are typically needed to develop robust and clean video games, then you should utilize the [http://www.pygame.org/ pygame package]. It can be readily imported into any activity:

<pre>
import pygame
...
</pre>

=== How do I detect when one of the game buttons on the laptop have been pressed? ===

The laptop game buttons (the circle, square, x, and check buttons next to the LCD) are encoded as page up, home, page down and end respectively. So, you can detect their press by listening for these specific events. For example, the code below listens for button presses and then just writes to an output widget which button was pressed.

<pre>
...
#### Initialize this activity.
def __init__(self, handle):
...
self.connect('key-press-event', self._keyPressCb)
...

#### Method _keyPressCb, which catches any presses of the game buttons.
def _keyPressCb(self, widget, event):

keyname = gtk.gdk.keyval_name(event.keyval)

if (keyname == 'KP_Page_Up'):
self._chat += "\nCircle Pressed!"
self._chat_buffer.set_text(self._chat)
elif (keyname == 'KP_Page_Down'):
self._chat += "\nX Pressed!"
self._chat_buffer.set_text(self._chat)
elif (keyname == 'KP_Home'):
self._chat += "\nSquare Pressed!"
self._chat_buffer.set_text(self._chat)
elif (keyname == 'KP_End'):
self._chat += "\nCheck Pressed!"
self._chat_buffer.set_text(self._chat)

return False
</pre>

=== How do I detect if one of the joystick buttons has been pressed? ===

This is the same process as detecting game buttons, except with different names for the keys. Again, you listen for "key-press-event" signals and then in your callback you check to see if the pressed button was one of the joystick keys.

<pre>
#### Initialize this activity.
def __init__(self, handle):
...
self.connect('key-press-event', self._keyPressCb)
...

#### Method _keyPressCb, which catches any presses of the game buttons.
def _keyPressCb(self, widget, event):

keyname = gtk.gdk.keyval_name(event.keyval)

if (keyname == 'KP_Up'):
self._chat += "\nUp Pressed!"
self._chat_buffer.set_text(self._chat)
elif (keyname == 'KP_Down'):
self._chat += "\nDown Pressed!"
self._chat_buffer.set_text(self._chat)
elif (keyname == 'KP_Left'):
self._chat += "\nLeft Pressed!"
self._chat_buffer.set_text(self._chat)
elif (keyname == 'KP_Right'):
self._chat += "\nRight Pressed!"
self._chat_buffer.set_text(self._chat)

return False
</pre>

=== How do i remove an specific button from the toolbar? ===

This is an example of the share button is removed:

<pre>
activity_toolbar = toolbox.get_activity_toolbar()
activity_toolbar.remove(activity_toolbar.share)
activity_toolbar.share = None
</pre>

== Notes ==
<references />

[[Category:Documentation]]
[[Category:Development Team]]

Development Team/Almanac/lang-es

2009-08-31T16:38:18Z

Fede: /* ¿Cómo puedo obtener la cantidad de espacio libre disponible dentro del directorio /home? */

{{translation
| source = Development_Team/Almanac
| lang = es
| status = {{translation/incomplete/}}
}}

{{Almanac}}
{{Almanac TOC}}
== ¿Cómo puedo obtener ayuda adicional más allá de este almanaque? ==
* ¿Quieres comenzar con los básico del desarrollo para Sugar? Puedes visitar el [http://wiki.sugarlabs.org/images/5/51/Activity_Handbook_200805_online.pdf Activity Handbook] de OLPC Austria (''Ten en cuenta que este manual fue actualizado por última vez en mayo del 2008, las capturas de tienen el diseño pre-8.2. En términos de código en sí, las cosas deberían funcionar como están descriptas. Si encuentra algún problema por favor póngase en contacto con [[User:ChristophD|ChristophD]].'')
* Ver también [[Development Team/Almanac/Code Snippets]]

Ahora, vamos con el almanaque actual...

== ¿Dónde puedo ver los cambios de la API? ==
API changes between OLPC releases can be seen here: [[Development Team/Almanac/API Changes|API Changes]]

== Comenzando ==
=== ¿Cómo estructuro mis archivos para que sean una actividad de válido en Sugar? ===
Puedes encontrar información sobre la estructura de la actividad aquí: [[Development Team/Almanac/Activity Bundles|Activity Bundles]]

=== ¿Cómo puedo hacer un icono para mi actividad? ===
La información sobre lo que debe hacer se puede encontrar aquí: [[Development Team/Almanac/Making Icons|Making Icons]]

== Paquete: sugar ==
* [[Development Team/Almanac/sugar.env|sugar.env]]
* [[Development Team/Almanac/sugar.profile|sugar.profile]]
* [[Development Team/Almanac/sugar.mime|sugar.mime]]
* [[Development Team/Almanac/sugar.logger|sugar.logger]]

== Paquete: sugar.activity ==
* [[Development Team/Almanac/sugar.activity.activity|sugar.activity.activity]]
* [[Development Team/Almanac/sugar.activity.activityfactory|sugar.activity.activityfactory]]
* [[Development Team/Almanac/sugar.activity.registry|sugar.activity.registry]]

== Paquete: sugar.datastore ==
* [[Development Team/Almanac/sugar.datastore.datastore|sugar.datastore.datastore]]

== Paquete: sugar.graphics ==
* [[Development Team/Almanac/sugar.graphics.alert|sugar.graphics.alert]]
* [[Development Team/Almanac/sugar.graphics.icon|sugar.graphics.icon]]
* [[Development Team/Almanac/sugar.graphics.notebook|sugar.graphics.notebook]]
* [[Development Team/Almanac/sugar.graphics.toolbutton|sugar.graphics.toolbutton]]
* [[Development Team/Almanac/sugar.graphics.toolbox|sugar.graphics.toolbox]]
* [[Development Team/Almanac/sugar.graphics.style|sugar.graphics.style]]

== Paquete: sugar.presence ==
* [[Development Team/Almanac/Sugar.presence|Sugar.presence]]
* [[Development Team/Almanac/Sugar.presence.activity|Sugar.presence.activity]]
* [[Development Team/Almanac/Sugar.presence.buddy|Sugar.presence.buddy]]
* [[Development Team/Almanac/Sugar.presence.presenceservice|Sugar.presence.presenceservice]]

== Clipboard ==
* Notas sobre el uso del [[Development Team/Almanac/GTK's Clipboard Module|módulo Clipboard de GTK ]]

== Logging ==
* [[Development Team/Almanac/sugar.logger|sugar.logger]]
* Notas sobre el uso del [[Development Team/Almanac/Python Standard Logging|standard de Logging en Python]]

== Internacionalización ==
*[[Development Team/Almanac/Internationalization|Internationalization]]

== Texto y gráficos para las actividades de Sugar ==
* [[Development Team/Almanac/Pango|Pango]]
=== ¿Cómo puedo crear un cuadro de texto para la edición de código? ===
Puedes usar gtksourceview2
<pre>
import gtk
import gtksourceview2
from sugar.graphics import style

...

# Configuramos el buffer
buffer = gtksourceview2.Buffer()
if hasattr(buffer, 'set_highlight'): # handle different API versions
buffer.set_highlight(True)
else:
buffer.set_highlight_syntax(True)

# Configuramos el tipo MIME para el buffer
lang_manager = gtksourceview2.language_manager_get_default()
if hasattr(lang_manager, 'list_languages'): # again, handle different APIs
langs = lang_manager.list_languages()
else:
lang_ids = lang_manager.get_language_ids()
langs = [lang_manager.get_language(lang_id)
for lang_id in lang_ids]
for lang in langs:
for m in lang.get_mime_types():
if m == mime_type: # <-- this is the mime type you want
buffer.set_language(lang)

# Establecemos el objeto para la vista, usarlo como gtk.TextView
view = gtksourceview2.View(buffer)
view.set_size_request(300, 450)
view.set_editable(True)
view.set_cursor_visible(True)
view.set_show_line_numbers(True)
view.set_wrap_mode(gtk.WRAP_CHAR)
view.set_right_margin_position(80)
#view.set_highlight_current_line(True) #FIXME: Ugly color
view.set_auto_indent(True)
view.modify_font(pango.FontDescription("Monospace " +
str(style.FONT_SIZE)))
...

</pre>

Para agregar texto al buffer:
<pre>
buffer.set_text(text)
</pre>
Para obtener todo el texto:
<pre>
text = buffer.get_text(buffer.get_start_iter(), buffer.get_end_iter())
</pre>

Probablemente quieras poner la view(vista) en un gtk.ScrolledWindow
<pre>
sw = gtk.ScrolledWindow()
sw.add(view)
sw.set_policy(gtk.POLICY_AUTOMATIC, gtk.POLICY_AUTOMATIC)
</pre>
y agregar el el objeto sw en vez de la view(vista).

Puedes encotnrar más en el código fuete de Pippyy en jarabe.view.sourceview.

== Audio y Video ==
* [[Development Team/Almanac/GStreamer|GStreamer]]

== Ratón ==
=== ¿Cómo puedo cambiar el cursor del ratón por el cursor de espera en mi actividad? ===
En la subclase de tu actividad:

<pre>
self.window.set_cursor( gtk.gdk.Cursor(gtk.gdk.WATCH) )
</pre>

y para volver al que está por defecto:

<pre>
self.window.set_cursor( None );
</pre>

=== ¿Cómo puedo rastrear la posición del ratón? ===
Existen varias razones por las que te puede interesar controlar la posición del ratón, que van desde el entretenimiento ([[http://en.wikipedia.org/wiki/Xeyes]]) a lo funcional (ocultar ciertas ventanas cuando el ratón no se ha movido por un par de segundos y volver a hacer aparecer esos elementos cuando este se mueva nuevamente). Esta es una manera en la cual se puede implementar esta funcionalidad:
<pre>

...
self.hideWidgetsTime = time.time()
self.mx = -1
self.my = -1
self.HIDE_WIDGET_TIMEOUT_ID = gobject.timeout_add( 500, self.mouseMightHaveMovedCb )

def _mouseMightHaveMovedCb( self ):
x, y = self.get_pointer()
passedTime = 0

if (x != self.mx or y != self.my):
self.hideWidgetsTime = time.time()
if (self.hiddenWidgets):
self.showWidgets()
self.hiddenWidgets = False
else:
passedTime = time.time() - self.hideWidgetsTime

if (passedTime >= 3):
if (not self.hiddenWidgets):
self.hideWidgets()
self.hiddenWidgets = True

self.mx = x
self.my = y
return True

</pre>

== Varios ==

Las tareas que aparecen más abajo son técnicas útiles que he encontrado mientras escribía código y documentación para esta referencia. No ha sido categorizadas aún.

=== ¿Cómo se si mi actividad está "activa" o no? ===

Puedes configurar un evento usando la constante VISIBILITY_NOTIFY_MASK para saber cuando se cambia la visibilidad. Luego en el callback para este evento lo que debes hacer es comprar el estado del evento con las variables gtk definidas para la visibilidad de tu actividad. Puedes ver [http://www.pygtk.org/docs/pygtk/gdk-constants.html#gdk-visibility-state-constants la sección de Constantes de Estado de Visibilidad de GDK] gtk.gdk.Constants para más información.

<pre>
# Notify when the visibility state changes by calling self.__visibility_notify_cb
# (PUT THIS IN YOUR ACTIVITY CODE - EG. THE __init__() METHOD)
self.add_events(gtk.gdk.VISIBILITY_NOTIFY_MASK)
self.connect("visibility-notify-event", self.__visibility_notify_cb)
...
# Callback method for when the activity's visibility changes
def __visibility_notify_cb(self, window, event):
if event.state == gtk.gdk.VISIBILITY_FULLY_OBSCURED:
print "I am not visible"
elif event.state in [gtk.gdk.VISIBILITY_UNOBSCURED, gtk.gdk.VISIBILITY_PARTIAL]:
print "I am visible"
</pre>

=== ¿Cómo puedo obtener la cantidad de espacio libre disponible dentro del directorio /home? ===
La siguiente función usa el módulo [http://docs.python.org/lib/module-statvfs.html statvfs]. El código siguiente muestra cómo obtener la cantidad total de espacio libre en /home.

<pre>
#### Método getFreespaceKb: devuelve el espacio disponible en kilobytes.
def getFreespaceKb(self):
stat = os.statvfs("/home")
freebytes = stat[statvfs.F_BSIZE] * stat[statvfs.F_BAVAIL]
freekb = freebytes / 1024
return freekb
</pre>

Ten en cuenta que asumir cosas acerca de "/home" no es una buena idea, es mejor usar os.environ['HOME']. Rainbow pondrá los archivos actuales en otros lugares, algunos en el ramdisk, otros en la flash.

Note, however, that assuming anything about "/home" is a bad idea, better use os.environ['HOME'] instead. Rainbow will put your actual files elsewhere,
some on ramdisks, some on flash.
Ten claro que espacio libre en el sistema de archivos realmente te importa.

=== How do I know whether my activity is running on a physical XO? ===
Sugar runs on ordinary computers as well as on XO's. While your activity is typically going to be run on a real XO, some people will indeed run it elsewhere. Normally you shouldn't write your activity to care whether it's on an XO or not. If for some odd reason, you need to care, the easiest way to tell if you are on a physical XO is to check whether /sys/power/olpc-pm, an essential power management file for the XO, exists. <ref>[http://lists.laptop.org/pipermail/devel/2008-June/015923.html reliably detecting if running on an XO]</ref> <ref>OLPC [[olpc:Power Management Interface]]</ref>

<pre>
import os
...
#Print out a boolean value that tells us whether we are on an XO or not.
print os.path.exists('/sys/power/olpc-pm')
</pre>

=== How do I know the current language setting on my XO? ===
The system variable 'LANG' tells you which language is currently active on the XO. The following code shows how to look at the value of this variable.

<pre>
import os
...
_logger.debug(os.environ['LANG'])
</pre>

=== How do I repeatedly call a specific method after N number of seconds? ===
The gobject.timeout_add() function allows you to invoke a callback method after a certain amount of time. If you want to repeatedly call a method, simply keep invoking the gobject.timeout_add function in your callback itself. The code below is a simple example, where the callback function is named repeatedly_call. Note that the timing of the callbacks are approximate. To get the process going, you should make an initial call to repeatedly_call() somewhere in your code.

You can see a more substantive example of this pattern in use when we [[olpc:Pango#How_do_I_dynamically_set_the_text_in_a_pango_layout.3F | regularly update the time displayed on a pango layout object]].

<pre>

#This method calls itself ROUGHLY every 1 second
def repeatedly_call(self):
now = datetime.datetime.now()
gobject.timeout_add(self.repeat_period_msec, self.repeatedly_update_time)
</pre>

=== How do I update the current build version of code that is running on my XO? ===

There are several pages that give you instructions on how to install/update your current build.

* If you already have a working build installed and an internet connection, first try [[olpc:olpc-update]].
* If that doesn't work, you can look at instructions for an [[olpc:Activated upgrade]] that can be done via USB] boot.

As the instructions on the pages linked above note, make sure to install your activities separately after you have upgraded to a specific base build.

=== I am developing on an XO laptop, but my keyboard and language settings are not ideal. How can I change them? ===

Internationalized laptops will often have settings that might slow you down while developing. To change around the language settings so you can better understand environment messages, use the [[olpc:Sugar Control Panel]]

Keyboard settings on internationalized laptops<ref>[[olpc:Keyboard layouts#OLPC keyboard layouts]]</ref> can also be suboptimal, especially as characters like "-" and "/" are in unfamiliar positions. You can use the <tt>setxkbmap</tt> command in the [[olpc:Terminal Activity]] to reset the type of keyboard input used and then attach a standard U.S. keyboard that will allow you to type normally. The command below sets the keyboard to the US mapping (it will reset to the default internationalized mapping upon restart).

setxkbmap us

=== My Python activity wants to use threads; how do I do that? ===

A question that has been answered with limited success is which threading patterns are most appropriate for use in Sugar. The following pattern of code to work fine in basic instances:

<pre>
#### Method: __init__, initialize this AnnotateActivity instance
def __init__(self, handle):
...
self.sample_thread = Thread(target=self.announce_thread, args=())
self.sample_thread.setDaemon(0)
self.sample_thread.start()
...

def announce_thread(self):
while (self.Running):
time.sleep(1)
print "thread running"
self._update_chat_text("Thread", "In here")
</pre>

This is the basic series of steps that most online documentation on python suggests to use when trying to work with threads in python. The problem is that it is unclear how this pattern relates to code that worked in the SimCity activity:

<pre>
import gobject
gobject.threads_init()
#import dbus.mainloop.glib
#dbus.mainloop.glib.threads_init()
</pre>

It should be noted that in the SimCity activity the pygame sound player would not produce sound reliably unless this setup was done.



Should the two patterns always be used in tandem? It seems that the latter code is mainly to initiate gobject and other libraries to work with threading, but it is unclear what restrictions there are with using threading with these libraries. Does one take precedence over the other? It is not clear if there is any problem with using the standard python threading code on the sugar technology stack.





In fact, experiments with threading on sugar leads to several different problems. For one thing, thread termination was tricky - using the can_close() method for sugar activities to terminate an activity only killed threads in some circumstances. It did not properly handle terminating threads in the case of CTRL-C or terminal interrupts. You can try to catch signals (SIGINT, SIGTERM or SIGHUP), but you will still be running in to errors in terminating child threads using these as well.





Another set of errors with threading comes up when trying to combine with stream tubes. The bottom line is that it is unclear what the scope of threading in a Sugar activity should be - should it simply work if you do the standard python threading pattern, is the use of the glib.threads_init and gobject.threads_init calls necessary, are there other interactions with threads and dbus that need to be accounted for? With more clarity from sugar developers on how the platform envisions threading to work in an activity, we can be more comfortable writing entries in the Almanac to help developers write error-free code.



=== How do I customize the title that is displayed for each instance of my activity? ===

By default, activity titles are just the generic activity names that you specify in your activity.info file. In some applications, you may want the activity title to be more dynamic.

For example, it makes sense to set the title for different browser sessions to the active web page being visited. That way, when you look back in the journal at the different browser sessions you have run in the previous few days, you can identify unique sessions based on the website you happened to be visiting at the time.

The code below shows how you can set the metadata for your activity to reflect a dynamic title based on whatever session criteria you feel is important. This example is adapted from the Browse activity, which sets activity instance titles based on the title of the current web page being visited.

<pre>
if self.metadata['mime_type'] == 'text/plain':
if not self._jobject.metadata['title_set_by_user'] == '1':
if self._browser.props.title:
# Set the title of this activity to be the current
# title of the page being visited by the browser.
self.metadata['title'] = self._browser.props.title
</pre>

=== What packages are available on sugar to support game development? ===

If your activity will require tools that are typically needed to develop robust and clean video games, then you should utilize the [http://www.pygame.org/ pygame package]. It can be readily imported into any activity:

<pre>
import pygame
...
</pre>

=== How do I detect when one of the game buttons on the laptop have been pressed? ===

The laptop game buttons (the circle, square, x, and check buttons next to the LCD) are encoded as page up, home, page down and end respectively. So, you can detect their press by listening for these specific events. For example, the code below listens for button presses and then just writes to an output widget which button was pressed.

<pre>
...
#### Initialize this activity.
def __init__(self, handle):
...
self.connect('key-press-event', self._keyPressCb)
...

#### Method _keyPressCb, which catches any presses of the game buttons.
def _keyPressCb(self, widget, event):

keyname = gtk.gdk.keyval_name(event.keyval)

if (keyname == 'KP_Page_Up'):
self._chat += "\nCircle Pressed!"
self._chat_buffer.set_text(self._chat)
elif (keyname == 'KP_Page_Down'):
self._chat += "\nX Pressed!"
self._chat_buffer.set_text(self._chat)
elif (keyname == 'KP_Home'):
self._chat += "\nSquare Pressed!"
self._chat_buffer.set_text(self._chat)
elif (keyname == 'KP_End'):
self._chat += "\nCheck Pressed!"
self._chat_buffer.set_text(self._chat)

return False
</pre>

=== How do I detect if one of the joystick buttons has been pressed? ===

This is the same process as detecting game buttons, except with different names for the keys. Again, you listen for "key-press-event" signals and then in your callback you check to see if the pressed button was one of the joystick keys.

<pre>
#### Initialize this activity.
def __init__(self, handle):
...
self.connect('key-press-event', self._keyPressCb)
...

#### Method _keyPressCb, which catches any presses of the game buttons.
def _keyPressCb(self, widget, event):

keyname = gtk.gdk.keyval_name(event.keyval)

if (keyname == 'KP_Up'):
self._chat += "\nUp Pressed!"
self._chat_buffer.set_text(self._chat)
elif (keyname == 'KP_Down'):
self._chat += "\nDown Pressed!"
self._chat_buffer.set_text(self._chat)
elif (keyname == 'KP_Left'):
self._chat += "\nLeft Pressed!"
self._chat_buffer.set_text(self._chat)
elif (keyname == 'KP_Right'):
self._chat += "\nRight Pressed!"
self._chat_buffer.set_text(self._chat)

return False
</pre>

=== How do i remove an specific button from the toolbar? ===

This is an example of the share button is removed:

<pre>
activity_toolbar = toolbox.get_activity_toolbar()
activity_toolbar.remove(activity_toolbar.share)
activity_toolbar.share = None
</pre>

== Notes ==
<references />

[[Category:Documentation]]
[[Category:Development Team]]

Development Team/Almanac/lang-es

2009-08-31T16:38:00Z

Fede: /* ¿Cómo puedo obtener la cantidad de espacio libre disponible dentro del directorio /home? */

{{translation
| source = Development_Team/Almanac
| lang = es
| status = {{translation/incomplete/}}
}}

{{Almanac}}
{{Almanac TOC}}
== ¿Cómo puedo obtener ayuda adicional más allá de este almanaque? ==
* ¿Quieres comenzar con los básico del desarrollo para Sugar? Puedes visitar el [http://wiki.sugarlabs.org/images/5/51/Activity_Handbook_200805_online.pdf Activity Handbook] de OLPC Austria (''Ten en cuenta que este manual fue actualizado por última vez en mayo del 2008, las capturas de tienen el diseño pre-8.2. En términos de código en sí, las cosas deberían funcionar como están descriptas. Si encuentra algún problema por favor póngase en contacto con [[User:ChristophD|ChristophD]].'')
* Ver también [[Development Team/Almanac/Code Snippets]]

Ahora, vamos con el almanaque actual...

== ¿Dónde puedo ver los cambios de la API? ==
API changes between OLPC releases can be seen here: [[Development Team/Almanac/API Changes|API Changes]]

== Comenzando ==
=== ¿Cómo estructuro mis archivos para que sean una actividad de válido en Sugar? ===
Puedes encontrar información sobre la estructura de la actividad aquí: [[Development Team/Almanac/Activity Bundles|Activity Bundles]]

=== ¿Cómo puedo hacer un icono para mi actividad? ===
La información sobre lo que debe hacer se puede encontrar aquí: [[Development Team/Almanac/Making Icons|Making Icons]]

== Paquete: sugar ==
* [[Development Team/Almanac/sugar.env|sugar.env]]
* [[Development Team/Almanac/sugar.profile|sugar.profile]]
* [[Development Team/Almanac/sugar.mime|sugar.mime]]
* [[Development Team/Almanac/sugar.logger|sugar.logger]]

== Paquete: sugar.activity ==
* [[Development Team/Almanac/sugar.activity.activity|sugar.activity.activity]]
* [[Development Team/Almanac/sugar.activity.activityfactory|sugar.activity.activityfactory]]
* [[Development Team/Almanac/sugar.activity.registry|sugar.activity.registry]]

== Paquete: sugar.datastore ==
* [[Development Team/Almanac/sugar.datastore.datastore|sugar.datastore.datastore]]

== Paquete: sugar.graphics ==
* [[Development Team/Almanac/sugar.graphics.alert|sugar.graphics.alert]]
* [[Development Team/Almanac/sugar.graphics.icon|sugar.graphics.icon]]
* [[Development Team/Almanac/sugar.graphics.notebook|sugar.graphics.notebook]]
* [[Development Team/Almanac/sugar.graphics.toolbutton|sugar.graphics.toolbutton]]
* [[Development Team/Almanac/sugar.graphics.toolbox|sugar.graphics.toolbox]]
* [[Development Team/Almanac/sugar.graphics.style|sugar.graphics.style]]

== Paquete: sugar.presence ==
* [[Development Team/Almanac/Sugar.presence|Sugar.presence]]
* [[Development Team/Almanac/Sugar.presence.activity|Sugar.presence.activity]]
* [[Development Team/Almanac/Sugar.presence.buddy|Sugar.presence.buddy]]
* [[Development Team/Almanac/Sugar.presence.presenceservice|Sugar.presence.presenceservice]]

== Clipboard ==
* Notas sobre el uso del [[Development Team/Almanac/GTK's Clipboard Module|módulo Clipboard de GTK ]]

== Logging ==
* [[Development Team/Almanac/sugar.logger|sugar.logger]]
* Notas sobre el uso del [[Development Team/Almanac/Python Standard Logging|standard de Logging en Python]]

== Internacionalización ==
*[[Development Team/Almanac/Internationalization|Internationalization]]

== Texto y gráficos para las actividades de Sugar ==
* [[Development Team/Almanac/Pango|Pango]]
=== ¿Cómo puedo crear un cuadro de texto para la edición de código? ===
Puedes usar gtksourceview2
<pre>
import gtk
import gtksourceview2
from sugar.graphics import style

...

# Configuramos el buffer
buffer = gtksourceview2.Buffer()
if hasattr(buffer, 'set_highlight'): # handle different API versions
buffer.set_highlight(True)
else:
buffer.set_highlight_syntax(True)

# Configuramos el tipo MIME para el buffer
lang_manager = gtksourceview2.language_manager_get_default()
if hasattr(lang_manager, 'list_languages'): # again, handle different APIs
langs = lang_manager.list_languages()
else:
lang_ids = lang_manager.get_language_ids()
langs = [lang_manager.get_language(lang_id)
for lang_id in lang_ids]
for lang in langs:
for m in lang.get_mime_types():
if m == mime_type: # <-- this is the mime type you want
buffer.set_language(lang)

# Establecemos el objeto para la vista, usarlo como gtk.TextView
view = gtksourceview2.View(buffer)
view.set_size_request(300, 450)
view.set_editable(True)
view.set_cursor_visible(True)
view.set_show_line_numbers(True)
view.set_wrap_mode(gtk.WRAP_CHAR)
view.set_right_margin_position(80)
#view.set_highlight_current_line(True) #FIXME: Ugly color
view.set_auto_indent(True)
view.modify_font(pango.FontDescription("Monospace " +
str(style.FONT_SIZE)))
...

</pre>

Para agregar texto al buffer:
<pre>
buffer.set_text(text)
</pre>
Para obtener todo el texto:
<pre>
text = buffer.get_text(buffer.get_start_iter(), buffer.get_end_iter())
</pre>

Probablemente quieras poner la view(vista) en un gtk.ScrolledWindow
<pre>
sw = gtk.ScrolledWindow()
sw.add(view)
sw.set_policy(gtk.POLICY_AUTOMATIC, gtk.POLICY_AUTOMATIC)
</pre>
y agregar el el objeto sw en vez de la view(vista).

Puedes encotnrar más en el código fuete de Pippyy en jarabe.view.sourceview.

== Audio y Video ==
* [[Development Team/Almanac/GStreamer|GStreamer]]

== Ratón ==
=== ¿Cómo puedo cambiar el cursor del ratón por el cursor de espera en mi actividad? ===
En la subclase de tu actividad:

<pre>
self.window.set_cursor( gtk.gdk.Cursor(gtk.gdk.WATCH) )
</pre>

y para volver al que está por defecto:

<pre>
self.window.set_cursor( None );
</pre>

=== ¿Cómo puedo rastrear la posición del ratón? ===
Existen varias razones por las que te puede interesar controlar la posición del ratón, que van desde el entretenimiento ([[http://en.wikipedia.org/wiki/Xeyes]]) a lo funcional (ocultar ciertas ventanas cuando el ratón no se ha movido por un par de segundos y volver a hacer aparecer esos elementos cuando este se mueva nuevamente). Esta es una manera en la cual se puede implementar esta funcionalidad:
<pre>

...
self.hideWidgetsTime = time.time()
self.mx = -1
self.my = -1
self.HIDE_WIDGET_TIMEOUT_ID = gobject.timeout_add( 500, self.mouseMightHaveMovedCb )

def _mouseMightHaveMovedCb( self ):
x, y = self.get_pointer()
passedTime = 0

if (x != self.mx or y != self.my):
self.hideWidgetsTime = time.time()
if (self.hiddenWidgets):
self.showWidgets()
self.hiddenWidgets = False
else:
passedTime = time.time() - self.hideWidgetsTime

if (passedTime >= 3):
if (not self.hiddenWidgets):
self.hideWidgets()
self.hiddenWidgets = True

self.mx = x
self.my = y
return True

</pre>

== Varios ==

Las tareas que aparecen más abajo son técnicas útiles que he encontrado mientras escribía código y documentación para esta referencia. No ha sido categorizadas aún.

=== ¿Cómo se si mi actividad está "activa" o no? ===

Puedes configurar un evento usando la constante VISIBILITY_NOTIFY_MASK para saber cuando se cambia la visibilidad. Luego en el callback para este evento lo que debes hacer es comprar el estado del evento con las variables gtk definidas para la visibilidad de tu actividad. Puedes ver [http://www.pygtk.org/docs/pygtk/gdk-constants.html#gdk-visibility-state-constants la sección de Constantes de Estado de Visibilidad de GDK] gtk.gdk.Constants para más información.

<pre>
# Notify when the visibility state changes by calling self.__visibility_notify_cb
# (PUT THIS IN YOUR ACTIVITY CODE - EG. THE __init__() METHOD)
self.add_events(gtk.gdk.VISIBILITY_NOTIFY_MASK)
self.connect("visibility-notify-event", self.__visibility_notify_cb)
...
# Callback method for when the activity's visibility changes
def __visibility_notify_cb(self, window, event):
if event.state == gtk.gdk.VISIBILITY_FULLY_OBSCURED:
print "I am not visible"
elif event.state in [gtk.gdk.VISIBILITY_UNOBSCURED, gtk.gdk.VISIBILITY_PARTIAL]:
print "I am visible"
</pre>

=== ¿Cómo puedo obtener la cantidad de espacio libre disponible dentro del directorio /home? ===
La siguiente función usa el módulo [http://docs.python.org/lib/module-statvfs.html statvfs]. El código siguiente muestra cómo obtener la cantidad total de espacio libre en /home.

<pre>
#### Método getFreespaceKb: devuelve el espacio disponible en kilobytes.
def getFreespaceKb(self):
stat = os.statvfs("/home")
freebytes = stat[statvfs.F_BSIZE] * stat[statvfs.F_BAVAIL]
freekb = freebytes / 1024
return freekb
</pre>

Ten en cuenta que asumir cosas acerca de "/home" no es una buena idea, es mejor usar os.environ['HOME']. Rainbow pondrá los archivos actuales en otros lugares, algunos en el ramdisk, otros en la flash.

Note, however, that assuming anything about "/home" is a bad idea, better use os.environ['HOME'] instead. Rainbow will put your actual files elsewhere,
some on ramdisks, some on flash.
Ten claro que el espacio libre en el sistema de archivos realmente te importa importa.

=== How do I know whether my activity is running on a physical XO? ===
Sugar runs on ordinary computers as well as on XO's. While your activity is typically going to be run on a real XO, some people will indeed run it elsewhere. Normally you shouldn't write your activity to care whether it's on an XO or not. If for some odd reason, you need to care, the easiest way to tell if you are on a physical XO is to check whether /sys/power/olpc-pm, an essential power management file for the XO, exists. <ref>[http://lists.laptop.org/pipermail/devel/2008-June/015923.html reliably detecting if running on an XO]</ref> <ref>OLPC [[olpc:Power Management Interface]]</ref>

<pre>
import os
...
#Print out a boolean value that tells us whether we are on an XO or not.
print os.path.exists('/sys/power/olpc-pm')
</pre>

=== How do I know the current language setting on my XO? ===
The system variable 'LANG' tells you which language is currently active on the XO. The following code shows how to look at the value of this variable.

<pre>
import os
...
_logger.debug(os.environ['LANG'])
</pre>

=== How do I repeatedly call a specific method after N number of seconds? ===
The gobject.timeout_add() function allows you to invoke a callback method after a certain amount of time. If you want to repeatedly call a method, simply keep invoking the gobject.timeout_add function in your callback itself. The code below is a simple example, where the callback function is named repeatedly_call. Note that the timing of the callbacks are approximate. To get the process going, you should make an initial call to repeatedly_call() somewhere in your code.

You can see a more substantive example of this pattern in use when we [[olpc:Pango#How_do_I_dynamically_set_the_text_in_a_pango_layout.3F | regularly update the time displayed on a pango layout object]].

<pre>

#This method calls itself ROUGHLY every 1 second
def repeatedly_call(self):
now = datetime.datetime.now()
gobject.timeout_add(self.repeat_period_msec, self.repeatedly_update_time)
</pre>

=== How do I update the current build version of code that is running on my XO? ===

There are several pages that give you instructions on how to install/update your current build.

* If you already have a working build installed and an internet connection, first try [[olpc:olpc-update]].
* If that doesn't work, you can look at instructions for an [[olpc:Activated upgrade]] that can be done via USB] boot.

As the instructions on the pages linked above note, make sure to install your activities separately after you have upgraded to a specific base build.

=== I am developing on an XO laptop, but my keyboard and language settings are not ideal. How can I change them? ===

Internationalized laptops will often have settings that might slow you down while developing. To change around the language settings so you can better understand environment messages, use the [[olpc:Sugar Control Panel]]

Keyboard settings on internationalized laptops<ref>[[olpc:Keyboard layouts#OLPC keyboard layouts]]</ref> can also be suboptimal, especially as characters like "-" and "/" are in unfamiliar positions. You can use the <tt>setxkbmap</tt> command in the [[olpc:Terminal Activity]] to reset the type of keyboard input used and then attach a standard U.S. keyboard that will allow you to type normally. The command below sets the keyboard to the US mapping (it will reset to the default internationalized mapping upon restart).

setxkbmap us

=== My Python activity wants to use threads; how do I do that? ===

A question that has been answered with limited success is which threading patterns are most appropriate for use in Sugar. The following pattern of code to work fine in basic instances:

<pre>
#### Method: __init__, initialize this AnnotateActivity instance
def __init__(self, handle):
...
self.sample_thread = Thread(target=self.announce_thread, args=())
self.sample_thread.setDaemon(0)
self.sample_thread.start()
...

def announce_thread(self):
while (self.Running):
time.sleep(1)
print "thread running"
self._update_chat_text("Thread", "In here")
</pre>

This is the basic series of steps that most online documentation on python suggests to use when trying to work with threads in python. The problem is that it is unclear how this pattern relates to code that worked in the SimCity activity:

<pre>
import gobject
gobject.threads_init()
#import dbus.mainloop.glib
#dbus.mainloop.glib.threads_init()
</pre>

It should be noted that in the SimCity activity the pygame sound player would not produce sound reliably unless this setup was done.



Should the two patterns always be used in tandem? It seems that the latter code is mainly to initiate gobject and other libraries to work with threading, but it is unclear what restrictions there are with using threading with these libraries. Does one take precedence over the other? It is not clear if there is any problem with using the standard python threading code on the sugar technology stack.





In fact, experiments with threading on sugar leads to several different problems. For one thing, thread termination was tricky - using the can_close() method for sugar activities to terminate an activity only killed threads in some circumstances. It did not properly handle terminating threads in the case of CTRL-C or terminal interrupts. You can try to catch signals (SIGINT, SIGTERM or SIGHUP), but you will still be running in to errors in terminating child threads using these as well.





Another set of errors with threading comes up when trying to combine with stream tubes. The bottom line is that it is unclear what the scope of threading in a Sugar activity should be - should it simply work if you do the standard python threading pattern, is the use of the glib.threads_init and gobject.threads_init calls necessary, are there other interactions with threads and dbus that need to be accounted for? With more clarity from sugar developers on how the platform envisions threading to work in an activity, we can be more comfortable writing entries in the Almanac to help developers write error-free code.



=== How do I customize the title that is displayed for each instance of my activity? ===

By default, activity titles are just the generic activity names that you specify in your activity.info file. In some applications, you may want the activity title to be more dynamic.

For example, it makes sense to set the title for different browser sessions to the active web page being visited. That way, when you look back in the journal at the different browser sessions you have run in the previous few days, you can identify unique sessions based on the website you happened to be visiting at the time.

The code below shows how you can set the metadata for your activity to reflect a dynamic title based on whatever session criteria you feel is important. This example is adapted from the Browse activity, which sets activity instance titles based on the title of the current web page being visited.

<pre>
if self.metadata['mime_type'] == 'text/plain':
if not self._jobject.metadata['title_set_by_user'] == '1':
if self._browser.props.title:
# Set the title of this activity to be the current
# title of the page being visited by the browser.
self.metadata['title'] = self._browser.props.title
</pre>

=== What packages are available on sugar to support game development? ===

If your activity will require tools that are typically needed to develop robust and clean video games, then you should utilize the [http://www.pygame.org/ pygame package]. It can be readily imported into any activity:

<pre>
import pygame
...
</pre>

=== How do I detect when one of the game buttons on the laptop have been pressed? ===

The laptop game buttons (the circle, square, x, and check buttons next to the LCD) are encoded as page up, home, page down and end respectively. So, you can detect their press by listening for these specific events. For example, the code below listens for button presses and then just writes to an output widget which button was pressed.

<pre>
...
#### Initialize this activity.
def __init__(self, handle):
...
self.connect('key-press-event', self._keyPressCb)
...

#### Method _keyPressCb, which catches any presses of the game buttons.
def _keyPressCb(self, widget, event):

keyname = gtk.gdk.keyval_name(event.keyval)

if (keyname == 'KP_Page_Up'):
self._chat += "\nCircle Pressed!"
self._chat_buffer.set_text(self._chat)
elif (keyname == 'KP_Page_Down'):
self._chat += "\nX Pressed!"
self._chat_buffer.set_text(self._chat)
elif (keyname == 'KP_Home'):
self._chat += "\nSquare Pressed!"
self._chat_buffer.set_text(self._chat)
elif (keyname == 'KP_End'):
self._chat += "\nCheck Pressed!"
self._chat_buffer.set_text(self._chat)

return False
</pre>

=== How do I detect if one of the joystick buttons has been pressed? ===

This is the same process as detecting game buttons, except with different names for the keys. Again, you listen for "key-press-event" signals and then in your callback you check to see if the pressed button was one of the joystick keys.

<pre>
#### Initialize this activity.
def __init__(self, handle):
...
self.connect('key-press-event', self._keyPressCb)
...

#### Method _keyPressCb, which catches any presses of the game buttons.
def _keyPressCb(self, widget, event):

keyname = gtk.gdk.keyval_name(event.keyval)

if (keyname == 'KP_Up'):
self._chat += "\nUp Pressed!"
self._chat_buffer.set_text(self._chat)
elif (keyname == 'KP_Down'):
self._chat += "\nDown Pressed!"
self._chat_buffer.set_text(self._chat)
elif (keyname == 'KP_Left'):
self._chat += "\nLeft Pressed!"
self._chat_buffer.set_text(self._chat)
elif (keyname == 'KP_Right'):
self._chat += "\nRight Pressed!"
self._chat_buffer.set_text(self._chat)

return False
</pre>

=== How do i remove an specific button from the toolbar? ===

This is an example of the share button is removed:

<pre>
activity_toolbar = toolbox.get_activity_toolbar()
activity_toolbar.remove(activity_toolbar.share)
activity_toolbar.share = None
</pre>

== Notes ==
<references />

[[Category:Documentation]]
[[Category:Development Team]]

Development Team/Almanac/lang-es

2009-08-31T16:36:20Z

Fede: /* ¿Cómo puedo obtener la cantidad de espacio libre disponible en el disco dentro el directorio /home? */

{{translation
| source = Development_Team/Almanac
| lang = es
| status = {{translation/incomplete/}}
}}

{{Almanac}}
{{Almanac TOC}}
== ¿Cómo puedo obtener ayuda adicional más allá de este almanaque? ==
* ¿Quieres comenzar con los básico del desarrollo para Sugar? Puedes visitar el [http://wiki.sugarlabs.org/images/5/51/Activity_Handbook_200805_online.pdf Activity Handbook] de OLPC Austria (''Ten en cuenta que este manual fue actualizado por última vez en mayo del 2008, las capturas de tienen el diseño pre-8.2. En términos de código en sí, las cosas deberían funcionar como están descriptas. Si encuentra algún problema por favor póngase en contacto con [[User:ChristophD|ChristophD]].'')
* Ver también [[Development Team/Almanac/Code Snippets]]

Ahora, vamos con el almanaque actual...

== ¿Dónde puedo ver los cambios de la API? ==
API changes between OLPC releases can be seen here: [[Development Team/Almanac/API Changes|API Changes]]

== Comenzando ==
=== ¿Cómo estructuro mis archivos para que sean una actividad de válido en Sugar? ===
Puedes encontrar información sobre la estructura de la actividad aquí: [[Development Team/Almanac/Activity Bundles|Activity Bundles]]

=== ¿Cómo puedo hacer un icono para mi actividad? ===
La información sobre lo que debe hacer se puede encontrar aquí: [[Development Team/Almanac/Making Icons|Making Icons]]

== Paquete: sugar ==
* [[Development Team/Almanac/sugar.env|sugar.env]]
* [[Development Team/Almanac/sugar.profile|sugar.profile]]
* [[Development Team/Almanac/sugar.mime|sugar.mime]]
* [[Development Team/Almanac/sugar.logger|sugar.logger]]

== Paquete: sugar.activity ==
* [[Development Team/Almanac/sugar.activity.activity|sugar.activity.activity]]
* [[Development Team/Almanac/sugar.activity.activityfactory|sugar.activity.activityfactory]]
* [[Development Team/Almanac/sugar.activity.registry|sugar.activity.registry]]

== Paquete: sugar.datastore ==
* [[Development Team/Almanac/sugar.datastore.datastore|sugar.datastore.datastore]]

== Paquete: sugar.graphics ==
* [[Development Team/Almanac/sugar.graphics.alert|sugar.graphics.alert]]
* [[Development Team/Almanac/sugar.graphics.icon|sugar.graphics.icon]]
* [[Development Team/Almanac/sugar.graphics.notebook|sugar.graphics.notebook]]
* [[Development Team/Almanac/sugar.graphics.toolbutton|sugar.graphics.toolbutton]]
* [[Development Team/Almanac/sugar.graphics.toolbox|sugar.graphics.toolbox]]
* [[Development Team/Almanac/sugar.graphics.style|sugar.graphics.style]]

== Paquete: sugar.presence ==
* [[Development Team/Almanac/Sugar.presence|Sugar.presence]]
* [[Development Team/Almanac/Sugar.presence.activity|Sugar.presence.activity]]
* [[Development Team/Almanac/Sugar.presence.buddy|Sugar.presence.buddy]]
* [[Development Team/Almanac/Sugar.presence.presenceservice|Sugar.presence.presenceservice]]

== Clipboard ==
* Notas sobre el uso del [[Development Team/Almanac/GTK's Clipboard Module|módulo Clipboard de GTK ]]

== Logging ==
* [[Development Team/Almanac/sugar.logger|sugar.logger]]
* Notas sobre el uso del [[Development Team/Almanac/Python Standard Logging|standard de Logging en Python]]

== Internacionalización ==
*[[Development Team/Almanac/Internationalization|Internationalization]]

== Texto y gráficos para las actividades de Sugar ==
* [[Development Team/Almanac/Pango|Pango]]
=== ¿Cómo puedo crear un cuadro de texto para la edición de código? ===
Puedes usar gtksourceview2
<pre>
import gtk
import gtksourceview2
from sugar.graphics import style

...

# Configuramos el buffer
buffer = gtksourceview2.Buffer()
if hasattr(buffer, 'set_highlight'): # handle different API versions
buffer.set_highlight(True)
else:
buffer.set_highlight_syntax(True)

# Configuramos el tipo MIME para el buffer
lang_manager = gtksourceview2.language_manager_get_default()
if hasattr(lang_manager, 'list_languages'): # again, handle different APIs
langs = lang_manager.list_languages()
else:
lang_ids = lang_manager.get_language_ids()
langs = [lang_manager.get_language(lang_id)
for lang_id in lang_ids]
for lang in langs:
for m in lang.get_mime_types():
if m == mime_type: # <-- this is the mime type you want
buffer.set_language(lang)

# Establecemos el objeto para la vista, usarlo como gtk.TextView
view = gtksourceview2.View(buffer)
view.set_size_request(300, 450)
view.set_editable(True)
view.set_cursor_visible(True)
view.set_show_line_numbers(True)
view.set_wrap_mode(gtk.WRAP_CHAR)
view.set_right_margin_position(80)
#view.set_highlight_current_line(True) #FIXME: Ugly color
view.set_auto_indent(True)
view.modify_font(pango.FontDescription("Monospace " +
str(style.FONT_SIZE)))
...

</pre>

Para agregar texto al buffer:
<pre>
buffer.set_text(text)
</pre>
Para obtener todo el texto:
<pre>
text = buffer.get_text(buffer.get_start_iter(), buffer.get_end_iter())
</pre>

Probablemente quieras poner la view(vista) en un gtk.ScrolledWindow
<pre>
sw = gtk.ScrolledWindow()
sw.add(view)
sw.set_policy(gtk.POLICY_AUTOMATIC, gtk.POLICY_AUTOMATIC)
</pre>
y agregar el el objeto sw en vez de la view(vista).

Puedes encotnrar más en el código fuete de Pippyy en jarabe.view.sourceview.

== Audio y Video ==
* [[Development Team/Almanac/GStreamer|GStreamer]]

== Ratón ==
=== ¿Cómo puedo cambiar el cursor del ratón por el cursor de espera en mi actividad? ===
En la subclase de tu actividad:

<pre>
self.window.set_cursor( gtk.gdk.Cursor(gtk.gdk.WATCH) )
</pre>

y para volver al que está por defecto:

<pre>
self.window.set_cursor( None );
</pre>

=== ¿Cómo puedo rastrear la posición del ratón? ===
Existen varias razones por las que te puede interesar controlar la posición del ratón, que van desde el entretenimiento ([[http://en.wikipedia.org/wiki/Xeyes]]) a lo funcional (ocultar ciertas ventanas cuando el ratón no se ha movido por un par de segundos y volver a hacer aparecer esos elementos cuando este se mueva nuevamente). Esta es una manera en la cual se puede implementar esta funcionalidad:
<pre>

...
self.hideWidgetsTime = time.time()
self.mx = -1
self.my = -1
self.HIDE_WIDGET_TIMEOUT_ID = gobject.timeout_add( 500, self.mouseMightHaveMovedCb )

def _mouseMightHaveMovedCb( self ):
x, y = self.get_pointer()
passedTime = 0

if (x != self.mx or y != self.my):
self.hideWidgetsTime = time.time()
if (self.hiddenWidgets):
self.showWidgets()
self.hiddenWidgets = False
else:
passedTime = time.time() - self.hideWidgetsTime

if (passedTime >= 3):
if (not self.hiddenWidgets):
self.hideWidgets()
self.hiddenWidgets = True

self.mx = x
self.my = y
return True

</pre>

== Varios ==

Las tareas que aparecen más abajo son técnicas útiles que he encontrado mientras escribía código y documentación para esta referencia. No ha sido categorizadas aún.

=== ¿Cómo se si mi actividad está "activa" o no? ===

Puedes configurar un evento usando la constante VISIBILITY_NOTIFY_MASK para saber cuando se cambia la visibilidad. Luego en el callback para este evento lo que debes hacer es comprar el estado del evento con las variables gtk definidas para la visibilidad de tu actividad. Puedes ver [http://www.pygtk.org/docs/pygtk/gdk-constants.html#gdk-visibility-state-constants la sección de Constantes de Estado de Visibilidad de GDK] gtk.gdk.Constants para más información.

<pre>
# Notify when the visibility state changes by calling self.__visibility_notify_cb
# (PUT THIS IN YOUR ACTIVITY CODE - EG. THE __init__() METHOD)
self.add_events(gtk.gdk.VISIBILITY_NOTIFY_MASK)
self.connect("visibility-notify-event", self.__visibility_notify_cb)
...
# Callback method for when the activity's visibility changes
def __visibility_notify_cb(self, window, event):
if event.state == gtk.gdk.VISIBILITY_FULLY_OBSCURED:
print "I am not visible"
elif event.state in [gtk.gdk.VISIBILITY_UNOBSCURED, gtk.gdk.VISIBILITY_PARTIAL]:
print "I am visible"
</pre>

=== ¿Cómo puedo obtener la cantidad de espacio libre disponible dentro del directorio /home? ===
La siguiente función usa el módulo [statvfs http://docs.python.org/lib/module-statvfs.html]. El código siguiente muestra cómo obtener la cantidad total de espacio libre en / home.

<pre>
#### Method: getFreespaceKb, devuelve el espacio disponible en kilobytes.
def getFreespaceKb(self):
stat = os.statvfs("/home")
freebytes = stat[statvfs.F_BSIZE] * stat[statvfs.F_BAVAIL]
freekb = freebytes / 1024
return freekb
</pre>

Ten en cuenta que asumir cosas acerca de "/home" no es una buena idea, es mejor usar os.environ['HOME']. Rainbow pondrá los archivos actuales en otros lugares, algunos en el ramdisk, otros en la flash.

Note, however, that assuming anything about "/home" is a bad idea, better use os.environ['HOME'] instead. Rainbow will put your actual files elsewhere,
some on ramdisks, some on flash.
Ten claro que el espacio libre en el sistema de archivos realmente te importa importa.

=== How do I know whether my activity is running on a physical XO? ===
Sugar runs on ordinary computers as well as on XO's. While your activity is typically going to be run on a real XO, some people will indeed run it elsewhere. Normally you shouldn't write your activity to care whether it's on an XO or not. If for some odd reason, you need to care, the easiest way to tell if you are on a physical XO is to check whether /sys/power/olpc-pm, an essential power management file for the XO, exists. <ref>[http://lists.laptop.org/pipermail/devel/2008-June/015923.html reliably detecting if running on an XO]</ref> <ref>OLPC [[olpc:Power Management Interface]]</ref>

<pre>
import os
...
#Print out a boolean value that tells us whether we are on an XO or not.
print os.path.exists('/sys/power/olpc-pm')
</pre>

=== How do I know the current language setting on my XO? ===
The system variable 'LANG' tells you which language is currently active on the XO. The following code shows how to look at the value of this variable.

<pre>
import os
...
_logger.debug(os.environ['LANG'])
</pre>

=== How do I repeatedly call a specific method after N number of seconds? ===
The gobject.timeout_add() function allows you to invoke a callback method after a certain amount of time. If you want to repeatedly call a method, simply keep invoking the gobject.timeout_add function in your callback itself. The code below is a simple example, where the callback function is named repeatedly_call. Note that the timing of the callbacks are approximate. To get the process going, you should make an initial call to repeatedly_call() somewhere in your code.

You can see a more substantive example of this pattern in use when we [[olpc:Pango#How_do_I_dynamically_set_the_text_in_a_pango_layout.3F | regularly update the time displayed on a pango layout object]].

<pre>

#This method calls itself ROUGHLY every 1 second
def repeatedly_call(self):
now = datetime.datetime.now()
gobject.timeout_add(self.repeat_period_msec, self.repeatedly_update_time)
</pre>

=== How do I update the current build version of code that is running on my XO? ===

There are several pages that give you instructions on how to install/update your current build.

* If you already have a working build installed and an internet connection, first try [[olpc:olpc-update]].
* If that doesn't work, you can look at instructions for an [[olpc:Activated upgrade]] that can be done via USB] boot.

As the instructions on the pages linked above note, make sure to install your activities separately after you have upgraded to a specific base build.

=== I am developing on an XO laptop, but my keyboard and language settings are not ideal. How can I change them? ===

Internationalized laptops will often have settings that might slow you down while developing. To change around the language settings so you can better understand environment messages, use the [[olpc:Sugar Control Panel]]

Keyboard settings on internationalized laptops<ref>[[olpc:Keyboard layouts#OLPC keyboard layouts]]</ref> can also be suboptimal, especially as characters like "-" and "/" are in unfamiliar positions. You can use the <tt>setxkbmap</tt> command in the [[olpc:Terminal Activity]] to reset the type of keyboard input used and then attach a standard U.S. keyboard that will allow you to type normally. The command below sets the keyboard to the US mapping (it will reset to the default internationalized mapping upon restart).

setxkbmap us

=== My Python activity wants to use threads; how do I do that? ===

A question that has been answered with limited success is which threading patterns are most appropriate for use in Sugar. The following pattern of code to work fine in basic instances:

<pre>
#### Method: __init__, initialize this AnnotateActivity instance
def __init__(self, handle):
...
self.sample_thread = Thread(target=self.announce_thread, args=())
self.sample_thread.setDaemon(0)
self.sample_thread.start()
...

def announce_thread(self):
while (self.Running):
time.sleep(1)
print "thread running"
self._update_chat_text("Thread", "In here")
</pre>

This is the basic series of steps that most online documentation on python suggests to use when trying to work with threads in python. The problem is that it is unclear how this pattern relates to code that worked in the SimCity activity:

<pre>
import gobject
gobject.threads_init()
#import dbus.mainloop.glib
#dbus.mainloop.glib.threads_init()
</pre>

It should be noted that in the SimCity activity the pygame sound player would not produce sound reliably unless this setup was done.



Should the two patterns always be used in tandem? It seems that the latter code is mainly to initiate gobject and other libraries to work with threading, but it is unclear what restrictions there are with using threading with these libraries. Does one take precedence over the other? It is not clear if there is any problem with using the standard python threading code on the sugar technology stack.





In fact, experiments with threading on sugar leads to several different problems. For one thing, thread termination was tricky - using the can_close() method for sugar activities to terminate an activity only killed threads in some circumstances. It did not properly handle terminating threads in the case of CTRL-C or terminal interrupts. You can try to catch signals (SIGINT, SIGTERM or SIGHUP), but you will still be running in to errors in terminating child threads using these as well.





Another set of errors with threading comes up when trying to combine with stream tubes. The bottom line is that it is unclear what the scope of threading in a Sugar activity should be - should it simply work if you do the standard python threading pattern, is the use of the glib.threads_init and gobject.threads_init calls necessary, are there other interactions with threads and dbus that need to be accounted for? With more clarity from sugar developers on how the platform envisions threading to work in an activity, we can be more comfortable writing entries in the Almanac to help developers write error-free code.



=== How do I customize the title that is displayed for each instance of my activity? ===

By default, activity titles are just the generic activity names that you specify in your activity.info file. In some applications, you may want the activity title to be more dynamic.

For example, it makes sense to set the title for different browser sessions to the active web page being visited. That way, when you look back in the journal at the different browser sessions you have run in the previous few days, you can identify unique sessions based on the website you happened to be visiting at the time.

The code below shows how you can set the metadata for your activity to reflect a dynamic title based on whatever session criteria you feel is important. This example is adapted from the Browse activity, which sets activity instance titles based on the title of the current web page being visited.

<pre>
if self.metadata['mime_type'] == 'text/plain':
if not self._jobject.metadata['title_set_by_user'] == '1':
if self._browser.props.title:
# Set the title of this activity to be the current
# title of the page being visited by the browser.
self.metadata['title'] = self._browser.props.title
</pre>

=== What packages are available on sugar to support game development? ===

If your activity will require tools that are typically needed to develop robust and clean video games, then you should utilize the [http://www.pygame.org/ pygame package]. It can be readily imported into any activity:

<pre>
import pygame
...
</pre>

=== How do I detect when one of the game buttons on the laptop have been pressed? ===

The laptop game buttons (the circle, square, x, and check buttons next to the LCD) are encoded as page up, home, page down and end respectively. So, you can detect their press by listening for these specific events. For example, the code below listens for button presses and then just writes to an output widget which button was pressed.

<pre>
...
#### Initialize this activity.
def __init__(self, handle):
...
self.connect('key-press-event', self._keyPressCb)
...

#### Method _keyPressCb, which catches any presses of the game buttons.
def _keyPressCb(self, widget, event):

keyname = gtk.gdk.keyval_name(event.keyval)

if (keyname == 'KP_Page_Up'):
self._chat += "\nCircle Pressed!"
self._chat_buffer.set_text(self._chat)
elif (keyname == 'KP_Page_Down'):
self._chat += "\nX Pressed!"
self._chat_buffer.set_text(self._chat)
elif (keyname == 'KP_Home'):
self._chat += "\nSquare Pressed!"
self._chat_buffer.set_text(self._chat)
elif (keyname == 'KP_End'):
self._chat += "\nCheck Pressed!"
self._chat_buffer.set_text(self._chat)

return False
</pre>

=== How do I detect if one of the joystick buttons has been pressed? ===

This is the same process as detecting game buttons, except with different names for the keys. Again, you listen for "key-press-event" signals and then in your callback you check to see if the pressed button was one of the joystick keys.

<pre>
#### Initialize this activity.
def __init__(self, handle):
...
self.connect('key-press-event', self._keyPressCb)
...

#### Method _keyPressCb, which catches any presses of the game buttons.
def _keyPressCb(self, widget, event):

keyname = gtk.gdk.keyval_name(event.keyval)

if (keyname == 'KP_Up'):
self._chat += "\nUp Pressed!"
self._chat_buffer.set_text(self._chat)
elif (keyname == 'KP_Down'):
self._chat += "\nDown Pressed!"
self._chat_buffer.set_text(self._chat)
elif (keyname == 'KP_Left'):
self._chat += "\nLeft Pressed!"
self._chat_buffer.set_text(self._chat)
elif (keyname == 'KP_Right'):
self._chat += "\nRight Pressed!"
self._chat_buffer.set_text(self._chat)

return False
</pre>

=== How do i remove an specific button from the toolbar? ===

This is an example of the share button is removed:

<pre>
activity_toolbar = toolbox.get_activity_toolbar()
activity_toolbar.remove(activity_toolbar.share)
activity_toolbar.share = None
</pre>

== Notes ==
<references />

[[Category:Documentation]]
[[Category:Development Team]]

Development Team/Almanac/lang-es

2009-08-31T16:35:47Z

Fede: /* How do I get the amount of free space available on disk under the /home directory tree? */

{{translation
| source = Development_Team/Almanac
| lang = es
| status = {{translation/incomplete/}}
}}

{{Almanac}}
{{Almanac TOC}}
== ¿Cómo puedo obtener ayuda adicional más allá de este almanaque? ==
* ¿Quieres comenzar con los básico del desarrollo para Sugar? Puedes visitar el [http://wiki.sugarlabs.org/images/5/51/Activity_Handbook_200805_online.pdf Activity Handbook] de OLPC Austria (''Ten en cuenta que este manual fue actualizado por última vez en mayo del 2008, las capturas de tienen el diseño pre-8.2. En términos de código en sí, las cosas deberían funcionar como están descriptas. Si encuentra algún problema por favor póngase en contacto con [[User:ChristophD|ChristophD]].'')
* Ver también [[Development Team/Almanac/Code Snippets]]

Ahora, vamos con el almanaque actual...

== ¿Dónde puedo ver los cambios de la API? ==
API changes between OLPC releases can be seen here: [[Development Team/Almanac/API Changes|API Changes]]

== Comenzando ==
=== ¿Cómo estructuro mis archivos para que sean una actividad de válido en Sugar? ===
Puedes encontrar información sobre la estructura de la actividad aquí: [[Development Team/Almanac/Activity Bundles|Activity Bundles]]

=== ¿Cómo puedo hacer un icono para mi actividad? ===
La información sobre lo que debe hacer se puede encontrar aquí: [[Development Team/Almanac/Making Icons|Making Icons]]

== Paquete: sugar ==
* [[Development Team/Almanac/sugar.env|sugar.env]]
* [[Development Team/Almanac/sugar.profile|sugar.profile]]
* [[Development Team/Almanac/sugar.mime|sugar.mime]]
* [[Development Team/Almanac/sugar.logger|sugar.logger]]

== Paquete: sugar.activity ==
* [[Development Team/Almanac/sugar.activity.activity|sugar.activity.activity]]
* [[Development Team/Almanac/sugar.activity.activityfactory|sugar.activity.activityfactory]]
* [[Development Team/Almanac/sugar.activity.registry|sugar.activity.registry]]

== Paquete: sugar.datastore ==
* [[Development Team/Almanac/sugar.datastore.datastore|sugar.datastore.datastore]]

== Paquete: sugar.graphics ==
* [[Development Team/Almanac/sugar.graphics.alert|sugar.graphics.alert]]
* [[Development Team/Almanac/sugar.graphics.icon|sugar.graphics.icon]]
* [[Development Team/Almanac/sugar.graphics.notebook|sugar.graphics.notebook]]
* [[Development Team/Almanac/sugar.graphics.toolbutton|sugar.graphics.toolbutton]]
* [[Development Team/Almanac/sugar.graphics.toolbox|sugar.graphics.toolbox]]
* [[Development Team/Almanac/sugar.graphics.style|sugar.graphics.style]]

== Paquete: sugar.presence ==
* [[Development Team/Almanac/Sugar.presence|Sugar.presence]]
* [[Development Team/Almanac/Sugar.presence.activity|Sugar.presence.activity]]
* [[Development Team/Almanac/Sugar.presence.buddy|Sugar.presence.buddy]]
* [[Development Team/Almanac/Sugar.presence.presenceservice|Sugar.presence.presenceservice]]

== Clipboard ==
* Notas sobre el uso del [[Development Team/Almanac/GTK's Clipboard Module|módulo Clipboard de GTK ]]

== Logging ==
* [[Development Team/Almanac/sugar.logger|sugar.logger]]
* Notas sobre el uso del [[Development Team/Almanac/Python Standard Logging|standard de Logging en Python]]

== Internacionalización ==
*[[Development Team/Almanac/Internationalization|Internationalization]]

== Texto y gráficos para las actividades de Sugar ==
* [[Development Team/Almanac/Pango|Pango]]
=== ¿Cómo puedo crear un cuadro de texto para la edición de código? ===
Puedes usar gtksourceview2
<pre>
import gtk
import gtksourceview2
from sugar.graphics import style

...

# Configuramos el buffer
buffer = gtksourceview2.Buffer()
if hasattr(buffer, 'set_highlight'): # handle different API versions
buffer.set_highlight(True)
else:
buffer.set_highlight_syntax(True)

# Configuramos el tipo MIME para el buffer
lang_manager = gtksourceview2.language_manager_get_default()
if hasattr(lang_manager, 'list_languages'): # again, handle different APIs
langs = lang_manager.list_languages()
else:
lang_ids = lang_manager.get_language_ids()
langs = [lang_manager.get_language(lang_id)
for lang_id in lang_ids]
for lang in langs:
for m in lang.get_mime_types():
if m == mime_type: # <-- this is the mime type you want
buffer.set_language(lang)

# Establecemos el objeto para la vista, usarlo como gtk.TextView
view = gtksourceview2.View(buffer)
view.set_size_request(300, 450)
view.set_editable(True)
view.set_cursor_visible(True)
view.set_show_line_numbers(True)
view.set_wrap_mode(gtk.WRAP_CHAR)
view.set_right_margin_position(80)
#view.set_highlight_current_line(True) #FIXME: Ugly color
view.set_auto_indent(True)
view.modify_font(pango.FontDescription("Monospace " +
str(style.FONT_SIZE)))
...

</pre>

Para agregar texto al buffer:
<pre>
buffer.set_text(text)
</pre>
Para obtener todo el texto:
<pre>
text = buffer.get_text(buffer.get_start_iter(), buffer.get_end_iter())
</pre>

Probablemente quieras poner la view(vista) en un gtk.ScrolledWindow
<pre>
sw = gtk.ScrolledWindow()
sw.add(view)
sw.set_policy(gtk.POLICY_AUTOMATIC, gtk.POLICY_AUTOMATIC)
</pre>
y agregar el el objeto sw en vez de la view(vista).

Puedes encotnrar más en el código fuete de Pippyy en jarabe.view.sourceview.

== Audio y Video ==
* [[Development Team/Almanac/GStreamer|GStreamer]]

== Ratón ==
=== ¿Cómo puedo cambiar el cursor del ratón por el cursor de espera en mi actividad? ===
En la subclase de tu actividad:

<pre>
self.window.set_cursor( gtk.gdk.Cursor(gtk.gdk.WATCH) )
</pre>

y para volver al que está por defecto:

<pre>
self.window.set_cursor( None );
</pre>

=== ¿Cómo puedo rastrear la posición del ratón? ===
Existen varias razones por las que te puede interesar controlar la posición del ratón, que van desde el entretenimiento ([[http://en.wikipedia.org/wiki/Xeyes]]) a lo funcional (ocultar ciertas ventanas cuando el ratón no se ha movido por un par de segundos y volver a hacer aparecer esos elementos cuando este se mueva nuevamente). Esta es una manera en la cual se puede implementar esta funcionalidad:
<pre>

...
self.hideWidgetsTime = time.time()
self.mx = -1
self.my = -1
self.HIDE_WIDGET_TIMEOUT_ID = gobject.timeout_add( 500, self.mouseMightHaveMovedCb )

def _mouseMightHaveMovedCb( self ):
x, y = self.get_pointer()
passedTime = 0

if (x != self.mx or y != self.my):
self.hideWidgetsTime = time.time()
if (self.hiddenWidgets):
self.showWidgets()
self.hiddenWidgets = False
else:
passedTime = time.time() - self.hideWidgetsTime

if (passedTime >= 3):
if (not self.hiddenWidgets):
self.hideWidgets()
self.hiddenWidgets = True

self.mx = x
self.my = y
return True

</pre>

== Varios ==

Las tareas que aparecen más abajo son técnicas útiles que he encontrado mientras escribía código y documentación para esta referencia. No ha sido categorizadas aún.

=== ¿Cómo se si mi actividad está "activa" o no? ===

Puedes configurar un evento usando la constante VISIBILITY_NOTIFY_MASK para saber cuando se cambia la visibilidad. Luego en el callback para este evento lo que debes hacer es comprar el estado del evento con las variables gtk definidas para la visibilidad de tu actividad. Puedes ver [http://www.pygtk.org/docs/pygtk/gdk-constants.html#gdk-visibility-state-constants la sección de Constantes de Estado de Visibilidad de GDK] gtk.gdk.Constants para más información.

<pre>
# Notify when the visibility state changes by calling self.__visibility_notify_cb
# (PUT THIS IN YOUR ACTIVITY CODE - EG. THE __init__() METHOD)
self.add_events(gtk.gdk.VISIBILITY_NOTIFY_MASK)
self.connect("visibility-notify-event", self.__visibility_notify_cb)
...
# Callback method for when the activity's visibility changes
def __visibility_notify_cb(self, window, event):
if event.state == gtk.gdk.VISIBILITY_FULLY_OBSCURED:
print "I am not visible"
elif event.state in [gtk.gdk.VISIBILITY_UNOBSCURED, gtk.gdk.VISIBILITY_PARTIAL]:
print "I am visible"
</pre>

=== ¿Cómo puedo obtener la cantidad de espacio libre disponible en el disco dentro el directorio /home? ===
La siguiente función usa el módulo [statvfs http://docs.python.org/lib/module-statvfs.html]. El código siguiente muestra cómo obtener la cantidad total de espacio libre en / home.

<pre>
#### Method: getFreespaceKb, devuelve el espacio disponible en kilobytes.
def getFreespaceKb(self):
stat = os.statvfs("/home")
freebytes = stat[statvfs.F_BSIZE] * stat[statvfs.F_BAVAIL]
freekb = freebytes / 1024
return freekb
</pre>

Ten en cuenta que asumir cosas acerca de "/home" no es una buena idea, es mejor usar os.environ['HOME']. Rainbow pondrá los archivos actuales en otros lugares, algunos en el ramdisk, otros en la flash.

Note, however, that assuming anything about "/home" is a bad idea, better use os.environ['HOME'] instead. Rainbow will put your actual files elsewhere,
some on ramdisks, some on flash.
Ten en claro que el espacio libre en el sistema de archivos realmente te importa importa.

=== How do I know whether my activity is running on a physical XO? ===
Sugar runs on ordinary computers as well as on XO's. While your activity is typically going to be run on a real XO, some people will indeed run it elsewhere. Normally you shouldn't write your activity to care whether it's on an XO or not. If for some odd reason, you need to care, the easiest way to tell if you are on a physical XO is to check whether /sys/power/olpc-pm, an essential power management file for the XO, exists. <ref>[http://lists.laptop.org/pipermail/devel/2008-June/015923.html reliably detecting if running on an XO]</ref> <ref>OLPC [[olpc:Power Management Interface]]</ref>

<pre>
import os
...
#Print out a boolean value that tells us whether we are on an XO or not.
print os.path.exists('/sys/power/olpc-pm')
</pre>

=== How do I know the current language setting on my XO? ===
The system variable 'LANG' tells you which language is currently active on the XO. The following code shows how to look at the value of this variable.

<pre>
import os
...
_logger.debug(os.environ['LANG'])
</pre>

=== How do I repeatedly call a specific method after N number of seconds? ===
The gobject.timeout_add() function allows you to invoke a callback method after a certain amount of time. If you want to repeatedly call a method, simply keep invoking the gobject.timeout_add function in your callback itself. The code below is a simple example, where the callback function is named repeatedly_call. Note that the timing of the callbacks are approximate. To get the process going, you should make an initial call to repeatedly_call() somewhere in your code.

You can see a more substantive example of this pattern in use when we [[olpc:Pango#How_do_I_dynamically_set_the_text_in_a_pango_layout.3F | regularly update the time displayed on a pango layout object]].

<pre>

#This method calls itself ROUGHLY every 1 second
def repeatedly_call(self):
now = datetime.datetime.now()
gobject.timeout_add(self.repeat_period_msec, self.repeatedly_update_time)
</pre>

=== How do I update the current build version of code that is running on my XO? ===

There are several pages that give you instructions on how to install/update your current build.

* If you already have a working build installed and an internet connection, first try [[olpc:olpc-update]].
* If that doesn't work, you can look at instructions for an [[olpc:Activated upgrade]] that can be done via USB] boot.

As the instructions on the pages linked above note, make sure to install your activities separately after you have upgraded to a specific base build.

=== I am developing on an XO laptop, but my keyboard and language settings are not ideal. How can I change them? ===

Internationalized laptops will often have settings that might slow you down while developing. To change around the language settings so you can better understand environment messages, use the [[olpc:Sugar Control Panel]]

Keyboard settings on internationalized laptops<ref>[[olpc:Keyboard layouts#OLPC keyboard layouts]]</ref> can also be suboptimal, especially as characters like "-" and "/" are in unfamiliar positions. You can use the <tt>setxkbmap</tt> command in the [[olpc:Terminal Activity]] to reset the type of keyboard input used and then attach a standard U.S. keyboard that will allow you to type normally. The command below sets the keyboard to the US mapping (it will reset to the default internationalized mapping upon restart).

setxkbmap us

=== My Python activity wants to use threads; how do I do that? ===

A question that has been answered with limited success is which threading patterns are most appropriate for use in Sugar. The following pattern of code to work fine in basic instances:

<pre>
#### Method: __init__, initialize this AnnotateActivity instance
def __init__(self, handle):
...
self.sample_thread = Thread(target=self.announce_thread, args=())
self.sample_thread.setDaemon(0)
self.sample_thread.start()
...

def announce_thread(self):
while (self.Running):
time.sleep(1)
print "thread running"
self._update_chat_text("Thread", "In here")
</pre>

This is the basic series of steps that most online documentation on python suggests to use when trying to work with threads in python. The problem is that it is unclear how this pattern relates to code that worked in the SimCity activity:

<pre>
import gobject
gobject.threads_init()
#import dbus.mainloop.glib
#dbus.mainloop.glib.threads_init()
</pre>

It should be noted that in the SimCity activity the pygame sound player would not produce sound reliably unless this setup was done.



Should the two patterns always be used in tandem? It seems that the latter code is mainly to initiate gobject and other libraries to work with threading, but it is unclear what restrictions there are with using threading with these libraries. Does one take precedence over the other? It is not clear if there is any problem with using the standard python threading code on the sugar technology stack.





In fact, experiments with threading on sugar leads to several different problems. For one thing, thread termination was tricky - using the can_close() method for sugar activities to terminate an activity only killed threads in some circumstances. It did not properly handle terminating threads in the case of CTRL-C or terminal interrupts. You can try to catch signals (SIGINT, SIGTERM or SIGHUP), but you will still be running in to errors in terminating child threads using these as well.





Another set of errors with threading comes up when trying to combine with stream tubes. The bottom line is that it is unclear what the scope of threading in a Sugar activity should be - should it simply work if you do the standard python threading pattern, is the use of the glib.threads_init and gobject.threads_init calls necessary, are there other interactions with threads and dbus that need to be accounted for? With more clarity from sugar developers on how the platform envisions threading to work in an activity, we can be more comfortable writing entries in the Almanac to help developers write error-free code.



=== How do I customize the title that is displayed for each instance of my activity? ===

By default, activity titles are just the generic activity names that you specify in your activity.info file. In some applications, you may want the activity title to be more dynamic.

For example, it makes sense to set the title for different browser sessions to the active web page being visited. That way, when you look back in the journal at the different browser sessions you have run in the previous few days, you can identify unique sessions based on the website you happened to be visiting at the time.

The code below shows how you can set the metadata for your activity to reflect a dynamic title based on whatever session criteria you feel is important. This example is adapted from the Browse activity, which sets activity instance titles based on the title of the current web page being visited.

<pre>
if self.metadata['mime_type'] == 'text/plain':
if not self._jobject.metadata['title_set_by_user'] == '1':
if self._browser.props.title:
# Set the title of this activity to be the current
# title of the page being visited by the browser.
self.metadata['title'] = self._browser.props.title
</pre>

=== What packages are available on sugar to support game development? ===

If your activity will require tools that are typically needed to develop robust and clean video games, then you should utilize the [http://www.pygame.org/ pygame package]. It can be readily imported into any activity:

<pre>
import pygame
...
</pre>

=== How do I detect when one of the game buttons on the laptop have been pressed? ===

The laptop game buttons (the circle, square, x, and check buttons next to the LCD) are encoded as page up, home, page down and end respectively. So, you can detect their press by listening for these specific events. For example, the code below listens for button presses and then just writes to an output widget which button was pressed.

<pre>
...
#### Initialize this activity.
def __init__(self, handle):
...
self.connect('key-press-event', self._keyPressCb)
...

#### Method _keyPressCb, which catches any presses of the game buttons.
def _keyPressCb(self, widget, event):

keyname = gtk.gdk.keyval_name(event.keyval)

if (keyname == 'KP_Page_Up'):
self._chat += "\nCircle Pressed!"
self._chat_buffer.set_text(self._chat)
elif (keyname == 'KP_Page_Down'):
self._chat += "\nX Pressed!"
self._chat_buffer.set_text(self._chat)
elif (keyname == 'KP_Home'):
self._chat += "\nSquare Pressed!"
self._chat_buffer.set_text(self._chat)
elif (keyname == 'KP_End'):
self._chat += "\nCheck Pressed!"
self._chat_buffer.set_text(self._chat)

return False
</pre>

=== How do I detect if one of the joystick buttons has been pressed? ===

This is the same process as detecting game buttons, except with different names for the keys. Again, you listen for "key-press-event" signals and then in your callback you check to see if the pressed button was one of the joystick keys.

<pre>
#### Initialize this activity.
def __init__(self, handle):
...
self.connect('key-press-event', self._keyPressCb)
...

#### Method _keyPressCb, which catches any presses of the game buttons.
def _keyPressCb(self, widget, event):

keyname = gtk.gdk.keyval_name(event.keyval)

if (keyname == 'KP_Up'):
self._chat += "\nUp Pressed!"
self._chat_buffer.set_text(self._chat)
elif (keyname == 'KP_Down'):
self._chat += "\nDown Pressed!"
self._chat_buffer.set_text(self._chat)
elif (keyname == 'KP_Left'):
self._chat += "\nLeft Pressed!"
self._chat_buffer.set_text(self._chat)
elif (keyname == 'KP_Right'):
self._chat += "\nRight Pressed!"
self._chat_buffer.set_text(self._chat)

return False
</pre>

=== How do i remove an specific button from the toolbar? ===

This is an example of the share button is removed:

<pre>
activity_toolbar = toolbox.get_activity_toolbar()
activity_toolbar.remove(activity_toolbar.share)
activity_toolbar.share = None
</pre>

== Notes ==
<references />

[[Category:Documentation]]
[[Category:Development Team]]

Development Team/Almanac/lang-es

2009-08-31T16:31:04Z

Fede: /* Miscellaneous */

{{translation
| source = Development_Team/Almanac
| lang = es
| status = {{translation/incomplete/}}
}}

{{Almanac}}
{{Almanac TOC}}
== ¿Cómo puedo obtener ayuda adicional más allá de este almanaque? ==
* ¿Quieres comenzar con los básico del desarrollo para Sugar? Puedes visitar el [http://wiki.sugarlabs.org/images/5/51/Activity_Handbook_200805_online.pdf Activity Handbook] de OLPC Austria (''Ten en cuenta que este manual fue actualizado por última vez en mayo del 2008, las capturas de tienen el diseño pre-8.2. En términos de código en sí, las cosas deberían funcionar como están descriptas. Si encuentra algún problema por favor póngase en contacto con [[User:ChristophD|ChristophD]].'')
* Ver también [[Development Team/Almanac/Code Snippets]]

Ahora, vamos con el almanaque actual...

== ¿Dónde puedo ver los cambios de la API? ==
API changes between OLPC releases can be seen here: [[Development Team/Almanac/API Changes|API Changes]]

== Comenzando ==
=== ¿Cómo estructuro mis archivos para que sean una actividad de válido en Sugar? ===
Puedes encontrar información sobre la estructura de la actividad aquí: [[Development Team/Almanac/Activity Bundles|Activity Bundles]]

=== ¿Cómo puedo hacer un icono para mi actividad? ===
La información sobre lo que debe hacer se puede encontrar aquí: [[Development Team/Almanac/Making Icons|Making Icons]]

== Paquete: sugar ==
* [[Development Team/Almanac/sugar.env|sugar.env]]
* [[Development Team/Almanac/sugar.profile|sugar.profile]]
* [[Development Team/Almanac/sugar.mime|sugar.mime]]
* [[Development Team/Almanac/sugar.logger|sugar.logger]]

== Paquete: sugar.activity ==
* [[Development Team/Almanac/sugar.activity.activity|sugar.activity.activity]]
* [[Development Team/Almanac/sugar.activity.activityfactory|sugar.activity.activityfactory]]
* [[Development Team/Almanac/sugar.activity.registry|sugar.activity.registry]]

== Paquete: sugar.datastore ==
* [[Development Team/Almanac/sugar.datastore.datastore|sugar.datastore.datastore]]

== Paquete: sugar.graphics ==
* [[Development Team/Almanac/sugar.graphics.alert|sugar.graphics.alert]]
* [[Development Team/Almanac/sugar.graphics.icon|sugar.graphics.icon]]
* [[Development Team/Almanac/sugar.graphics.notebook|sugar.graphics.notebook]]
* [[Development Team/Almanac/sugar.graphics.toolbutton|sugar.graphics.toolbutton]]
* [[Development Team/Almanac/sugar.graphics.toolbox|sugar.graphics.toolbox]]
* [[Development Team/Almanac/sugar.graphics.style|sugar.graphics.style]]

== Paquete: sugar.presence ==
* [[Development Team/Almanac/Sugar.presence|Sugar.presence]]
* [[Development Team/Almanac/Sugar.presence.activity|Sugar.presence.activity]]
* [[Development Team/Almanac/Sugar.presence.buddy|Sugar.presence.buddy]]
* [[Development Team/Almanac/Sugar.presence.presenceservice|Sugar.presence.presenceservice]]

== Clipboard ==
* Notas sobre el uso del [[Development Team/Almanac/GTK's Clipboard Module|módulo Clipboard de GTK ]]

== Logging ==
* [[Development Team/Almanac/sugar.logger|sugar.logger]]
* Notas sobre el uso del [[Development Team/Almanac/Python Standard Logging|standard de Logging en Python]]

== Internacionalización ==
*[[Development Team/Almanac/Internationalization|Internationalization]]

== Texto y gráficos para las actividades de Sugar ==
* [[Development Team/Almanac/Pango|Pango]]
=== ¿Cómo puedo crear un cuadro de texto para la edición de código? ===
Puedes usar gtksourceview2
<pre>
import gtk
import gtksourceview2
from sugar.graphics import style

...

# Configuramos el buffer
buffer = gtksourceview2.Buffer()
if hasattr(buffer, 'set_highlight'): # handle different API versions
buffer.set_highlight(True)
else:
buffer.set_highlight_syntax(True)

# Configuramos el tipo MIME para el buffer
lang_manager = gtksourceview2.language_manager_get_default()
if hasattr(lang_manager, 'list_languages'): # again, handle different APIs
langs = lang_manager.list_languages()
else:
lang_ids = lang_manager.get_language_ids()
langs = [lang_manager.get_language(lang_id)
for lang_id in lang_ids]
for lang in langs:
for m in lang.get_mime_types():
if m == mime_type: # <-- this is the mime type you want
buffer.set_language(lang)

# Establecemos el objeto para la vista, usarlo como gtk.TextView
view = gtksourceview2.View(buffer)
view.set_size_request(300, 450)
view.set_editable(True)
view.set_cursor_visible(True)
view.set_show_line_numbers(True)
view.set_wrap_mode(gtk.WRAP_CHAR)
view.set_right_margin_position(80)
#view.set_highlight_current_line(True) #FIXME: Ugly color
view.set_auto_indent(True)
view.modify_font(pango.FontDescription("Monospace " +
str(style.FONT_SIZE)))
...

</pre>

Para agregar texto al buffer:
<pre>
buffer.set_text(text)
</pre>
Para obtener todo el texto:
<pre>
text = buffer.get_text(buffer.get_start_iter(), buffer.get_end_iter())
</pre>

Probablemente quieras poner la view(vista) en un gtk.ScrolledWindow
<pre>
sw = gtk.ScrolledWindow()
sw.add(view)
sw.set_policy(gtk.POLICY_AUTOMATIC, gtk.POLICY_AUTOMATIC)
</pre>
y agregar el el objeto sw en vez de la view(vista).

Puedes encotnrar más en el código fuete de Pippyy en jarabe.view.sourceview.

== Audio y Video ==
* [[Development Team/Almanac/GStreamer|GStreamer]]

== Ratón ==
=== ¿Cómo puedo cambiar el cursor del ratón por el cursor de espera en mi actividad? ===
En la subclase de tu actividad:

<pre>
self.window.set_cursor( gtk.gdk.Cursor(gtk.gdk.WATCH) )
</pre>

y para volver al que está por defecto:

<pre>
self.window.set_cursor( None );
</pre>

=== ¿Cómo puedo rastrear la posición del ratón? ===
Existen varias razones por las que te puede interesar controlar la posición del ratón, que van desde el entretenimiento ([[http://en.wikipedia.org/wiki/Xeyes]]) a lo funcional (ocultar ciertas ventanas cuando el ratón no se ha movido por un par de segundos y volver a hacer aparecer esos elementos cuando este se mueva nuevamente). Esta es una manera en la cual se puede implementar esta funcionalidad:
<pre>

...
self.hideWidgetsTime = time.time()
self.mx = -1
self.my = -1
self.HIDE_WIDGET_TIMEOUT_ID = gobject.timeout_add( 500, self.mouseMightHaveMovedCb )

def _mouseMightHaveMovedCb( self ):
x, y = self.get_pointer()
passedTime = 0

if (x != self.mx or y != self.my):
self.hideWidgetsTime = time.time()
if (self.hiddenWidgets):
self.showWidgets()
self.hiddenWidgets = False
else:
passedTime = time.time() - self.hideWidgetsTime

if (passedTime >= 3):
if (not self.hiddenWidgets):
self.hideWidgets()
self.hiddenWidgets = True

self.mx = x
self.my = y
return True

</pre>

== Varios ==

Las tareas que aparecen más abajo son técnicas útiles que he encontrado mientras escribía código y documentación para esta referencia. No ha sido categorizadas aún.

=== ¿Cómo se si mi actividad está "activa" o no? ===

Puedes configurar un evento usando la constante VISIBILITY_NOTIFY_MASK para saber cuando se cambia la visibilidad. Luego en el callback para este evento lo que debes hacer es comprar el estado del evento con las variables gtk definidas para la visibilidad de tu actividad. Puedes ver [http://www.pygtk.org/docs/pygtk/gdk-constants.html#gdk-visibility-state-constants la sección de Constantes de Estado de Visibilidad de GDK] gtk.gdk.Constants para más información.

<pre>
# Notify when the visibility state changes by calling self.__visibility_notify_cb
# (PUT THIS IN YOUR ACTIVITY CODE - EG. THE __init__() METHOD)
self.add_events(gtk.gdk.VISIBILITY_NOTIFY_MASK)
self.connect("visibility-notify-event", self.__visibility_notify_cb)
...
# Callback method for when the activity's visibility changes
def __visibility_notify_cb(self, window, event):
if event.state == gtk.gdk.VISIBILITY_FULLY_OBSCURED:
print "I am not visible"
elif event.state in [gtk.gdk.VISIBILITY_UNOBSCURED, gtk.gdk.VISIBILITY_PARTIAL]:
print "I am visible"
</pre>

=== How do I get the amount of free space available on disk under the /home directory tree? ===
The following function uses the [http://docs.python.org/lib/module-statvfs.html statvfs] module. The following code demonstrates how to get the total amount of free space under /home.

<pre>
#### Method: getFreespaceKb, returns the available freespace in kilobytes.
def getFreespaceKb(self):
stat = os.statvfs("/home")
freebytes = stat[statvfs.F_BSIZE] * stat[statvfs.F_BAVAIL]
freekb = freebytes / 1024
return freekb
</pre>

Note, however, that assuming anything about "/home" is a bad idea, better use os.environ['HOME'] instead. Rainbow will put your actual files elsewhere,
some on ramdisks, some on flash. Be clear about which filesystem's free space you actually care about.

=== How do I know whether my activity is running on a physical XO? ===
Sugar runs on ordinary computers as well as on XO's. While your activity is typically going to be run on a real XO, some people will indeed run it elsewhere. Normally you shouldn't write your activity to care whether it's on an XO or not. If for some odd reason, you need to care, the easiest way to tell if you are on a physical XO is to check whether /sys/power/olpc-pm, an essential power management file for the XO, exists. <ref>[http://lists.laptop.org/pipermail/devel/2008-June/015923.html reliably detecting if running on an XO]</ref> <ref>OLPC [[olpc:Power Management Interface]]</ref>

<pre>
import os
...
#Print out a boolean value that tells us whether we are on an XO or not.
print os.path.exists('/sys/power/olpc-pm')
</pre>

=== How do I know the current language setting on my XO? ===
The system variable 'LANG' tells you which language is currently active on the XO. The following code shows how to look at the value of this variable.

<pre>
import os
...
_logger.debug(os.environ['LANG'])
</pre>

=== How do I repeatedly call a specific method after N number of seconds? ===
The gobject.timeout_add() function allows you to invoke a callback method after a certain amount of time. If you want to repeatedly call a method, simply keep invoking the gobject.timeout_add function in your callback itself. The code below is a simple example, where the callback function is named repeatedly_call. Note that the timing of the callbacks are approximate. To get the process going, you should make an initial call to repeatedly_call() somewhere in your code.

You can see a more substantive example of this pattern in use when we [[olpc:Pango#How_do_I_dynamically_set_the_text_in_a_pango_layout.3F | regularly update the time displayed on a pango layout object]].

<pre>

#This method calls itself ROUGHLY every 1 second
def repeatedly_call(self):
now = datetime.datetime.now()
gobject.timeout_add(self.repeat_period_msec, self.repeatedly_update_time)
</pre>

=== How do I update the current build version of code that is running on my XO? ===

There are several pages that give you instructions on how to install/update your current build.

* If you already have a working build installed and an internet connection, first try [[olpc:olpc-update]].
* If that doesn't work, you can look at instructions for an [[olpc:Activated upgrade]] that can be done via USB] boot.

As the instructions on the pages linked above note, make sure to install your activities separately after you have upgraded to a specific base build.

=== I am developing on an XO laptop, but my keyboard and language settings are not ideal. How can I change them? ===

Internationalized laptops will often have settings that might slow you down while developing. To change around the language settings so you can better understand environment messages, use the [[olpc:Sugar Control Panel]]

Keyboard settings on internationalized laptops<ref>[[olpc:Keyboard layouts#OLPC keyboard layouts]]</ref> can also be suboptimal, especially as characters like "-" and "/" are in unfamiliar positions. You can use the <tt>setxkbmap</tt> command in the [[olpc:Terminal Activity]] to reset the type of keyboard input used and then attach a standard U.S. keyboard that will allow you to type normally. The command below sets the keyboard to the US mapping (it will reset to the default internationalized mapping upon restart).

setxkbmap us

=== My Python activity wants to use threads; how do I do that? ===

A question that has been answered with limited success is which threading patterns are most appropriate for use in Sugar. The following pattern of code to work fine in basic instances:

<pre>
#### Method: __init__, initialize this AnnotateActivity instance
def __init__(self, handle):
...
self.sample_thread = Thread(target=self.announce_thread, args=())
self.sample_thread.setDaemon(0)
self.sample_thread.start()
...

def announce_thread(self):
while (self.Running):
time.sleep(1)
print "thread running"
self._update_chat_text("Thread", "In here")
</pre>

This is the basic series of steps that most online documentation on python suggests to use when trying to work with threads in python. The problem is that it is unclear how this pattern relates to code that worked in the SimCity activity:

<pre>
import gobject
gobject.threads_init()
#import dbus.mainloop.glib
#dbus.mainloop.glib.threads_init()
</pre>

It should be noted that in the SimCity activity the pygame sound player would not produce sound reliably unless this setup was done.



Should the two patterns always be used in tandem? It seems that the latter code is mainly to initiate gobject and other libraries to work with threading, but it is unclear what restrictions there are with using threading with these libraries. Does one take precedence over the other? It is not clear if there is any problem with using the standard python threading code on the sugar technology stack.





In fact, experiments with threading on sugar leads to several different problems. For one thing, thread termination was tricky - using the can_close() method for sugar activities to terminate an activity only killed threads in some circumstances. It did not properly handle terminating threads in the case of CTRL-C or terminal interrupts. You can try to catch signals (SIGINT, SIGTERM or SIGHUP), but you will still be running in to errors in terminating child threads using these as well.





Another set of errors with threading comes up when trying to combine with stream tubes. The bottom line is that it is unclear what the scope of threading in a Sugar activity should be - should it simply work if you do the standard python threading pattern, is the use of the glib.threads_init and gobject.threads_init calls necessary, are there other interactions with threads and dbus that need to be accounted for? With more clarity from sugar developers on how the platform envisions threading to work in an activity, we can be more comfortable writing entries in the Almanac to help developers write error-free code.



=== How do I customize the title that is displayed for each instance of my activity? ===

By default, activity titles are just the generic activity names that you specify in your activity.info file. In some applications, you may want the activity title to be more dynamic.

For example, it makes sense to set the title for different browser sessions to the active web page being visited. That way, when you look back in the journal at the different browser sessions you have run in the previous few days, you can identify unique sessions based on the website you happened to be visiting at the time.

The code below shows how you can set the metadata for your activity to reflect a dynamic title based on whatever session criteria you feel is important. This example is adapted from the Browse activity, which sets activity instance titles based on the title of the current web page being visited.

<pre>
if self.metadata['mime_type'] == 'text/plain':
if not self._jobject.metadata['title_set_by_user'] == '1':
if self._browser.props.title:
# Set the title of this activity to be the current
# title of the page being visited by the browser.
self.metadata['title'] = self._browser.props.title
</pre>

=== What packages are available on sugar to support game development? ===

If your activity will require tools that are typically needed to develop robust and clean video games, then you should utilize the [http://www.pygame.org/ pygame package]. It can be readily imported into any activity:

<pre>
import pygame
...
</pre>

=== How do I detect when one of the game buttons on the laptop have been pressed? ===

The laptop game buttons (the circle, square, x, and check buttons next to the LCD) are encoded as page up, home, page down and end respectively. So, you can detect their press by listening for these specific events. For example, the code below listens for button presses and then just writes to an output widget which button was pressed.

<pre>
...
#### Initialize this activity.
def __init__(self, handle):
...
self.connect('key-press-event', self._keyPressCb)
...

#### Method _keyPressCb, which catches any presses of the game buttons.
def _keyPressCb(self, widget, event):

keyname = gtk.gdk.keyval_name(event.keyval)

if (keyname == 'KP_Page_Up'):
self._chat += "\nCircle Pressed!"
self._chat_buffer.set_text(self._chat)
elif (keyname == 'KP_Page_Down'):
self._chat += "\nX Pressed!"
self._chat_buffer.set_text(self._chat)
elif (keyname == 'KP_Home'):
self._chat += "\nSquare Pressed!"
self._chat_buffer.set_text(self._chat)
elif (keyname == 'KP_End'):
self._chat += "\nCheck Pressed!"
self._chat_buffer.set_text(self._chat)

return False
</pre>

=== How do I detect if one of the joystick buttons has been pressed? ===

This is the same process as detecting game buttons, except with different names for the keys. Again, you listen for "key-press-event" signals and then in your callback you check to see if the pressed button was one of the joystick keys.

<pre>
#### Initialize this activity.
def __init__(self, handle):
...
self.connect('key-press-event', self._keyPressCb)
...

#### Method _keyPressCb, which catches any presses of the game buttons.
def _keyPressCb(self, widget, event):

keyname = gtk.gdk.keyval_name(event.keyval)

if (keyname == 'KP_Up'):
self._chat += "\nUp Pressed!"
self._chat_buffer.set_text(self._chat)
elif (keyname == 'KP_Down'):
self._chat += "\nDown Pressed!"
self._chat_buffer.set_text(self._chat)
elif (keyname == 'KP_Left'):
self._chat += "\nLeft Pressed!"
self._chat_buffer.set_text(self._chat)
elif (keyname == 'KP_Right'):
self._chat += "\nRight Pressed!"
self._chat_buffer.set_text(self._chat)

return False
</pre>

=== How do i remove an specific button from the toolbar? ===

This is an example of the share button is removed:

<pre>
activity_toolbar = toolbox.get_activity_toolbar()
activity_toolbar.remove(activity_toolbar.share)
activity_toolbar.share = None
</pre>

== Notes ==
<references />

[[Category:Documentation]]
[[Category:Development Team]]

Development Team/Almanac/lang-es

2009-08-31T16:21:11Z

Fede: /* Mouse */

{{translation
| source = Development_Team/Almanac
| lang = es
| status = {{translation/incomplete/}}
}}

{{Almanac}}
{{Almanac TOC}}
== ¿Cómo puedo obtener ayuda adicional más allá de este almanaque? ==
* ¿Quieres comenzar con los básico del desarrollo para Sugar? Puedes visitar el [http://wiki.sugarlabs.org/images/5/51/Activity_Handbook_200805_online.pdf Activity Handbook] de OLPC Austria (''Ten en cuenta que este manual fue actualizado por última vez en mayo del 2008, las capturas de tienen el diseño pre-8.2. En términos de código en sí, las cosas deberían funcionar como están descriptas. Si encuentra algún problema por favor póngase en contacto con [[User:ChristophD|ChristophD]].'')
* Ver también [[Development Team/Almanac/Code Snippets]]

Ahora, vamos con el almanaque actual...

== ¿Dónde puedo ver los cambios de la API? ==
API changes between OLPC releases can be seen here: [[Development Team/Almanac/API Changes|API Changes]]

== Comenzando ==
=== ¿Cómo estructuro mis archivos para que sean una actividad de válido en Sugar? ===
Puedes encontrar información sobre la estructura de la actividad aquí: [[Development Team/Almanac/Activity Bundles|Activity Bundles]]

=== ¿Cómo puedo hacer un icono para mi actividad? ===
La información sobre lo que debe hacer se puede encontrar aquí: [[Development Team/Almanac/Making Icons|Making Icons]]

== Paquete: sugar ==
* [[Development Team/Almanac/sugar.env|sugar.env]]
* [[Development Team/Almanac/sugar.profile|sugar.profile]]
* [[Development Team/Almanac/sugar.mime|sugar.mime]]
* [[Development Team/Almanac/sugar.logger|sugar.logger]]

== Paquete: sugar.activity ==
* [[Development Team/Almanac/sugar.activity.activity|sugar.activity.activity]]
* [[Development Team/Almanac/sugar.activity.activityfactory|sugar.activity.activityfactory]]
* [[Development Team/Almanac/sugar.activity.registry|sugar.activity.registry]]

== Paquete: sugar.datastore ==
* [[Development Team/Almanac/sugar.datastore.datastore|sugar.datastore.datastore]]

== Paquete: sugar.graphics ==
* [[Development Team/Almanac/sugar.graphics.alert|sugar.graphics.alert]]
* [[Development Team/Almanac/sugar.graphics.icon|sugar.graphics.icon]]
* [[Development Team/Almanac/sugar.graphics.notebook|sugar.graphics.notebook]]
* [[Development Team/Almanac/sugar.graphics.toolbutton|sugar.graphics.toolbutton]]
* [[Development Team/Almanac/sugar.graphics.toolbox|sugar.graphics.toolbox]]
* [[Development Team/Almanac/sugar.graphics.style|sugar.graphics.style]]

== Paquete: sugar.presence ==
* [[Development Team/Almanac/Sugar.presence|Sugar.presence]]
* [[Development Team/Almanac/Sugar.presence.activity|Sugar.presence.activity]]
* [[Development Team/Almanac/Sugar.presence.buddy|Sugar.presence.buddy]]
* [[Development Team/Almanac/Sugar.presence.presenceservice|Sugar.presence.presenceservice]]

== Clipboard ==
* Notas sobre el uso del [[Development Team/Almanac/GTK's Clipboard Module|módulo Clipboard de GTK ]]

== Logging ==
* [[Development Team/Almanac/sugar.logger|sugar.logger]]
* Notas sobre el uso del [[Development Team/Almanac/Python Standard Logging|standard de Logging en Python]]

== Internacionalización ==
*[[Development Team/Almanac/Internationalization|Internationalization]]

== Texto y gráficos para las actividades de Sugar ==
* [[Development Team/Almanac/Pango|Pango]]
=== ¿Cómo puedo crear un cuadro de texto para la edición de código? ===
Puedes usar gtksourceview2
<pre>
import gtk
import gtksourceview2
from sugar.graphics import style

...

# Configuramos el buffer
buffer = gtksourceview2.Buffer()
if hasattr(buffer, 'set_highlight'): # handle different API versions
buffer.set_highlight(True)
else:
buffer.set_highlight_syntax(True)

# Configuramos el tipo MIME para el buffer
lang_manager = gtksourceview2.language_manager_get_default()
if hasattr(lang_manager, 'list_languages'): # again, handle different APIs
langs = lang_manager.list_languages()
else:
lang_ids = lang_manager.get_language_ids()
langs = [lang_manager.get_language(lang_id)
for lang_id in lang_ids]
for lang in langs:
for m in lang.get_mime_types():
if m == mime_type: # <-- this is the mime type you want
buffer.set_language(lang)

# Establecemos el objeto para la vista, usarlo como gtk.TextView
view = gtksourceview2.View(buffer)
view.set_size_request(300, 450)
view.set_editable(True)
view.set_cursor_visible(True)
view.set_show_line_numbers(True)
view.set_wrap_mode(gtk.WRAP_CHAR)
view.set_right_margin_position(80)
#view.set_highlight_current_line(True) #FIXME: Ugly color
view.set_auto_indent(True)
view.modify_font(pango.FontDescription("Monospace " +
str(style.FONT_SIZE)))
...

</pre>

Para agregar texto al buffer:
<pre>
buffer.set_text(text)
</pre>
Para obtener todo el texto:
<pre>
text = buffer.get_text(buffer.get_start_iter(), buffer.get_end_iter())
</pre>

Probablemente quieras poner la view(vista) en un gtk.ScrolledWindow
<pre>
sw = gtk.ScrolledWindow()
sw.add(view)
sw.set_policy(gtk.POLICY_AUTOMATIC, gtk.POLICY_AUTOMATIC)
</pre>
y agregar el el objeto sw en vez de la view(vista).

Puedes encotnrar más en el código fuete de Pippyy en jarabe.view.sourceview.

== Audio y Video ==
* [[Development Team/Almanac/GStreamer|GStreamer]]

== Ratón ==
=== ¿Cómo puedo cambiar el cursor del ratón por el cursor de espera en mi actividad? ===
En la subclase de tu actividad:

<pre>
self.window.set_cursor( gtk.gdk.Cursor(gtk.gdk.WATCH) )
</pre>

y para volver al que está por defecto:

<pre>
self.window.set_cursor( None );
</pre>

=== ¿Cómo puedo rastrear la posición del ratón? ===
Existen varias razones por las que te puede interesar controlar la posición del ratón, que van desde el entretenimiento ([[http://en.wikipedia.org/wiki/Xeyes]]) a lo funcional (ocultar ciertas ventanas cuando el ratón no se ha movido por un par de segundos y volver a hacer aparecer esos elementos cuando este se mueva nuevamente). Esta es una manera en la cual se puede implementar esta funcionalidad:
<pre>

...
self.hideWidgetsTime = time.time()
self.mx = -1
self.my = -1
self.HIDE_WIDGET_TIMEOUT_ID = gobject.timeout_add( 500, self.mouseMightHaveMovedCb )

def _mouseMightHaveMovedCb( self ):
x, y = self.get_pointer()
passedTime = 0

if (x != self.mx or y != self.my):
self.hideWidgetsTime = time.time()
if (self.hiddenWidgets):
self.showWidgets()
self.hiddenWidgets = False
else:
passedTime = time.time() - self.hideWidgetsTime

if (passedTime >= 3):
if (not self.hiddenWidgets):
self.hideWidgets()
self.hiddenWidgets = True

self.mx = x
self.my = y
return True

</pre>

== Miscellaneous==

The tasks below are random useful techniques that have come up as I write code and documentation for this reference. They have yet to be categorized, but will be as a sufficient set of related entries are written.

=== How do I know when my activity is "active" or not? ===

You can set an event using the VISIBILITY_NOTIFY_MASK constant in order to know when your activity changes visibility. Then in the callback for this event, you simply compare the event's state to gtk-defined variables for activity visibility. See the [http://www.pygtk.org/docs/pygtk/gdk-constants.html#gdk-visibility-state-constants GDK Visibility State Constants] section of gtk.gdk.Constants for more information.

<pre>
# Notify when the visibility state changes by calling self.__visibility_notify_cb
# (PUT THIS IN YOUR ACTIVITY CODE - EG. THE __init__() METHOD)
self.add_events(gtk.gdk.VISIBILITY_NOTIFY_MASK)
self.connect("visibility-notify-event", self.__visibility_notify_cb)
...
# Callback method for when the activity's visibility changes
def __visibility_notify_cb(self, window, event):
if event.state == gtk.gdk.VISIBILITY_FULLY_OBSCURED:
print "I am not visible"
elif event.state in [gtk.gdk.VISIBILITY_UNOBSCURED, gtk.gdk.VISIBILITY_PARTIAL]:
print "I am visible"
</pre>

=== How do I get the amount of free space available on disk under the /home directory tree? ===
The following function uses the [http://docs.python.org/lib/module-statvfs.html statvfs] module. The following code demonstrates how to get the total amount of free space under /home.

<pre>
#### Method: getFreespaceKb, returns the available freespace in kilobytes.
def getFreespaceKb(self):
stat = os.statvfs("/home")
freebytes = stat[statvfs.F_BSIZE] * stat[statvfs.F_BAVAIL]
freekb = freebytes / 1024
return freekb
</pre>

Note, however, that assuming anything about "/home" is a bad idea, better use os.environ['HOME'] instead. Rainbow will put your actual files elsewhere,
some on ramdisks, some on flash. Be clear about which filesystem's free space you actually care about.

=== How do I know whether my activity is running on a physical XO? ===
Sugar runs on ordinary computers as well as on XO's. While your activity is typically going to be run on a real XO, some people will indeed run it elsewhere. Normally you shouldn't write your activity to care whether it's on an XO or not. If for some odd reason, you need to care, the easiest way to tell if you are on a physical XO is to check whether /sys/power/olpc-pm, an essential power management file for the XO, exists. <ref>[http://lists.laptop.org/pipermail/devel/2008-June/015923.html reliably detecting if running on an XO]</ref> <ref>OLPC [[olpc:Power Management Interface]]</ref>

<pre>
import os
...
#Print out a boolean value that tells us whether we are on an XO or not.
print os.path.exists('/sys/power/olpc-pm')
</pre>

=== How do I know the current language setting on my XO? ===
The system variable 'LANG' tells you which language is currently active on the XO. The following code shows how to look at the value of this variable.

<pre>
import os
...
_logger.debug(os.environ['LANG'])
</pre>

=== How do I repeatedly call a specific method after N number of seconds? ===
The gobject.timeout_add() function allows you to invoke a callback method after a certain amount of time. If you want to repeatedly call a method, simply keep invoking the gobject.timeout_add function in your callback itself. The code below is a simple example, where the callback function is named repeatedly_call. Note that the timing of the callbacks are approximate. To get the process going, you should make an initial call to repeatedly_call() somewhere in your code.

You can see a more substantive example of this pattern in use when we [[olpc:Pango#How_do_I_dynamically_set_the_text_in_a_pango_layout.3F | regularly update the time displayed on a pango layout object]].

<pre>

#This method calls itself ROUGHLY every 1 second
def repeatedly_call(self):
now = datetime.datetime.now()
gobject.timeout_add(self.repeat_period_msec, self.repeatedly_update_time)
</pre>

=== How do I update the current build version of code that is running on my XO? ===

There are several pages that give you instructions on how to install/update your current build.

* If you already have a working build installed and an internet connection, first try [[olpc:olpc-update]].
* If that doesn't work, you can look at instructions for an [[olpc:Activated upgrade]] that can be done via USB] boot.

As the instructions on the pages linked above note, make sure to install your activities separately after you have upgraded to a specific base build.

=== I am developing on an XO laptop, but my keyboard and language settings are not ideal. How can I change them? ===

Internationalized laptops will often have settings that might slow you down while developing. To change around the language settings so you can better understand environment messages, use the [[olpc:Sugar Control Panel]]

Keyboard settings on internationalized laptops<ref>[[olpc:Keyboard layouts#OLPC keyboard layouts]]</ref> can also be suboptimal, especially as characters like "-" and "/" are in unfamiliar positions. You can use the <tt>setxkbmap</tt> command in the [[olpc:Terminal Activity]] to reset the type of keyboard input used and then attach a standard U.S. keyboard that will allow you to type normally. The command below sets the keyboard to the US mapping (it will reset to the default internationalized mapping upon restart).

setxkbmap us

=== My Python activity wants to use threads; how do I do that? ===

A question that has been answered with limited success is which threading patterns are most appropriate for use in Sugar. The following pattern of code to work fine in basic instances:

<pre>
#### Method: __init__, initialize this AnnotateActivity instance
def __init__(self, handle):
...
self.sample_thread = Thread(target=self.announce_thread, args=())
self.sample_thread.setDaemon(0)
self.sample_thread.start()
...

def announce_thread(self):
while (self.Running):
time.sleep(1)
print "thread running"
self._update_chat_text("Thread", "In here")
</pre>

This is the basic series of steps that most online documentation on python suggests to use when trying to work with threads in python. The problem is that it is unclear how this pattern relates to code that worked in the SimCity activity:

<pre>
import gobject
gobject.threads_init()
#import dbus.mainloop.glib
#dbus.mainloop.glib.threads_init()
</pre>

It should be noted that in the SimCity activity the pygame sound player would not produce sound reliably unless this setup was done.



Should the two patterns always be used in tandem? It seems that the latter code is mainly to initiate gobject and other libraries to work with threading, but it is unclear what restrictions there are with using threading with these libraries. Does one take precedence over the other? It is not clear if there is any problem with using the standard python threading code on the sugar technology stack.





In fact, experiments with threading on sugar leads to several different problems. For one thing, thread termination was tricky - using the can_close() method for sugar activities to terminate an activity only killed threads in some circumstances. It did not properly handle terminating threads in the case of CTRL-C or terminal interrupts. You can try to catch signals (SIGINT, SIGTERM or SIGHUP), but you will still be running in to errors in terminating child threads using these as well.





Another set of errors with threading comes up when trying to combine with stream tubes. The bottom line is that it is unclear what the scope of threading in a Sugar activity should be - should it simply work if you do the standard python threading pattern, is the use of the glib.threads_init and gobject.threads_init calls necessary, are there other interactions with threads and dbus that need to be accounted for? With more clarity from sugar developers on how the platform envisions threading to work in an activity, we can be more comfortable writing entries in the Almanac to help developers write error-free code.



=== How do I customize the title that is displayed for each instance of my activity? ===

By default, activity titles are just the generic activity names that you specify in your activity.info file. In some applications, you may want the activity title to be more dynamic.

For example, it makes sense to set the title for different browser sessions to the active web page being visited. That way, when you look back in the journal at the different browser sessions you have run in the previous few days, you can identify unique sessions based on the website you happened to be visiting at the time.

The code below shows how you can set the metadata for your activity to reflect a dynamic title based on whatever session criteria you feel is important. This example is adapted from the Browse activity, which sets activity instance titles based on the title of the current web page being visited.

<pre>
if self.metadata['mime_type'] == 'text/plain':
if not self._jobject.metadata['title_set_by_user'] == '1':
if self._browser.props.title:
# Set the title of this activity to be the current
# title of the page being visited by the browser.
self.metadata['title'] = self._browser.props.title
</pre>

=== What packages are available on sugar to support game development? ===

If your activity will require tools that are typically needed to develop robust and clean video games, then you should utilize the [http://www.pygame.org/ pygame package]. It can be readily imported into any activity:

<pre>
import pygame
...
</pre>

=== How do I detect when one of the game buttons on the laptop have been pressed? ===

The laptop game buttons (the circle, square, x, and check buttons next to the LCD) are encoded as page up, home, page down and end respectively. So, you can detect their press by listening for these specific events. For example, the code below listens for button presses and then just writes to an output widget which button was pressed.

<pre>
...
#### Initialize this activity.
def __init__(self, handle):
...
self.connect('key-press-event', self._keyPressCb)
...

#### Method _keyPressCb, which catches any presses of the game buttons.
def _keyPressCb(self, widget, event):

keyname = gtk.gdk.keyval_name(event.keyval)

if (keyname == 'KP_Page_Up'):
self._chat += "\nCircle Pressed!"
self._chat_buffer.set_text(self._chat)
elif (keyname == 'KP_Page_Down'):
self._chat += "\nX Pressed!"
self._chat_buffer.set_text(self._chat)
elif (keyname == 'KP_Home'):
self._chat += "\nSquare Pressed!"
self._chat_buffer.set_text(self._chat)
elif (keyname == 'KP_End'):
self._chat += "\nCheck Pressed!"
self._chat_buffer.set_text(self._chat)

return False
</pre>

=== How do I detect if one of the joystick buttons has been pressed? ===

This is the same process as detecting game buttons, except with different names for the keys. Again, you listen for "key-press-event" signals and then in your callback you check to see if the pressed button was one of the joystick keys.

<pre>
#### Initialize this activity.
def __init__(self, handle):
...
self.connect('key-press-event', self._keyPressCb)
...

#### Method _keyPressCb, which catches any presses of the game buttons.
def _keyPressCb(self, widget, event):

keyname = gtk.gdk.keyval_name(event.keyval)

if (keyname == 'KP_Up'):
self._chat += "\nUp Pressed!"
self._chat_buffer.set_text(self._chat)
elif (keyname == 'KP_Down'):
self._chat += "\nDown Pressed!"
self._chat_buffer.set_text(self._chat)
elif (keyname == 'KP_Left'):
self._chat += "\nLeft Pressed!"
self._chat_buffer.set_text(self._chat)
elif (keyname == 'KP_Right'):
self._chat += "\nRight Pressed!"
self._chat_buffer.set_text(self._chat)

return False
</pre>

=== How do i remove an specific button from the toolbar? ===

This is an example of the share button is removed:

<pre>
activity_toolbar = toolbox.get_activity_toolbar()
activity_toolbar.remove(activity_toolbar.share)
activity_toolbar.share = None
</pre>

== Notes ==
<references />

[[Category:Documentation]]
[[Category:Development Team]]

Development Team/Almanac/lang-es

2009-08-31T16:16:05Z

Fede: /* Audio & Video */

{{translation
| source = Development_Team/Almanac
| lang = es
| status = {{translation/incomplete/}}
}}

{{Almanac}}
{{Almanac TOC}}
== ¿Cómo puedo obtener ayuda adicional más allá de este almanaque? ==
* ¿Quieres comenzar con los básico del desarrollo para Sugar? Puedes visitar el [http://wiki.sugarlabs.org/images/5/51/Activity_Handbook_200805_online.pdf Activity Handbook] de OLPC Austria (''Ten en cuenta que este manual fue actualizado por última vez en mayo del 2008, las capturas de tienen el diseño pre-8.2. En términos de código en sí, las cosas deberían funcionar como están descriptas. Si encuentra algún problema por favor póngase en contacto con [[User:ChristophD|ChristophD]].'')
* Ver también [[Development Team/Almanac/Code Snippets]]

Ahora, vamos con el almanaque actual...

== ¿Dónde puedo ver los cambios de la API? ==
API changes between OLPC releases can be seen here: [[Development Team/Almanac/API Changes|API Changes]]

== Comenzando ==
=== ¿Cómo estructuro mis archivos para que sean una actividad de válido en Sugar? ===
Puedes encontrar información sobre la estructura de la actividad aquí: [[Development Team/Almanac/Activity Bundles|Activity Bundles]]

=== ¿Cómo puedo hacer un icono para mi actividad? ===
La información sobre lo que debe hacer se puede encontrar aquí: [[Development Team/Almanac/Making Icons|Making Icons]]

== Paquete: sugar ==
* [[Development Team/Almanac/sugar.env|sugar.env]]
* [[Development Team/Almanac/sugar.profile|sugar.profile]]
* [[Development Team/Almanac/sugar.mime|sugar.mime]]
* [[Development Team/Almanac/sugar.logger|sugar.logger]]

== Paquete: sugar.activity ==
* [[Development Team/Almanac/sugar.activity.activity|sugar.activity.activity]]
* [[Development Team/Almanac/sugar.activity.activityfactory|sugar.activity.activityfactory]]
* [[Development Team/Almanac/sugar.activity.registry|sugar.activity.registry]]

== Paquete: sugar.datastore ==
* [[Development Team/Almanac/sugar.datastore.datastore|sugar.datastore.datastore]]

== Paquete: sugar.graphics ==
* [[Development Team/Almanac/sugar.graphics.alert|sugar.graphics.alert]]
* [[Development Team/Almanac/sugar.graphics.icon|sugar.graphics.icon]]
* [[Development Team/Almanac/sugar.graphics.notebook|sugar.graphics.notebook]]
* [[Development Team/Almanac/sugar.graphics.toolbutton|sugar.graphics.toolbutton]]
* [[Development Team/Almanac/sugar.graphics.toolbox|sugar.graphics.toolbox]]
* [[Development Team/Almanac/sugar.graphics.style|sugar.graphics.style]]

== Paquete: sugar.presence ==
* [[Development Team/Almanac/Sugar.presence|Sugar.presence]]
* [[Development Team/Almanac/Sugar.presence.activity|Sugar.presence.activity]]
* [[Development Team/Almanac/Sugar.presence.buddy|Sugar.presence.buddy]]
* [[Development Team/Almanac/Sugar.presence.presenceservice|Sugar.presence.presenceservice]]

== Clipboard ==
* Notas sobre el uso del [[Development Team/Almanac/GTK's Clipboard Module|módulo Clipboard de GTK ]]

== Logging ==
* [[Development Team/Almanac/sugar.logger|sugar.logger]]
* Notas sobre el uso del [[Development Team/Almanac/Python Standard Logging|standard de Logging en Python]]

== Internacionalización ==
*[[Development Team/Almanac/Internationalization|Internationalization]]

== Texto y gráficos para las actividades de Sugar ==
* [[Development Team/Almanac/Pango|Pango]]
=== ¿Cómo puedo crear un cuadro de texto para la edición de código? ===
Puedes usar gtksourceview2
<pre>
import gtk
import gtksourceview2
from sugar.graphics import style

...

# Configuramos el buffer
buffer = gtksourceview2.Buffer()
if hasattr(buffer, 'set_highlight'): # handle different API versions
buffer.set_highlight(True)
else:
buffer.set_highlight_syntax(True)

# Configuramos el tipo MIME para el buffer
lang_manager = gtksourceview2.language_manager_get_default()
if hasattr(lang_manager, 'list_languages'): # again, handle different APIs
langs = lang_manager.list_languages()
else:
lang_ids = lang_manager.get_language_ids()
langs = [lang_manager.get_language(lang_id)
for lang_id in lang_ids]
for lang in langs:
for m in lang.get_mime_types():
if m == mime_type: # <-- this is the mime type you want
buffer.set_language(lang)

# Establecemos el objeto para la vista, usarlo como gtk.TextView
view = gtksourceview2.View(buffer)
view.set_size_request(300, 450)
view.set_editable(True)
view.set_cursor_visible(True)
view.set_show_line_numbers(True)
view.set_wrap_mode(gtk.WRAP_CHAR)
view.set_right_margin_position(80)
#view.set_highlight_current_line(True) #FIXME: Ugly color
view.set_auto_indent(True)
view.modify_font(pango.FontDescription("Monospace " +
str(style.FONT_SIZE)))
...

</pre>

Para agregar texto al buffer:
<pre>
buffer.set_text(text)
</pre>
Para obtener todo el texto:
<pre>
text = buffer.get_text(buffer.get_start_iter(), buffer.get_end_iter())
</pre>

Probablemente quieras poner la view(vista) en un gtk.ScrolledWindow
<pre>
sw = gtk.ScrolledWindow()
sw.add(view)
sw.set_policy(gtk.POLICY_AUTOMATIC, gtk.POLICY_AUTOMATIC)
</pre>
y agregar el el objeto sw en vez de la view(vista).

Puedes encotnrar más en el código fuete de Pippyy en jarabe.view.sourceview.

== Audio y Video ==
* [[Development Team/Almanac/GStreamer|GStreamer]]

== Mouse ==
=== How do I change the mouse cursor in my activity to the wait cursor? ===
In your activity subclass:

<pre>
self.window.set_cursor( gtk.gdk.Cursor(gtk.gdk.WATCH) )
</pre>

and to switch it back to the default:

<pre>
self.window.set_cursor( None );
</pre>

=== How do I track the position of the mouse? ===
There are many different reasons you might want to track the position of the mouse in your activity, ranging from the entertaining ([[http://en.wikipedia.org/wiki/Xeyes]]) to the functional (hiding certain windows when the mouse hasn't moved for a couple of seconds and making those ui elements re-appear when the mouse has moved again). Here is one way you can implement this functionality:

<pre>

...
self.hideWidgetsTime = time.time()
self.mx = -1
self.my = -1
self.HIDE_WIDGET_TIMEOUT_ID = gobject.timeout_add( 500, self.mouseMightHaveMovedCb )

def _mouseMightHaveMovedCb( self ):
x, y = self.get_pointer()
passedTime = 0

if (x != self.mx or y != self.my):
self.hideWidgetsTime = time.time()
if (self.hiddenWidgets):
self.showWidgets()
self.hiddenWidgets = False
else:
passedTime = time.time() - self.hideWidgetsTime

if (passedTime >= 3):
if (not self.hiddenWidgets):
self.hideWidgets()
self.hiddenWidgets = True

self.mx = x
self.my = y
return True

</pre>

== Miscellaneous==

The tasks below are random useful techniques that have come up as I write code and documentation for this reference. They have yet to be categorized, but will be as a sufficient set of related entries are written.

=== How do I know when my activity is "active" or not? ===

You can set an event using the VISIBILITY_NOTIFY_MASK constant in order to know when your activity changes visibility. Then in the callback for this event, you simply compare the event's state to gtk-defined variables for activity visibility. See the [http://www.pygtk.org/docs/pygtk/gdk-constants.html#gdk-visibility-state-constants GDK Visibility State Constants] section of gtk.gdk.Constants for more information.

<pre>
# Notify when the visibility state changes by calling self.__visibility_notify_cb
# (PUT THIS IN YOUR ACTIVITY CODE - EG. THE __init__() METHOD)
self.add_events(gtk.gdk.VISIBILITY_NOTIFY_MASK)
self.connect("visibility-notify-event", self.__visibility_notify_cb)
...
# Callback method for when the activity's visibility changes
def __visibility_notify_cb(self, window, event):
if event.state == gtk.gdk.VISIBILITY_FULLY_OBSCURED:
print "I am not visible"
elif event.state in [gtk.gdk.VISIBILITY_UNOBSCURED, gtk.gdk.VISIBILITY_PARTIAL]:
print "I am visible"
</pre>

=== How do I get the amount of free space available on disk under the /home directory tree? ===
The following function uses the [http://docs.python.org/lib/module-statvfs.html statvfs] module. The following code demonstrates how to get the total amount of free space under /home.

<pre>
#### Method: getFreespaceKb, returns the available freespace in kilobytes.
def getFreespaceKb(self):
stat = os.statvfs("/home")
freebytes = stat[statvfs.F_BSIZE] * stat[statvfs.F_BAVAIL]
freekb = freebytes / 1024
return freekb
</pre>

Note, however, that assuming anything about "/home" is a bad idea, better use os.environ['HOME'] instead. Rainbow will put your actual files elsewhere,
some on ramdisks, some on flash. Be clear about which filesystem's free space you actually care about.

=== How do I know whether my activity is running on a physical XO? ===
Sugar runs on ordinary computers as well as on XO's. While your activity is typically going to be run on a real XO, some people will indeed run it elsewhere. Normally you shouldn't write your activity to care whether it's on an XO or not. If for some odd reason, you need to care, the easiest way to tell if you are on a physical XO is to check whether /sys/power/olpc-pm, an essential power management file for the XO, exists. <ref>[http://lists.laptop.org/pipermail/devel/2008-June/015923.html reliably detecting if running on an XO]</ref> <ref>OLPC [[olpc:Power Management Interface]]</ref>

<pre>
import os
...
#Print out a boolean value that tells us whether we are on an XO or not.
print os.path.exists('/sys/power/olpc-pm')
</pre>

=== How do I know the current language setting on my XO? ===
The system variable 'LANG' tells you which language is currently active on the XO. The following code shows how to look at the value of this variable.

<pre>
import os
...
_logger.debug(os.environ['LANG'])
</pre>

=== How do I repeatedly call a specific method after N number of seconds? ===
The gobject.timeout_add() function allows you to invoke a callback method after a certain amount of time. If you want to repeatedly call a method, simply keep invoking the gobject.timeout_add function in your callback itself. The code below is a simple example, where the callback function is named repeatedly_call. Note that the timing of the callbacks are approximate. To get the process going, you should make an initial call to repeatedly_call() somewhere in your code.

You can see a more substantive example of this pattern in use when we [[olpc:Pango#How_do_I_dynamically_set_the_text_in_a_pango_layout.3F | regularly update the time displayed on a pango layout object]].

<pre>

#This method calls itself ROUGHLY every 1 second
def repeatedly_call(self):
now = datetime.datetime.now()
gobject.timeout_add(self.repeat_period_msec, self.repeatedly_update_time)
</pre>

=== How do I update the current build version of code that is running on my XO? ===

There are several pages that give you instructions on how to install/update your current build.

* If you already have a working build installed and an internet connection, first try [[olpc:olpc-update]].
* If that doesn't work, you can look at instructions for an [[olpc:Activated upgrade]] that can be done via USB] boot.

As the instructions on the pages linked above note, make sure to install your activities separately after you have upgraded to a specific base build.

=== I am developing on an XO laptop, but my keyboard and language settings are not ideal. How can I change them? ===

Internationalized laptops will often have settings that might slow you down while developing. To change around the language settings so you can better understand environment messages, use the [[olpc:Sugar Control Panel]]

Keyboard settings on internationalized laptops<ref>[[olpc:Keyboard layouts#OLPC keyboard layouts]]</ref> can also be suboptimal, especially as characters like "-" and "/" are in unfamiliar positions. You can use the <tt>setxkbmap</tt> command in the [[olpc:Terminal Activity]] to reset the type of keyboard input used and then attach a standard U.S. keyboard that will allow you to type normally. The command below sets the keyboard to the US mapping (it will reset to the default internationalized mapping upon restart).

setxkbmap us

=== My Python activity wants to use threads; how do I do that? ===

A question that has been answered with limited success is which threading patterns are most appropriate for use in Sugar. The following pattern of code to work fine in basic instances:

<pre>
#### Method: __init__, initialize this AnnotateActivity instance
def __init__(self, handle):
...
self.sample_thread = Thread(target=self.announce_thread, args=())
self.sample_thread.setDaemon(0)
self.sample_thread.start()
...

def announce_thread(self):
while (self.Running):
time.sleep(1)
print "thread running"
self._update_chat_text("Thread", "In here")
</pre>

This is the basic series of steps that most online documentation on python suggests to use when trying to work with threads in python. The problem is that it is unclear how this pattern relates to code that worked in the SimCity activity:

<pre>
import gobject
gobject.threads_init()
#import dbus.mainloop.glib
#dbus.mainloop.glib.threads_init()
</pre>

It should be noted that in the SimCity activity the pygame sound player would not produce sound reliably unless this setup was done.



Should the two patterns always be used in tandem? It seems that the latter code is mainly to initiate gobject and other libraries to work with threading, but it is unclear what restrictions there are with using threading with these libraries. Does one take precedence over the other? It is not clear if there is any problem with using the standard python threading code on the sugar technology stack.





In fact, experiments with threading on sugar leads to several different problems. For one thing, thread termination was tricky - using the can_close() method for sugar activities to terminate an activity only killed threads in some circumstances. It did not properly handle terminating threads in the case of CTRL-C or terminal interrupts. You can try to catch signals (SIGINT, SIGTERM or SIGHUP), but you will still be running in to errors in terminating child threads using these as well.





Another set of errors with threading comes up when trying to combine with stream tubes. The bottom line is that it is unclear what the scope of threading in a Sugar activity should be - should it simply work if you do the standard python threading pattern, is the use of the glib.threads_init and gobject.threads_init calls necessary, are there other interactions with threads and dbus that need to be accounted for? With more clarity from sugar developers on how the platform envisions threading to work in an activity, we can be more comfortable writing entries in the Almanac to help developers write error-free code.



=== How do I customize the title that is displayed for each instance of my activity? ===

By default, activity titles are just the generic activity names that you specify in your activity.info file. In some applications, you may want the activity title to be more dynamic.

For example, it makes sense to set the title for different browser sessions to the active web page being visited. That way, when you look back in the journal at the different browser sessions you have run in the previous few days, you can identify unique sessions based on the website you happened to be visiting at the time.

The code below shows how you can set the metadata for your activity to reflect a dynamic title based on whatever session criteria you feel is important. This example is adapted from the Browse activity, which sets activity instance titles based on the title of the current web page being visited.

<pre>
if self.metadata['mime_type'] == 'text/plain':
if not self._jobject.metadata['title_set_by_user'] == '1':
if self._browser.props.title:
# Set the title of this activity to be the current
# title of the page being visited by the browser.
self.metadata['title'] = self._browser.props.title
</pre>

=== What packages are available on sugar to support game development? ===

If your activity will require tools that are typically needed to develop robust and clean video games, then you should utilize the [http://www.pygame.org/ pygame package]. It can be readily imported into any activity:

<pre>
import pygame
...
</pre>

=== How do I detect when one of the game buttons on the laptop have been pressed? ===

The laptop game buttons (the circle, square, x, and check buttons next to the LCD) are encoded as page up, home, page down and end respectively. So, you can detect their press by listening for these specific events. For example, the code below listens for button presses and then just writes to an output widget which button was pressed.

<pre>
...
#### Initialize this activity.
def __init__(self, handle):
...
self.connect('key-press-event', self._keyPressCb)
...

#### Method _keyPressCb, which catches any presses of the game buttons.
def _keyPressCb(self, widget, event):

keyname = gtk.gdk.keyval_name(event.keyval)

if (keyname == 'KP_Page_Up'):
self._chat += "\nCircle Pressed!"
self._chat_buffer.set_text(self._chat)
elif (keyname == 'KP_Page_Down'):
self._chat += "\nX Pressed!"
self._chat_buffer.set_text(self._chat)
elif (keyname == 'KP_Home'):
self._chat += "\nSquare Pressed!"
self._chat_buffer.set_text(self._chat)
elif (keyname == 'KP_End'):
self._chat += "\nCheck Pressed!"
self._chat_buffer.set_text(self._chat)

return False
</pre>

=== How do I detect if one of the joystick buttons has been pressed? ===

This is the same process as detecting game buttons, except with different names for the keys. Again, you listen for "key-press-event" signals and then in your callback you check to see if the pressed button was one of the joystick keys.

<pre>
#### Initialize this activity.
def __init__(self, handle):
...
self.connect('key-press-event', self._keyPressCb)
...

#### Method _keyPressCb, which catches any presses of the game buttons.
def _keyPressCb(self, widget, event):

keyname = gtk.gdk.keyval_name(event.keyval)

if (keyname == 'KP_Up'):
self._chat += "\nUp Pressed!"
self._chat_buffer.set_text(self._chat)
elif (keyname == 'KP_Down'):
self._chat += "\nDown Pressed!"
self._chat_buffer.set_text(self._chat)
elif (keyname == 'KP_Left'):
self._chat += "\nLeft Pressed!"
self._chat_buffer.set_text(self._chat)
elif (keyname == 'KP_Right'):
self._chat += "\nRight Pressed!"
self._chat_buffer.set_text(self._chat)

return False
</pre>

=== How do i remove an specific button from the toolbar? ===

This is an example of the share button is removed:

<pre>
activity_toolbar = toolbox.get_activity_toolbar()
activity_toolbar.remove(activity_toolbar.share)
activity_toolbar.share = None
</pre>

== Notes ==
<references />

[[Category:Documentation]]
[[Category:Development Team]]

Development Team/Almanac/lang-es

2009-08-31T16:15:45Z

Fede: /* Text and Graphics for Sugar Activities */

{{translation
| source = Development_Team/Almanac
| lang = es
| status = {{translation/incomplete/}}
}}

{{Almanac}}
{{Almanac TOC}}
== ¿Cómo puedo obtener ayuda adicional más allá de este almanaque? ==
* ¿Quieres comenzar con los básico del desarrollo para Sugar? Puedes visitar el [http://wiki.sugarlabs.org/images/5/51/Activity_Handbook_200805_online.pdf Activity Handbook] de OLPC Austria (''Ten en cuenta que este manual fue actualizado por última vez en mayo del 2008, las capturas de tienen el diseño pre-8.2. En términos de código en sí, las cosas deberían funcionar como están descriptas. Si encuentra algún problema por favor póngase en contacto con [[User:ChristophD|ChristophD]].'')
* Ver también [[Development Team/Almanac/Code Snippets]]

Ahora, vamos con el almanaque actual...

== ¿Dónde puedo ver los cambios de la API? ==
API changes between OLPC releases can be seen here: [[Development Team/Almanac/API Changes|API Changes]]

== Comenzando ==
=== ¿Cómo estructuro mis archivos para que sean una actividad de válido en Sugar? ===
Puedes encontrar información sobre la estructura de la actividad aquí: [[Development Team/Almanac/Activity Bundles|Activity Bundles]]

=== ¿Cómo puedo hacer un icono para mi actividad? ===
La información sobre lo que debe hacer se puede encontrar aquí: [[Development Team/Almanac/Making Icons|Making Icons]]

== Paquete: sugar ==
* [[Development Team/Almanac/sugar.env|sugar.env]]
* [[Development Team/Almanac/sugar.profile|sugar.profile]]
* [[Development Team/Almanac/sugar.mime|sugar.mime]]
* [[Development Team/Almanac/sugar.logger|sugar.logger]]

== Paquete: sugar.activity ==
* [[Development Team/Almanac/sugar.activity.activity|sugar.activity.activity]]
* [[Development Team/Almanac/sugar.activity.activityfactory|sugar.activity.activityfactory]]
* [[Development Team/Almanac/sugar.activity.registry|sugar.activity.registry]]

== Paquete: sugar.datastore ==
* [[Development Team/Almanac/sugar.datastore.datastore|sugar.datastore.datastore]]

== Paquete: sugar.graphics ==
* [[Development Team/Almanac/sugar.graphics.alert|sugar.graphics.alert]]
* [[Development Team/Almanac/sugar.graphics.icon|sugar.graphics.icon]]
* [[Development Team/Almanac/sugar.graphics.notebook|sugar.graphics.notebook]]
* [[Development Team/Almanac/sugar.graphics.toolbutton|sugar.graphics.toolbutton]]
* [[Development Team/Almanac/sugar.graphics.toolbox|sugar.graphics.toolbox]]
* [[Development Team/Almanac/sugar.graphics.style|sugar.graphics.style]]

== Paquete: sugar.presence ==
* [[Development Team/Almanac/Sugar.presence|Sugar.presence]]
* [[Development Team/Almanac/Sugar.presence.activity|Sugar.presence.activity]]
* [[Development Team/Almanac/Sugar.presence.buddy|Sugar.presence.buddy]]
* [[Development Team/Almanac/Sugar.presence.presenceservice|Sugar.presence.presenceservice]]

== Clipboard ==
* Notas sobre el uso del [[Development Team/Almanac/GTK's Clipboard Module|módulo Clipboard de GTK ]]

== Logging ==
* [[Development Team/Almanac/sugar.logger|sugar.logger]]
* Notas sobre el uso del [[Development Team/Almanac/Python Standard Logging|standard de Logging en Python]]

== Internacionalización ==
*[[Development Team/Almanac/Internationalization|Internationalization]]

== Texto y gráficos para las actividades de Sugar ==
* [[Development Team/Almanac/Pango|Pango]]
=== ¿Cómo puedo crear un cuadro de texto para la edición de código? ===
Puedes usar gtksourceview2
<pre>
import gtk
import gtksourceview2
from sugar.graphics import style

...

# Configuramos el buffer
buffer = gtksourceview2.Buffer()
if hasattr(buffer, 'set_highlight'): # handle different API versions
buffer.set_highlight(True)
else:
buffer.set_highlight_syntax(True)

# Configuramos el tipo MIME para el buffer
lang_manager = gtksourceview2.language_manager_get_default()
if hasattr(lang_manager, 'list_languages'): # again, handle different APIs
langs = lang_manager.list_languages()
else:
lang_ids = lang_manager.get_language_ids()
langs = [lang_manager.get_language(lang_id)
for lang_id in lang_ids]
for lang in langs:
for m in lang.get_mime_types():
if m == mime_type: # <-- this is the mime type you want
buffer.set_language(lang)

# Establecemos el objeto para la vista, usarlo como gtk.TextView
view = gtksourceview2.View(buffer)
view.set_size_request(300, 450)
view.set_editable(True)
view.set_cursor_visible(True)
view.set_show_line_numbers(True)
view.set_wrap_mode(gtk.WRAP_CHAR)
view.set_right_margin_position(80)
#view.set_highlight_current_line(True) #FIXME: Ugly color
view.set_auto_indent(True)
view.modify_font(pango.FontDescription("Monospace " +
str(style.FONT_SIZE)))
...

</pre>

Para agregar texto al buffer:
<pre>
buffer.set_text(text)
</pre>
Para obtener todo el texto:
<pre>
text = buffer.get_text(buffer.get_start_iter(), buffer.get_end_iter())
</pre>

Probablemente quieras poner la view(vista) en un gtk.ScrolledWindow
<pre>
sw = gtk.ScrolledWindow()
sw.add(view)
sw.set_policy(gtk.POLICY_AUTOMATIC, gtk.POLICY_AUTOMATIC)
</pre>
y agregar el el objeto sw en vez de la view(vista).

Puedes encotnrar más en el código fuete de Pippyy en jarabe.view.sourceview.

== Audio & Video ==
* [[Development Team/Almanac/GStreamer|GStreamer]]

== Mouse ==
=== How do I change the mouse cursor in my activity to the wait cursor? ===
In your activity subclass:

<pre>
self.window.set_cursor( gtk.gdk.Cursor(gtk.gdk.WATCH) )
</pre>

and to switch it back to the default:

<pre>
self.window.set_cursor( None );
</pre>

=== How do I track the position of the mouse? ===
There are many different reasons you might want to track the position of the mouse in your activity, ranging from the entertaining ([[http://en.wikipedia.org/wiki/Xeyes]]) to the functional (hiding certain windows when the mouse hasn't moved for a couple of seconds and making those ui elements re-appear when the mouse has moved again). Here is one way you can implement this functionality:

<pre>

...
self.hideWidgetsTime = time.time()
self.mx = -1
self.my = -1
self.HIDE_WIDGET_TIMEOUT_ID = gobject.timeout_add( 500, self.mouseMightHaveMovedCb )

def _mouseMightHaveMovedCb( self ):
x, y = self.get_pointer()
passedTime = 0

if (x != self.mx or y != self.my):
self.hideWidgetsTime = time.time()
if (self.hiddenWidgets):
self.showWidgets()
self.hiddenWidgets = False
else:
passedTime = time.time() - self.hideWidgetsTime

if (passedTime >= 3):
if (not self.hiddenWidgets):
self.hideWidgets()
self.hiddenWidgets = True

self.mx = x
self.my = y
return True

</pre>

== Miscellaneous==

The tasks below are random useful techniques that have come up as I write code and documentation for this reference. They have yet to be categorized, but will be as a sufficient set of related entries are written.

=== How do I know when my activity is "active" or not? ===

You can set an event using the VISIBILITY_NOTIFY_MASK constant in order to know when your activity changes visibility. Then in the callback for this event, you simply compare the event's state to gtk-defined variables for activity visibility. See the [http://www.pygtk.org/docs/pygtk/gdk-constants.html#gdk-visibility-state-constants GDK Visibility State Constants] section of gtk.gdk.Constants for more information.

<pre>
# Notify when the visibility state changes by calling self.__visibility_notify_cb
# (PUT THIS IN YOUR ACTIVITY CODE - EG. THE __init__() METHOD)
self.add_events(gtk.gdk.VISIBILITY_NOTIFY_MASK)
self.connect("visibility-notify-event", self.__visibility_notify_cb)
...
# Callback method for when the activity's visibility changes
def __visibility_notify_cb(self, window, event):
if event.state == gtk.gdk.VISIBILITY_FULLY_OBSCURED:
print "I am not visible"
elif event.state in [gtk.gdk.VISIBILITY_UNOBSCURED, gtk.gdk.VISIBILITY_PARTIAL]:
print "I am visible"
</pre>

=== How do I get the amount of free space available on disk under the /home directory tree? ===
The following function uses the [http://docs.python.org/lib/module-statvfs.html statvfs] module. The following code demonstrates how to get the total amount of free space under /home.

<pre>
#### Method: getFreespaceKb, returns the available freespace in kilobytes.
def getFreespaceKb(self):
stat = os.statvfs("/home")
freebytes = stat[statvfs.F_BSIZE] * stat[statvfs.F_BAVAIL]
freekb = freebytes / 1024
return freekb
</pre>

Note, however, that assuming anything about "/home" is a bad idea, better use os.environ['HOME'] instead. Rainbow will put your actual files elsewhere,
some on ramdisks, some on flash. Be clear about which filesystem's free space you actually care about.

=== How do I know whether my activity is running on a physical XO? ===
Sugar runs on ordinary computers as well as on XO's. While your activity is typically going to be run on a real XO, some people will indeed run it elsewhere. Normally you shouldn't write your activity to care whether it's on an XO or not. If for some odd reason, you need to care, the easiest way to tell if you are on a physical XO is to check whether /sys/power/olpc-pm, an essential power management file for the XO, exists. <ref>[http://lists.laptop.org/pipermail/devel/2008-June/015923.html reliably detecting if running on an XO]</ref> <ref>OLPC [[olpc:Power Management Interface]]</ref>

<pre>
import os
...
#Print out a boolean value that tells us whether we are on an XO or not.
print os.path.exists('/sys/power/olpc-pm')
</pre>

=== How do I know the current language setting on my XO? ===
The system variable 'LANG' tells you which language is currently active on the XO. The following code shows how to look at the value of this variable.

<pre>
import os
...
_logger.debug(os.environ['LANG'])
</pre>

=== How do I repeatedly call a specific method after N number of seconds? ===
The gobject.timeout_add() function allows you to invoke a callback method after a certain amount of time. If you want to repeatedly call a method, simply keep invoking the gobject.timeout_add function in your callback itself. The code below is a simple example, where the callback function is named repeatedly_call. Note that the timing of the callbacks are approximate. To get the process going, you should make an initial call to repeatedly_call() somewhere in your code.

You can see a more substantive example of this pattern in use when we [[olpc:Pango#How_do_I_dynamically_set_the_text_in_a_pango_layout.3F | regularly update the time displayed on a pango layout object]].

<pre>

#This method calls itself ROUGHLY every 1 second
def repeatedly_call(self):
now = datetime.datetime.now()
gobject.timeout_add(self.repeat_period_msec, self.repeatedly_update_time)
</pre>

=== How do I update the current build version of code that is running on my XO? ===

There are several pages that give you instructions on how to install/update your current build.

* If you already have a working build installed and an internet connection, first try [[olpc:olpc-update]].
* If that doesn't work, you can look at instructions for an [[olpc:Activated upgrade]] that can be done via USB] boot.

As the instructions on the pages linked above note, make sure to install your activities separately after you have upgraded to a specific base build.

=== I am developing on an XO laptop, but my keyboard and language settings are not ideal. How can I change them? ===

Internationalized laptops will often have settings that might slow you down while developing. To change around the language settings so you can better understand environment messages, use the [[olpc:Sugar Control Panel]]

Keyboard settings on internationalized laptops<ref>[[olpc:Keyboard layouts#OLPC keyboard layouts]]</ref> can also be suboptimal, especially as characters like "-" and "/" are in unfamiliar positions. You can use the <tt>setxkbmap</tt> command in the [[olpc:Terminal Activity]] to reset the type of keyboard input used and then attach a standard U.S. keyboard that will allow you to type normally. The command below sets the keyboard to the US mapping (it will reset to the default internationalized mapping upon restart).

setxkbmap us

=== My Python activity wants to use threads; how do I do that? ===

A question that has been answered with limited success is which threading patterns are most appropriate for use in Sugar. The following pattern of code to work fine in basic instances:

<pre>
#### Method: __init__, initialize this AnnotateActivity instance
def __init__(self, handle):
...
self.sample_thread = Thread(target=self.announce_thread, args=())
self.sample_thread.setDaemon(0)
self.sample_thread.start()
...

def announce_thread(self):
while (self.Running):
time.sleep(1)
print "thread running"
self._update_chat_text("Thread", "In here")
</pre>

This is the basic series of steps that most online documentation on python suggests to use when trying to work with threads in python. The problem is that it is unclear how this pattern relates to code that worked in the SimCity activity:

<pre>
import gobject
gobject.threads_init()
#import dbus.mainloop.glib
#dbus.mainloop.glib.threads_init()
</pre>

It should be noted that in the SimCity activity the pygame sound player would not produce sound reliably unless this setup was done.



Should the two patterns always be used in tandem? It seems that the latter code is mainly to initiate gobject and other libraries to work with threading, but it is unclear what restrictions there are with using threading with these libraries. Does one take precedence over the other? It is not clear if there is any problem with using the standard python threading code on the sugar technology stack.





In fact, experiments with threading on sugar leads to several different problems. For one thing, thread termination was tricky - using the can_close() method for sugar activities to terminate an activity only killed threads in some circumstances. It did not properly handle terminating threads in the case of CTRL-C or terminal interrupts. You can try to catch signals (SIGINT, SIGTERM or SIGHUP), but you will still be running in to errors in terminating child threads using these as well.





Another set of errors with threading comes up when trying to combine with stream tubes. The bottom line is that it is unclear what the scope of threading in a Sugar activity should be - should it simply work if you do the standard python threading pattern, is the use of the glib.threads_init and gobject.threads_init calls necessary, are there other interactions with threads and dbus that need to be accounted for? With more clarity from sugar developers on how the platform envisions threading to work in an activity, we can be more comfortable writing entries in the Almanac to help developers write error-free code.



=== How do I customize the title that is displayed for each instance of my activity? ===

By default, activity titles are just the generic activity names that you specify in your activity.info file. In some applications, you may want the activity title to be more dynamic.

For example, it makes sense to set the title for different browser sessions to the active web page being visited. That way, when you look back in the journal at the different browser sessions you have run in the previous few days, you can identify unique sessions based on the website you happened to be visiting at the time.

The code below shows how you can set the metadata for your activity to reflect a dynamic title based on whatever session criteria you feel is important. This example is adapted from the Browse activity, which sets activity instance titles based on the title of the current web page being visited.

<pre>
if self.metadata['mime_type'] == 'text/plain':
if not self._jobject.metadata['title_set_by_user'] == '1':
if self._browser.props.title:
# Set the title of this activity to be the current
# title of the page being visited by the browser.
self.metadata['title'] = self._browser.props.title
</pre>

=== What packages are available on sugar to support game development? ===

If your activity will require tools that are typically needed to develop robust and clean video games, then you should utilize the [http://www.pygame.org/ pygame package]. It can be readily imported into any activity:

<pre>
import pygame
...
</pre>

=== How do I detect when one of the game buttons on the laptop have been pressed? ===

The laptop game buttons (the circle, square, x, and check buttons next to the LCD) are encoded as page up, home, page down and end respectively. So, you can detect their press by listening for these specific events. For example, the code below listens for button presses and then just writes to an output widget which button was pressed.

<pre>
...
#### Initialize this activity.
def __init__(self, handle):
...
self.connect('key-press-event', self._keyPressCb)
...

#### Method _keyPressCb, which catches any presses of the game buttons.
def _keyPressCb(self, widget, event):

keyname = gtk.gdk.keyval_name(event.keyval)

if (keyname == 'KP_Page_Up'):
self._chat += "\nCircle Pressed!"
self._chat_buffer.set_text(self._chat)
elif (keyname == 'KP_Page_Down'):
self._chat += "\nX Pressed!"
self._chat_buffer.set_text(self._chat)
elif (keyname == 'KP_Home'):
self._chat += "\nSquare Pressed!"
self._chat_buffer.set_text(self._chat)
elif (keyname == 'KP_End'):
self._chat += "\nCheck Pressed!"
self._chat_buffer.set_text(self._chat)

return False
</pre>

=== How do I detect if one of the joystick buttons has been pressed? ===

This is the same process as detecting game buttons, except with different names for the keys. Again, you listen for "key-press-event" signals and then in your callback you check to see if the pressed button was one of the joystick keys.

<pre>
#### Initialize this activity.
def __init__(self, handle):
...
self.connect('key-press-event', self._keyPressCb)
...

#### Method _keyPressCb, which catches any presses of the game buttons.
def _keyPressCb(self, widget, event):

keyname = gtk.gdk.keyval_name(event.keyval)

if (keyname == 'KP_Up'):
self._chat += "\nUp Pressed!"
self._chat_buffer.set_text(self._chat)
elif (keyname == 'KP_Down'):
self._chat += "\nDown Pressed!"
self._chat_buffer.set_text(self._chat)
elif (keyname == 'KP_Left'):
self._chat += "\nLeft Pressed!"
self._chat_buffer.set_text(self._chat)
elif (keyname == 'KP_Right'):
self._chat += "\nRight Pressed!"
self._chat_buffer.set_text(self._chat)

return False
</pre>

=== How do i remove an specific button from the toolbar? ===

This is an example of the share button is removed:

<pre>
activity_toolbar = toolbox.get_activity_toolbar()
activity_toolbar.remove(activity_toolbar.share)
activity_toolbar.share = None
</pre>

== Notes ==
<references />

[[Category:Documentation]]
[[Category:Development Team]]

Development Team/Almanac/lang-es

2009-08-31T16:09:50Z

Fede: /* Internationalization */

{{translation
| source = Development_Team/Almanac
| lang = es
| status = {{translation/incomplete/}}
}}

{{Almanac}}
{{Almanac TOC}}
== ¿Cómo puedo obtener ayuda adicional más allá de este almanaque? ==
* ¿Quieres comenzar con los básico del desarrollo para Sugar? Puedes visitar el [http://wiki.sugarlabs.org/images/5/51/Activity_Handbook_200805_online.pdf Activity Handbook] de OLPC Austria (''Ten en cuenta que este manual fue actualizado por última vez en mayo del 2008, las capturas de tienen el diseño pre-8.2. En términos de código en sí, las cosas deberían funcionar como están descriptas. Si encuentra algún problema por favor póngase en contacto con [[User:ChristophD|ChristophD]].'')
* Ver también [[Development Team/Almanac/Code Snippets]]

Ahora, vamos con el almanaque actual...

== ¿Dónde puedo ver los cambios de la API? ==
API changes between OLPC releases can be seen here: [[Development Team/Almanac/API Changes|API Changes]]

== Comenzando ==
=== ¿Cómo estructuro mis archivos para que sean una actividad de válido en Sugar? ===
Puedes encontrar información sobre la estructura de la actividad aquí: [[Development Team/Almanac/Activity Bundles|Activity Bundles]]

=== ¿Cómo puedo hacer un icono para mi actividad? ===
La información sobre lo que debe hacer se puede encontrar aquí: [[Development Team/Almanac/Making Icons|Making Icons]]

== Paquete: sugar ==
* [[Development Team/Almanac/sugar.env|sugar.env]]
* [[Development Team/Almanac/sugar.profile|sugar.profile]]
* [[Development Team/Almanac/sugar.mime|sugar.mime]]
* [[Development Team/Almanac/sugar.logger|sugar.logger]]

== Paquete: sugar.activity ==
* [[Development Team/Almanac/sugar.activity.activity|sugar.activity.activity]]
* [[Development Team/Almanac/sugar.activity.activityfactory|sugar.activity.activityfactory]]
* [[Development Team/Almanac/sugar.activity.registry|sugar.activity.registry]]

== Paquete: sugar.datastore ==
* [[Development Team/Almanac/sugar.datastore.datastore|sugar.datastore.datastore]]

== Paquete: sugar.graphics ==
* [[Development Team/Almanac/sugar.graphics.alert|sugar.graphics.alert]]
* [[Development Team/Almanac/sugar.graphics.icon|sugar.graphics.icon]]
* [[Development Team/Almanac/sugar.graphics.notebook|sugar.graphics.notebook]]
* [[Development Team/Almanac/sugar.graphics.toolbutton|sugar.graphics.toolbutton]]
* [[Development Team/Almanac/sugar.graphics.toolbox|sugar.graphics.toolbox]]
* [[Development Team/Almanac/sugar.graphics.style|sugar.graphics.style]]

== Paquete: sugar.presence ==
* [[Development Team/Almanac/Sugar.presence|Sugar.presence]]
* [[Development Team/Almanac/Sugar.presence.activity|Sugar.presence.activity]]
* [[Development Team/Almanac/Sugar.presence.buddy|Sugar.presence.buddy]]
* [[Development Team/Almanac/Sugar.presence.presenceservice|Sugar.presence.presenceservice]]

== Clipboard ==
* Notas sobre el uso del [[Development Team/Almanac/GTK's Clipboard Module|módulo Clipboard de GTK ]]

== Logging ==
* [[Development Team/Almanac/sugar.logger|sugar.logger]]
* Notas sobre el uso del [[Development Team/Almanac/Python Standard Logging|standard de Logging en Python]]

== Internacionalización ==
*[[Development Team/Almanac/Internationalization|Internationalization]]

== Text and Graphics for Sugar Activities ==
* [[Development Team/Almanac/Pango|Pango]]
=== How do I create a text box for code editing? ===
You can use gtksourceview2
<pre>
import gtk
import gtksourceview2
from sugar.graphics import style

...

# set up the buffer
buffer = gtksourceview2.Buffer()
if hasattr(buffer, 'set_highlight'): # handle different API versions
buffer.set_highlight(True)
else:
buffer.set_highlight_syntax(True)

# set mime type for the buffer
lang_manager = gtksourceview2.language_manager_get_default()
if hasattr(lang_manager, 'list_languages'): # again, handle different APIs
langs = lang_manager.list_languages()
else:
lang_ids = lang_manager.get_language_ids()
langs = [lang_manager.get_language(lang_id)
for lang_id in lang_ids]
for lang in langs:
for m in lang.get_mime_types():
if m == mime_type: # <-- this is the mime type you want
buffer.set_language(lang)

# set up the view object, use it like gtk.TextView
view = gtksourceview2.View(buffer)
view.set_size_request(300, 450)
view.set_editable(True)
view.set_cursor_visible(True)
view.set_show_line_numbers(True)
view.set_wrap_mode(gtk.WRAP_CHAR)
view.set_right_margin_position(80)
#view.set_highlight_current_line(True) #FIXME: Ugly color
view.set_auto_indent(True)
view.modify_font(pango.FontDescription("Monospace " +
str(style.FONT_SIZE)))
...

</pre>

To set the text in the buffer:
<pre>
buffer.set_text(text)
</pre>
To get all the text:
<pre>
text = buffer.get_text(buffer.get_start_iter(), buffer.get_end_iter())
</pre>

You will probably want to put the view in a gtk.ScrolledWindow
<pre>
sw = gtk.ScrolledWindow()
sw.add(view)
sw.set_policy(gtk.POLICY_AUTOMATIC, gtk.POLICY_AUTOMATIC)
</pre>
and add the sw object instead of the view.

You can find more in the Pippy source and in jarabe.view.sourceview.

== Audio & Video ==
* [[Development Team/Almanac/GStreamer|GStreamer]]

== Mouse ==
=== How do I change the mouse cursor in my activity to the wait cursor? ===
In your activity subclass:

<pre>
self.window.set_cursor( gtk.gdk.Cursor(gtk.gdk.WATCH) )
</pre>

and to switch it back to the default:

<pre>
self.window.set_cursor( None );
</pre>

=== How do I track the position of the mouse? ===
There are many different reasons you might want to track the position of the mouse in your activity, ranging from the entertaining ([[http://en.wikipedia.org/wiki/Xeyes]]) to the functional (hiding certain windows when the mouse hasn't moved for a couple of seconds and making those ui elements re-appear when the mouse has moved again). Here is one way you can implement this functionality:

<pre>

...
self.hideWidgetsTime = time.time()
self.mx = -1
self.my = -1
self.HIDE_WIDGET_TIMEOUT_ID = gobject.timeout_add( 500, self.mouseMightHaveMovedCb )

def _mouseMightHaveMovedCb( self ):
x, y = self.get_pointer()
passedTime = 0

if (x != self.mx or y != self.my):
self.hideWidgetsTime = time.time()
if (self.hiddenWidgets):
self.showWidgets()
self.hiddenWidgets = False
else:
passedTime = time.time() - self.hideWidgetsTime

if (passedTime >= 3):
if (not self.hiddenWidgets):
self.hideWidgets()
self.hiddenWidgets = True

self.mx = x
self.my = y
return True

</pre>

== Miscellaneous==

The tasks below are random useful techniques that have come up as I write code and documentation for this reference. They have yet to be categorized, but will be as a sufficient set of related entries are written.

=== How do I know when my activity is "active" or not? ===

You can set an event using the VISIBILITY_NOTIFY_MASK constant in order to know when your activity changes visibility. Then in the callback for this event, you simply compare the event's state to gtk-defined variables for activity visibility. See the [http://www.pygtk.org/docs/pygtk/gdk-constants.html#gdk-visibility-state-constants GDK Visibility State Constants] section of gtk.gdk.Constants for more information.

<pre>
# Notify when the visibility state changes by calling self.__visibility_notify_cb
# (PUT THIS IN YOUR ACTIVITY CODE - EG. THE __init__() METHOD)
self.add_events(gtk.gdk.VISIBILITY_NOTIFY_MASK)
self.connect("visibility-notify-event", self.__visibility_notify_cb)
...
# Callback method for when the activity's visibility changes
def __visibility_notify_cb(self, window, event):
if event.state == gtk.gdk.VISIBILITY_FULLY_OBSCURED:
print "I am not visible"
elif event.state in [gtk.gdk.VISIBILITY_UNOBSCURED, gtk.gdk.VISIBILITY_PARTIAL]:
print "I am visible"
</pre>

=== How do I get the amount of free space available on disk under the /home directory tree? ===
The following function uses the [http://docs.python.org/lib/module-statvfs.html statvfs] module. The following code demonstrates how to get the total amount of free space under /home.

<pre>
#### Method: getFreespaceKb, returns the available freespace in kilobytes.
def getFreespaceKb(self):
stat = os.statvfs("/home")
freebytes = stat[statvfs.F_BSIZE] * stat[statvfs.F_BAVAIL]
freekb = freebytes / 1024
return freekb
</pre>

Note, however, that assuming anything about "/home" is a bad idea, better use os.environ['HOME'] instead. Rainbow will put your actual files elsewhere,
some on ramdisks, some on flash. Be clear about which filesystem's free space you actually care about.

=== How do I know whether my activity is running on a physical XO? ===
Sugar runs on ordinary computers as well as on XO's. While your activity is typically going to be run on a real XO, some people will indeed run it elsewhere. Normally you shouldn't write your activity to care whether it's on an XO or not. If for some odd reason, you need to care, the easiest way to tell if you are on a physical XO is to check whether /sys/power/olpc-pm, an essential power management file for the XO, exists. <ref>[http://lists.laptop.org/pipermail/devel/2008-June/015923.html reliably detecting if running on an XO]</ref> <ref>OLPC [[olpc:Power Management Interface]]</ref>

<pre>
import os
...
#Print out a boolean value that tells us whether we are on an XO or not.
print os.path.exists('/sys/power/olpc-pm')
</pre>

=== How do I know the current language setting on my XO? ===
The system variable 'LANG' tells you which language is currently active on the XO. The following code shows how to look at the value of this variable.

<pre>
import os
...
_logger.debug(os.environ['LANG'])
</pre>

=== How do I repeatedly call a specific method after N number of seconds? ===
The gobject.timeout_add() function allows you to invoke a callback method after a certain amount of time. If you want to repeatedly call a method, simply keep invoking the gobject.timeout_add function in your callback itself. The code below is a simple example, where the callback function is named repeatedly_call. Note that the timing of the callbacks are approximate. To get the process going, you should make an initial call to repeatedly_call() somewhere in your code.

You can see a more substantive example of this pattern in use when we [[olpc:Pango#How_do_I_dynamically_set_the_text_in_a_pango_layout.3F | regularly update the time displayed on a pango layout object]].

<pre>

#This method calls itself ROUGHLY every 1 second
def repeatedly_call(self):
now = datetime.datetime.now()
gobject.timeout_add(self.repeat_period_msec, self.repeatedly_update_time)
</pre>

=== How do I update the current build version of code that is running on my XO? ===

There are several pages that give you instructions on how to install/update your current build.

* If you already have a working build installed and an internet connection, first try [[olpc:olpc-update]].
* If that doesn't work, you can look at instructions for an [[olpc:Activated upgrade]] that can be done via USB] boot.

As the instructions on the pages linked above note, make sure to install your activities separately after you have upgraded to a specific base build.

=== I am developing on an XO laptop, but my keyboard and language settings are not ideal. How can I change them? ===

Internationalized laptops will often have settings that might slow you down while developing. To change around the language settings so you can better understand environment messages, use the [[olpc:Sugar Control Panel]]

Keyboard settings on internationalized laptops<ref>[[olpc:Keyboard layouts#OLPC keyboard layouts]]</ref> can also be suboptimal, especially as characters like "-" and "/" are in unfamiliar positions. You can use the <tt>setxkbmap</tt> command in the [[olpc:Terminal Activity]] to reset the type of keyboard input used and then attach a standard U.S. keyboard that will allow you to type normally. The command below sets the keyboard to the US mapping (it will reset to the default internationalized mapping upon restart).

setxkbmap us

=== My Python activity wants to use threads; how do I do that? ===

A question that has been answered with limited success is which threading patterns are most appropriate for use in Sugar. The following pattern of code to work fine in basic instances:

<pre>
#### Method: __init__, initialize this AnnotateActivity instance
def __init__(self, handle):
...
self.sample_thread = Thread(target=self.announce_thread, args=())
self.sample_thread.setDaemon(0)
self.sample_thread.start()
...

def announce_thread(self):
while (self.Running):
time.sleep(1)
print "thread running"
self._update_chat_text("Thread", "In here")
</pre>

This is the basic series of steps that most online documentation on python suggests to use when trying to work with threads in python. The problem is that it is unclear how this pattern relates to code that worked in the SimCity activity:

<pre>
import gobject
gobject.threads_init()
#import dbus.mainloop.glib
#dbus.mainloop.glib.threads_init()
</pre>

It should be noted that in the SimCity activity the pygame sound player would not produce sound reliably unless this setup was done.



Should the two patterns always be used in tandem? It seems that the latter code is mainly to initiate gobject and other libraries to work with threading, but it is unclear what restrictions there are with using threading with these libraries. Does one take precedence over the other? It is not clear if there is any problem with using the standard python threading code on the sugar technology stack.





In fact, experiments with threading on sugar leads to several different problems. For one thing, thread termination was tricky - using the can_close() method for sugar activities to terminate an activity only killed threads in some circumstances. It did not properly handle terminating threads in the case of CTRL-C or terminal interrupts. You can try to catch signals (SIGINT, SIGTERM or SIGHUP), but you will still be running in to errors in terminating child threads using these as well.





Another set of errors with threading comes up when trying to combine with stream tubes. The bottom line is that it is unclear what the scope of threading in a Sugar activity should be - should it simply work if you do the standard python threading pattern, is the use of the glib.threads_init and gobject.threads_init calls necessary, are there other interactions with threads and dbus that need to be accounted for? With more clarity from sugar developers on how the platform envisions threading to work in an activity, we can be more comfortable writing entries in the Almanac to help developers write error-free code.



=== How do I customize the title that is displayed for each instance of my activity? ===

By default, activity titles are just the generic activity names that you specify in your activity.info file. In some applications, you may want the activity title to be more dynamic.

For example, it makes sense to set the title for different browser sessions to the active web page being visited. That way, when you look back in the journal at the different browser sessions you have run in the previous few days, you can identify unique sessions based on the website you happened to be visiting at the time.

The code below shows how you can set the metadata for your activity to reflect a dynamic title based on whatever session criteria you feel is important. This example is adapted from the Browse activity, which sets activity instance titles based on the title of the current web page being visited.

<pre>
if self.metadata['mime_type'] == 'text/plain':
if not self._jobject.metadata['title_set_by_user'] == '1':
if self._browser.props.title:
# Set the title of this activity to be the current
# title of the page being visited by the browser.
self.metadata['title'] = self._browser.props.title
</pre>

=== What packages are available on sugar to support game development? ===

If your activity will require tools that are typically needed to develop robust and clean video games, then you should utilize the [http://www.pygame.org/ pygame package]. It can be readily imported into any activity:

<pre>
import pygame
...
</pre>

=== How do I detect when one of the game buttons on the laptop have been pressed? ===

The laptop game buttons (the circle, square, x, and check buttons next to the LCD) are encoded as page up, home, page down and end respectively. So, you can detect their press by listening for these specific events. For example, the code below listens for button presses and then just writes to an output widget which button was pressed.

<pre>
...
#### Initialize this activity.
def __init__(self, handle):
...
self.connect('key-press-event', self._keyPressCb)
...

#### Method _keyPressCb, which catches any presses of the game buttons.
def _keyPressCb(self, widget, event):

keyname = gtk.gdk.keyval_name(event.keyval)

if (keyname == 'KP_Page_Up'):
self._chat += "\nCircle Pressed!"
self._chat_buffer.set_text(self._chat)
elif (keyname == 'KP_Page_Down'):
self._chat += "\nX Pressed!"
self._chat_buffer.set_text(self._chat)
elif (keyname == 'KP_Home'):
self._chat += "\nSquare Pressed!"
self._chat_buffer.set_text(self._chat)
elif (keyname == 'KP_End'):
self._chat += "\nCheck Pressed!"
self._chat_buffer.set_text(self._chat)

return False
</pre>

=== How do I detect if one of the joystick buttons has been pressed? ===

This is the same process as detecting game buttons, except with different names for the keys. Again, you listen for "key-press-event" signals and then in your callback you check to see if the pressed button was one of the joystick keys.

<pre>
#### Initialize this activity.
def __init__(self, handle):
...
self.connect('key-press-event', self._keyPressCb)
...

#### Method _keyPressCb, which catches any presses of the game buttons.
def _keyPressCb(self, widget, event):

keyname = gtk.gdk.keyval_name(event.keyval)

if (keyname == 'KP_Up'):
self._chat += "\nUp Pressed!"
self._chat_buffer.set_text(self._chat)
elif (keyname == 'KP_Down'):
self._chat += "\nDown Pressed!"
self._chat_buffer.set_text(self._chat)
elif (keyname == 'KP_Left'):
self._chat += "\nLeft Pressed!"
self._chat_buffer.set_text(self._chat)
elif (keyname == 'KP_Right'):
self._chat += "\nRight Pressed!"
self._chat_buffer.set_text(self._chat)

return False
</pre>

=== How do i remove an specific button from the toolbar? ===

This is an example of the share button is removed:

<pre>
activity_toolbar = toolbox.get_activity_toolbar()
activity_toolbar.remove(activity_toolbar.share)
activity_toolbar.share = None
</pre>

== Notes ==
<references />

[[Category:Documentation]]
[[Category:Development Team]]

Development Team/Almanac/lang-es

2009-08-31T16:08:00Z

Fede: /* Logging */

{{translation
| source = Development_Team/Almanac
| lang = es
| status = {{translation/incomplete/}}
}}

{{Almanac}}
{{Almanac TOC}}
== ¿Cómo puedo obtener ayuda adicional más allá de este almanaque? ==
* ¿Quieres comenzar con los básico del desarrollo para Sugar? Puedes visitar el [http://wiki.sugarlabs.org/images/5/51/Activity_Handbook_200805_online.pdf Activity Handbook] de OLPC Austria (''Ten en cuenta que este manual fue actualizado por última vez en mayo del 2008, las capturas de tienen el diseño pre-8.2. En términos de código en sí, las cosas deberían funcionar como están descriptas. Si encuentra algún problema por favor póngase en contacto con [[User:ChristophD|ChristophD]].'')
* Ver también [[Development Team/Almanac/Code Snippets]]

Ahora, vamos con el almanaque actual...

== ¿Dónde puedo ver los cambios de la API? ==
API changes between OLPC releases can be seen here: [[Development Team/Almanac/API Changes|API Changes]]

== Comenzando ==
=== ¿Cómo estructuro mis archivos para que sean una actividad de válido en Sugar? ===
Puedes encontrar información sobre la estructura de la actividad aquí: [[Development Team/Almanac/Activity Bundles|Activity Bundles]]

=== ¿Cómo puedo hacer un icono para mi actividad? ===
La información sobre lo que debe hacer se puede encontrar aquí: [[Development Team/Almanac/Making Icons|Making Icons]]

== Paquete: sugar ==
* [[Development Team/Almanac/sugar.env|sugar.env]]
* [[Development Team/Almanac/sugar.profile|sugar.profile]]
* [[Development Team/Almanac/sugar.mime|sugar.mime]]
* [[Development Team/Almanac/sugar.logger|sugar.logger]]

== Paquete: sugar.activity ==
* [[Development Team/Almanac/sugar.activity.activity|sugar.activity.activity]]
* [[Development Team/Almanac/sugar.activity.activityfactory|sugar.activity.activityfactory]]
* [[Development Team/Almanac/sugar.activity.registry|sugar.activity.registry]]

== Paquete: sugar.datastore ==
* [[Development Team/Almanac/sugar.datastore.datastore|sugar.datastore.datastore]]

== Paquete: sugar.graphics ==
* [[Development Team/Almanac/sugar.graphics.alert|sugar.graphics.alert]]
* [[Development Team/Almanac/sugar.graphics.icon|sugar.graphics.icon]]
* [[Development Team/Almanac/sugar.graphics.notebook|sugar.graphics.notebook]]
* [[Development Team/Almanac/sugar.graphics.toolbutton|sugar.graphics.toolbutton]]
* [[Development Team/Almanac/sugar.graphics.toolbox|sugar.graphics.toolbox]]
* [[Development Team/Almanac/sugar.graphics.style|sugar.graphics.style]]

== Paquete: sugar.presence ==
* [[Development Team/Almanac/Sugar.presence|Sugar.presence]]
* [[Development Team/Almanac/Sugar.presence.activity|Sugar.presence.activity]]
* [[Development Team/Almanac/Sugar.presence.buddy|Sugar.presence.buddy]]
* [[Development Team/Almanac/Sugar.presence.presenceservice|Sugar.presence.presenceservice]]

== Clipboard ==
* Notas sobre el uso del [[Development Team/Almanac/GTK's Clipboard Module|módulo Clipboard de GTK ]]

== Logging ==
* [[Development Team/Almanac/sugar.logger|sugar.logger]]
* Notas sobre el uso del [[Development Team/Almanac/Python Standard Logging|standard de Logging en Python]]

== Internationalization ==
*[[Development Team/Almanac/Internationalization|Internationalization]]

== Text and Graphics for Sugar Activities ==
* [[Development Team/Almanac/Pango|Pango]]
=== How do I create a text box for code editing? ===
You can use gtksourceview2
<pre>
import gtk
import gtksourceview2
from sugar.graphics import style

...

# set up the buffer
buffer = gtksourceview2.Buffer()
if hasattr(buffer, 'set_highlight'): # handle different API versions
buffer.set_highlight(True)
else:
buffer.set_highlight_syntax(True)

# set mime type for the buffer
lang_manager = gtksourceview2.language_manager_get_default()
if hasattr(lang_manager, 'list_languages'): # again, handle different APIs
langs = lang_manager.list_languages()
else:
lang_ids = lang_manager.get_language_ids()
langs = [lang_manager.get_language(lang_id)
for lang_id in lang_ids]
for lang in langs:
for m in lang.get_mime_types():
if m == mime_type: # <-- this is the mime type you want
buffer.set_language(lang)

# set up the view object, use it like gtk.TextView
view = gtksourceview2.View(buffer)
view.set_size_request(300, 450)
view.set_editable(True)
view.set_cursor_visible(True)
view.set_show_line_numbers(True)
view.set_wrap_mode(gtk.WRAP_CHAR)
view.set_right_margin_position(80)
#view.set_highlight_current_line(True) #FIXME: Ugly color
view.set_auto_indent(True)
view.modify_font(pango.FontDescription("Monospace " +
str(style.FONT_SIZE)))
...

</pre>

To set the text in the buffer:
<pre>
buffer.set_text(text)
</pre>
To get all the text:
<pre>
text = buffer.get_text(buffer.get_start_iter(), buffer.get_end_iter())
</pre>

You will probably want to put the view in a gtk.ScrolledWindow
<pre>
sw = gtk.ScrolledWindow()
sw.add(view)
sw.set_policy(gtk.POLICY_AUTOMATIC, gtk.POLICY_AUTOMATIC)
</pre>
and add the sw object instead of the view.

You can find more in the Pippy source and in jarabe.view.sourceview.

== Audio & Video ==
* [[Development Team/Almanac/GStreamer|GStreamer]]

== Mouse ==
=== How do I change the mouse cursor in my activity to the wait cursor? ===
In your activity subclass:

<pre>
self.window.set_cursor( gtk.gdk.Cursor(gtk.gdk.WATCH) )
</pre>

and to switch it back to the default:

<pre>
self.window.set_cursor( None );
</pre>

=== How do I track the position of the mouse? ===
There are many different reasons you might want to track the position of the mouse in your activity, ranging from the entertaining ([[http://en.wikipedia.org/wiki/Xeyes]]) to the functional (hiding certain windows when the mouse hasn't moved for a couple of seconds and making those ui elements re-appear when the mouse has moved again). Here is one way you can implement this functionality:

<pre>

...
self.hideWidgetsTime = time.time()
self.mx = -1
self.my = -1
self.HIDE_WIDGET_TIMEOUT_ID = gobject.timeout_add( 500, self.mouseMightHaveMovedCb )

def _mouseMightHaveMovedCb( self ):
x, y = self.get_pointer()
passedTime = 0

if (x != self.mx or y != self.my):
self.hideWidgetsTime = time.time()
if (self.hiddenWidgets):
self.showWidgets()
self.hiddenWidgets = False
else:
passedTime = time.time() - self.hideWidgetsTime

if (passedTime >= 3):
if (not self.hiddenWidgets):
self.hideWidgets()
self.hiddenWidgets = True

self.mx = x
self.my = y
return True

</pre>

== Miscellaneous==

The tasks below are random useful techniques that have come up as I write code and documentation for this reference. They have yet to be categorized, but will be as a sufficient set of related entries are written.

=== How do I know when my activity is "active" or not? ===

You can set an event using the VISIBILITY_NOTIFY_MASK constant in order to know when your activity changes visibility. Then in the callback for this event, you simply compare the event's state to gtk-defined variables for activity visibility. See the [http://www.pygtk.org/docs/pygtk/gdk-constants.html#gdk-visibility-state-constants GDK Visibility State Constants] section of gtk.gdk.Constants for more information.

<pre>
# Notify when the visibility state changes by calling self.__visibility_notify_cb
# (PUT THIS IN YOUR ACTIVITY CODE - EG. THE __init__() METHOD)
self.add_events(gtk.gdk.VISIBILITY_NOTIFY_MASK)
self.connect("visibility-notify-event", self.__visibility_notify_cb)
...
# Callback method for when the activity's visibility changes
def __visibility_notify_cb(self, window, event):
if event.state == gtk.gdk.VISIBILITY_FULLY_OBSCURED:
print "I am not visible"
elif event.state in [gtk.gdk.VISIBILITY_UNOBSCURED, gtk.gdk.VISIBILITY_PARTIAL]:
print "I am visible"
</pre>

=== How do I get the amount of free space available on disk under the /home directory tree? ===
The following function uses the [http://docs.python.org/lib/module-statvfs.html statvfs] module. The following code demonstrates how to get the total amount of free space under /home.

<pre>
#### Method: getFreespaceKb, returns the available freespace in kilobytes.
def getFreespaceKb(self):
stat = os.statvfs("/home")
freebytes = stat[statvfs.F_BSIZE] * stat[statvfs.F_BAVAIL]
freekb = freebytes / 1024
return freekb
</pre>

Note, however, that assuming anything about "/home" is a bad idea, better use os.environ['HOME'] instead. Rainbow will put your actual files elsewhere,
some on ramdisks, some on flash. Be clear about which filesystem's free space you actually care about.

=== How do I know whether my activity is running on a physical XO? ===
Sugar runs on ordinary computers as well as on XO's. While your activity is typically going to be run on a real XO, some people will indeed run it elsewhere. Normally you shouldn't write your activity to care whether it's on an XO or not. If for some odd reason, you need to care, the easiest way to tell if you are on a physical XO is to check whether /sys/power/olpc-pm, an essential power management file for the XO, exists. <ref>[http://lists.laptop.org/pipermail/devel/2008-June/015923.html reliably detecting if running on an XO]</ref> <ref>OLPC [[olpc:Power Management Interface]]</ref>

<pre>
import os
...
#Print out a boolean value that tells us whether we are on an XO or not.
print os.path.exists('/sys/power/olpc-pm')
</pre>

=== How do I know the current language setting on my XO? ===
The system variable 'LANG' tells you which language is currently active on the XO. The following code shows how to look at the value of this variable.

<pre>
import os
...
_logger.debug(os.environ['LANG'])
</pre>

=== How do I repeatedly call a specific method after N number of seconds? ===
The gobject.timeout_add() function allows you to invoke a callback method after a certain amount of time. If you want to repeatedly call a method, simply keep invoking the gobject.timeout_add function in your callback itself. The code below is a simple example, where the callback function is named repeatedly_call. Note that the timing of the callbacks are approximate. To get the process going, you should make an initial call to repeatedly_call() somewhere in your code.

You can see a more substantive example of this pattern in use when we [[olpc:Pango#How_do_I_dynamically_set_the_text_in_a_pango_layout.3F | regularly update the time displayed on a pango layout object]].

<pre>

#This method calls itself ROUGHLY every 1 second
def repeatedly_call(self):
now = datetime.datetime.now()
gobject.timeout_add(self.repeat_period_msec, self.repeatedly_update_time)
</pre>

=== How do I update the current build version of code that is running on my XO? ===

There are several pages that give you instructions on how to install/update your current build.

* If you already have a working build installed and an internet connection, first try [[olpc:olpc-update]].
* If that doesn't work, you can look at instructions for an [[olpc:Activated upgrade]] that can be done via USB] boot.

As the instructions on the pages linked above note, make sure to install your activities separately after you have upgraded to a specific base build.

=== I am developing on an XO laptop, but my keyboard and language settings are not ideal. How can I change them? ===

Internationalized laptops will often have settings that might slow you down while developing. To change around the language settings so you can better understand environment messages, use the [[olpc:Sugar Control Panel]]

Keyboard settings on internationalized laptops<ref>[[olpc:Keyboard layouts#OLPC keyboard layouts]]</ref> can also be suboptimal, especially as characters like "-" and "/" are in unfamiliar positions. You can use the <tt>setxkbmap</tt> command in the [[olpc:Terminal Activity]] to reset the type of keyboard input used and then attach a standard U.S. keyboard that will allow you to type normally. The command below sets the keyboard to the US mapping (it will reset to the default internationalized mapping upon restart).

setxkbmap us

=== My Python activity wants to use threads; how do I do that? ===

A question that has been answered with limited success is which threading patterns are most appropriate for use in Sugar. The following pattern of code to work fine in basic instances:

<pre>
#### Method: __init__, initialize this AnnotateActivity instance
def __init__(self, handle):
...
self.sample_thread = Thread(target=self.announce_thread, args=())
self.sample_thread.setDaemon(0)
self.sample_thread.start()
...

def announce_thread(self):
while (self.Running):
time.sleep(1)
print "thread running"
self._update_chat_text("Thread", "In here")
</pre>

This is the basic series of steps that most online documentation on python suggests to use when trying to work with threads in python. The problem is that it is unclear how this pattern relates to code that worked in the SimCity activity:

<pre>
import gobject
gobject.threads_init()
#import dbus.mainloop.glib
#dbus.mainloop.glib.threads_init()
</pre>

It should be noted that in the SimCity activity the pygame sound player would not produce sound reliably unless this setup was done.



Should the two patterns always be used in tandem? It seems that the latter code is mainly to initiate gobject and other libraries to work with threading, but it is unclear what restrictions there are with using threading with these libraries. Does one take precedence over the other? It is not clear if there is any problem with using the standard python threading code on the sugar technology stack.





In fact, experiments with threading on sugar leads to several different problems. For one thing, thread termination was tricky - using the can_close() method for sugar activities to terminate an activity only killed threads in some circumstances. It did not properly handle terminating threads in the case of CTRL-C or terminal interrupts. You can try to catch signals (SIGINT, SIGTERM or SIGHUP), but you will still be running in to errors in terminating child threads using these as well.





Another set of errors with threading comes up when trying to combine with stream tubes. The bottom line is that it is unclear what the scope of threading in a Sugar activity should be - should it simply work if you do the standard python threading pattern, is the use of the glib.threads_init and gobject.threads_init calls necessary, are there other interactions with threads and dbus that need to be accounted for? With more clarity from sugar developers on how the platform envisions threading to work in an activity, we can be more comfortable writing entries in the Almanac to help developers write error-free code.



=== How do I customize the title that is displayed for each instance of my activity? ===

By default, activity titles are just the generic activity names that you specify in your activity.info file. In some applications, you may want the activity title to be more dynamic.

For example, it makes sense to set the title for different browser sessions to the active web page being visited. That way, when you look back in the journal at the different browser sessions you have run in the previous few days, you can identify unique sessions based on the website you happened to be visiting at the time.

The code below shows how you can set the metadata for your activity to reflect a dynamic title based on whatever session criteria you feel is important. This example is adapted from the Browse activity, which sets activity instance titles based on the title of the current web page being visited.

<pre>
if self.metadata['mime_type'] == 'text/plain':
if not self._jobject.metadata['title_set_by_user'] == '1':
if self._browser.props.title:
# Set the title of this activity to be the current
# title of the page being visited by the browser.
self.metadata['title'] = self._browser.props.title
</pre>

=== What packages are available on sugar to support game development? ===

If your activity will require tools that are typically needed to develop robust and clean video games, then you should utilize the [http://www.pygame.org/ pygame package]. It can be readily imported into any activity:

<pre>
import pygame
...
</pre>

=== How do I detect when one of the game buttons on the laptop have been pressed? ===

The laptop game buttons (the circle, square, x, and check buttons next to the LCD) are encoded as page up, home, page down and end respectively. So, you can detect their press by listening for these specific events. For example, the code below listens for button presses and then just writes to an output widget which button was pressed.

<pre>
...
#### Initialize this activity.
def __init__(self, handle):
...
self.connect('key-press-event', self._keyPressCb)
...

#### Method _keyPressCb, which catches any presses of the game buttons.
def _keyPressCb(self, widget, event):

keyname = gtk.gdk.keyval_name(event.keyval)

if (keyname == 'KP_Page_Up'):
self._chat += "\nCircle Pressed!"
self._chat_buffer.set_text(self._chat)
elif (keyname == 'KP_Page_Down'):
self._chat += "\nX Pressed!"
self._chat_buffer.set_text(self._chat)
elif (keyname == 'KP_Home'):
self._chat += "\nSquare Pressed!"
self._chat_buffer.set_text(self._chat)
elif (keyname == 'KP_End'):
self._chat += "\nCheck Pressed!"
self._chat_buffer.set_text(self._chat)

return False
</pre>

=== How do I detect if one of the joystick buttons has been pressed? ===

This is the same process as detecting game buttons, except with different names for the keys. Again, you listen for "key-press-event" signals and then in your callback you check to see if the pressed button was one of the joystick keys.

<pre>
#### Initialize this activity.
def __init__(self, handle):
...
self.connect('key-press-event', self._keyPressCb)
...

#### Method _keyPressCb, which catches any presses of the game buttons.
def _keyPressCb(self, widget, event):

keyname = gtk.gdk.keyval_name(event.keyval)

if (keyname == 'KP_Up'):
self._chat += "\nUp Pressed!"
self._chat_buffer.set_text(self._chat)
elif (keyname == 'KP_Down'):
self._chat += "\nDown Pressed!"
self._chat_buffer.set_text(self._chat)
elif (keyname == 'KP_Left'):
self._chat += "\nLeft Pressed!"
self._chat_buffer.set_text(self._chat)
elif (keyname == 'KP_Right'):
self._chat += "\nRight Pressed!"
self._chat_buffer.set_text(self._chat)

return False
</pre>

=== How do i remove an specific button from the toolbar? ===

This is an example of the share button is removed:

<pre>
activity_toolbar = toolbox.get_activity_toolbar()
activity_toolbar.remove(activity_toolbar.share)
activity_toolbar.share = None
</pre>

== Notes ==
<references />

[[Category:Documentation]]
[[Category:Development Team]]

Development Team/Almanac/lang-es

2009-08-31T16:06:56Z

Fede: /* Clipboard */

{{translation
| source = Development_Team/Almanac
| lang = es
| status = {{translation/incomplete/}}
}}

{{Almanac}}
{{Almanac TOC}}
== ¿Cómo puedo obtener ayuda adicional más allá de este almanaque? ==
* ¿Quieres comenzar con los básico del desarrollo para Sugar? Puedes visitar el [http://wiki.sugarlabs.org/images/5/51/Activity_Handbook_200805_online.pdf Activity Handbook] de OLPC Austria (''Ten en cuenta que este manual fue actualizado por última vez en mayo del 2008, las capturas de tienen el diseño pre-8.2. En términos de código en sí, las cosas deberían funcionar como están descriptas. Si encuentra algún problema por favor póngase en contacto con [[User:ChristophD|ChristophD]].'')
* Ver también [[Development Team/Almanac/Code Snippets]]

Ahora, vamos con el almanaque actual...

== ¿Dónde puedo ver los cambios de la API? ==
API changes between OLPC releases can be seen here: [[Development Team/Almanac/API Changes|API Changes]]

== Comenzando ==
=== ¿Cómo estructuro mis archivos para que sean una actividad de válido en Sugar? ===
Puedes encontrar información sobre la estructura de la actividad aquí: [[Development Team/Almanac/Activity Bundles|Activity Bundles]]

=== ¿Cómo puedo hacer un icono para mi actividad? ===
La información sobre lo que debe hacer se puede encontrar aquí: [[Development Team/Almanac/Making Icons|Making Icons]]

== Paquete: sugar ==
* [[Development Team/Almanac/sugar.env|sugar.env]]
* [[Development Team/Almanac/sugar.profile|sugar.profile]]
* [[Development Team/Almanac/sugar.mime|sugar.mime]]
* [[Development Team/Almanac/sugar.logger|sugar.logger]]

== Paquete: sugar.activity ==
* [[Development Team/Almanac/sugar.activity.activity|sugar.activity.activity]]
* [[Development Team/Almanac/sugar.activity.activityfactory|sugar.activity.activityfactory]]
* [[Development Team/Almanac/sugar.activity.registry|sugar.activity.registry]]

== Paquete: sugar.datastore ==
* [[Development Team/Almanac/sugar.datastore.datastore|sugar.datastore.datastore]]

== Paquete: sugar.graphics ==
* [[Development Team/Almanac/sugar.graphics.alert|sugar.graphics.alert]]
* [[Development Team/Almanac/sugar.graphics.icon|sugar.graphics.icon]]
* [[Development Team/Almanac/sugar.graphics.notebook|sugar.graphics.notebook]]
* [[Development Team/Almanac/sugar.graphics.toolbutton|sugar.graphics.toolbutton]]
* [[Development Team/Almanac/sugar.graphics.toolbox|sugar.graphics.toolbox]]
* [[Development Team/Almanac/sugar.graphics.style|sugar.graphics.style]]

== Paquete: sugar.presence ==
* [[Development Team/Almanac/Sugar.presence|Sugar.presence]]
* [[Development Team/Almanac/Sugar.presence.activity|Sugar.presence.activity]]
* [[Development Team/Almanac/Sugar.presence.buddy|Sugar.presence.buddy]]
* [[Development Team/Almanac/Sugar.presence.presenceservice|Sugar.presence.presenceservice]]

== Clipboard ==
* Notas sobre el uso del [[Development Team/Almanac/GTK's Clipboard Module|módulo Clipboard de GTK ]]

== Logging ==
* [[Development Team/Almanac/sugar.logger|sugar.logger]]
* Notes on using [[Development Team/Almanac/Python Standard Logging|Python Standard Logging]]

== Internationalization ==
*[[Development Team/Almanac/Internationalization|Internationalization]]

== Text and Graphics for Sugar Activities ==
* [[Development Team/Almanac/Pango|Pango]]
=== How do I create a text box for code editing? ===
You can use gtksourceview2
<pre>
import gtk
import gtksourceview2
from sugar.graphics import style

...

# set up the buffer
buffer = gtksourceview2.Buffer()
if hasattr(buffer, 'set_highlight'): # handle different API versions
buffer.set_highlight(True)
else:
buffer.set_highlight_syntax(True)

# set mime type for the buffer
lang_manager = gtksourceview2.language_manager_get_default()
if hasattr(lang_manager, 'list_languages'): # again, handle different APIs
langs = lang_manager.list_languages()
else:
lang_ids = lang_manager.get_language_ids()
langs = [lang_manager.get_language(lang_id)
for lang_id in lang_ids]
for lang in langs:
for m in lang.get_mime_types():
if m == mime_type: # <-- this is the mime type you want
buffer.set_language(lang)

# set up the view object, use it like gtk.TextView
view = gtksourceview2.View(buffer)
view.set_size_request(300, 450)
view.set_editable(True)
view.set_cursor_visible(True)
view.set_show_line_numbers(True)
view.set_wrap_mode(gtk.WRAP_CHAR)
view.set_right_margin_position(80)
#view.set_highlight_current_line(True) #FIXME: Ugly color
view.set_auto_indent(True)
view.modify_font(pango.FontDescription("Monospace " +
str(style.FONT_SIZE)))
...

</pre>

To set the text in the buffer:
<pre>
buffer.set_text(text)
</pre>
To get all the text:
<pre>
text = buffer.get_text(buffer.get_start_iter(), buffer.get_end_iter())
</pre>

You will probably want to put the view in a gtk.ScrolledWindow
<pre>
sw = gtk.ScrolledWindow()
sw.add(view)
sw.set_policy(gtk.POLICY_AUTOMATIC, gtk.POLICY_AUTOMATIC)
</pre>
and add the sw object instead of the view.

You can find more in the Pippy source and in jarabe.view.sourceview.

== Audio & Video ==
* [[Development Team/Almanac/GStreamer|GStreamer]]

== Mouse ==
=== How do I change the mouse cursor in my activity to the wait cursor? ===
In your activity subclass:

<pre>
self.window.set_cursor( gtk.gdk.Cursor(gtk.gdk.WATCH) )
</pre>

and to switch it back to the default:

<pre>
self.window.set_cursor( None );
</pre>

=== How do I track the position of the mouse? ===
There are many different reasons you might want to track the position of the mouse in your activity, ranging from the entertaining ([[http://en.wikipedia.org/wiki/Xeyes]]) to the functional (hiding certain windows when the mouse hasn't moved for a couple of seconds and making those ui elements re-appear when the mouse has moved again). Here is one way you can implement this functionality:

<pre>

...
self.hideWidgetsTime = time.time()
self.mx = -1
self.my = -1
self.HIDE_WIDGET_TIMEOUT_ID = gobject.timeout_add( 500, self.mouseMightHaveMovedCb )

def _mouseMightHaveMovedCb( self ):
x, y = self.get_pointer()
passedTime = 0

if (x != self.mx or y != self.my):
self.hideWidgetsTime = time.time()
if (self.hiddenWidgets):
self.showWidgets()
self.hiddenWidgets = False
else:
passedTime = time.time() - self.hideWidgetsTime

if (passedTime >= 3):
if (not self.hiddenWidgets):
self.hideWidgets()
self.hiddenWidgets = True

self.mx = x
self.my = y
return True

</pre>

== Miscellaneous==

The tasks below are random useful techniques that have come up as I write code and documentation for this reference. They have yet to be categorized, but will be as a sufficient set of related entries are written.

=== How do I know when my activity is "active" or not? ===

You can set an event using the VISIBILITY_NOTIFY_MASK constant in order to know when your activity changes visibility. Then in the callback for this event, you simply compare the event's state to gtk-defined variables for activity visibility. See the [http://www.pygtk.org/docs/pygtk/gdk-constants.html#gdk-visibility-state-constants GDK Visibility State Constants] section of gtk.gdk.Constants for more information.

<pre>
# Notify when the visibility state changes by calling self.__visibility_notify_cb
# (PUT THIS IN YOUR ACTIVITY CODE - EG. THE __init__() METHOD)
self.add_events(gtk.gdk.VISIBILITY_NOTIFY_MASK)
self.connect("visibility-notify-event", self.__visibility_notify_cb)
...
# Callback method for when the activity's visibility changes
def __visibility_notify_cb(self, window, event):
if event.state == gtk.gdk.VISIBILITY_FULLY_OBSCURED:
print "I am not visible"
elif event.state in [gtk.gdk.VISIBILITY_UNOBSCURED, gtk.gdk.VISIBILITY_PARTIAL]:
print "I am visible"
</pre>

=== How do I get the amount of free space available on disk under the /home directory tree? ===
The following function uses the [http://docs.python.org/lib/module-statvfs.html statvfs] module. The following code demonstrates how to get the total amount of free space under /home.

<pre>
#### Method: getFreespaceKb, returns the available freespace in kilobytes.
def getFreespaceKb(self):
stat = os.statvfs("/home")
freebytes = stat[statvfs.F_BSIZE] * stat[statvfs.F_BAVAIL]
freekb = freebytes / 1024
return freekb
</pre>

Note, however, that assuming anything about "/home" is a bad idea, better use os.environ['HOME'] instead. Rainbow will put your actual files elsewhere,
some on ramdisks, some on flash. Be clear about which filesystem's free space you actually care about.

=== How do I know whether my activity is running on a physical XO? ===
Sugar runs on ordinary computers as well as on XO's. While your activity is typically going to be run on a real XO, some people will indeed run it elsewhere. Normally you shouldn't write your activity to care whether it's on an XO or not. If for some odd reason, you need to care, the easiest way to tell if you are on a physical XO is to check whether /sys/power/olpc-pm, an essential power management file for the XO, exists. <ref>[http://lists.laptop.org/pipermail/devel/2008-June/015923.html reliably detecting if running on an XO]</ref> <ref>OLPC [[olpc:Power Management Interface]]</ref>

<pre>
import os
...
#Print out a boolean value that tells us whether we are on an XO or not.
print os.path.exists('/sys/power/olpc-pm')
</pre>

=== How do I know the current language setting on my XO? ===
The system variable 'LANG' tells you which language is currently active on the XO. The following code shows how to look at the value of this variable.

<pre>
import os
...
_logger.debug(os.environ['LANG'])
</pre>

=== How do I repeatedly call a specific method after N number of seconds? ===
The gobject.timeout_add() function allows you to invoke a callback method after a certain amount of time. If you want to repeatedly call a method, simply keep invoking the gobject.timeout_add function in your callback itself. The code below is a simple example, where the callback function is named repeatedly_call. Note that the timing of the callbacks are approximate. To get the process going, you should make an initial call to repeatedly_call() somewhere in your code.

You can see a more substantive example of this pattern in use when we [[olpc:Pango#How_do_I_dynamically_set_the_text_in_a_pango_layout.3F | regularly update the time displayed on a pango layout object]].

<pre>

#This method calls itself ROUGHLY every 1 second
def repeatedly_call(self):
now = datetime.datetime.now()
gobject.timeout_add(self.repeat_period_msec, self.repeatedly_update_time)
</pre>

=== How do I update the current build version of code that is running on my XO? ===

There are several pages that give you instructions on how to install/update your current build.

* If you already have a working build installed and an internet connection, first try [[olpc:olpc-update]].
* If that doesn't work, you can look at instructions for an [[olpc:Activated upgrade]] that can be done via USB] boot.

As the instructions on the pages linked above note, make sure to install your activities separately after you have upgraded to a specific base build.

=== I am developing on an XO laptop, but my keyboard and language settings are not ideal. How can I change them? ===

Internationalized laptops will often have settings that might slow you down while developing. To change around the language settings so you can better understand environment messages, use the [[olpc:Sugar Control Panel]]

Keyboard settings on internationalized laptops<ref>[[olpc:Keyboard layouts#OLPC keyboard layouts]]</ref> can also be suboptimal, especially as characters like "-" and "/" are in unfamiliar positions. You can use the <tt>setxkbmap</tt> command in the [[olpc:Terminal Activity]] to reset the type of keyboard input used and then attach a standard U.S. keyboard that will allow you to type normally. The command below sets the keyboard to the US mapping (it will reset to the default internationalized mapping upon restart).

setxkbmap us

=== My Python activity wants to use threads; how do I do that? ===

A question that has been answered with limited success is which threading patterns are most appropriate for use in Sugar. The following pattern of code to work fine in basic instances:

<pre>
#### Method: __init__, initialize this AnnotateActivity instance
def __init__(self, handle):
...
self.sample_thread = Thread(target=self.announce_thread, args=())
self.sample_thread.setDaemon(0)
self.sample_thread.start()
...

def announce_thread(self):
while (self.Running):
time.sleep(1)
print "thread running"
self._update_chat_text("Thread", "In here")
</pre>

This is the basic series of steps that most online documentation on python suggests to use when trying to work with threads in python. The problem is that it is unclear how this pattern relates to code that worked in the SimCity activity:

<pre>
import gobject
gobject.threads_init()
#import dbus.mainloop.glib
#dbus.mainloop.glib.threads_init()
</pre>

It should be noted that in the SimCity activity the pygame sound player would not produce sound reliably unless this setup was done.



Should the two patterns always be used in tandem? It seems that the latter code is mainly to initiate gobject and other libraries to work with threading, but it is unclear what restrictions there are with using threading with these libraries. Does one take precedence over the other? It is not clear if there is any problem with using the standard python threading code on the sugar technology stack.





In fact, experiments with threading on sugar leads to several different problems. For one thing, thread termination was tricky - using the can_close() method for sugar activities to terminate an activity only killed threads in some circumstances. It did not properly handle terminating threads in the case of CTRL-C or terminal interrupts. You can try to catch signals (SIGINT, SIGTERM or SIGHUP), but you will still be running in to errors in terminating child threads using these as well.





Another set of errors with threading comes up when trying to combine with stream tubes. The bottom line is that it is unclear what the scope of threading in a Sugar activity should be - should it simply work if you do the standard python threading pattern, is the use of the glib.threads_init and gobject.threads_init calls necessary, are there other interactions with threads and dbus that need to be accounted for? With more clarity from sugar developers on how the platform envisions threading to work in an activity, we can be more comfortable writing entries in the Almanac to help developers write error-free code.



=== How do I customize the title that is displayed for each instance of my activity? ===

By default, activity titles are just the generic activity names that you specify in your activity.info file. In some applications, you may want the activity title to be more dynamic.

For example, it makes sense to set the title for different browser sessions to the active web page being visited. That way, when you look back in the journal at the different browser sessions you have run in the previous few days, you can identify unique sessions based on the website you happened to be visiting at the time.

The code below shows how you can set the metadata for your activity to reflect a dynamic title based on whatever session criteria you feel is important. This example is adapted from the Browse activity, which sets activity instance titles based on the title of the current web page being visited.

<pre>
if self.metadata['mime_type'] == 'text/plain':
if not self._jobject.metadata['title_set_by_user'] == '1':
if self._browser.props.title:
# Set the title of this activity to be the current
# title of the page being visited by the browser.
self.metadata['title'] = self._browser.props.title
</pre>

=== What packages are available on sugar to support game development? ===

If your activity will require tools that are typically needed to develop robust and clean video games, then you should utilize the [http://www.pygame.org/ pygame package]. It can be readily imported into any activity:

<pre>
import pygame
...
</pre>

=== How do I detect when one of the game buttons on the laptop have been pressed? ===

The laptop game buttons (the circle, square, x, and check buttons next to the LCD) are encoded as page up, home, page down and end respectively. So, you can detect their press by listening for these specific events. For example, the code below listens for button presses and then just writes to an output widget which button was pressed.

<pre>
...
#### Initialize this activity.
def __init__(self, handle):
...
self.connect('key-press-event', self._keyPressCb)
...

#### Method _keyPressCb, which catches any presses of the game buttons.
def _keyPressCb(self, widget, event):

keyname = gtk.gdk.keyval_name(event.keyval)

if (keyname == 'KP_Page_Up'):
self._chat += "\nCircle Pressed!"
self._chat_buffer.set_text(self._chat)
elif (keyname == 'KP_Page_Down'):
self._chat += "\nX Pressed!"
self._chat_buffer.set_text(self._chat)
elif (keyname == 'KP_Home'):
self._chat += "\nSquare Pressed!"
self._chat_buffer.set_text(self._chat)
elif (keyname == 'KP_End'):
self._chat += "\nCheck Pressed!"
self._chat_buffer.set_text(self._chat)

return False
</pre>

=== How do I detect if one of the joystick buttons has been pressed? ===

This is the same process as detecting game buttons, except with different names for the keys. Again, you listen for "key-press-event" signals and then in your callback you check to see if the pressed button was one of the joystick keys.

<pre>
#### Initialize this activity.
def __init__(self, handle):
...
self.connect('key-press-event', self._keyPressCb)
...

#### Method _keyPressCb, which catches any presses of the game buttons.
def _keyPressCb(self, widget, event):

keyname = gtk.gdk.keyval_name(event.keyval)

if (keyname == 'KP_Up'):
self._chat += "\nUp Pressed!"
self._chat_buffer.set_text(self._chat)
elif (keyname == 'KP_Down'):
self._chat += "\nDown Pressed!"
self._chat_buffer.set_text(self._chat)
elif (keyname == 'KP_Left'):
self._chat += "\nLeft Pressed!"
self._chat_buffer.set_text(self._chat)
elif (keyname == 'KP_Right'):
self._chat += "\nRight Pressed!"
self._chat_buffer.set_text(self._chat)

return False
</pre>

=== How do i remove an specific button from the toolbar? ===

This is an example of the share button is removed:

<pre>
activity_toolbar = toolbox.get_activity_toolbar()
activity_toolbar.remove(activity_toolbar.share)
activity_toolbar.share = None
</pre>

== Notes ==
<references />

[[Category:Documentation]]
[[Category:Development Team]]

Development Team/Almanac/lang-es

2009-08-31T16:05:17Z

Fede:

{{translation
| source = Development_Team/Almanac
| lang = es
| status = {{translation/incomplete/}}
}}

{{Almanac}}
{{Almanac TOC}}
== ¿Cómo puedo obtener ayuda adicional más allá de este almanaque? ==
* ¿Quieres comenzar con los básico del desarrollo para Sugar? Puedes visitar el [http://wiki.sugarlabs.org/images/5/51/Activity_Handbook_200805_online.pdf Activity Handbook] de OLPC Austria (''Ten en cuenta que este manual fue actualizado por última vez en mayo del 2008, las capturas de tienen el diseño pre-8.2. En términos de código en sí, las cosas deberían funcionar como están descriptas. Si encuentra algún problema por favor póngase en contacto con [[User:ChristophD|ChristophD]].'')
* Ver también [[Development Team/Almanac/Code Snippets]]

Ahora, vamos con el almanaque actual...

== ¿Dónde puedo ver los cambios de la API? ==
API changes between OLPC releases can be seen here: [[Development Team/Almanac/API Changes|API Changes]]

== Comenzando ==
=== ¿Cómo estructuro mis archivos para que sean una actividad de válido en Sugar? ===
Puedes encontrar información sobre la estructura de la actividad aquí: [[Development Team/Almanac/Activity Bundles|Activity Bundles]]

=== ¿Cómo puedo hacer un icono para mi actividad? ===
La información sobre lo que debe hacer se puede encontrar aquí: [[Development Team/Almanac/Making Icons|Making Icons]]

== Paquete: sugar ==
* [[Development Team/Almanac/sugar.env|sugar.env]]
* [[Development Team/Almanac/sugar.profile|sugar.profile]]
* [[Development Team/Almanac/sugar.mime|sugar.mime]]
* [[Development Team/Almanac/sugar.logger|sugar.logger]]

== Paquete: sugar.activity ==
* [[Development Team/Almanac/sugar.activity.activity|sugar.activity.activity]]
* [[Development Team/Almanac/sugar.activity.activityfactory|sugar.activity.activityfactory]]
* [[Development Team/Almanac/sugar.activity.registry|sugar.activity.registry]]

== Paquete: sugar.datastore ==
* [[Development Team/Almanac/sugar.datastore.datastore|sugar.datastore.datastore]]

== Paquete: sugar.graphics ==
* [[Development Team/Almanac/sugar.graphics.alert|sugar.graphics.alert]]
* [[Development Team/Almanac/sugar.graphics.icon|sugar.graphics.icon]]
* [[Development Team/Almanac/sugar.graphics.notebook|sugar.graphics.notebook]]
* [[Development Team/Almanac/sugar.graphics.toolbutton|sugar.graphics.toolbutton]]
* [[Development Team/Almanac/sugar.graphics.toolbox|sugar.graphics.toolbox]]
* [[Development Team/Almanac/sugar.graphics.style|sugar.graphics.style]]

== Paquete: sugar.presence ==
* [[Development Team/Almanac/Sugar.presence|Sugar.presence]]
* [[Development Team/Almanac/Sugar.presence.activity|Sugar.presence.activity]]
* [[Development Team/Almanac/Sugar.presence.buddy|Sugar.presence.buddy]]
* [[Development Team/Almanac/Sugar.presence.presenceservice|Sugar.presence.presenceservice]]

== Clipboard ==
* Notes on using [[Development Team/Almanac/GTK's Clipboard Module|GTK's Clipboard Module]]

== Logging ==
* [[Development Team/Almanac/sugar.logger|sugar.logger]]
* Notes on using [[Development Team/Almanac/Python Standard Logging|Python Standard Logging]]

== Internationalization ==
*[[Development Team/Almanac/Internationalization|Internationalization]]

== Text and Graphics for Sugar Activities ==
* [[Development Team/Almanac/Pango|Pango]]
=== How do I create a text box for code editing? ===
You can use gtksourceview2
<pre>
import gtk
import gtksourceview2
from sugar.graphics import style

...

# set up the buffer
buffer = gtksourceview2.Buffer()
if hasattr(buffer, 'set_highlight'): # handle different API versions
buffer.set_highlight(True)
else:
buffer.set_highlight_syntax(True)

# set mime type for the buffer
lang_manager = gtksourceview2.language_manager_get_default()
if hasattr(lang_manager, 'list_languages'): # again, handle different APIs
langs = lang_manager.list_languages()
else:
lang_ids = lang_manager.get_language_ids()
langs = [lang_manager.get_language(lang_id)
for lang_id in lang_ids]
for lang in langs:
for m in lang.get_mime_types():
if m == mime_type: # <-- this is the mime type you want
buffer.set_language(lang)

# set up the view object, use it like gtk.TextView
view = gtksourceview2.View(buffer)
view.set_size_request(300, 450)
view.set_editable(True)
view.set_cursor_visible(True)
view.set_show_line_numbers(True)
view.set_wrap_mode(gtk.WRAP_CHAR)
view.set_right_margin_position(80)
#view.set_highlight_current_line(True) #FIXME: Ugly color
view.set_auto_indent(True)
view.modify_font(pango.FontDescription("Monospace " +
str(style.FONT_SIZE)))
...

</pre>

To set the text in the buffer:
<pre>
buffer.set_text(text)
</pre>
To get all the text:
<pre>
text = buffer.get_text(buffer.get_start_iter(), buffer.get_end_iter())
</pre>

You will probably want to put the view in a gtk.ScrolledWindow
<pre>
sw = gtk.ScrolledWindow()
sw.add(view)
sw.set_policy(gtk.POLICY_AUTOMATIC, gtk.POLICY_AUTOMATIC)
</pre>
and add the sw object instead of the view.

You can find more in the Pippy source and in jarabe.view.sourceview.

== Audio & Video ==
* [[Development Team/Almanac/GStreamer|GStreamer]]

== Mouse ==
=== How do I change the mouse cursor in my activity to the wait cursor? ===
In your activity subclass:

<pre>
self.window.set_cursor( gtk.gdk.Cursor(gtk.gdk.WATCH) )
</pre>

and to switch it back to the default:

<pre>
self.window.set_cursor( None );
</pre>

=== How do I track the position of the mouse? ===
There are many different reasons you might want to track the position of the mouse in your activity, ranging from the entertaining ([[http://en.wikipedia.org/wiki/Xeyes]]) to the functional (hiding certain windows when the mouse hasn't moved for a couple of seconds and making those ui elements re-appear when the mouse has moved again). Here is one way you can implement this functionality:

<pre>

...
self.hideWidgetsTime = time.time()
self.mx = -1
self.my = -1
self.HIDE_WIDGET_TIMEOUT_ID = gobject.timeout_add( 500, self.mouseMightHaveMovedCb )

def _mouseMightHaveMovedCb( self ):
x, y = self.get_pointer()
passedTime = 0

if (x != self.mx or y != self.my):
self.hideWidgetsTime = time.time()
if (self.hiddenWidgets):
self.showWidgets()
self.hiddenWidgets = False
else:
passedTime = time.time() - self.hideWidgetsTime

if (passedTime >= 3):
if (not self.hiddenWidgets):
self.hideWidgets()
self.hiddenWidgets = True

self.mx = x
self.my = y
return True

</pre>

== Miscellaneous==

The tasks below are random useful techniques that have come up as I write code and documentation for this reference. They have yet to be categorized, but will be as a sufficient set of related entries are written.

=== How do I know when my activity is "active" or not? ===

You can set an event using the VISIBILITY_NOTIFY_MASK constant in order to know when your activity changes visibility. Then in the callback for this event, you simply compare the event's state to gtk-defined variables for activity visibility. See the [http://www.pygtk.org/docs/pygtk/gdk-constants.html#gdk-visibility-state-constants GDK Visibility State Constants] section of gtk.gdk.Constants for more information.

<pre>
# Notify when the visibility state changes by calling self.__visibility_notify_cb
# (PUT THIS IN YOUR ACTIVITY CODE - EG. THE __init__() METHOD)
self.add_events(gtk.gdk.VISIBILITY_NOTIFY_MASK)
self.connect("visibility-notify-event", self.__visibility_notify_cb)
...
# Callback method for when the activity's visibility changes
def __visibility_notify_cb(self, window, event):
if event.state == gtk.gdk.VISIBILITY_FULLY_OBSCURED:
print "I am not visible"
elif event.state in [gtk.gdk.VISIBILITY_UNOBSCURED, gtk.gdk.VISIBILITY_PARTIAL]:
print "I am visible"
</pre>

=== How do I get the amount of free space available on disk under the /home directory tree? ===
The following function uses the [http://docs.python.org/lib/module-statvfs.html statvfs] module. The following code demonstrates how to get the total amount of free space under /home.

<pre>
#### Method: getFreespaceKb, returns the available freespace in kilobytes.
def getFreespaceKb(self):
stat = os.statvfs("/home")
freebytes = stat[statvfs.F_BSIZE] * stat[statvfs.F_BAVAIL]
freekb = freebytes / 1024
return freekb
</pre>

Note, however, that assuming anything about "/home" is a bad idea, better use os.environ['HOME'] instead. Rainbow will put your actual files elsewhere,
some on ramdisks, some on flash. Be clear about which filesystem's free space you actually care about.

=== How do I know whether my activity is running on a physical XO? ===
Sugar runs on ordinary computers as well as on XO's. While your activity is typically going to be run on a real XO, some people will indeed run it elsewhere. Normally you shouldn't write your activity to care whether it's on an XO or not. If for some odd reason, you need to care, the easiest way to tell if you are on a physical XO is to check whether /sys/power/olpc-pm, an essential power management file for the XO, exists. <ref>[http://lists.laptop.org/pipermail/devel/2008-June/015923.html reliably detecting if running on an XO]</ref> <ref>OLPC [[olpc:Power Management Interface]]</ref>

<pre>
import os
...
#Print out a boolean value that tells us whether we are on an XO or not.
print os.path.exists('/sys/power/olpc-pm')
</pre>

=== How do I know the current language setting on my XO? ===
The system variable 'LANG' tells you which language is currently active on the XO. The following code shows how to look at the value of this variable.

<pre>
import os
...
_logger.debug(os.environ['LANG'])
</pre>

=== How do I repeatedly call a specific method after N number of seconds? ===
The gobject.timeout_add() function allows you to invoke a callback method after a certain amount of time. If you want to repeatedly call a method, simply keep invoking the gobject.timeout_add function in your callback itself. The code below is a simple example, where the callback function is named repeatedly_call. Note that the timing of the callbacks are approximate. To get the process going, you should make an initial call to repeatedly_call() somewhere in your code.

You can see a more substantive example of this pattern in use when we [[olpc:Pango#How_do_I_dynamically_set_the_text_in_a_pango_layout.3F | regularly update the time displayed on a pango layout object]].

<pre>

#This method calls itself ROUGHLY every 1 second
def repeatedly_call(self):
now = datetime.datetime.now()
gobject.timeout_add(self.repeat_period_msec, self.repeatedly_update_time)
</pre>

=== How do I update the current build version of code that is running on my XO? ===

There are several pages that give you instructions on how to install/update your current build.

* If you already have a working build installed and an internet connection, first try [[olpc:olpc-update]].
* If that doesn't work, you can look at instructions for an [[olpc:Activated upgrade]] that can be done via USB] boot.

As the instructions on the pages linked above note, make sure to install your activities separately after you have upgraded to a specific base build.

=== I am developing on an XO laptop, but my keyboard and language settings are not ideal. How can I change them? ===

Internationalized laptops will often have settings that might slow you down while developing. To change around the language settings so you can better understand environment messages, use the [[olpc:Sugar Control Panel]]

Keyboard settings on internationalized laptops<ref>[[olpc:Keyboard layouts#OLPC keyboard layouts]]</ref> can also be suboptimal, especially as characters like "-" and "/" are in unfamiliar positions. You can use the <tt>setxkbmap</tt> command in the [[olpc:Terminal Activity]] to reset the type of keyboard input used and then attach a standard U.S. keyboard that will allow you to type normally. The command below sets the keyboard to the US mapping (it will reset to the default internationalized mapping upon restart).

setxkbmap us

=== My Python activity wants to use threads; how do I do that? ===

A question that has been answered with limited success is which threading patterns are most appropriate for use in Sugar. The following pattern of code to work fine in basic instances:

<pre>
#### Method: __init__, initialize this AnnotateActivity instance
def __init__(self, handle):
...
self.sample_thread = Thread(target=self.announce_thread, args=())
self.sample_thread.setDaemon(0)
self.sample_thread.start()
...

def announce_thread(self):
while (self.Running):
time.sleep(1)
print "thread running"
self._update_chat_text("Thread", "In here")
</pre>

This is the basic series of steps that most online documentation on python suggests to use when trying to work with threads in python. The problem is that it is unclear how this pattern relates to code that worked in the SimCity activity:

<pre>
import gobject
gobject.threads_init()
#import dbus.mainloop.glib
#dbus.mainloop.glib.threads_init()
</pre>

It should be noted that in the SimCity activity the pygame sound player would not produce sound reliably unless this setup was done.



Should the two patterns always be used in tandem? It seems that the latter code is mainly to initiate gobject and other libraries to work with threading, but it is unclear what restrictions there are with using threading with these libraries. Does one take precedence over the other? It is not clear if there is any problem with using the standard python threading code on the sugar technology stack.





In fact, experiments with threading on sugar leads to several different problems. For one thing, thread termination was tricky - using the can_close() method for sugar activities to terminate an activity only killed threads in some circumstances. It did not properly handle terminating threads in the case of CTRL-C or terminal interrupts. You can try to catch signals (SIGINT, SIGTERM or SIGHUP), but you will still be running in to errors in terminating child threads using these as well.





Another set of errors with threading comes up when trying to combine with stream tubes. The bottom line is that it is unclear what the scope of threading in a Sugar activity should be - should it simply work if you do the standard python threading pattern, is the use of the glib.threads_init and gobject.threads_init calls necessary, are there other interactions with threads and dbus that need to be accounted for? With more clarity from sugar developers on how the platform envisions threading to work in an activity, we can be more comfortable writing entries in the Almanac to help developers write error-free code.



=== How do I customize the title that is displayed for each instance of my activity? ===

By default, activity titles are just the generic activity names that you specify in your activity.info file. In some applications, you may want the activity title to be more dynamic.

For example, it makes sense to set the title for different browser sessions to the active web page being visited. That way, when you look back in the journal at the different browser sessions you have run in the previous few days, you can identify unique sessions based on the website you happened to be visiting at the time.

The code below shows how you can set the metadata for your activity to reflect a dynamic title based on whatever session criteria you feel is important. This example is adapted from the Browse activity, which sets activity instance titles based on the title of the current web page being visited.

<pre>
if self.metadata['mime_type'] == 'text/plain':
if not self._jobject.metadata['title_set_by_user'] == '1':
if self._browser.props.title:
# Set the title of this activity to be the current
# title of the page being visited by the browser.
self.metadata['title'] = self._browser.props.title
</pre>

=== What packages are available on sugar to support game development? ===

If your activity will require tools that are typically needed to develop robust and clean video games, then you should utilize the [http://www.pygame.org/ pygame package]. It can be readily imported into any activity:

<pre>
import pygame
...
</pre>

=== How do I detect when one of the game buttons on the laptop have been pressed? ===

The laptop game buttons (the circle, square, x, and check buttons next to the LCD) are encoded as page up, home, page down and end respectively. So, you can detect their press by listening for these specific events. For example, the code below listens for button presses and then just writes to an output widget which button was pressed.

<pre>
...
#### Initialize this activity.
def __init__(self, handle):
...
self.connect('key-press-event', self._keyPressCb)
...

#### Method _keyPressCb, which catches any presses of the game buttons.
def _keyPressCb(self, widget, event):

keyname = gtk.gdk.keyval_name(event.keyval)

if (keyname == 'KP_Page_Up'):
self._chat += "\nCircle Pressed!"
self._chat_buffer.set_text(self._chat)
elif (keyname == 'KP_Page_Down'):
self._chat += "\nX Pressed!"
self._chat_buffer.set_text(self._chat)
elif (keyname == 'KP_Home'):
self._chat += "\nSquare Pressed!"
self._chat_buffer.set_text(self._chat)
elif (keyname == 'KP_End'):
self._chat += "\nCheck Pressed!"
self._chat_buffer.set_text(self._chat)

return False
</pre>

=== How do I detect if one of the joystick buttons has been pressed? ===

This is the same process as detecting game buttons, except with different names for the keys. Again, you listen for "key-press-event" signals and then in your callback you check to see if the pressed button was one of the joystick keys.

<pre>
#### Initialize this activity.
def __init__(self, handle):
...
self.connect('key-press-event', self._keyPressCb)
...

#### Method _keyPressCb, which catches any presses of the game buttons.
def _keyPressCb(self, widget, event):

keyname = gtk.gdk.keyval_name(event.keyval)

if (keyname == 'KP_Up'):
self._chat += "\nUp Pressed!"
self._chat_buffer.set_text(self._chat)
elif (keyname == 'KP_Down'):
self._chat += "\nDown Pressed!"
self._chat_buffer.set_text(self._chat)
elif (keyname == 'KP_Left'):
self._chat += "\nLeft Pressed!"
self._chat_buffer.set_text(self._chat)
elif (keyname == 'KP_Right'):
self._chat += "\nRight Pressed!"
self._chat_buffer.set_text(self._chat)

return False
</pre>

=== How do i remove an specific button from the toolbar? ===

This is an example of the share button is removed:

<pre>
activity_toolbar = toolbox.get_activity_toolbar()
activity_toolbar.remove(activity_toolbar.share)
activity_toolbar.share = None
</pre>

== Notes ==
<references />

[[Category:Documentation]]
[[Category:Development Team]]

Development Team/Almanac/lang-es

2009-08-31T15:57:16Z

Fede:

{{translation
| source = Development_Team/Almanac
| lang = es
| status = {{translation/incomplete/}}
}}

{{Almanac}}
{{Almanac TOC}}
== ¿Cómo puedo obtener ayuda adicional más allá de este almanaque? ==
* Looking to get started with the basics of Sugar development? Check out OLPC Austria's [http://wiki.sugarlabs.org/images/5/51/Activity_Handbook_200805_online.pdf Activity Handbook] (''Please note that this handbook was last updated in May 2008 so the screenshots still show pre-8.2 design. In terms of the code itself things should still work as described. If you run into any issues please contact [[User:ChristophD|ChristophD]].'')
* See also [[Development Team/Almanac/Code Snippets]]

Now, on to the actual almanac ...

== ¿Dónde puedo ver los cambios de la API? ==
API changes between OLPC releases can be seen here: [[Development Team/Almanac/API Changes|API Changes]]

== Comenzando ==
=== ¿Cómo estructuro mis archivos para que sean una actividad de válido en Sugar? ===
Puedes encontrar información sobre la estructura de la actividad aquí: [[Development Team/Almanac/Activity Bundles|Activity Bundles]]

=== ¿Cómo puedo hacer un icono para mi actividad? ===
La información sobre lo que debe hacer se puede encontrar aquí: [[Development Team/Almanac/Making Icons|Making Icons]]

== Paquete: sugar ==
* [[Development Team/Almanac/sugar.env|sugar.env]]
* [[Development Team/Almanac/sugar.profile|sugar.profile]]
* [[Development Team/Almanac/sugar.mime|sugar.mime]]
* [[Development Team/Almanac/sugar.logger|sugar.logger]]

== Paquete: sugar.activity ==
* [[Development Team/Almanac/sugar.activity.activity|sugar.activity.activity]]
* [[Development Team/Almanac/sugar.activity.activityfactory|sugar.activity.activityfactory]]
* [[Development Team/Almanac/sugar.activity.registry|sugar.activity.registry]]

== Paquete: sugar.datastore ==
* [[Development Team/Almanac/sugar.datastore.datastore|sugar.datastore.datastore]]

== Paquete: sugar.graphics ==
* [[Development Team/Almanac/sugar.graphics.alert|sugar.graphics.alert]]
* [[Development Team/Almanac/sugar.graphics.icon|sugar.graphics.icon]]
* [[Development Team/Almanac/sugar.graphics.notebook|sugar.graphics.notebook]]
* [[Development Team/Almanac/sugar.graphics.toolbutton|sugar.graphics.toolbutton]]
* [[Development Team/Almanac/sugar.graphics.toolbox|sugar.graphics.toolbox]]
* [[Development Team/Almanac/sugar.graphics.style|sugar.graphics.style]]

== Paquete: sugar.presence ==
* [[Development Team/Almanac/Sugar.presence|Sugar.presence]]
* [[Development Team/Almanac/Sugar.presence.activity|Sugar.presence.activity]]
* [[Development Team/Almanac/Sugar.presence.buddy|Sugar.presence.buddy]]
* [[Development Team/Almanac/Sugar.presence.presenceservice|Sugar.presence.presenceservice]]

== Clipboard ==
* Notes on using [[Development Team/Almanac/GTK's Clipboard Module|GTK's Clipboard Module]]

== Logging ==
* [[Development Team/Almanac/sugar.logger|sugar.logger]]
* Notes on using [[Development Team/Almanac/Python Standard Logging|Python Standard Logging]]

== Internationalization ==
*[[Development Team/Almanac/Internationalization|Internationalization]]

== Text and Graphics for Sugar Activities ==
* [[Development Team/Almanac/Pango|Pango]]
=== How do I create a text box for code editing? ===
You can use gtksourceview2
<pre>
import gtk
import gtksourceview2
from sugar.graphics import style

...

# set up the buffer
buffer = gtksourceview2.Buffer()
if hasattr(buffer, 'set_highlight'): # handle different API versions
buffer.set_highlight(True)
else:
buffer.set_highlight_syntax(True)

# set mime type for the buffer
lang_manager = gtksourceview2.language_manager_get_default()
if hasattr(lang_manager, 'list_languages'): # again, handle different APIs
langs = lang_manager.list_languages()
else:
lang_ids = lang_manager.get_language_ids()
langs = [lang_manager.get_language(lang_id)
for lang_id in lang_ids]
for lang in langs:
for m in lang.get_mime_types():
if m == mime_type: # <-- this is the mime type you want
buffer.set_language(lang)

# set up the view object, use it like gtk.TextView
view = gtksourceview2.View(buffer)
view.set_size_request(300, 450)
view.set_editable(True)
view.set_cursor_visible(True)
view.set_show_line_numbers(True)
view.set_wrap_mode(gtk.WRAP_CHAR)
view.set_right_margin_position(80)
#view.set_highlight_current_line(True) #FIXME: Ugly color
view.set_auto_indent(True)
view.modify_font(pango.FontDescription("Monospace " +
str(style.FONT_SIZE)))
...

</pre>

To set the text in the buffer:
<pre>
buffer.set_text(text)
</pre>
To get all the text:
<pre>
text = buffer.get_text(buffer.get_start_iter(), buffer.get_end_iter())
</pre>

You will probably want to put the view in a gtk.ScrolledWindow
<pre>
sw = gtk.ScrolledWindow()
sw.add(view)
sw.set_policy(gtk.POLICY_AUTOMATIC, gtk.POLICY_AUTOMATIC)
</pre>
and add the sw object instead of the view.

You can find more in the Pippy source and in jarabe.view.sourceview.

== Audio & Video ==
* [[Development Team/Almanac/GStreamer|GStreamer]]

== Mouse ==
=== How do I change the mouse cursor in my activity to the wait cursor? ===
In your activity subclass:

<pre>
self.window.set_cursor( gtk.gdk.Cursor(gtk.gdk.WATCH) )
</pre>

and to switch it back to the default:

<pre>
self.window.set_cursor( None );
</pre>

=== How do I track the position of the mouse? ===
There are many different reasons you might want to track the position of the mouse in your activity, ranging from the entertaining ([[http://en.wikipedia.org/wiki/Xeyes]]) to the functional (hiding certain windows when the mouse hasn't moved for a couple of seconds and making those ui elements re-appear when the mouse has moved again). Here is one way you can implement this functionality:

<pre>

...
self.hideWidgetsTime = time.time()
self.mx = -1
self.my = -1
self.HIDE_WIDGET_TIMEOUT_ID = gobject.timeout_add( 500, self.mouseMightHaveMovedCb )

def _mouseMightHaveMovedCb( self ):
x, y = self.get_pointer()
passedTime = 0

if (x != self.mx or y != self.my):
self.hideWidgetsTime = time.time()
if (self.hiddenWidgets):
self.showWidgets()
self.hiddenWidgets = False
else:
passedTime = time.time() - self.hideWidgetsTime

if (passedTime >= 3):
if (not self.hiddenWidgets):
self.hideWidgets()
self.hiddenWidgets = True

self.mx = x
self.my = y
return True

</pre>

== Miscellaneous==

The tasks below are random useful techniques that have come up as I write code and documentation for this reference. They have yet to be categorized, but will be as a sufficient set of related entries are written.

=== How do I know when my activity is "active" or not? ===

You can set an event using the VISIBILITY_NOTIFY_MASK constant in order to know when your activity changes visibility. Then in the callback for this event, you simply compare the event's state to gtk-defined variables for activity visibility. See the [http://www.pygtk.org/docs/pygtk/gdk-constants.html#gdk-visibility-state-constants GDK Visibility State Constants] section of gtk.gdk.Constants for more information.

<pre>
# Notify when the visibility state changes by calling self.__visibility_notify_cb
# (PUT THIS IN YOUR ACTIVITY CODE - EG. THE __init__() METHOD)
self.add_events(gtk.gdk.VISIBILITY_NOTIFY_MASK)
self.connect("visibility-notify-event", self.__visibility_notify_cb)
...
# Callback method for when the activity's visibility changes
def __visibility_notify_cb(self, window, event):
if event.state == gtk.gdk.VISIBILITY_FULLY_OBSCURED:
print "I am not visible"
elif event.state in [gtk.gdk.VISIBILITY_UNOBSCURED, gtk.gdk.VISIBILITY_PARTIAL]:
print "I am visible"
</pre>

=== How do I get the amount of free space available on disk under the /home directory tree? ===
The following function uses the [http://docs.python.org/lib/module-statvfs.html statvfs] module. The following code demonstrates how to get the total amount of free space under /home.

<pre>
#### Method: getFreespaceKb, returns the available freespace in kilobytes.
def getFreespaceKb(self):
stat = os.statvfs("/home")
freebytes = stat[statvfs.F_BSIZE] * stat[statvfs.F_BAVAIL]
freekb = freebytes / 1024
return freekb
</pre>

Note, however, that assuming anything about "/home" is a bad idea, better use os.environ['HOME'] instead. Rainbow will put your actual files elsewhere,
some on ramdisks, some on flash. Be clear about which filesystem's free space you actually care about.

=== How do I know whether my activity is running on a physical XO? ===
Sugar runs on ordinary computers as well as on XO's. While your activity is typically going to be run on a real XO, some people will indeed run it elsewhere. Normally you shouldn't write your activity to care whether it's on an XO or not. If for some odd reason, you need to care, the easiest way to tell if you are on a physical XO is to check whether /sys/power/olpc-pm, an essential power management file for the XO, exists. <ref>[http://lists.laptop.org/pipermail/devel/2008-June/015923.html reliably detecting if running on an XO]</ref> <ref>OLPC [[olpc:Power Management Interface]]</ref>

<pre>
import os
...
#Print out a boolean value that tells us whether we are on an XO or not.
print os.path.exists('/sys/power/olpc-pm')
</pre>

=== How do I know the current language setting on my XO? ===
The system variable 'LANG' tells you which language is currently active on the XO. The following code shows how to look at the value of this variable.

<pre>
import os
...
_logger.debug(os.environ['LANG'])
</pre>

=== How do I repeatedly call a specific method after N number of seconds? ===
The gobject.timeout_add() function allows you to invoke a callback method after a certain amount of time. If you want to repeatedly call a method, simply keep invoking the gobject.timeout_add function in your callback itself. The code below is a simple example, where the callback function is named repeatedly_call. Note that the timing of the callbacks are approximate. To get the process going, you should make an initial call to repeatedly_call() somewhere in your code.

You can see a more substantive example of this pattern in use when we [[olpc:Pango#How_do_I_dynamically_set_the_text_in_a_pango_layout.3F | regularly update the time displayed on a pango layout object]].

<pre>

#This method calls itself ROUGHLY every 1 second
def repeatedly_call(self):
now = datetime.datetime.now()
gobject.timeout_add(self.repeat_period_msec, self.repeatedly_update_time)
</pre>

=== How do I update the current build version of code that is running on my XO? ===

There are several pages that give you instructions on how to install/update your current build.

* If you already have a working build installed and an internet connection, first try [[olpc:olpc-update]].
* If that doesn't work, you can look at instructions for an [[olpc:Activated upgrade]] that can be done via USB] boot.

As the instructions on the pages linked above note, make sure to install your activities separately after you have upgraded to a specific base build.

=== I am developing on an XO laptop, but my keyboard and language settings are not ideal. How can I change them? ===

Internationalized laptops will often have settings that might slow you down while developing. To change around the language settings so you can better understand environment messages, use the [[olpc:Sugar Control Panel]]

Keyboard settings on internationalized laptops<ref>[[olpc:Keyboard layouts#OLPC keyboard layouts]]</ref> can also be suboptimal, especially as characters like "-" and "/" are in unfamiliar positions. You can use the <tt>setxkbmap</tt> command in the [[olpc:Terminal Activity]] to reset the type of keyboard input used and then attach a standard U.S. keyboard that will allow you to type normally. The command below sets the keyboard to the US mapping (it will reset to the default internationalized mapping upon restart).

setxkbmap us

=== My Python activity wants to use threads; how do I do that? ===

A question that has been answered with limited success is which threading patterns are most appropriate for use in Sugar. The following pattern of code to work fine in basic instances:

<pre>
#### Method: __init__, initialize this AnnotateActivity instance
def __init__(self, handle):
...
self.sample_thread = Thread(target=self.announce_thread, args=())
self.sample_thread.setDaemon(0)
self.sample_thread.start()
...

def announce_thread(self):
while (self.Running):
time.sleep(1)
print "thread running"
self._update_chat_text("Thread", "In here")
</pre>

This is the basic series of steps that most online documentation on python suggests to use when trying to work with threads in python. The problem is that it is unclear how this pattern relates to code that worked in the SimCity activity:

<pre>
import gobject
gobject.threads_init()
#import dbus.mainloop.glib
#dbus.mainloop.glib.threads_init()
</pre>

It should be noted that in the SimCity activity the pygame sound player would not produce sound reliably unless this setup was done.



Should the two patterns always be used in tandem? It seems that the latter code is mainly to initiate gobject and other libraries to work with threading, but it is unclear what restrictions there are with using threading with these libraries. Does one take precedence over the other? It is not clear if there is any problem with using the standard python threading code on the sugar technology stack.





In fact, experiments with threading on sugar leads to several different problems. For one thing, thread termination was tricky - using the can_close() method for sugar activities to terminate an activity only killed threads in some circumstances. It did not properly handle terminating threads in the case of CTRL-C or terminal interrupts. You can try to catch signals (SIGINT, SIGTERM or SIGHUP), but you will still be running in to errors in terminating child threads using these as well.





Another set of errors with threading comes up when trying to combine with stream tubes. The bottom line is that it is unclear what the scope of threading in a Sugar activity should be - should it simply work if you do the standard python threading pattern, is the use of the glib.threads_init and gobject.threads_init calls necessary, are there other interactions with threads and dbus that need to be accounted for? With more clarity from sugar developers on how the platform envisions threading to work in an activity, we can be more comfortable writing entries in the Almanac to help developers write error-free code.



=== How do I customize the title that is displayed for each instance of my activity? ===

By default, activity titles are just the generic activity names that you specify in your activity.info file. In some applications, you may want the activity title to be more dynamic.

For example, it makes sense to set the title for different browser sessions to the active web page being visited. That way, when you look back in the journal at the different browser sessions you have run in the previous few days, you can identify unique sessions based on the website you happened to be visiting at the time.

The code below shows how you can set the metadata for your activity to reflect a dynamic title based on whatever session criteria you feel is important. This example is adapted from the Browse activity, which sets activity instance titles based on the title of the current web page being visited.

<pre>
if self.metadata['mime_type'] == 'text/plain':
if not self._jobject.metadata['title_set_by_user'] == '1':
if self._browser.props.title:
# Set the title of this activity to be the current
# title of the page being visited by the browser.
self.metadata['title'] = self._browser.props.title
</pre>

=== What packages are available on sugar to support game development? ===

If your activity will require tools that are typically needed to develop robust and clean video games, then you should utilize the [http://www.pygame.org/ pygame package]. It can be readily imported into any activity:

<pre>
import pygame
...
</pre>

=== How do I detect when one of the game buttons on the laptop have been pressed? ===

The laptop game buttons (the circle, square, x, and check buttons next to the LCD) are encoded as page up, home, page down and end respectively. So, you can detect their press by listening for these specific events. For example, the code below listens for button presses and then just writes to an output widget which button was pressed.

<pre>
...
#### Initialize this activity.
def __init__(self, handle):
...
self.connect('key-press-event', self._keyPressCb)
...

#### Method _keyPressCb, which catches any presses of the game buttons.
def _keyPressCb(self, widget, event):

keyname = gtk.gdk.keyval_name(event.keyval)

if (keyname == 'KP_Page_Up'):
self._chat += "\nCircle Pressed!"
self._chat_buffer.set_text(self._chat)
elif (keyname == 'KP_Page_Down'):
self._chat += "\nX Pressed!"
self._chat_buffer.set_text(self._chat)
elif (keyname == 'KP_Home'):
self._chat += "\nSquare Pressed!"
self._chat_buffer.set_text(self._chat)
elif (keyname == 'KP_End'):
self._chat += "\nCheck Pressed!"
self._chat_buffer.set_text(self._chat)

return False
</pre>

=== How do I detect if one of the joystick buttons has been pressed? ===

This is the same process as detecting game buttons, except with different names for the keys. Again, you listen for "key-press-event" signals and then in your callback you check to see if the pressed button was one of the joystick keys.

<pre>
#### Initialize this activity.
def __init__(self, handle):
...
self.connect('key-press-event', self._keyPressCb)
...

#### Method _keyPressCb, which catches any presses of the game buttons.
def _keyPressCb(self, widget, event):

keyname = gtk.gdk.keyval_name(event.keyval)

if (keyname == 'KP_Up'):
self._chat += "\nUp Pressed!"
self._chat_buffer.set_text(self._chat)
elif (keyname == 'KP_Down'):
self._chat += "\nDown Pressed!"
self._chat_buffer.set_text(self._chat)
elif (keyname == 'KP_Left'):
self._chat += "\nLeft Pressed!"
self._chat_buffer.set_text(self._chat)
elif (keyname == 'KP_Right'):
self._chat += "\nRight Pressed!"
self._chat_buffer.set_text(self._chat)

return False
</pre>

=== How do i remove an specific button from the toolbar? ===

This is an example of the share button is removed:

<pre>
activity_toolbar = toolbox.get_activity_toolbar()
activity_toolbar.remove(activity_toolbar.share)
activity_toolbar.share = None
</pre>

== Notes ==
<references />

[[Category:Documentation]]
[[Category:Development Team]]

Development Team/Almanac/lang-es

2009-08-31T15:51:47Z

Fede:

{{translation
| source = Development_Team/Almanac
| lang = es
| status = {{translation/incomplete/}}
}}

{{Almanac}}
{{Almanac TOC}}
== How do I get additional help beyond this almanac? ==
* Looking to get started with the basics of Sugar development? Check out OLPC Austria's [http://wiki.sugarlabs.org/images/5/51/Activity_Handbook_200805_online.pdf Activity Handbook] (''Please note that this handbook was last updated in May 2008 so the screenshots still show pre-8.2 design. In terms of the code itself things should still work as described. If you run into any issues please contact [[User:ChristophD|ChristophD]].'')
* See also [[Development Team/Almanac/Code Snippets]]

Now, on to the actual almanac ...

== Where can I see API changes? ==
API changes between OLPC releases can be seen here: [[Development Team/Almanac/API Changes|API Changes]]

== Getting Started ==
=== How do I structure my files so that they are a valid sugar activity? ===
Information on activity bundle structure can be found here: [[Development Team/Almanac/Activity Bundles|Activity Bundles]]

=== How do I make an icon for my activity? ===
Information on what you need to do can be found here: [[Development Team/Almanac/Making Icons|Making Icons]]

== Package: sugar ==
* [[Development Team/Almanac/sugar.env|sugar.env]]
* [[Development Team/Almanac/sugar.profile|sugar.profile]]
* [[Development Team/Almanac/sugar.mime|sugar.mime]]
* [[Development Team/Almanac/sugar.logger|sugar.logger]]

== Package: sugar.activity ==
* [[Development Team/Almanac/sugar.activity.activity|sugar.activity.activity]]
* [[Development Team/Almanac/sugar.activity.activityfactory|sugar.activity.activityfactory]]
* [[Development Team/Almanac/sugar.activity.registry|sugar.activity.registry]]

== Package: sugar.datastore ==
* [[Development Team/Almanac/sugar.datastore.datastore|sugar.datastore.datastore]]

== Package: sugar.graphics ==
* [[Development Team/Almanac/sugar.graphics.alert|sugar.graphics.alert]]
* [[Development Team/Almanac/sugar.graphics.icon|sugar.graphics.icon]]
* [[Development Team/Almanac/sugar.graphics.notebook|sugar.graphics.notebook]]
* [[Development Team/Almanac/sugar.graphics.toolbutton|sugar.graphics.toolbutton]]
* [[Development Team/Almanac/sugar.graphics.toolbox|sugar.graphics.toolbox]]
* [[Development Team/Almanac/sugar.graphics.style|sugar.graphics.style]]

== Package: sugar.presence ==
* [[Development Team/Almanac/Sugar.presence|Sugar.presence]]
* [[Development Team/Almanac/Sugar.presence.activity|Sugar.presence.activity]]
* [[Development Team/Almanac/Sugar.presence.buddy|Sugar.presence.buddy]]
* [[Development Team/Almanac/Sugar.presence.presenceservice|Sugar.presence.presenceservice]]

== Clipboard ==
* Notes on using [[Development Team/Almanac/GTK's Clipboard Module|GTK's Clipboard Module]]

== Logging ==
* [[Development Team/Almanac/sugar.logger|sugar.logger]]
* Notes on using [[Development Team/Almanac/Python Standard Logging|Python Standard Logging]]

== Internationalization ==
*[[Development Team/Almanac/Internationalization|Internationalization]]

== Text and Graphics for Sugar Activities ==
* [[Development Team/Almanac/Pango|Pango]]
=== How do I create a text box for code editing? ===
You can use gtksourceview2
<pre>
import gtk
import gtksourceview2
from sugar.graphics import style

...

# set up the buffer
buffer = gtksourceview2.Buffer()
if hasattr(buffer, 'set_highlight'): # handle different API versions
buffer.set_highlight(True)
else:
buffer.set_highlight_syntax(True)

# set mime type for the buffer
lang_manager = gtksourceview2.language_manager_get_default()
if hasattr(lang_manager, 'list_languages'): # again, handle different APIs
langs = lang_manager.list_languages()
else:
lang_ids = lang_manager.get_language_ids()
langs = [lang_manager.get_language(lang_id)
for lang_id in lang_ids]
for lang in langs:
for m in lang.get_mime_types():
if m == mime_type: # <-- this is the mime type you want
buffer.set_language(lang)

# set up the view object, use it like gtk.TextView
view = gtksourceview2.View(buffer)
view.set_size_request(300, 450)
view.set_editable(True)
view.set_cursor_visible(True)
view.set_show_line_numbers(True)
view.set_wrap_mode(gtk.WRAP_CHAR)
view.set_right_margin_position(80)
#view.set_highlight_current_line(True) #FIXME: Ugly color
view.set_auto_indent(True)
view.modify_font(pango.FontDescription("Monospace " +
str(style.FONT_SIZE)))
...

</pre>

To set the text in the buffer:
<pre>
buffer.set_text(text)
</pre>
To get all the text:
<pre>
text = buffer.get_text(buffer.get_start_iter(), buffer.get_end_iter())
</pre>

You will probably want to put the view in a gtk.ScrolledWindow
<pre>
sw = gtk.ScrolledWindow()
sw.add(view)
sw.set_policy(gtk.POLICY_AUTOMATIC, gtk.POLICY_AUTOMATIC)
</pre>
and add the sw object instead of the view.

You can find more in the Pippy source and in jarabe.view.sourceview.

== Audio & Video ==
* [[Development Team/Almanac/GStreamer|GStreamer]]

== Mouse ==
=== How do I change the mouse cursor in my activity to the wait cursor? ===
In your activity subclass:

<pre>
self.window.set_cursor( gtk.gdk.Cursor(gtk.gdk.WATCH) )
</pre>

and to switch it back to the default:

<pre>
self.window.set_cursor( None );
</pre>

=== How do I track the position of the mouse? ===
There are many different reasons you might want to track the position of the mouse in your activity, ranging from the entertaining ([[http://en.wikipedia.org/wiki/Xeyes]]) to the functional (hiding certain windows when the mouse hasn't moved for a couple of seconds and making those ui elements re-appear when the mouse has moved again). Here is one way you can implement this functionality:

<pre>

...
self.hideWidgetsTime = time.time()
self.mx = -1
self.my = -1
self.HIDE_WIDGET_TIMEOUT_ID = gobject.timeout_add( 500, self.mouseMightHaveMovedCb )

def _mouseMightHaveMovedCb( self ):
x, y = self.get_pointer()
passedTime = 0

if (x != self.mx or y != self.my):
self.hideWidgetsTime = time.time()
if (self.hiddenWidgets):
self.showWidgets()
self.hiddenWidgets = False
else:
passedTime = time.time() - self.hideWidgetsTime

if (passedTime >= 3):
if (not self.hiddenWidgets):
self.hideWidgets()
self.hiddenWidgets = True

self.mx = x
self.my = y
return True

</pre>

== Miscellaneous==

The tasks below are random useful techniques that have come up as I write code and documentation for this reference. They have yet to be categorized, but will be as a sufficient set of related entries are written.

=== How do I know when my activity is "active" or not? ===

You can set an event using the VISIBILITY_NOTIFY_MASK constant in order to know when your activity changes visibility. Then in the callback for this event, you simply compare the event's state to gtk-defined variables for activity visibility. See the [http://www.pygtk.org/docs/pygtk/gdk-constants.html#gdk-visibility-state-constants GDK Visibility State Constants] section of gtk.gdk.Constants for more information.

<pre>
# Notify when the visibility state changes by calling self.__visibility_notify_cb
# (PUT THIS IN YOUR ACTIVITY CODE - EG. THE __init__() METHOD)
self.add_events(gtk.gdk.VISIBILITY_NOTIFY_MASK)
self.connect("visibility-notify-event", self.__visibility_notify_cb)
...
# Callback method for when the activity's visibility changes
def __visibility_notify_cb(self, window, event):
if event.state == gtk.gdk.VISIBILITY_FULLY_OBSCURED:
print "I am not visible"
elif event.state in [gtk.gdk.VISIBILITY_UNOBSCURED, gtk.gdk.VISIBILITY_PARTIAL]:
print "I am visible"
</pre>

=== How do I get the amount of free space available on disk under the /home directory tree? ===
The following function uses the [http://docs.python.org/lib/module-statvfs.html statvfs] module. The following code demonstrates how to get the total amount of free space under /home.

<pre>
#### Method: getFreespaceKb, returns the available freespace in kilobytes.
def getFreespaceKb(self):
stat = os.statvfs("/home")
freebytes = stat[statvfs.F_BSIZE] * stat[statvfs.F_BAVAIL]
freekb = freebytes / 1024
return freekb
</pre>

Note, however, that assuming anything about "/home" is a bad idea, better use os.environ['HOME'] instead. Rainbow will put your actual files elsewhere,
some on ramdisks, some on flash. Be clear about which filesystem's free space you actually care about.

=== How do I know whether my activity is running on a physical XO? ===
Sugar runs on ordinary computers as well as on XO's. While your activity is typically going to be run on a real XO, some people will indeed run it elsewhere. Normally you shouldn't write your activity to care whether it's on an XO or not. If for some odd reason, you need to care, the easiest way to tell if you are on a physical XO is to check whether /sys/power/olpc-pm, an essential power management file for the XO, exists. <ref>[http://lists.laptop.org/pipermail/devel/2008-June/015923.html reliably detecting if running on an XO]</ref> <ref>OLPC [[olpc:Power Management Interface]]</ref>

<pre>
import os
...
#Print out a boolean value that tells us whether we are on an XO or not.
print os.path.exists('/sys/power/olpc-pm')
</pre>

=== How do I know the current language setting on my XO? ===
The system variable 'LANG' tells you which language is currently active on the XO. The following code shows how to look at the value of this variable.

<pre>
import os
...
_logger.debug(os.environ['LANG'])
</pre>

=== How do I repeatedly call a specific method after N number of seconds? ===
The gobject.timeout_add() function allows you to invoke a callback method after a certain amount of time. If you want to repeatedly call a method, simply keep invoking the gobject.timeout_add function in your callback itself. The code below is a simple example, where the callback function is named repeatedly_call. Note that the timing of the callbacks are approximate. To get the process going, you should make an initial call to repeatedly_call() somewhere in your code.

You can see a more substantive example of this pattern in use when we [[olpc:Pango#How_do_I_dynamically_set_the_text_in_a_pango_layout.3F | regularly update the time displayed on a pango layout object]].

<pre>

#This method calls itself ROUGHLY every 1 second
def repeatedly_call(self):
now = datetime.datetime.now()
gobject.timeout_add(self.repeat_period_msec, self.repeatedly_update_time)
</pre>

=== How do I update the current build version of code that is running on my XO? ===

There are several pages that give you instructions on how to install/update your current build.

* If you already have a working build installed and an internet connection, first try [[olpc:olpc-update]].
* If that doesn't work, you can look at instructions for an [[olpc:Activated upgrade]] that can be done via USB] boot.

As the instructions on the pages linked above note, make sure to install your activities separately after you have upgraded to a specific base build.

=== I am developing on an XO laptop, but my keyboard and language settings are not ideal. How can I change them? ===

Internationalized laptops will often have settings that might slow you down while developing. To change around the language settings so you can better understand environment messages, use the [[olpc:Sugar Control Panel]]

Keyboard settings on internationalized laptops<ref>[[olpc:Keyboard layouts#OLPC keyboard layouts]]</ref> can also be suboptimal, especially as characters like "-" and "/" are in unfamiliar positions. You can use the <tt>setxkbmap</tt> command in the [[olpc:Terminal Activity]] to reset the type of keyboard input used and then attach a standard U.S. keyboard that will allow you to type normally. The command below sets the keyboard to the US mapping (it will reset to the default internationalized mapping upon restart).

setxkbmap us

=== My Python activity wants to use threads; how do I do that? ===

A question that has been answered with limited success is which threading patterns are most appropriate for use in Sugar. The following pattern of code to work fine in basic instances:

<pre>
#### Method: __init__, initialize this AnnotateActivity instance
def __init__(self, handle):
...
self.sample_thread = Thread(target=self.announce_thread, args=())
self.sample_thread.setDaemon(0)
self.sample_thread.start()
...

def announce_thread(self):
while (self.Running):
time.sleep(1)
print "thread running"
self._update_chat_text("Thread", "In here")
</pre>

This is the basic series of steps that most online documentation on python suggests to use when trying to work with threads in python. The problem is that it is unclear how this pattern relates to code that worked in the SimCity activity:

<pre>
import gobject
gobject.threads_init()
#import dbus.mainloop.glib
#dbus.mainloop.glib.threads_init()
</pre>

It should be noted that in the SimCity activity the pygame sound player would not produce sound reliably unless this setup was done.



Should the two patterns always be used in tandem? It seems that the latter code is mainly to initiate gobject and other libraries to work with threading, but it is unclear what restrictions there are with using threading with these libraries. Does one take precedence over the other? It is not clear if there is any problem with using the standard python threading code on the sugar technology stack.





In fact, experiments with threading on sugar leads to several different problems. For one thing, thread termination was tricky - using the can_close() method for sugar activities to terminate an activity only killed threads in some circumstances. It did not properly handle terminating threads in the case of CTRL-C or terminal interrupts. You can try to catch signals (SIGINT, SIGTERM or SIGHUP), but you will still be running in to errors in terminating child threads using these as well.





Another set of errors with threading comes up when trying to combine with stream tubes. The bottom line is that it is unclear what the scope of threading in a Sugar activity should be - should it simply work if you do the standard python threading pattern, is the use of the glib.threads_init and gobject.threads_init calls necessary, are there other interactions with threads and dbus that need to be accounted for? With more clarity from sugar developers on how the platform envisions threading to work in an activity, we can be more comfortable writing entries in the Almanac to help developers write error-free code.



=== How do I customize the title that is displayed for each instance of my activity? ===

By default, activity titles are just the generic activity names that you specify in your activity.info file. In some applications, you may want the activity title to be more dynamic.

For example, it makes sense to set the title for different browser sessions to the active web page being visited. That way, when you look back in the journal at the different browser sessions you have run in the previous few days, you can identify unique sessions based on the website you happened to be visiting at the time.

The code below shows how you can set the metadata for your activity to reflect a dynamic title based on whatever session criteria you feel is important. This example is adapted from the Browse activity, which sets activity instance titles based on the title of the current web page being visited.

<pre>
if self.metadata['mime_type'] == 'text/plain':
if not self._jobject.metadata['title_set_by_user'] == '1':
if self._browser.props.title:
# Set the title of this activity to be the current
# title of the page being visited by the browser.
self.metadata['title'] = self._browser.props.title
</pre>

=== What packages are available on sugar to support game development? ===

If your activity will require tools that are typically needed to develop robust and clean video games, then you should utilize the [http://www.pygame.org/ pygame package]. It can be readily imported into any activity:

<pre>
import pygame
...
</pre>

=== How do I detect when one of the game buttons on the laptop have been pressed? ===

The laptop game buttons (the circle, square, x, and check buttons next to the LCD) are encoded as page up, home, page down and end respectively. So, you can detect their press by listening for these specific events. For example, the code below listens for button presses and then just writes to an output widget which button was pressed.

<pre>
...
#### Initialize this activity.
def __init__(self, handle):
...
self.connect('key-press-event', self._keyPressCb)
...

#### Method _keyPressCb, which catches any presses of the game buttons.
def _keyPressCb(self, widget, event):

keyname = gtk.gdk.keyval_name(event.keyval)

if (keyname == 'KP_Page_Up'):
self._chat += "\nCircle Pressed!"
self._chat_buffer.set_text(self._chat)
elif (keyname == 'KP_Page_Down'):
self._chat += "\nX Pressed!"
self._chat_buffer.set_text(self._chat)
elif (keyname == 'KP_Home'):
self._chat += "\nSquare Pressed!"
self._chat_buffer.set_text(self._chat)
elif (keyname == 'KP_End'):
self._chat += "\nCheck Pressed!"
self._chat_buffer.set_text(self._chat)

return False
</pre>

=== How do I detect if one of the joystick buttons has been pressed? ===

This is the same process as detecting game buttons, except with different names for the keys. Again, you listen for "key-press-event" signals and then in your callback you check to see if the pressed button was one of the joystick keys.

<pre>
#### Initialize this activity.
def __init__(self, handle):
...
self.connect('key-press-event', self._keyPressCb)
...

#### Method _keyPressCb, which catches any presses of the game buttons.
def _keyPressCb(self, widget, event):

keyname = gtk.gdk.keyval_name(event.keyval)

if (keyname == 'KP_Up'):
self._chat += "\nUp Pressed!"
self._chat_buffer.set_text(self._chat)
elif (keyname == 'KP_Down'):
self._chat += "\nDown Pressed!"
self._chat_buffer.set_text(self._chat)
elif (keyname == 'KP_Left'):
self._chat += "\nLeft Pressed!"
self._chat_buffer.set_text(self._chat)
elif (keyname == 'KP_Right'):
self._chat += "\nRight Pressed!"
self._chat_buffer.set_text(self._chat)

return False
</pre>

=== How do i remove an specific button from the toolbar? ===

This is an example of the share button is removed:

<pre>
activity_toolbar = toolbox.get_activity_toolbar()
activity_toolbar.remove(activity_toolbar.share)
activity_toolbar.share = None
</pre>

== Notes ==
<references />

[[Category:Documentation]]
[[Category:Development Team]]

Development Team/Almanac/lang-es

2009-08-31T15:48:43Z

Fede:

{{translation
| source = Development_Team/Almanac
| lang = es
| status = {{translation/incomplete/{{SUBPAGENAME}}}}
}}

Development Team/Almanac

2009-08-31T15:45:53Z

Fede:

{{Translations}}
{{Almanac}}
{{Almanac TOC}}
== How do I get additional help beyond this almanac? ==
* Looking to get started with the basics of Sugar development? Check out OLPC Austria's [http://wiki.sugarlabs.org/images/5/51/Activity_Handbook_200805_online.pdf Activity Handbook] (''Please note that this handbook was last updated in May 2008 so the screenshots still show pre-8.2 design. In terms of the code itself things should still work as described. If you run into any issues please contact [[User:ChristophD|ChristophD]].'')
* See also [[Development Team/Almanac/Code Snippets]]

Now, on to the actual almanac ...

== Where can I see API changes? ==
API changes between OLPC releases can be seen here: [[Development Team/Almanac/API Changes|API Changes]]

== Getting Started ==
=== How do I structure my files so that they are a valid sugar activity? ===
Information on activity bundle structure can be found here: [[Development Team/Almanac/Activity Bundles|Activity Bundles]]

=== How do I make an icon for my activity? ===
Information on what you need to do can be found here: [[Development Team/Almanac/Making Icons|Making Icons]]

== Package: sugar ==
* [[Development Team/Almanac/sugar.env|sugar.env]]
* [[Development Team/Almanac/sugar.profile|sugar.profile]]
* [[Development Team/Almanac/sugar.mime|sugar.mime]]
* [[Development Team/Almanac/sugar.logger|sugar.logger]]

== Package: sugar.activity ==
* [[Development Team/Almanac/sugar.activity.activity|sugar.activity.activity]]
* [[Development Team/Almanac/sugar.activity.activityfactory|sugar.activity.activityfactory]]
* [[Development Team/Almanac/sugar.activity.registry|sugar.activity.registry]]

== Package: sugar.datastore ==
* [[Development Team/Almanac/sugar.datastore.datastore|sugar.datastore.datastore]]

== Package: sugar.graphics ==
* [[Development Team/Almanac/sugar.graphics.alert|sugar.graphics.alert]]
* [[Development Team/Almanac/sugar.graphics.icon|sugar.graphics.icon]]
* [[Development Team/Almanac/sugar.graphics.notebook|sugar.graphics.notebook]]
* [[Development Team/Almanac/sugar.graphics.toolbutton|sugar.graphics.toolbutton]]
* [[Development Team/Almanac/sugar.graphics.toolbox|sugar.graphics.toolbox]]
* [[Development Team/Almanac/sugar.graphics.style|sugar.graphics.style]]

== Package: sugar.presence ==
* [[Development Team/Almanac/Sugar.presence|Sugar.presence]]
* [[Development Team/Almanac/Sugar.presence.activity|Sugar.presence.activity]]
* [[Development Team/Almanac/Sugar.presence.buddy|Sugar.presence.buddy]]
* [[Development Team/Almanac/Sugar.presence.presenceservice|Sugar.presence.presenceservice]]

== Clipboard ==
* Notes on using [[Development Team/Almanac/GTK's Clipboard Module|GTK's Clipboard Module]]

== Logging ==
* [[Development Team/Almanac/sugar.logger|sugar.logger]]
* Notes on using [[Development Team/Almanac/Python Standard Logging|Python Standard Logging]]

== Internationalization ==
*[[Development Team/Almanac/Internationalization|Internationalization]]

== Text and Graphics for Sugar Activities ==
* [[Development Team/Almanac/Pango|Pango]]
=== How do I create a text box for code editing? ===
You can use gtksourceview2
<pre>
import gtk
import gtksourceview2
from sugar.graphics import style

...

# set up the buffer
buffer = gtksourceview2.Buffer()
if hasattr(buffer, 'set_highlight'): # handle different API versions
buffer.set_highlight(True)
else:
buffer.set_highlight_syntax(True)

# set mime type for the buffer
lang_manager = gtksourceview2.language_manager_get_default()
if hasattr(lang_manager, 'list_languages'): # again, handle different APIs
langs = lang_manager.list_languages()
else:
lang_ids = lang_manager.get_language_ids()
langs = [lang_manager.get_language(lang_id)
for lang_id in lang_ids]
for lang in langs:
for m in lang.get_mime_types():
if m == mime_type: # <-- this is the mime type you want
buffer.set_language(lang)

# set up the view object, use it like gtk.TextView
view = gtksourceview2.View(buffer)
view.set_size_request(300, 450)
view.set_editable(True)
view.set_cursor_visible(True)
view.set_show_line_numbers(True)
view.set_wrap_mode(gtk.WRAP_CHAR)
view.set_right_margin_position(80)
#view.set_highlight_current_line(True) #FIXME: Ugly color
view.set_auto_indent(True)
view.modify_font(pango.FontDescription("Monospace " +
str(style.FONT_SIZE)))
...

</pre>

To set the text in the buffer:
<pre>
buffer.set_text(text)
</pre>
To get all the text:
<pre>
text = buffer.get_text(buffer.get_start_iter(), buffer.get_end_iter())
</pre>

You will probably want to put the view in a gtk.ScrolledWindow
<pre>
sw = gtk.ScrolledWindow()
sw.add(view)
sw.set_policy(gtk.POLICY_AUTOMATIC, gtk.POLICY_AUTOMATIC)
</pre>
and add the sw object instead of the view.

You can find more in the Pippy source and in jarabe.view.sourceview.

== Audio & Video ==
* [[Development Team/Almanac/GStreamer|GStreamer]]

== Mouse ==
=== How do I change the mouse cursor in my activity to the wait cursor? ===
In your activity subclass:

<pre>
self.window.set_cursor( gtk.gdk.Cursor(gtk.gdk.WATCH) )
</pre>

and to switch it back to the default:

<pre>
self.window.set_cursor( None );
</pre>

=== How do I track the position of the mouse? ===
There are many different reasons you might want to track the position of the mouse in your activity, ranging from the entertaining ([[http://en.wikipedia.org/wiki/Xeyes]]) to the functional (hiding certain windows when the mouse hasn't moved for a couple of seconds and making those ui elements re-appear when the mouse has moved again). Here is one way you can implement this functionality:

<pre>

...
self.hideWidgetsTime = time.time()
self.mx = -1
self.my = -1
self.HIDE_WIDGET_TIMEOUT_ID = gobject.timeout_add( 500, self.mouseMightHaveMovedCb )

def _mouseMightHaveMovedCb( self ):
x, y = self.get_pointer()
passedTime = 0

if (x != self.mx or y != self.my):
self.hideWidgetsTime = time.time()
if (self.hiddenWidgets):
self.showWidgets()
self.hiddenWidgets = False
else:
passedTime = time.time() - self.hideWidgetsTime

if (passedTime >= 3):
if (not self.hiddenWidgets):
self.hideWidgets()
self.hiddenWidgets = True

self.mx = x
self.my = y
return True

</pre>

== Miscellaneous==

The tasks below are random useful techniques that have come up as I write code and documentation for this reference. They have yet to be categorized, but will be as a sufficient set of related entries are written.

=== How do I know when my activity is "active" or not? ===

You can set an event using the VISIBILITY_NOTIFY_MASK constant in order to know when your activity changes visibility. Then in the callback for this event, you simply compare the event's state to gtk-defined variables for activity visibility. See the [http://www.pygtk.org/docs/pygtk/gdk-constants.html#gdk-visibility-state-constants GDK Visibility State Constants] section of gtk.gdk.Constants for more information.

<pre>
# Notify when the visibility state changes by calling self.__visibility_notify_cb
# (PUT THIS IN YOUR ACTIVITY CODE - EG. THE __init__() METHOD)
self.add_events(gtk.gdk.VISIBILITY_NOTIFY_MASK)
self.connect("visibility-notify-event", self.__visibility_notify_cb)
...
# Callback method for when the activity's visibility changes
def __visibility_notify_cb(self, window, event):
if event.state == gtk.gdk.VISIBILITY_FULLY_OBSCURED:
print "I am not visible"
elif event.state in [gtk.gdk.VISIBILITY_UNOBSCURED, gtk.gdk.VISIBILITY_PARTIAL]:
print "I am visible"
</pre>

=== How do I get the amount of free space available on disk under the /home directory tree? ===
The following function uses the [http://docs.python.org/lib/module-statvfs.html statvfs] module. The following code demonstrates how to get the total amount of free space under /home.

<pre>
#### Method: getFreespaceKb, returns the available freespace in kilobytes.
def getFreespaceKb(self):
stat = os.statvfs("/home")
freebytes = stat[statvfs.F_BSIZE] * stat[statvfs.F_BAVAIL]
freekb = freebytes / 1024
return freekb
</pre>

Note, however, that assuming anything about "/home" is a bad idea, better use os.environ['HOME'] instead. Rainbow will put your actual files elsewhere,
some on ramdisks, some on flash. Be clear about which filesystem's free space you actually care about.

=== How do I know whether my activity is running on a physical XO? ===
Sugar runs on ordinary computers as well as on XO's. While your activity is typically going to be run on a real XO, some people will indeed run it elsewhere. Normally you shouldn't write your activity to care whether it's on an XO or not. If for some odd reason, you need to care, the easiest way to tell if you are on a physical XO is to check whether /sys/power/olpc-pm, an essential power management file for the XO, exists. <ref>[http://lists.laptop.org/pipermail/devel/2008-June/015923.html reliably detecting if running on an XO]</ref> <ref>OLPC [[olpc:Power Management Interface]]</ref>

<pre>
import os
...
#Print out a boolean value that tells us whether we are on an XO or not.
print os.path.exists('/sys/power/olpc-pm')
</pre>

=== How do I know the current language setting on my XO? ===
The system variable 'LANG' tells you which language is currently active on the XO. The following code shows how to look at the value of this variable.

<pre>
import os
...
_logger.debug(os.environ['LANG'])
</pre>

=== How do I repeatedly call a specific method after N number of seconds? ===
The gobject.timeout_add() function allows you to invoke a callback method after a certain amount of time. If you want to repeatedly call a method, simply keep invoking the gobject.timeout_add function in your callback itself. The code below is a simple example, where the callback function is named repeatedly_call. Note that the timing of the callbacks are approximate. To get the process going, you should make an initial call to repeatedly_call() somewhere in your code.

You can see a more substantive example of this pattern in use when we [[olpc:Pango#How_do_I_dynamically_set_the_text_in_a_pango_layout.3F | regularly update the time displayed on a pango layout object]].

<pre>

#This method calls itself ROUGHLY every 1 second
def repeatedly_call(self):
now = datetime.datetime.now()
gobject.timeout_add(self.repeat_period_msec, self.repeatedly_update_time)
</pre>

=== How do I update the current build version of code that is running on my XO? ===

There are several pages that give you instructions on how to install/update your current build.

* If you already have a working build installed and an internet connection, first try [[olpc:olpc-update]].
* If that doesn't work, you can look at instructions for an [[olpc:Activated upgrade]] that can be done via USB] boot.

As the instructions on the pages linked above note, make sure to install your activities separately after you have upgraded to a specific base build.

=== I am developing on an XO laptop, but my keyboard and language settings are not ideal. How can I change them? ===

Internationalized laptops will often have settings that might slow you down while developing. To change around the language settings so you can better understand environment messages, use the [[olpc:Sugar Control Panel]]

Keyboard settings on internationalized laptops<ref>[[olpc:Keyboard layouts#OLPC keyboard layouts]]</ref> can also be suboptimal, especially as characters like "-" and "/" are in unfamiliar positions. You can use the <tt>setxkbmap</tt> command in the [[olpc:Terminal Activity]] to reset the type of keyboard input used and then attach a standard U.S. keyboard that will allow you to type normally. The command below sets the keyboard to the US mapping (it will reset to the default internationalized mapping upon restart).

setxkbmap us

=== My Python activity wants to use threads; how do I do that? ===

A question that has been answered with limited success is which threading patterns are most appropriate for use in Sugar. The following pattern of code to work fine in basic instances:

<pre>
#### Method: __init__, initialize this AnnotateActivity instance
def __init__(self, handle):
...
self.sample_thread = Thread(target=self.announce_thread, args=())
self.sample_thread.setDaemon(0)
self.sample_thread.start()
...

def announce_thread(self):
while (self.Running):
time.sleep(1)
print "thread running"
self._update_chat_text("Thread", "In here")
</pre>

This is the basic series of steps that most online documentation on python suggests to use when trying to work with threads in python. The problem is that it is unclear how this pattern relates to code that worked in the SimCity activity:

<pre>
import gobject
gobject.threads_init()
#import dbus.mainloop.glib
#dbus.mainloop.glib.threads_init()
</pre>

It should be noted that in the SimCity activity the pygame sound player would not produce sound reliably unless this setup was done.



Should the two patterns always be used in tandem? It seems that the latter code is mainly to initiate gobject and other libraries to work with threading, but it is unclear what restrictions there are with using threading with these libraries. Does one take precedence over the other? It is not clear if there is any problem with using the standard python threading code on the sugar technology stack.





In fact, experiments with threading on sugar leads to several different problems. For one thing, thread termination was tricky - using the can_close() method for sugar activities to terminate an activity only killed threads in some circumstances. It did not properly handle terminating threads in the case of CTRL-C or terminal interrupts. You can try to catch signals (SIGINT, SIGTERM or SIGHUP), but you will still be running in to errors in terminating child threads using these as well.





Another set of errors with threading comes up when trying to combine with stream tubes. The bottom line is that it is unclear what the scope of threading in a Sugar activity should be - should it simply work if you do the standard python threading pattern, is the use of the glib.threads_init and gobject.threads_init calls necessary, are there other interactions with threads and dbus that need to be accounted for? With more clarity from sugar developers on how the platform envisions threading to work in an activity, we can be more comfortable writing entries in the Almanac to help developers write error-free code.



=== How do I customize the title that is displayed for each instance of my activity? ===

By default, activity titles are just the generic activity names that you specify in your activity.info file. In some applications, you may want the activity title to be more dynamic.

For example, it makes sense to set the title for different browser sessions to the active web page being visited. That way, when you look back in the journal at the different browser sessions you have run in the previous few days, you can identify unique sessions based on the website you happened to be visiting at the time.

The code below shows how you can set the metadata for your activity to reflect a dynamic title based on whatever session criteria you feel is important. This example is adapted from the Browse activity, which sets activity instance titles based on the title of the current web page being visited.

<pre>
if self.metadata['mime_type'] == 'text/plain':
if not self._jobject.metadata['title_set_by_user'] == '1':
if self._browser.props.title:
# Set the title of this activity to be the current
# title of the page being visited by the browser.
self.metadata['title'] = self._browser.props.title
</pre>

=== What packages are available on sugar to support game development? ===

If your activity will require tools that are typically needed to develop robust and clean video games, then you should utilize the [http://www.pygame.org/ pygame package]. It can be readily imported into any activity:

<pre>
import pygame
...
</pre>

=== How do I detect when one of the game buttons on the laptop have been pressed? ===

The laptop game buttons (the circle, square, x, and check buttons next to the LCD) are encoded as page up, home, page down and end respectively. So, you can detect their press by listening for these specific events. For example, the code below listens for button presses and then just writes to an output widget which button was pressed.

<pre>
...
#### Initialize this activity.
def __init__(self, handle):
...
self.connect('key-press-event', self._keyPressCb)
...

#### Method _keyPressCb, which catches any presses of the game buttons.
def _keyPressCb(self, widget, event):

keyname = gtk.gdk.keyval_name(event.keyval)

if (keyname == 'KP_Page_Up'):
self._chat += "\nCircle Pressed!"
self._chat_buffer.set_text(self._chat)
elif (keyname == 'KP_Page_Down'):
self._chat += "\nX Pressed!"
self._chat_buffer.set_text(self._chat)
elif (keyname == 'KP_Home'):
self._chat += "\nSquare Pressed!"
self._chat_buffer.set_text(self._chat)
elif (keyname == 'KP_End'):
self._chat += "\nCheck Pressed!"
self._chat_buffer.set_text(self._chat)

return False
</pre>

=== How do I detect if one of the joystick buttons has been pressed? ===

This is the same process as detecting game buttons, except with different names for the keys. Again, you listen for "key-press-event" signals and then in your callback you check to see if the pressed button was one of the joystick keys.

<pre>
#### Initialize this activity.
def __init__(self, handle):
...
self.connect('key-press-event', self._keyPressCb)
...

#### Method _keyPressCb, which catches any presses of the game buttons.
def _keyPressCb(self, widget, event):

keyname = gtk.gdk.keyval_name(event.keyval)

if (keyname == 'KP_Up'):
self._chat += "\nUp Pressed!"
self._chat_buffer.set_text(self._chat)
elif (keyname == 'KP_Down'):
self._chat += "\nDown Pressed!"
self._chat_buffer.set_text(self._chat)
elif (keyname == 'KP_Left'):
self._chat += "\nLeft Pressed!"
self._chat_buffer.set_text(self._chat)
elif (keyname == 'KP_Right'):
self._chat += "\nRight Pressed!"
self._chat_buffer.set_text(self._chat)

return False
</pre>

=== How do i remove an specific button from the toolbar? ===

This is an example of the share button is removed:

<pre>
activity_toolbar = toolbox.get_activity_toolbar()
activity_toolbar.remove(activity_toolbar.share)
activity_toolbar.share = None
</pre>

== Notes ==
<references />

[[Category:Documentation]]
[[Category:Development Team]]

Development Team/Almanac/translations

2009-08-31T15:45:46Z

Fede: Created page with '{{Translationlist | es | origlang=en | translated={{{translated}}}}}'

{{Translationlist | es | origlang=en | translated={{{translated}}}}}

Development Team/Almanac/lang-es

2009-08-31T15:45:43Z

Fede: Created page with '{{subst:requesttranslation}}'

{{translation
| source = Development_Team/Almanac
| lang = es
| status = {{translation/wanted/{{SUBPAGENAME}}}}
}}