PyMaemo/Python-osso examples
(Adding OSSO example page) |
(Temporarily point example URLs to the old website backup) |
||
| Line 5: | Line 5: | ||
== List of examples == | == List of examples == | ||
| - | [ | + | [https://garage.maemo.org/svn/pymaemo/wwwold/documentation/python_osso_examples/code/osso_examples.tar.gz Download all examples] |
=== Application === | === Application === | ||
| Line 11: | Line 11: | ||
This example shows how to bring an application to foreground using osso.Application.application_top(). | This example shows how to bring an application to foreground using osso.Application.application_top(). | ||
| - | * [ | + | * [https://garage.maemo.org/svn/pymaemo/wwwold/documentation/python_osso_examples/code/application/osso_test_app.py osso_test_app.py] - Application that will be brought to foreground. |
| - | * [ | + | * [https://garage.maemo.org/svn/pymaemo/wwwold/documentation/python_osso_examples/code/application/osso_test_app.service osso_test_app.service] - Service file for the target application. |
| - | * [ | + | * [https://garage.maemo.org/svn/pymaemo/wwwold/documentation/python_osso_examples/code/application/osso_test_sender.py osso_test_sender.py] - Application that will call the OSSO service. |
=== Auto-saving / State Saving === | === Auto-saving / State Saving === | ||
| Line 19: | Line 19: | ||
These examples show how to use the auto-saving and state saving features from python-osso. Each file is a separate example. | These examples show how to use the auto-saving and state saving features from python-osso. Each file is a separate example. | ||
| - | * [ | + | * [https://garage.maemo.org/svn/pymaemo/wwwold/documentation/python_osso_examples/code/autosave/osso_test_autosave.py osso_test_autosave.py] - The same objects from the example below, but instead of calling the save function directly, any changes call user_data_changed, and when exiting force_autosave is called. |
| - | * [ | + | * [https://garage.maemo.org/svn/pymaemo/wwwold/documentation/python_osso_examples/code/autosave/osso_test_statesaving.py osso_test_statesaving.py] - Creates a gtk.Entry and a gtk.HScale. It saves the state when the application goes to background or exits, restoring the state on the next startup, unless the device resets or is turned off. |
=== Device State === | === Device State === | ||
| Line 26: | Line 26: | ||
These examples show how to interact with the display and the device. | These examples show how to interact with the display and the device. | ||
| - | * [ | + | * [https://garage.maemo.org/svn/pymaemo/wwwold/documentation/python_osso_examples/code/device-state/osso_test_device_on.py osso_test_device_on.py] - Requests to turn on the display. |
| - | * [ | + | * [https://garage.maemo.org/svn/pymaemo/wwwold/documentation/python_osso_examples/code/device-state/osso_test_device_blank_pause.py osso_test_device_blank_pause.py] - Requests to do not blank the screen. This will keep the screen on for 60 seconds. |
| - | * [ | + | * [https://garage.maemo.org/svn/pymaemo/wwwold/documentation/python_osso_examples/code/device-state/osso_test_device_state_cb.py osso_test_device_state_cb.py] - Registers a callback for device state changes (Offline mode, etc...). |
=== Help === | === Help === | ||
These examples show how to use HELP and enable the "?" button in dialogs | These examples show how to use HELP and enable the "?" button in dialogs | ||
| - | * [ | + | * [https://garage.maemo.org/svn/pymaemo/wwwold/documentation/python_osso_examples/code/helplib/osso_test_help.py osso_test_help.py] - Shows two buttons: one to load a help topic and another to open a dialog with an "?" button in titlebar. |
=== Mime === | === Mime === | ||
These examples show how use the MIME functions. | These examples show how use the MIME functions. | ||
| - | * [ | + | * [https://garage.maemo.org/svn/pymaemo/wwwold/documentation/python_osso_examples/code/mime/osso_test_mime_category.py osso_test_mime_category.py] - Prints the category the specified mime type is in. |
| - | * [ | + | * [https://garage.maemo.org/svn/pymaemo/wwwold/documentation/python_osso_examples/code/mime/osso_test_mime_default-app.py osso_test_mime_default-app.py] - Prints information about the current default application for the given mime type. |
| - | * [ | + | * [https://garage.maemo.org/svn/pymaemo/wwwold/documentation/python_osso_examples/code/mime/osso_test_mime_open.py osso_test_mime_open.py] - Opens an file using the default application for its mime type. |
| - | * [ | + | * [https://garage.maemo.org/svn/pymaemo/wwwold/documentation/python_osso_examples/code/mime/osso_test_mime_icons.py osso_test_mime_icons.py] - Shows icons associated with a given mime type. |
=== Plugin === | === Plugin === | ||
This example shows how to load plugins. | This example shows how to load plugins. | ||
| - | * [ | + | * [https://garage.maemo.org/svn/pymaemo/wwwold/documentation/python_osso_examples/code/plugin/test_plugin_app.py test_plugin_app.py] - Loads the test plugin. |
| - | * [ | + | * [https://garage.maemo.org/svn/pymaemo/wwwold/documentation/python_osso_examples/code/plugin/testplugin.c testplugin.c] - Test plugin. |
| - | * [ | + | * [https://garage.maemo.org/svn/pymaemo/wwwold/documentation/python_osso_examples/code/plugin/testplugin.desktop testplugin.desktop] - Desktop file for the test plugin. |
=== RPC === | === RPC === | ||
These examples show how to make remote procedure calls using python-osso. | These examples show how to make remote procedure calls using python-osso. | ||
| - | * [ | + | * [https://garage.maemo.org/svn/pymaemo/wwwold/documentation/python_osso_examples/code/rpc/osso_test_sender.py osso_test_sender.py] - GUI app that requests a service from the target app. |
| - | * [ | + | * [https://garage.maemo.org/svn/pymaemo/wwwold/documentation/python_osso_examples/code/rpc/osso_test_receiver.py osso_test_receiver.py] - Sample service that will be called by osso_test_sender.py |
=== Status Bar === | === Status Bar === | ||
| Line 60: | Line 60: | ||
This example shows how to send events to status bar applets. | This example shows how to send events to status bar applets. | ||
| - | * [ | + | * [https://garage.maemo.org/svn/pymaemo/wwwold/documentation/python_osso_examples/code/statusbar/osso_test_statusbar.py osso_test_statusbar.py] - Requests the display applet to change the display brightness. |
=== System Note === | === System Note === | ||
| Line 66: | Line 66: | ||
These examples show how to use notification dialogs with applications that run without gui. | These examples show how to use notification dialogs with applications that run without gui. | ||
| - | * [ | + | * [https://garage.maemo.org/svn/pymaemo/wwwold/documentation/python_osso_examples/code/systemnote/osso_test_note_dialog.py osso_test_note_dialog.py] - Shows a dialog note. |
| - | * [ | + | * [https://garage.maemo.org/svn/pymaemo/wwwold/documentation/python_osso_examples/code/systemnote/osso_test_note_infoprint.py osso_test_note_infoprint.py] - Shows an information banner. |
=== Time Notification === | === Time Notification === | ||
This example registers a callback and tries to set the system time. Notice: Currently this won't change the time. (Even in C). | This example registers a callback and tries to set the system time. Notice: Currently this won't change the time. (Even in C). | ||
| - | * [ | + | * [https://garage.maemo.org/svn/pymaemo/wwwold/documentation/python_osso_examples/code/timenotification/osso_test_timenotification.py osso_test_note_timenotification.py] |
== References == | == References == | ||
[6] Debian New Maintainers' Guide: [http://www.us.debian.org/doc/maint-guide/] | [6] Debian New Maintainers' Guide: [http://www.us.debian.org/doc/maint-guide/] | ||
Revision as of 13:31, 16 November 2009
Contents |
Introduction
This document shows some examples of the functionalities available in the python-osso package.
List of examples
Application
This example shows how to bring an application to foreground using osso.Application.application_top().
- osso_test_app.py - Application that will be brought to foreground.
- osso_test_app.service - Service file for the target application.
- osso_test_sender.py - Application that will call the OSSO service.
Auto-saving / State Saving
These examples show how to use the auto-saving and state saving features from python-osso. Each file is a separate example.
- osso_test_autosave.py - The same objects from the example below, but instead of calling the save function directly, any changes call user_data_changed, and when exiting force_autosave is called.
- osso_test_statesaving.py - Creates a gtk.Entry and a gtk.HScale. It saves the state when the application goes to background or exits, restoring the state on the next startup, unless the device resets or is turned off.
Device State
These examples show how to interact with the display and the device.
- osso_test_device_on.py - Requests to turn on the display.
- osso_test_device_blank_pause.py - Requests to do not blank the screen. This will keep the screen on for 60 seconds.
- osso_test_device_state_cb.py - Registers a callback for device state changes (Offline mode, etc...).
Help
These examples show how to use HELP and enable the "?" button in dialogs
- osso_test_help.py - Shows two buttons: one to load a help topic and another to open a dialog with an "?" button in titlebar.
Mime
These examples show how use the MIME functions.
- osso_test_mime_category.py - Prints the category the specified mime type is in.
- osso_test_mime_default-app.py - Prints information about the current default application for the given mime type.
- osso_test_mime_open.py - Opens an file using the default application for its mime type.
- osso_test_mime_icons.py - Shows icons associated with a given mime type.
Plugin
This example shows how to load plugins.
- test_plugin_app.py - Loads the test plugin.
- testplugin.c - Test plugin.
- testplugin.desktop - Desktop file for the test plugin.
RPC
These examples show how to make remote procedure calls using python-osso.
- osso_test_sender.py - GUI app that requests a service from the target app.
- osso_test_receiver.py - Sample service that will be called by osso_test_sender.py
Status Bar
This example shows how to send events to status bar applets.
- osso_test_statusbar.py - Requests the display applet to change the display brightness.
System Note
These examples show how to use notification dialogs with applications that run without gui.
- osso_test_note_dialog.py - Shows a dialog note.
- osso_test_note_infoprint.py - Shows an information banner.
Time Notification
This example registers a callback and tries to set the system time. Notice: Currently this won't change the time. (Even in C).
References
[6] Debian New Maintainers' Guide: [1]