s60 module referencezchab6a/v3/pys60/pys60-197.pdfs60 module reference 5.1.2 contactdb object 5.1.3...

S60 Module Reference


Up: Python Documentation Index Next: Front Matter


Nokia

Release 1.9.7 final 04 Aug 2009

● Front Matter ● Contents ● 1. Getting Started

❍ 1.1 Installing Python runtime and its dependencies ❍ 1.2 Packaging a Sample Application

■ 1.2.1 On a Windows host machine ■ 1.2.2 On a Linux or Mac host machine

● 2. Operating System Services and Information ❍ 2.1 e32 -- A Symbian OS related services package

■ 2.1.1 Module Level Functions ■ 2.1.2 Ao_lock Type ■ 2.1.3 Ao_timer Type

❍ 2.2 sysinfo -- Access to system information ● 3. User Interface and Graphics

❍ 3.1 appuifw -- Interface to the S60 GUI framework ■ 3.1.1 Basics of appuifw Module ■ 3.1.2 Softkeys ■ 3.1.3 Module Level Functions ■ 3.1.4 Application Type ■ 3.1.5 Form Type ■ 3.1.6 Text Type ■ 3.1.7 Listbox Type ■ 3.1.8 Icon Type ■ 3.1.9 Content_handler Type

http://pys60.garage.maemo.org/doc/s60/ (1 of 5)27/08/2009 02:31:02


■ 3.1.10 Canvas Type ■ 3.1.11 InfoPopup Type

❍ 3.2 globalui -- Interface to the S60 global UI notifiers ❍ 3.3 graphics -- A graphics related services package

■ 3.3.1 Module Level Functions ■ 3.3.2 Image Class Static Methods ■ 3.3.3 Image Objects ■ 3.3.4 Common Features of Drawable Objects

❍ 3.4 camera -- Interface for taking photographs and video recording ❍ 3.5 keycapture -- Interface for global capturing of key events.

■ 3.5.1 Module Level Constants ■ 3.5.2 KeyCapturer objects

❍ 3.6 topwindow -- Interface for creating windows that are shown on top of other applications.

■ 3.6.1 TopWindow objects ❍ 3.7 gles -- Bindings to OpenGL ES

■ 3.7.1 array type ■ 3.7.2 Error handling ■ 3.7.3 Differences to OpenGL ES C API

❍ 3.8 glcanvas -- UI Control for Displaying OpenGL ES Graphics ❍ 3.9 sensor -- Module to access the device sensors.

■ 3.9.1 Module for devices that support S60 Sensor API ■ 3.9.2 Module for devices that support S60 Sensor FrameWork

● 4. Audio and Communication Services ❍ 4.1 audio -- An audio related services package

■ 4.1.1 Sound Objects ❍ 4.2 telephone -- Telephone services ❍ 4.3 messaging -- A messaging services package ❍ 4.4 inbox -- Interface to device inbox

■ 4.4.1 Inbox Objects ❍ 4.5 location -- GSM location information

■ 4.5.1 Examples ❍ 4.6 positioning -- Simplified interface to the position information

■ 4.6.1 Example ❍ 4.7 btsocket -- Provides Bluetooth (BT) support

● 5. Data Management ❍ 5.1 contacts -- A contacts related services package

■ 5.1.1 Module Level Functions



■ 5.1.2 ContactDb Object ■ 5.1.3 Contact Object ■ 5.1.4 ContactField Object ■ 5.1.5 Groups Object ■ 5.1.6 Group Object

❍ 5.2 e32calendar -- Access to calendar related services ■ 5.2.1 Module Level Functions ■ 5.2.2 CalendarDb Objects ■ 5.2.3 Entry Objects ■ 5.2.4 Repeat Rules

❍ 5.3 e32db -- Interface to the Symbian native DB ■ 5.3.1 Dbms Objects ■ 5.3.2 DB_view Objects ■ 5.3.3 Mapping Between SQL and Python Data Types ■ 5.3.4 Date and Time Handling

❍ 5.4 e32dbm -- DBM implemented using the Symbian native DBMS ■ 5.4.1 Module Level Functions ■ 5.4.2 e32dbm Objects

❍ 5.5 logs -- Module to access the phone logs. ■ 5.5.1 Module Level Functions

❍ 5.6 Acronyms and Abbreviations ● 6. scriptext - Platform Service API Usage from Python runtime

❍ 6.1 Overview of scriptext usage ■ 6.1.1 Module level functions and Data Types ■ 6.1.2 Instantiating a Service Object ■ 6.1.3 Making Synchronous Request ■ 6.1.4 Making Asynchronous Request ■ 6.1.5 Cancelling of Asynchronous Service Request

❍ 6.2 Application Manager ■ 6.2.1 GetList ■ 6.2.2 LaunchApp ■ 6.2.3 LaunchDoc

❍ 6.3 Calendar ■ 6.3.1 GetList ■ 6.3.2 Add ■ 6.3.3 Delete ■ 6.3.4 Import ■ 6.3.5 Export



■ 6.3.6 RequestNotification ■ 6.3.7 Key Values

❍ 6.4 Contacts ■ 6.4.1 GetList ■ 6.4.2 Add ■ 6.4.3 Delete ■ 6.4.4 Import ■ 6.4.5 Export ■ 6.4.6 Organise ■ 6.4.7 Key Values

❍ 6.5 Landmarks ■ 6.5.1 New ■ 6.5.2 GetList ■ 6.5.3 Add ■ 6.5.4 Delete ■ 6.5.5 Import ■ 6.5.6 Export ■ 6.5.7 Organise ■ 6.5.8 Key Values

❍ 6.6 Location ■ 6.6.1 GetList ■ 6.6.2 Trace ■ 6.6.3 CancelNotification ■ 6.6.4 MathOperations

❍ 6.7 Logging ■ 6.7.1 Add ■ 6.7.2 GetList ■ 6.7.3 Delete ■ 6.7.4 RequestNotification

❍ 6.8 Messaging ■ 6.8.1 GetList ■ 6.8.2 Send ■ 6.8.3 RegisterNotification ■ 6.8.4 CancelNotification ■ 6.8.5 ChangeStatus ■ 6.8.6 Delete

❍ 6.9 Media Management ■ 6.9.1 GetList



■ 6.9.2 Key Values ❍ 6.10 Sensors

■ 6.10.1 FindSensorChannel ■ 6.10.2 RegisterForNotification ■ 6.10.3 GetChannelProperty

❍ 6.11 Sys Info ■ 6.11.1 GetInfo ■ 6.11.2 SetInfo ■ 6.11.3 GetNotification ■ 6.11.4 Key Values

❍ 6.12 Appendix ■ 6.12.1 Platform Service API Error Codes and Description ■ 6.12.2 EventID

● 7. Module Repository ● 8. Extending and Embedding PyS60

❍ 8.1 Extending PyS60 ■ 8.1.1 Example Extension Module ■ 8.1.2 Compiling the extension module ■ 8.1.3 Distributing extension modules

❍ 8.2 Embedding PyS60 ❍ 8.3 Porting 1.4.x to 1.9.x

● 9. Terms and Abbreviations ● Bibliography ● A. Known Issues ● B. Reporting Bugs ● Module Index ● Index ● About this document ...


Up: Python Documentation Index Next: Front Matter

Release 1.9.7 final , documentation updated on 04 Aug 2009. See About this document... for information on suggesting changes.


Python 2.5.4 Documentation - 23rd December, 2008

Python Documentation

Python Documentation

Release 2.5.4 23rd December, 2008

● Tutorial (start here)

● What's New in Python (changes since the last major release)

● Global Module Index (for quick access to all documentation)

● Library Reference (keep this under your pillow)

● Macintosh Module Reference (this too, if you use a Macintosh)

● S60 Module Reference (and this, if you use an S60 device)

● Installing Python Modules (for administrators)

● Distributing Python Modules (for developers and packagers)

● Language Reference (for language lawyers)

● Extending and Embedding (tutorial for C/C++ programmers)

● Python/C API (reference for C/C++ programmers)

● Documenting Python (information for documentation authors)

● Documentation Central (for everyone)

● Python How-To Guides (special topics)

See About the Python Documentation for information on suggesting changes.

http://pys60.garage.maemo.org/doc/index.html27/08/2009 02:31:03

http://pys60.garage.maemo.org/doc/modindex.htmlhttp://pys60.garage.maemo.org/doc/tut/tut.htmlhttp://pys60.garage.maemo.org/doc/whatsnew/whatsnew25.htmlhttp://pys60.garage.maemo.org/doc/modindex.htmlhttp://pys60.garage.maemo.org/doc/lib/lib.htmlhttp://pys60.garage.maemo.org/doc/mac/mac.htmlhttp://pys60.garage.maemo.org/doc/inst/inst.htmlhttp://pys60.garage.maemo.org/doc/dist/dist.htmlhttp://pys60.garage.maemo.org/doc/ref/ref.htmlhttp://pys60.garage.maemo.org/doc/ext/ext.htmlhttp://pys60.garage.maemo.org/doc/api/api.htmlhttp://pys60.garage.maemo.org/doc/doc/doc.htmlhttp://www.python.org/doc/http://www.python.org/doc/howto/http://pys60.garage.maemo.org/doc/about.html

Front Matter


Previous: S60 Module Reference Up: S60 Module Reference Next: Contents

Front Matter

This is Python(R) for S60 version 1.9.7 final created by Nokia Corporation.

Copyright © 2004 - 2009 Nokia Corporation.

The original software, including modifications of Nokia Corporation therein, is licensed under the applicable license(s) for Python 2.5.4, unless specially indicated otherwise in the relevant source code file.

You can view the entire copyright information from here pys60_copyright_info.txt

Abstract:

This document is for Python for S60 Platform (Python for S60), which simplifies application development and provides a scripting solution for the Symbian C++ APIs.


Previous: S60 Module Reference Up: S60 Module Reference Next: Contents


http://pys60.garage.maemo.org/doc/s60/front.html27/08/2009 02:31:04

http://pys60.garage.maemo.org/doc/s60/pys60_copyright_info.txt

Contents


Previous: Front Matter Up: S60 Module Reference Next: 1. Getting Started

Contents

● 1. Getting Started ❍ 1.1 Installing Python runtime and its dependencies ❍ 1.2 Packaging a Sample Application

■ 1.2.1 On a Windows host machine ■ 1.2.2 On a Linux or Mac host machine

● 2. Operating System Services and Information ❍ 2.1 e32 -- A Symbian OS related services package

■ 2.1.1 Module Level Functions ■ 2.1.2 Ao_lock Type ■ 2.1.3 Ao_timer Type

❍ 2.2 sysinfo -- Access to system information ● 3. User Interface and Graphics

❍ 3.1 appuifw -- Interface to the S60 GUI framework ■ 3.1.1 Basics of appuifw Module ■ 3.1.2 Softkeys ■ 3.1.3 Module Level Functions ■ 3.1.4 Application Type ■ 3.1.5 Form Type ■ 3.1.6 Text Type ■ 3.1.7 Listbox Type ■ 3.1.8 Icon Type ■ 3.1.9 Content_handler Type ■ 3.1.10 Canvas Type ■ 3.1.11 InfoPopup Type

❍ 3.2 globalui -- Interface to the S60 global UI notifiers ❍ 3.3 graphics -- A graphics related services package

■ 3.3.1 Module Level Functions ■ 3.3.2 Image Class Static Methods ■ 3.3.3 Image Objects ■ 3.3.4 Common Features of Drawable Objects

❍ 3.4 camera -- Interface for taking photographs and video recording

http://pys60.garage.maemo.org/doc/s60/contents.html (1 of 5)27/08/2009 02:31:05

Contents

❍ 3.5 keycapture -- Interface for global capturing of key events. ■ 3.5.1 Module Level Constants ■ 3.5.2 KeyCapturer objects

❍ 3.6 topwindow -- Interface for creating windows that are shown on top of other applications.

■ 3.6.1 TopWindow objects ❍ 3.7 gles -- Bindings to OpenGL ES

■ 3.7.1 array type ■ 3.7.2 Error handling ■ 3.7.3 Differences to OpenGL ES C API

❍ 3.8 glcanvas -- UI Control for Displaying OpenGL ES Graphics ❍ 3.9 sensor -- Module to access the device sensors.

■ 3.9.1 Module for devices that support S60 Sensor API ■ 3.9.2 Module for devices that support S60 Sensor FrameWork

● 4. Audio and Communication Services ❍ 4.1 audio -- An audio related services package

■ 4.1.1 Sound Objects ❍ 4.2 telephone -- Telephone services ❍ 4.3 messaging -- A messaging services package ❍ 4.4 inbox -- Interface to device inbox

■ 4.4.1 Inbox Objects ❍ 4.5 location -- GSM location information

■ 4.5.1 Examples ❍ 4.6 positioning -- Simplified interface to the position information

■ 4.6.1 Example ❍ 4.7 btsocket -- Provides Bluetooth (BT) support

● 5. Data Management ❍ 5.1 contacts -- A contacts related services package

■ 5.1.1 Module Level Functions ■ 5.1.2 ContactDb Object ■ 5.1.3 Contact Object ■ 5.1.4 ContactField Object ■ 5.1.5 Groups Object ■ 5.1.6 Group Object

❍ 5.2 e32calendar -- Access to calendar related services ■ 5.2.1 Module Level Functions ■ 5.2.2 CalendarDb Objects ■ 5.2.3 Entry Objects


Contents

■ 5.2.4 Repeat Rules ❍ 5.3 e32db -- Interface to the Symbian native DB

■ 5.3.1 Dbms Objects ■ 5.3.2 DB_view Objects ■ 5.3.3 Mapping Between SQL and Python Data Types ■ 5.3.4 Date and Time Handling

❍ 5.4 e32dbm -- DBM implemented using the Symbian native DBMS ■ 5.4.1 Module Level Functions ■ 5.4.2 e32dbm Objects

❍ 5.5 logs -- Module to access the phone logs. ■ 5.5.1 Module Level Functions

❍ 5.6 Acronyms and Abbreviations ● 6. scriptext - Platform Service API Usage from Python runtime

❍ 6.1 Overview of scriptext usage ■ 6.1.1 Module level functions and Data Types ■ 6.1.2 Instantiating a Service Object ■ 6.1.3 Making Synchronous Request ■ 6.1.4 Making Asynchronous Request ■ 6.1.5 Cancelling of Asynchronous Service Request

❍ 6.2 Application Manager ■ 6.2.1 GetList ■ 6.2.2 LaunchApp ■ 6.2.3 LaunchDoc

❍ 6.3 Calendar ■ 6.3.1 GetList ■ 6.3.2 Add ■ 6.3.3 Delete ■ 6.3.4 Import ■ 6.3.5 Export ■ 6.3.6 RequestNotification ■ 6.3.7 Key Values

❍ 6.4 Contacts ■ 6.4.1 GetList ■ 6.4.2 Add ■ 6.4.3 Delete ■ 6.4.4 Import ■ 6.4.5 Export ■ 6.4.6 Organise


Contents

■ 6.4.7 Key Values ❍ 6.5 Landmarks

■ 6.5.1 New ■ 6.5.2 GetList ■ 6.5.3 Add ■ 6.5.4 Delete ■ 6.5.5 Import ■ 6.5.6 Export ■ 6.5.7 Organise ■ 6.5.8 Key Values

❍ 6.6 Location ■ 6.6.1 GetList ■ 6.6.2 Trace ■ 6.6.3 CancelNotification ■ 6.6.4 MathOperations

❍ 6.7 Logging ■ 6.7.1 Add ■ 6.7.2 GetList ■ 6.7.3 Delete ■ 6.7.4 RequestNotification

❍ 6.8 Messaging ■ 6.8.1 GetList ■ 6.8.2 Send ■ 6.8.3 RegisterNotification ■ 6.8.4 CancelNotification ■ 6.8.5 ChangeStatus ■ 6.8.6 Delete

❍ 6.9 Media Management ■ 6.9.1 GetList ■ 6.9.2 Key Values

❍ 6.10 Sensors ■ 6.10.1 FindSensorChannel ■ 6.10.2 RegisterForNotification ■ 6.10.3 GetChannelProperty

❍ 6.11 Sys Info ■ 6.11.1 GetInfo ■ 6.11.2 SetInfo ■ 6.11.3 GetNotification


Contents

■ 6.11.4 Key Values ❍ 6.12 Appendix

■ 6.12.1 Platform Service API Error Codes and Description ■ 6.12.2 EventID

● 7. Module Repository ● 8. Extending and Embedding PyS60

❍ 8.1 Extending PyS60 ■ 8.1.1 Example Extension Module ■ 8.1.2 Compiling the extension module ■ 8.1.3 Distributing extension modules

❍ 8.2 Embedding PyS60 ❍ 8.3 Porting 1.4.x to 1.9.x

● 9. Terms and Abbreviations ● Bibliography ● A. Known Issues ● B. Reporting Bugs ● Module Index ● Index


Previous: Front Matter Up: S60 Module Reference Next: 1. Getting Started



Module Index


Previous: B. Reporting Bugs Up: S60 Module Reference Next: Index

Module Index

This index only lists modules documented in this manual. The Global Module Index lists all modules that are documented in this set of manuals.

Some module names are followed by an annotation indicating what platform they are available on.

appuifw (S60) audio (S60) btsocket camera (S60) contacts (S60) e32 (S60)

e32calendar (S60) e32db (S60) e32dbm (S60) glcanvas (S60) gles (S60) globalui (S60)

graphics (S60) inbox (S60) keycapture (S60) location (S60) logs (S60) messaging (S60)

positioning (S60) scriptext sensor (S60) sysinfo (S60) telephone (S60) topwindow (S60)


Previous: B. Reporting Bugs Up: S60 Module Reference Next: Index


http://pys60.garage.maemo.org/doc/s60/modindex.html27/08/2009 02:31:06

http://pys60.garage.maemo.org/doc/modindex.html

Index


Previous: Module Index Up: S60 Module Reference Next: About this document ...

Index

_ | a | b | c | d | e | f | g | h | i | k | l | m | n | o | p | q | r | s | t | u | v | w

_ (underscore)

__del__() (EventFilter method) __delitem__() (CalendarDb method) __delitem__() (Contact method) __delitem__() (ContactDb method) __getitem__() (array method) __getitem__() (CalendarDb method)

__init__() (EventFilter method) __init__() (OrientationEventFilter method) __init__() (Sensor method) __len__() (array method) __setitem__() (array method)

A

access_point() (in module btsocket) access_points() (in module btsocket) activate_tab() (Application method) active_profile() (in module sysinfo) add() (Text method) add_anniversary() (CalendarDb method) add_appointment() (CalendarDb method) add_contact() (ContactDb method) add_event() (CalendarDb method) add_field() (Contact method) add_group() (Groups method) add_image() (TopWindow method) add_reminder() (CalendarDb method) add_todo() (CalendarDb method)

AnniversaryEntry (class in e32calendar) answer() (in module telephone) ao_callgate() (in module e32) Ao_lock (class in e32) ao_sleep() (in module e32) Ao_timer (class in e32) ao_yield() (in module e32) Application (class in appuifw) AppointmentEntry (class in e32calendar) appuifw (standard module) arc() (InfoPopup method) array (class in gles) as_vcalendar() (Entry method) as_vcard() (Contact method)

http://pys60.garage.maemo.org/doc/s60/genindex.html (1 of 12)27/08/2009 02:31:08

http://pys60.garage.maemo.org/doc/s60/node55.html#l2h-334http://pys60.garage.maemo.org/doc/s60/node55.html#l2h-333http://pys60.garage.maemo.org/doc/s60/node55.html#l2h-338http://pys60.garage.maemo.org/doc/s60/node55.html#l2h-326http://pys60.garage.maemo.org/doc/s60/node93.html#l2h-509http://pys60.garage.maemo.org/doc/s60/node91.html#l2h-507http://pys60.garage.maemo.org/doc/s60/node37.html#l2h-172

Index

address() (Inbox method) AF_BT (in module btsocket) after() (Ao_timer method) alarm (Entry attribute) all_keys (in module keycapture)

audio (extension module) AUTH (in module btsocket) AUTHOR (in module btsocket) available_fonts() (in module appuifw)

B

background_color (TopWindow attribute) battery() (in module sysinfo) begin() (Contact method) begin() (Dbms method) begin_redraw() (Canvas method) bind() (Canvas method) bind() (GLCanvas method) bind() (Inbox method) bind() (Listbox method) bind() (Text method)

blit() (InfoPopup method) body (Application attribute) bt_advertise_service() (in module btsocket) bt_discover() (in module btsocket) bt_obex_discover() (in module btsocket) bt_obex_receive() (in module btsocket) bt_obex_send_file() (in module btsocket) bt_rfcomm_get_available_server_channel() (in module btsocket) BTPROTO_RFCOMM (in module btsocket) btsocket (extension module)

C

CalendarDb (class in e32calendar) call_state() (in module telephone) callback (EventFilter attribute) calls() (in module logs) camera (extension module) cameras_available() (in module camera) cancel() (Ao_timer method) Canvas (class in appuifw) cleanup() (EventFilter method) cleanup() (OrientationEventFilter method) clear() (InfoPopup method)

commit() (Dbms method) commit() (Entry method) compact() (ContactDb method) compact() (Dbms method) compact_required() (ContactDb method) connect() (Sensor method) connected() (Sensor method) Contact (class in contacts) ContactDb (class in contacts) ContactField (class in contacts) contacts (extension module)


http://pys60.garage.maemo.org/doc/s60/node37.html#l2h-177http://pys60.garage.maemo.org/doc/s60/node55.html#l2h-332http://pys60.garage.maemo.org/doc/s60/node55.html#l2h-336http://pys60.garage.maemo.org/doc/s60/node55.html#l2h-340http://pys60.garage.maemo.org/doc/s60/node37.html#l2h-174http://pys60.garage.maemo.org/doc/s60/node55.html#l2h-327http://pys60.garage.maemo.org/doc/s60/node55.html#l2h-329

Index

clear() (Text method) close() (Dbms method) close() (e32dbm method) close() (Sound method) col() (Db_view method) col_count() (Db_view method) col_length() (Db_view method) col_raw() (Db_view method) col_rawtime() (Db_view method) col_type() (Db_view method) color (Text attribute) commit() (Contact method)

content (Entry attribute) content() (Inbox method) Content_handler (class in appuifw) corner_type (TopWindow attribute) count_line() (Db_view method) create() (Dbms method) cross_out_time (TodoEntry attribute) crossed_out (Entry attribute) current() (Listbox method) current_position() (Sound method) current_volume() (Sound method)

D

daily_instances() (CalendarDb method) data_logs() (in module logs) Db_view (class in e32db) Dbms (class in e32db) default_module() (in module positioning) delete() (Inbox method) delete() (Text method) dial() (in module telephone)

directional_pad (Application attribute) disconnect() (Sensor method) display_pixels() (in module sysinfo) display_twips() (in module sysinfo) drawNow() (GLCanvas method) drive_list() (in module e32) duration() (Sound method)

E


http://pys60.garage.maemo.org/doc/s60/node95.html#l2h-512http://pys60.garage.maemo.org/doc/s60/node55.html#l2h-328

Index

e32 (extension module) e32calendar (extension module) e32db (extension module) e32dbm (module) EAColumn (in module appuifw) EApplicationWindow (in module appuifw) EBatteryPane (in module appuifw) EBColumn (in module appuifw) ECColumn (in module appuifw) EContextPane (in module appuifw) EControlPane (in module appuifw) EControlPaneBottom (in module appuifw) EControlPaneTop (in module appuifw) ECreated (in module messaging) EDColumn (in module appuifw) EDeleted (in module messaging) EDraft (in module inbox) EFatalServerError (in module messaging) EFindPane (in module appuifw) EHCenterVBottom (in module appuifw) EHCenterVCenter (in module appuifw) EHCenterVTop (in module appuifw) EHLeftVBottom (in module appuifw) EHLeftVCenter (in module appuifw) EHLeftVTop (in module appuifw) EHRightVBottom (in module appuifw) EHRightVCenter (in module appuifw) EHRightVTop (in module appuifw) EInbox (in module inbox) EIndicatorPane (in module appuifw) ellipse() (InfoPopup method) emails() (in module logs) EMainPane (in module appuifw) EMovedToOutBox (in module messaging) ENaviPane (in module appuifw) ENCRYPT (in module btsocket) end_redraw() (Canvas method) end_time (Entry attribute)

EOutbox (in module inbox) EPlaying (in module audio) EPrepareComplete (in module camera) ERecordComplete (in module camera) ERecording (in module audio) EScheduledForSend (in module messaging) EScheduleFailed (in module messaging) EScreen (in module appuifw) ESendFailed (in module messaging) ESent (in module inbox) ESent (in module messaging) ESignalPane (in module appuifw) EStaconBottom (in module appuifw) EStaconTop (in module appuifw) EStatusAnswering (in module telephone) EStatusConnected (in module telephone) EStatusConnecting (in module telephone) EStatusDialling (in module telephone) EStatusDisconnecting (in module telephone) EStatusHold (in module telephone) EStatusIdle (in module telephone) EStatusPane (in module appuifw) EStatusPaneBottom (in module appuifw) EStatusPaneTop (in module appuifw) EStatusReconnectPending (in module telephone) EStatusRinging (in module telephone) EStatusTransferAlerting (in module telephone) EStatusTransferring (in module telephone) EStatusUnknown (in module telephone) ETitlePane (in module appuifw) EUniversalIndicatorPane (in module appuifw) event() (EventFilter method) event() (OrientationEventFilter method), [Link] EventEntry (class in e32calendar) EventFilter (class in sensor) EWallpaperPane (in module appuifw) execute() (Dbms method) execute() (Form method)


http://pys60.garage.maemo.org/doc/s60/node37.html#l2h-170http://pys60.garage.maemo.org/doc/s60/node55.html#l2h-335http://pys60.garage.maemo.org/doc/s60/node55.html#l2h-339http://pys60.garage.maemo.org/doc/s60/node55.html#l2h-342http://pys60.garage.maemo.org/doc/s60/node92.html#l2h-508http://pys60.garage.maemo.org/doc/s60/node55.html#l2h-331

Index

ENoServiceCentre (in module messaging) ENotReady (in module audio) Entry (class in e32calendar) EOpen (in module audio) EOpenComplete (in module camera)

exit_key_handler (Application attribute) export_vcalendars() (CalendarDb method) export_vcards() (ContactDb method) exposure_modes() (in module camera)

F

faxes() (in module logs) FFormAutoFormEdit (in module appuifw) FFormAutoLabelEdit (in module appuifw) FFormDoubleSpaced (in module appuifw) FFormEditModeOnly (in module appuifw) FFormViewModeOnly (in module appuifw) field_types() (ContactDb method) file_copy() (in module e32) find() (Contact method) find() (ContactDb method) find_instances() (CalendarDb method) first_line() (Db_view method)

flags (Form attribute) flash_modes() (in module camera) focus (Application attribute) focus (Text attribute) font (Text attribute) Form (class in appuifw) format_rawtime() (in module e32db) format_time() (in module e32db) forwarding (KeyCapturer attribute) free_drivespace() (in module sysinfo) free_ram() (in module sysinfo) full_name() (Application method)

G

get() (Text method) get_capabilities() (in module e32) get_line() (Db_view method) get_pos() (Text method) get_repeat() (Entry method) glBufferData() (in module gles) glBufferDatab() (in module gles) glBufferDataf() (in module gles) glBufferDatas() (in module gles) glBufferDataub() (in module gles)

glGetTexEnvx() (in module gles) glGetTexParameterf() (in module gles) glGetTexParameterx() (in module gles) glLightfv() (in module gles) glLightModelfv() (in module gles) glLightModelxv() (in module gles) glLightxv() (in module gles) glLoadMatrixf() (in module gles) glLoadMatrixx() (in module gles) glMaterialfv() (in module gles)


http://pys60.garage.maemo.org/doc/s60/node49.html#l2h-266http://pys60.garage.maemo.org/doc/s60/node49.html#l2h-267http://pys60.garage.maemo.org/doc/s60/node49.html#l2h-271http://pys60.garage.maemo.org/doc/s60/node49.html#l2h-269http://pys60.garage.maemo.org/doc/s60/node49.html#l2h-268http://pys60.garage.maemo.org/doc/s60/node49.html#l2h-299http://pys60.garage.maemo.org/doc/s60/node49.html#l2h-300http://pys60.garage.maemo.org/doc/s60/node49.html#l2h-301http://pys60.garage.maemo.org/doc/s60/node48.html#l2h-238http://pys60.garage.maemo.org/doc/s60/node48.html#l2h-236http://pys60.garage.maemo.org/doc/s60/node48.html#l2h-237http://pys60.garage.maemo.org/doc/s60/node48.html#l2h-239http://pys60.garage.maemo.org/doc/s60/node48.html#l2h-240http://pys60.garage.maemo.org/doc/s60/node48.html#l2h-241http://pys60.garage.maemo.org/doc/s60/node48.html#l2h-242

Index

glBufferDataus() (in module gles) glBufferDatax() (in module gles) glBufferSubData() (in module gles) glBufferSubDatab() (in module gles) glBufferSubDataf() (in module gles) glBufferSubDatas() (in module gles) glBufferSubDataub() (in module gles) glBufferSubDataus() (in module gles) glBufferSubDatax() (in module gles) GLCanvas (class in glcanvas) glcanvas (extension module) glClipPlanef() (in module gles) glClipPlanex() (in module gles) glColorPointer() (in module gles) glColorPointerf() (in module gles) glColorPointerub() (in module gles) glColorPointerx() (in module gles) glCompressedTexImage2D() (in module gles) glCompressedTexSubImage2D() (in module gles) glDeleteBuffers() (in module gles) glDeleteTextures() (in module gles) glDrawElements() (in module gles) glDrawElementsub() (in module gles) glDrawElementsus() (in module gles) glDrawTexfvOES() (in module gles), [Link] glDrawTexivOES() (in module gles) glDrawTexsvOES() (in module gles) gles (extension module) glFogv() (in module gles) glFogxv() (in module gles) glGenBuffers() (in module gles) glGenTextures() (in module gles) glGetBooleanv() (in module gles) glGetBufferParameteriv() (in module gles) glGetClipPlanef() (in module gles), [Link] glGetFixedv() (in module gles) glGetFloatv() (in module gles) glGetIntegerv() (in module gles)

glMaterialxv() (in module gles) glMatrixIndexPointerOES() (in module gles) glMatrixIndexPointerOESub() (in module gles) glMultMatrixf() (in module gles) glMultMatrixx() (in module gles) glNormalPointer() (in module gles) glNormalPointerb() (in module gles) glNormalPointerf() (in module gles) glNormalPointers() (in module gles) glNormalPointerx() (in module gles) global_msg_query() (in module globalui) global_note() (in module globalui) global_popup_menu() (in module globalui) global_query() (in module globalui) globalui (extension module) glPointParameterfv() (in module gles) glPointParameterxv() (in module gles) glPointSizePointerOES() (in module gles) glPointSizePointerOESf() (in module gles) glPointSizePointerOESx() (in module gles) glReadPixels() (in module gles) glTexCoordPointer() (in module gles) glTexCoordPointerb() (in module gles) glTexCoordPointerf() (in module gles) glTexCoordPointers() (in module gles) glTexCoordPointerx() (in module gles) glTexEnvfv() (in module gles) glTexEnvxv() (in module gles) glTexImage2D() (in module gles) glTexSubImage2D() (in module gles) glVertexPointer() (in module gles) glVertexPointerb() (in module gles) glVertexPointerf() (in module gles) glVertexPointers() (in module gles) glVertexPointerx() (in module gles) glWeightPointerOES() (in module gles) glWeightPointerOESf() (in module gles) glWeightPointerOESx() (in module gles)


http://pys60.garage.maemo.org/doc/s60/node49.html#l2h-270http://pys60.garage.maemo.org/doc/s60/node49.html#l2h-272http://pys60.garage.maemo.org/doc/s60/node49.html#l2h-273http://pys60.garage.maemo.org/doc/s60/node49.html#l2h-274http://pys60.garage.maemo.org/doc/s60/node49.html#l2h-278http://pys60.garage.maemo.org/doc/s60/node49.html#l2h-276http://pys60.garage.maemo.org/doc/s60/node49.html#l2h-275http://pys60.garage.maemo.org/doc/s60/node49.html#l2h-277http://pys60.garage.maemo.org/doc/s60/node49.html#l2h-279http://pys60.garage.maemo.org/doc/s60/node49.html#l2h-280http://pys60.garage.maemo.org/doc/s60/node49.html#l2h-281http://pys60.garage.maemo.org/doc/s60/node48.html#l2h-221http://pys60.garage.maemo.org/doc/s60/node48.html#l2h-223http://pys60.garage.maemo.org/doc/s60/node48.html#l2h-222http://pys60.garage.maemo.org/doc/s60/node48.html#l2h-224http://pys60.garage.maemo.org/doc/s60/node48.html#l2h-225http://pys60.garage.maemo.org/doc/s60/node48.html#l2h-226http://pys60.garage.maemo.org/doc/s60/node49.html#l2h-282http://pys60.garage.maemo.org/doc/s60/node48.html#l2h-227http://pys60.garage.maemo.org/doc/s60/node48.html#l2h-228http://pys60.garage.maemo.org/doc/s60/node48.html#l2h-229http://pys60.garage.maemo.org/doc/s60/node48.html#l2h-230http://pys60.garage.maemo.org/doc/s60/node49.html#l2h-285http://pys60.garage.maemo.org/doc/s60/node49.html#l2h-286http://pys60.garage.maemo.org/doc/s60/node49.html#l2h-284http://pys60.garage.maemo.org/doc/s60/node49.html#l2h-283http://pys60.garage.maemo.org/doc/s60/node48.html#l2h-231http://pys60.garage.maemo.org/doc/s60/node48.html#l2h-232http://pys60.garage.maemo.org/doc/s60/node49.html#l2h-287http://pys60.garage.maemo.org/doc/s60/node48.html#l2h-233http://pys60.garage.maemo.org/doc/s60/node49.html#l2h-288http://pys60.garage.maemo.org/doc/s60/node49.html#l2h-289http://pys60.garage.maemo.org/doc/s60/node49.html#l2h-290http://pys60.garage.maemo.org/doc/s60/node49.html#l2h-291http://pys60.garage.maemo.org/doc/s60/node49.html#l2h-292http://pys60.garage.maemo.org/doc/s60/node49.html#l2h-293http://pys60.garage.maemo.org/doc/s60/node48.html#l2h-234http://pys60.garage.maemo.org/doc/s60/node48.html#l2h-243http://pys60.garage.maemo.org/doc/s60/node49.html#l2h-302http://pys60.garage.maemo.org/doc/s60/node49.html#l2h-303http://pys60.garage.maemo.org/doc/s60/node48.html#l2h-244http://pys60.garage.maemo.org/doc/s60/node48.html#l2h-245http://pys60.garage.maemo.org/doc/s60/node48.html#l2h-246http://pys60.garage.maemo.org/doc/s60/node48.html#l2h-247http://pys60.garage.maemo.org/doc/s60/node48.html#l2h-249http://pys60.garage.maemo.org/doc/s60/node48.html#l2h-248http://pys60.garage.maemo.org/doc/s60/node48.html#l2h-250http://pys60.garage.maemo.org/doc/s60/node49.html#l2h-304http://pys60.garage.maemo.org/doc/s60/node49.html#l2h-305http://pys60.garage.maemo.org/doc/s60/node49.html#l2h-306http://pys60.garage.maemo.org/doc/s60/node49.html#l2h-307http://pys60.garage.maemo.org/doc/s60/node49.html#l2h-308http://pys60.garage.maemo.org/doc/s60/node48.html#l2h-251http://pys60.garage.maemo.org/doc/s60/node48.html#l2h-252http://pys60.garage.maemo.org/doc/s60/node48.html#l2h-253http://pys60.garage.maemo.org/doc/s60/node48.html#l2h-255http://pys60.garage.maemo.org/doc/s60/node48.html#l2h-254http://pys60.garage.maemo.org/doc/s60/node48.html#l2h-256http://pys60.garage.maemo.org/doc/s60/node48.html#l2h-257http://pys60.garage.maemo.org/doc/s60/node48.html#l2h-258http://pys60.garage.maemo.org/doc/s60/node48.html#l2h-259http://pys60.garage.maemo.org/doc/s60/node48.html#l2h-260http://pys60.garage.maemo.org/doc/s60/node48.html#l2h-261http://pys60.garage.maemo.org/doc/s60/node48.html#l2h-262http://pys60.garage.maemo.org/doc/s60/node48.html#l2h-264http://pys60.garage.maemo.org/doc/s60/node48.html#l2h-263http://pys60.garage.maemo.org/doc/s60/node48.html#l2h-265http://pys60.garage.maemo.org/doc/s60/node49.html#l2h-309http://pys60.garage.maemo.org/doc/s60/node49.html#l2h-310http://pys60.garage.maemo.org/doc/s60/node49.html#l2h-311

Index

glGetLightfv() (in module gles) glGetLightxv() (in module gles) glGetMaterialfv() (in module gles) glGetMaterialxv() (in module gles) glGetString() (in module gles) glGetTexEnvf() (in module gles)

graphics (extension module) Group (class in contacts) Groups (class in contacts) groups (ContactDb attribute) gsm_location() (in module location)

H

hang\_up() (in module telephone) has_capabilities() (in module e32) hide() (InfoPopup method) hide() (TopWindow method)

highlight_color (Text attribute) HIGHLIGHT_ROUNDED (in module appuifw) HIGHLIGHT_SHADOW (in module appuifw) HIGHLIGHT_STANDARD (in module appuifw)

I

Icon (class in appuifw) id (Contact attribute) id (Entry attribute) id (Group attribute) Image.inspect() (in module graphics) Image.new() (in module graphics) Image.open() (in module graphics) image_modes() (in module camera) image_sizes() (in module camera) images (TopWindow attribute) imei() (in module sysinfo) import_vcalendars() (CalendarDb method)

import_vcards() (ContactDb method) in_emulator() (in module e32) inactivity() (in module e32) Inbox (class in inbox) inbox (extension module) incoming_call() (in module telephone) InfoPopup (class in appuifw) insert() (Form method) is_col_null() (Db_view method) is_group (Contact attribute) is_ui_thread() (in module e32)

K



Index

keycapture (extension module) keys() (ContactDb method)

keys (KeyCapturer attribute) KMdaRepeatForever (in module audio)

L

label (ContactField attribute) last_key() (KeyCapturer method) last_modified (Contact attribute) last_modified (Entry attribute) last_position() (in module positioning) layout() (Application method) len() (Text method) length() (Form method) line() (InfoPopup method)

Listbox (class in appuifw) load() (Image method) location (ContactField attribute) location (Entry attribute) location (extension module) log_data() (in module logs) log_data_by_time() (in module logs) logs (extension module)

M

makeCurrent() (GLCanvas method) max_ramdrive_size() (in module sysinfo) max_volume() (Sound method) max_zoom() (in module camera) maximum_size (TopWindow attribute) measure_text() (InfoPopup method) menu (Application attribute) menu (Form attribute)

messaging (extension module) mms_send() (in module messaging) module_info() (in module positioning) modules() (in module positioning) monthly_instances() (CalendarDb method) multi_query() (in module appuifw) multi_selection_list() (in module appuifw)

N



Index

name (Group attribute) next_line() (Db_view method)

note() (in module appuifw)

O

OBEX (in module btsocket) open() (Content_handler method) open() (Dbms method) open() (in module contacts) open() (in module e32calendar) open() (in module e32dbm) open_standalone() (Content_handler method) orientation (Application attribute) orientation.BACK (GLCanvas attribute)

orientation.BOTTOM (GLCanvas attribute) orientation.FRONT (GLCanvas attribute) orientation.LEFT (GLCanvas attribute) orientation.RIGHT (GLCanvas attribute) orientation.TOP (GLCanvas attribute) OrientationEventFilter (class in sensor) originating (Entry attribute) os_version() (in module sysinfo)

P

pieslice() (InfoPopup method) play() (Sound method) point() (InfoPopup method) polygon() (InfoPopup method) pop() (Form method) popup_menu() (in module appuifw) position() (in module positioning) position (Listbox attribute)

position (TopWindow attribute) POSITION_INTERVAL (in module positioning) positioning (extension module) prepare() (Db_view method) priority (Entry attribute) pys60_version (in module e32) pys60_version_info (in module e32)

Q

query() (in module appuifw)


http://pys60.garage.maemo.org/doc/s60/node54.html#l2h-324http://pys60.garage.maemo.org/doc/s60/node54.html#l2h-320http://pys60.garage.maemo.org/doc/s60/node54.html#l2h-323http://pys60.garage.maemo.org/doc/s60/node54.html#l2h-321http://pys60.garage.maemo.org/doc/s60/node54.html#l2h-322http://pys60.garage.maemo.org/doc/s60/node54.html#l2h-319http://pys60.garage.maemo.org/doc/s60/node55.html#l2h-337http://pys60.garage.maemo.org/doc/s60/node37.html#l2h-171http://pys60.garage.maemo.org/doc/s60/node37.html#l2h-173http://pys60.garage.maemo.org/doc/s60/node37.html#l2h-168

Index

R

raw_log_data() (in module logs) record() (Sound method) rectangle() (InfoPopup method) release() (in module camera) ReminderEntry (class in e32calendar) remove_image() (TopWindow method) reorganize() (e32dbm method) replication (Entry attribute)

reset_inactivity() (in module e32) resize() (Image method) RFCOMM (in module btsocket) ring_type() (in module sysinfo) rollback() (Contact method) rollback() (Dbms method) rollback() (Entry method) RotEventFilter (class in sensor)

S

s60_version_info (in module e32) save() (Image method) save_hook (Form attribute) say() (in module audio) scheduler_logs() (in module logs) schema (ContactField attribute) screen (Application attribute) screenshot() (in module graphics) scriptext (extension module) select_access_point() (in module btsocket) select_module() (in module positioning) selection_list() (in module appuifw) Sensor (class in sensor) sensor (extension module) sensors() (in module sensor) set() (Text method) set_default_access_point() (in module btsocket) set_event_filter() (Sensor method) set_exit() (Application method) set_home_time() (in module e32) set_list() (Listbox method)

signal() (Ao_lock method) signal_bars() (in module sysinfo) signal_dbm() (in module sysinfo) size (Canvas attribute) size (Image attribute) size (Listbox attribute) size (TopWindow attribute) sms() (in module logs) sms_messages() (Inbox method) sms_send() (in module messaging) Sound (class in audio) Sound.open() (in module audio) start() (KeyCapturer method) start_exe() (in module e32) start_finder() (in module camera) start_record() (in module camera) start_server() (in module e32) start_time (Entry attribute) state() (Sound method) stop() (Image method) stop() (KeyCapturer method)



Index

set_pos() (Text method) set_position() (Sound method) set_repeat() (Entry method) set_requestors() (in module positioning) set_security() (in module btsocket) set_tabs() (Application method) set_time() (Entry method) set_unread() (inbox method) set_volume() (Sound method) shadow (TopWindow attribute) show() (InfoPopup method) show() (TopWindow method)

stop() (Sound method) stop_finder() (in module camera) stop_position() (in module positioning) stop_record() (in module camera) style (Text attribute) STYLE_BOLD (in module appuifw) STYLE_ITALIC (in module appuifw) STYLE_STRIKETHROUGH (in module appuifw) STYLE_UNDERLINE (in module appuifw) sw_version() (in module sysinfo) sync() (e32dbm method) sysinfo (extension module)

T

take_photo() (in module camera) telephone (extension module) text() (InfoPopup method) time() (Inbox method) title (Application attribute) title (Contact attribute) TodoEntry (class in e32calendar) TopWindow (class in topwindow)

topwindow (extension module) total_ram() (in module sysinfo) total_rom() (in module sysinfo) touch_enabled() (in module appuifw) transpose() (Image method) twipsize (Image attribute) type (ContactField attribute)

U

uid() (Application method) unread() (Inbox method)

V



Index

value (ContactField attribute) visible (TopWindow attribute)

W

wait() (Ao_lock method) white_balance_modes() (in module camera)


Previous: Module Index Up: S60 Module Reference Next: About this document ...



1. Getting Started


Previous: Contents Up: S60 Module Reference Next: 1.1 Installing Python runtime

1. Getting Started

Thank you for installing Python for S60 package. Python for S60 is a powerful scripting language with an extensive standard library and easy-to-use APIs for S60 phone features, based on Python 2.5.4.

Subsections

● 1.1 Installing Python runtime and its dependencies ● 1.2 Packaging a Sample Application

❍ 1.2.1 On a Windows host machine ❍ 1.2.2 On a Linux or Mac host machine


Previous: Contents Up: S60 Module Reference Next: 1.1 Installing Python runtime


http://pys60.garage.maemo.org/doc/s60/getstarted.html27/08/2009 02:31:10

1.1 Installing Python runtime and its dependencies


Previous: 1. Getting Started Up: 1. Getting Started Next: 1.2 Packaging a Sample

1.1 Installing Python runtime and its dependencies

Python runtime package has embedded dependent packages in it. It can be installed either from an installer or from an archive depending on the host machine - For Windows host machine, download Installer - For Linux or Mac host machine, download Archive Optional libraries and PythonScriptShell packages are available as part of both Installer and Archive - stdioserver to run python scripts packaged with console profile. - SSL library if you need SSL support in socket module. Note: The unsigned Python runtime component and the PythonScriptShell packages are also available with high capability set in Installer/Archive


Previous: 1. Getting Started Up: 1. Getting Started Next: 1.2 Packaging a Sample


http://pys60.garage.maemo.org/doc/s60/install.html27/08/2009 02:31:10

https://garage.maemo.org/frs/download.php/6446/PythonForS60_1.9.7_Setup.exehttps://garage.maemo.org/frs/download.php/6448/PythonForS60_1.9.7.tar.gz

1.2 Packaging a Sample Application


Previous: 1.1 Installing Python runtime Up: 1. Getting Started Next: 1.2.1 On a Windows

1.2 Packaging a Sample Application

This section describes how to create a sis file from a Python script.

Subsections

● 1.2.1 On a Windows host machine ● 1.2.2 On a Linux or Mac host machine


Previous: 1.1 Installing Python runtime Up: 1. Getting Started Next: 1.2.1 On a Windows


http://pys60.garage.maemo.org/doc/s60/package.html27/08/2009 02:31:11

1.2.1 On a Windows host machine


Previous: 1.2 Packaging a Sample Up: 1.2 Packaging a Sample Next: 1.2.2 On a Linux

1.2.1 On a Windows host machine

The following steps provide the procedure for writing and packaging a helloworld script.

● Create a "helloworld" script with the filename "helloworld.py" containing print "Hello World!" code snippet.

● Click Start > Programs > PythonForS60 1.9.7 > PyS60 Application Packager, the PyS60 application packager dialog box opens.

● Select the Scriptfile radio button and then, click the Browse button to select the helloworld.py script from the file Open dialog.

● Click the Create button to create the sis file with the current settings. ● Install the sis file helloworld_v1_0_0.sis created in the source directory of "helloworld.py" file.


Previous: 1.2 Packaging a Sample Up: 1.2 Packaging a Sample Next: 1.2.2 On a Linux


http://pys60.garage.maemo.org/doc/s60/node6.html27/08/2009 02:31:12

1.2.2 On a Linux or Mac host machine


Previous: 1.2.1 On a Windows Up: 1.2 Packaging a Sample Next: 2. Operating System Services

1.2.2 On a Linux or Mac host machine

The following steps provide the procedure for writing and packaging a helloworld script.

● Create a "helloworld" script with the filename "helloworld.py" containing print "Hello World!" code snippet.

● Using a command prompt, enter the directory which contains the ensymble.py and copy the "helloworld.py" file here.

● Execute the command "python ensymble.py py2sis helloworld.py". ● The sis file would be generated in the current directory. Install this on an S60 device. ● Execute "python ensymble.py py2sis --help", for more info on py2sis options.


Previous: 1.2.1 On a Windows Up: 1.2 Packaging a Sample Next: 2. Operating System Services


http://pys60.garage.maemo.org/doc/s60/win.html27/08/2009 02:31:13

2. Operating System Services and Information


Previous: 1.2.2 On a Linux Up: S60 Module Reference Next: 2.1 e32

2. Operating System Services and Information

Subsections

● 2.1 e32 -- A Symbian OS related services package ❍ 2.1.1 Module Level Functions ❍ 2.1.2 Ao_lock Type ❍ 2.1.3 Ao_timer Type

● 2.2 sysinfo -- Access to system information


Previous: 1.2.2 On a Linux Up: S60 Module Reference Next: 2.1 e32


http://pys60.garage.maemo.org/doc/s60/s60os.html27/08/2009 02:31:14

2.1 e32 -- A Symbian OS related services package


Previous: 2. Operating System Services Up: 2. Operating System Services Next: 2.1.1 Module Level Functions

2.1 e32 -- A Symbian OS related services package

Availability: S60.

The e32 module offers Symbian OS related utilities that are not related to the UI and are not provided by the standard Python library modules.

Subsections

● 2.1.1 Module Level Functions ● 2.1.2 Ao_lock Type ● 2.1.3 Ao_timer Type


Previous: 2. Operating System Services Up: 2. Operating System Services Next: 2.1.1 Module Level Functions


http://pys60.garage.maemo.org/doc/s60/module-e32.html27/08/2009 02:31:15

2.1.1 Module Level Functions


Previous: 2.1 e32 Up: 2.1 e32 Next: 2.1.2 Ao_lock Type


The following free functions - functions that do not belong to any class - are defined in the e32 module:

ao_yield()

Yields to the active scheduler to have ready active objects with priority above normal scheduled for running. This has the effect of flushing the eventual pending UI events. Note that the UI callback code may be run in the context of the thread that performs an ao_yield. For information on active scheduler, see S60 SDK documentation [4].

ao_sleep(interval [, callback])Sleeps for the given interval without blocking the active scheduler. When the optional callback is given, the call to ao_sleep returns immediately and the callback gets called after interval. See also Section 2.1.3, Ao_timer Type.

ao_callgate(wrapped_callable)Wraps wrapped_callable into returned callable object callgate that can be called in any thread. As a result of a call to callgate, wrapped_callable gets called in the context of the thread that originally created the callgate. Arguments can be given to the call. This is actually a simple wrapping of the Symbian active object facility.

drive_list()Returns a list of currently visible drives as a list of Unicode strings ':'

file_copy(target_name, source_name)Copies the file source_name to target_name. The names must be complete paths.

in_emulator()Returns True if running in an emulator, or False if running on a device.

set_home_time(time)Set the device's time to time (see Section ).

pys60_versionA string containing the version number of the Python for S60 and some additional information.

http://pys60.garage.maemo.org/doc/s60/node10.html (1 of 3)27/08/2009 02:31:16


Example:

>>> import e32>>> e32.pys60_version'1.9.3 svn2793'>>>

pys60_version_infoA tuple containing the five components of the Python for S60 version number: major, minor, micro, release tag, and serial. All values except release level are integers; the release tag is a string. A value other than 'final' for the release tag signifies a development release. The pys60_version_info value corresponding to the Python for S60 version 1.9.3 is (1, 9, 3, 'svn2793', 0).

Example:

>>> import e32>>> e32.pys60_version_info(1, 9, 3, 'svn2793', 0)>>>

s60_version_infoReturns the S60 platform version of the device.

Example:

>>> import e32>>> e32.s60_version_info(3, 0)>>>

is_ui_thread()Returns True if the code that calls this function runs in the context of the UI thread; otherwise returns False.

start_exe(filename, command [,wait])Launches the native Symbian OS executable filename (Unicode) and passes it the command string. When wait is set, the function synchronously waits for the exit of the executable and returns a value that describes the exit type. Possible values are 0 for normal exit and 2 for abnormal exit.

start_server(filename)



Starts the Python script in file filename (Unicode) as a server in its own process. Note that appuifw module is not available to a server script.

reset_inactivity()Resets the timers since the user was last active. As a consequence, the device backlight is normally turned on when this function is invoked.

inactivity()Returns the time in seconds since the user of the device was last active.

get_capabilities()Returns tuple of capabilities granted to the application. Example:

>>> import e32>>> e32.get_capabilities()('ReadUserData','WriteUserData')>>>

has_capabilities(capability_list)Check if the application has all the capabilities that are passed in a list, 'capability_list'. Returns True if all the capabilities specified in the list are present, False otherwise.

Examples:

>>> import e32>>> e32.has_capabilities(['Location','ReadUserData'])False>>> e32.has_capabilities(['Location','SwEvent'])False>>> e32.has_capabilities(['WriteUserData','ReadUserData'])True>>>


Previous: 2.1 e32 Up: 2.1 e32 Next: 2.1.2 Ao_lock Type



2.1.2 Ao_lock Type


Previous: 2.1.1 Module Level Functions Up: 2.1 e32 Next: 2.1.3 Ao_timer Type

2.1.2 Ao_lock Type

class Ao_lock()Creates an Ao_lock instance. A Symbian active object based synchronization service. This can be used in the main thread without blocking the handling of UI events. The application should not exit while a thread is waiting in Ao_lock. If Ao_lock.wait is called while another wait call is already in progress, an AssertionError is raised.

Instances of Ao_lock type have the following methods:

wait()If the lock has already been signaled, returns immediately. Otherwise blocks in wait for the lock to be signaled. Only one waiter is allowed, so you should avoid recursive calls to this service. wait can only be called in the thread that created the lock object. During the wait, other Symbian-active objects are being served, so the UI will not freeze. This may result in the UI callback code being run in the context of the thread that is waiting in Ao_lock. This must be considered when designing the application logic.

signal()Signals the lock. The waiter is released.


Previous: 2.1.1 Module Level Functions Up: 2.1 e32 Next: 2.1.3 Ao_timer Type



2.1.3 Ao_timer Type


Previous: 2.1.2 Ao_lock Type Up: 2.1 e32 Next: 2.2 sysinfo

2.1.3 Ao_timer Type

The rationale for the Ao_timer type is that you cannot cancel a pending e32.ao_sleep. This is problematic if e.g. the user exits an application which is sleeping. In this case a panic would occur since the sleep is not cancelled - this is the reason you should avoid using e32.ao_sleep and instead use the Ao_timer with appropriate cancel calls if there is for example a possibility for the user to exit the application during a sleep.

class Ao_timer()Creates an Ao_timer instance. A Symbian active object based sleeping service. This can be used in the main thread without blocking the handling of UI events. The application should not exit while a thread has a pending after call in Ao_timer. Only one after invocation can be pending at time for each instance of this type.

Instances of Ao_timer type have the following methods:

after(interval [,callback])Sleeps for the given interval without blocking the active scheduler. When the optional callback is given, the call to after returns immediately and the callback gets called after interval.

cancel()Cancels a pending after call.


Previous: 2.1.2 Ao_lock Type Up: 2.1 e32 Next: 2.2 sysinfo



2.2 sysinfo -- Access to system information


Previous: 2.1.3 Ao_timer Type Up: 2. Operating System Services Next: 3. User Interface and


Availability: S60.

The sysinfo module offers an API for checking the system information of a S60 mobile device.

The sysinfo module has the following functions:

active_profile()Returns the current active profile as a string, which can be one of the following: 'general', 'silent', 'meeting', 'outdoor', 'pager', 'offline', , 'drive', or 'user '.

battery()Returns the current battery level. The value ranges from 0 (empty) to 100 (full) on a S60 mobile device. On the emulator the value is always 0.

Note: The returned value may be incorrect while the device is being charged.

display_twips()

Returns the width and height of the display in twips. For a definition of a twip, see Chapter 9, Terms and Abbreviations.

display_pixels()Returns the width and height of the display in pixels.

free_drivespace()Returns the amount of free space left on the drives in bytes, for example {u'C:' 100}. The keys in the dictionary are the drive letters followed by a colon (:).

imei()Returns the IMEI code of the device as a Unicode string or, if running on the emulator, the hardcoded string u'000000000000000'.

http://pys60.garage.maemo.org/doc/s60/module-sysinfo.html (1 of 3)27/08/2009 02:31:19


max_ramdrive_size()Returns the maximum size of the RAM drive on the device.

total_ram()Returns the amount of RAM memory on the device.

free_ram()Returns the amount of free RAM memory available on the device.

total_rom()Returns the amount of read-only ROM memory on the device.

ring_type()Returns the current ringing type as a string, which can be one of the following: 'normal', 'ascending', 'ring_once', 'beep', or 'silent'.

os_version()

Returns the operating system version number of the device as a three element tuple (major version, minor version, build number). The elements are as follows2.1:

❍ The major version number, ranging from 0 to 127 inclusive ❍ The minor version number, ranging from 0 to 99 inclusive ❍ The build number, ranging from 0 to 32767 inclusive.

signal_bars()Returns the current network signal strength ranging from 0 to 7, with 0 meaning no signal and 7 meaning a strong signal. If using an emulator, value 0 is always returned.

signal_dbm()Returns the current network signal strength in dBm. This is available SDK 2.8 onwards. If using an emulator value 0 is always returned.

sw_version()Returns the software version as a Unicode string. On the emulator, returns the hardcoded string u'emulator'. For example, a software version can be returned as u'V 4.09.1 26-02-04 NHL-10 (c) NMP'.



Footnotes

... follows2.1

Descriptions for these values are based on information found in S60 SDK documentation [4].


Previous: 2.1.3 Ao_timer Type Up: 2. Operating System Services Next: 3. User Interface and



3. User Interface and Graphics


Previous: 2.2 sysinfo Up: S60 Module Reference Next: 3.1 appuifw


Subsections

● 3.1 appuifw -- Interface to the S60 GUI framework ❍ 3.1.1 Basics of appuifw Module ❍ 3.1.2 Softkeys ❍ 3.1.3 Module Level Functions ❍ 3.1.4 Application Type ❍ 3.1.5 Form Type ❍ 3.1.6 Text Type ❍ 3.1.7 Listbox Type ❍ 3.1.8 Icon Type ❍ 3.1.9 Content_handler Type ❍ 3.1.10 Canvas Type ❍ 3.1.11 InfoPopup Type

● 3.2 globalui -- Interface to the S60 global UI notifiers ● 3.3 graphics -- A graphics related services package

❍ 3.3.1 Module Level Functions ❍ 3.3.2 Image Class Static Methods ❍ 3.3.3 Image Objects ❍ 3.3.4 Common Features of Drawable Objects

■ 3.3.4.1 Options ■ 3.3.4.2 Coordinate representation ■ 3.3.4.3 Color representation ■ 3.3.4.4 Font specifications ■ 3.3.4.5 Common Methods of Drawable Objects

● 3.4 camera -- Interface for taking photographs and video recording ● 3.5 keycapture -- Interface for global capturing of key events.

❍ 3.5.1 Module Level Constants ❍ 3.5.2 KeyCapturer objects

● 3.6 topwindow -- Interface for creating windows that are shown on top of other applications.

http://pys60.garage.maemo.org/doc/s60/s60graph.html (1 of 2)27/08/2009 02:31:20

http://pys60.garage.maemo.org/doc/s60/node33.htmlhttp://pys60.garage.maemo.org/doc/s60/node34.htmlhttp://pys60.garage.maemo.org/doc/s60/node35.htmlhttp://pys60.garage.maemo.org/doc/s60/node36.htmlhttp://pys60.garage.maemo.org/doc/s60/node37.html


❍ 3.6.1 TopWindow objects ● 3.7 gles -- Bindings to OpenGL ES

❍ 3.7.1 array type ❍ 3.7.2 Error handling ❍ 3.7.3 Differences to OpenGL ES C API

■ 3.7.3.1 OpenGL ES 1.0 ■ 3.7.3.2 OpenGL ES 1.1

● 3.8 glcanvas -- UI Control for Displaying OpenGL ES Graphics ● 3.9 sensor -- Module to access the device sensors.

❍ 3.9.1 Module for devices that support S60 Sensor API ■ 3.9.1.1 Module Level Functions ■ 3.9.1.2 Constants ■ 3.9.1.3 Classes

❍ 3.9.2 Module for devices that support S60 Sensor FrameWork ■ 3.9.2.1 Module Level Functions ■ 3.9.2.2 Base Class ■ 3.9.2.3 class AccelerometerXYZAxisData ■ 3.9.2.4 class AccelerometerDoubleTappingData ■ 3.9.2.5 class MagnetometerXYZAxisData ■ 3.9.2.6 class MagneticNorthData ■ 3.9.2.7 class AmbientLightData ■ 3.9.2.8 class ProximityMonitor ■ 3.9.2.9 class OrientationData ■ 3.9.2.10 class RotationData


Previous: 2.2 sysinfo Up: S60 Module Reference Next: 3.1 appuifw


http://pys60.garage.maemo.org/doc/s60/s60graph.html (2 of 2)27/08/2009 02:31:20

http://pys60.garage.maemo.org/doc/s60/node48.htmlhttp://pys60.garage.maemo.org/doc/s60/node49.htmlhttp://pys60.garage.maemo.org/doc/s60/node53.htmlhttp://pys60.garage.maemo.org/doc/s60/node54.htmlhttp://pys60.garage.maemo.org/doc/s60/node55.htmlhttp://pys60.garage.maemo.org/doc/s60/node57.htmlhttp://pys60.garage.maemo.org/doc/s60/node58.htmlhttp://pys60.garage.maemo.org/doc/s60/node59.htmlhttp://pys60.garage.maemo.org/doc/s60/node60.htmlhttp://pys60.garage.maemo.org/doc/s60/node61.htmlhttp://pys60.garage.maemo.org/doc/s60/node62.htmlhttp://pys60.garage.maemo.org/doc/s60/node63.htmlhttp://pys60.garage.maemo.org/doc/s60/node64.htmlhttp://pys60.garage.maemo.org/doc/s60/node65.htmlhttp://pys60.garage.maemo.org/doc/s60/node66.html

3.1 appuifw -- Interface to the S60 GUI framework


Previous: 3. User Interface and Up: 3. User Interface and Next: 3.1.1 Basics of appuifw


Availability: S60.

The appuifw module offers an interface to the S60 UI application framework. Figure 3.1 provides an overview of the Python for S60 environment for UI application programming.

Note: The services of this interface may only be used in the context of the main thread, that is, the initial thread of a UI application script.

http://pys60.garage.maemo.org/doc/s60/module-appuifw.html (1 of 3)27/08/2009 02:31:21


Figure 3.1:Python for S60 UI environment overview

Subsections

● 3.1.1 Basics of appuifw Module ● 3.1.2 Softkeys ● 3.1.3 Module Level Functions ● 3.1.4 Application Type ● 3.1.5 Form Type ● 3.1.6 Text Type ● 3.1.7 Listbox Type ● 3.1.8 Icon Type ● 3.1.9 Content_handler Type ● 3.1.10 Canvas Type



● 3.1.11 InfoPopup Type


Previous: 3. User Interface and Up: 3. User Interface and Next: 3.1.1 Basics of appuifw



3.1.1 Basics of appuifw Module


Previous: 3.1 appuifw Up: 3.1 appuifw Next: 3.1.2 Softkeys


Figure 3.2 shows the layout of a S60 application UI in the normal screen mode and a summary of how it relates to the services available at the appuifw API. For alternative layouts, see Figure 3.3.



Figure 3.2:The different parts of the screen when using the 'normal' layout

Figure 3.3:UI layouts. left: 'normal', middle: 'large', right: 'full'

The main application window may be set up to be occupied by a UI control.

A multi-view application can show the different views as tabs in the navigation pane and react as the users navigate between tabs.

Dialogs always take precedence over the usual UI controls and appear on top of them.

UI controls are implemented as Python types. These types are available:

● Text ● Listbox ● Canvas

UI controls appear on the screen as soon as an instance of the corresponding Python type is set to the body field (app.body) of the current application UI.

Form is a versatile dialog implemented as a type.

The Content_handler type facilitates interfacing to other UI applications and common high-level UI components. It is based on the notion that designated handlers can reduce UI application interaction to operations on MIME-type content.

The following dialogs are implemented as functions:

● note



● query ● multi_query ● selection_list ● multi_selection_list ● popup_menu

A dialog becomes visible as soon as the corresponding Python function has been called. The function returns with the eventual user input or information on the cancellation of the dialog. Form is an exception; it is shown when its execute method is called.


Previous: 3.1 appuifw Up: 3.1 appuifw Next: 3.1.2 Softkeys



3.1.2 Softkeys


Previous: 3.1.1 Basics of appuifw Up: 3.1 appuifw Next: 3.1.3 Module Level Functions

3.1.2 Softkeys

The softkeys are managed by the underlying S60 Platform. When no dialog is visible, the right softkey is bound to application exit and the left one represents an Options menu. Python for S60 offers an interface for manipulating the menu and for binding the Exit key to a Python-callable object (see Section 3.1.4).

The native code that implements a dialog also manages the softkeys of the dialog, typically OK and Cancel. When the user input needs to be validated before accepting it and dismissing the dialog, it is best to use Form.


Previous: 3.1.1 Basics of appuifw Up: 3.1 appuifw Next: 3.1.3 Module Level Functions





Previous: 3.1.2 Softkeys Up: 3.1 appuifw Next: 3.1.4 Application Type


The following free functions - functions that do not belong to any class - are defined in the appuifw module:

available_fonts()Returns a list (Unicode) of all fonts available in the device.

touch_enabled()Returns 'True' if the device supports touch input, 'False' otherwise.

query(label, type[, initial_value])Performs a query with a single-field dialog. The prompt is set to label, and the type of the dialog is defined by type. The value of type can be any of the following strings:

❍ 'text' ❍ 'code' ❍ 'number' ❍ 'date' ❍ 'time' ❍ 'query' ❍ 'float'

The type of the optional initial_value parameter and the returned input depend on the value of type:

❍ For text fields, ('text', 'code') it is Unicode ❍ For number fields, it is numeric ❍ For date fields, it is seconds since epoch rounded down to the nearest local midnight

A simple confirmation query and time query take no initial value and return True/None and seconds since local midnight, correspondingly. All queries return None if the users cancel the dialog.

For 'float' query the initial_value setting has no effect.

multi_query(label_1, label_2)A two-field text (Unicode) input dialog. Returns the input values as a 2-tuple. Returns None if the users cancel the dialog.

note(text[, type[, global]])Displays a note dialog of the chosen type with text (Unicode). The default value for type is 'info', which is automatically used if type is not set. type can be one of the following strings: 'error', 'info' or 'conf'.

If global (integer) is any other value than zero a global note is displayed. A global note is displayed even if the Python application calling this function is in background. The same set of types is supported as in standard note.



popup_menu(list[, label])A pop-up menu style dialog. list representing the menu contents can be a list of Unicode strings or a list of Unicode string pairs (tuples). The resulting dialog list is then a single-style or a double-style list. A single-style list is shown in full; whereas a double-style list shows the items one at a time. Returns None if the user cancels the operation.

selection_list(choices[, search_field=0])Executes a dialog that allows the users to select a list item and returns the index of the chosen item, or None if the selection is cancelled by the users. choices is a list of Unicode strings. search_field is 0 (disabled) by default and is optional. Setting it to 1 enables a search field (find pane) that facilitates searching for items in long lists. If enabled, the search field appears after you press a letter key.

multi_selection_list(choices[, style='checkbox', search_field=0])Executes a dialog that allows the users to select multiple list items. Returns a tuple of indexes (a pair of Unicode strings) of the chosen items, or empty tuple if the no selection is made by the users. choices is a list of Unicode strings. style is an optional string; the default value being 'checkbox'. If 'checkbox' is given, the list will be a checkbox list, where empty checkboxes indicate what items can be marked. The other possible value that can be set for style is 'checkmark'. If 'checkmark' is given, the list will be a markable list, which lists items but does not indicate specifically that items can be selected. To select items on a markable list, use the 'Options' that has Mark/Unmark or the Edit key to select an item and the Navigation key to browse the list. For example views on checkbox and markable lists, see Figure 3.4. search_field is 0 (disabled) by default and is optional. Setting it to 1 enables a search field (find pane) that facilitates searching for items in long lists. If enabled, the search field is always visible with checkbox lists; with markable lists it appears by pressing a letter key.

Example:

tuple = appuifw.multi_selection_list([u'Harry', u'Ron', u'Hermione', u'Voldemort'], style='checkmark', search_field=1)

Figure 3.4:Examples of a checkbox list (left) and a

markable list (right)


Previous: 3.1.2 Softkeys Up: 3.1 appuifw Next: 3.1.4 Application Type


3.1.4 Application Type


Previous: 3.1.3 Module Level Functions Up: 3.1 appuifw Next: 3.1.5 Form Type


A single implicit instance of this type always exists when appuifw module is present and can be referred to with the name app. New instances cannot be created by a Python program.

class Application Instances of Application type have the following attributes:

bodyThe UI control that is visible in the application's main window. Currently either Text, a Listbox object, Canvas, or None.

directional_padA boolean flag which controls the appearance of a virtual 4-way directional pad that is displayed either at the bottom of the screen or on the right hand corner depending on the orientation when using a Canvas. This is enabled by default on devices that do not have a physical left and right soft key. This value is ignored on other devices, hence setting it to either True or False will have no effect.

Set it to True to enable 4-way directional pad and False to disable it.

exit_key_handlerA callable object that is called when the user presses the Exit softkey. Setting exit_key_handler to None sets it back to the default value.

focusA callable object that is called with integer as parameter (0 = focus lost, 1 = focus regained) when the application receives focus or it is switched to background. Focus is received e.g. when the application is switched from background to foreground or when the focus is regained from screensaver. Similarly when the screensaver is displayed, focus is lost.

Examples:

>>> import appuifw>>> def cb(fg):... if(fg):... print "foreground"... else:... print "background"...>>> appuifw.app.focus=cb>>> # switch to background, following text is printed from callback:>>> background>>> # switch to foreground, following text is printed from callback:>>> foreground

Note: An improper callback can cause adverse effects. If you, for example, define a callback



which takes no parameters you will receive never-ending TypeError exceptions on the Nokia 6600.

menuThis is a list of the following kinds of items:

■ (title, callback) which creates a regular menu item ■ (title, ((title, callback)[...])) which creates a submenu

title (Unicode) is the name of the item and callback the associated callable object. The maximum allowed number of items in a menu, or items in a submenu, or submenus in a menu is 30.

Example:

appuifw.app.menu = [(u"Item 1", item1), (u"Submenu 1", ((u"Subitem 1", subitem1), (u"Subitem 2", subitem2)))]

orientationAvailable only for S60 3rdEd. The orientation of the application. The orientation of the application can be one of the following values: 'automatic' (this is the default value), 'portrait' or 'landscape'.

screenThe screen area used by an application. See Figure 3.3 for example screens. The appearance of the application on the screen can be affected by setting one of the following values: 'normal', 'large' and 'full'.

Examples:

appuifw.app.screen='normal' # normal screen with title pane and softkey labelsappuifw.app.screen='large' # only softkey labels visibleappuifw.app.screen='full' # full screen mode on all devices

titleThe title of the application that is visible in the application's title pane. Must be Unicode.

Instances of Application type have the following methods:

activate_tab(index)Activates the tab index counting from zero.

full_name()Returns the full name, in Unicode, of the native application in whose context the current Python interpreter session runs.

layout(layout_id)

Returns as a tuple the size and the position of the requested layout_id. The logical layouts are outlined partly in Figure 3.2. The position is given from the top left corner. The layout_id can be one of the constants defined

in module appuifw3.1:



EScreenScreen.

EApplicationWindowWindow that fills the entire screen.

EStatusPaneIndicates common components for most of the applications.

EMainPaneThe application main pane is used in all the applications.

EControlPaneControl pane.

ESignalPaneThe signal pane is used to indicate signal strength.

EContextPaneThe context pane is used to indicate an active application.

ETitlePaneUsed to indicate the subject or the name of the main pane content.

EBatteryPaneThe battery pane is used to indicate battery strength.

EUniversalIndicatorPaneThe universal indicator pane is used to indicate items that require the user's attention while browsing applications.

ENaviPaneThe navi pane is used to indicate navigation within an application, to provide context sensitive information to the user while entering or editing data, or to show additional information.

EFindPaneA fixed find pane is used with lists instead of the find pop-up window.

EWallpaperPaneWallpaper pane.

EIndicatorPaneThe universal indicator pane is used to indicate items that require the user's attention while browsing applications.

EAColumnUsed generally to display small sized graphics or heading texts.

EBColumnUsed generally to display large sized icons or heading texts.



ECColumnUsed generally to display data entered by the user. Overlaps with the D column.

EDColumnUsed generally to display additional icons. Overlaps with the C column.

EStaconTopTop part of status and control panes in landscape layout.

EStaconBottomBottom part of status and control panes in landscape layout.

EStatusPaneBottomBottom part of status pane in landscape layout.

EControlPaneBottomBottom part of control pane in landscape layout.

EControlPaneTopTop part of control pane in landscape layout.

EStatusPaneTopTop part of status pane in landscape layout.

Example:

>>> import appuifw>>> appuifw.app.layout(appuifw.EMainPane)((176, 144), (0, 44))>>> # size and position (x, y) of the main pane in Nokia N70

set_exit()Requests a graceful exit from the application as soon as the current script execution returns.

set_tabs(tab_texts[,callback=None])Sets tabs with given names on them in the navigation bar; tab_texts is a list of Unicode strings. When the users navigate between tabs, callback gets called with the index of the active tab as an argument. Tabs can be disabled by giving an empty or one-item tab_texts list.

uid()Returns the UID, in Unicode, of the native application in whose context the current Python interpreter session runs.

Footnotes

...appuifw3.1

Descriptions of the values are from the S60 SDK documentation [4].




Previous: 3.1.3 Module Level Functions Up: 3.1 appuifw Next: 3.1.5 Form Type



3.1.5 Form Type


Previous: 3.1.4 Application Type Up: 3.1 appuifw Next: 3.1.6 Text Type

3.1.5 Form Type

Form implements a dynamically configurable, editable multi-field dialog. Form caters for advanced dialog use cases with requirements such as free selectability of the combination of fields, possibility of validating the user input, and automatically producing the contents of some dialog fields before allowing the closing of the dialog.

class Form(fields[, flags=0])Creates a Form instance. fields is a list of field descriptors: (label, type[, value]) where

label is a Unicode string

type is one of the following strings: 'text', 'number', 'date', 'time', 'combo' or 'float'

value, depending on type: Unicode string, numeric, float (seconds since Unix epoch rounded down to the nearest local midnight), float (seconds since local midnight), ([choice_label ...], index) of float. For 'float' type the initial value setting might not be shown in the UI.

Form can also be configured and populated after construction. The configuration flags are visible as an attribute. Form implements the list protocol that can be used for setting the form fields, as well as obtaining their values after the dialog has been executed.

Instances of Form type have the following attributes:

flagsThis attribute holds the values of the various configuration flags. Currently supported flags are:

FFormEditModeOnlyWhen this flag is set, the form remains in edit mode while execute runs.

FFormViewModeOnlyWhen this flag is set, the form cannot be edited at all.


3.1.5 Form Type

FFormAutoLabelEditThis flag enables support for allowing the end-users to edit the labels of the form fields.

FFormAutoFormEditThis flag enables automatic support for allowing the end-users to add and delete the form fields. Note that this is an experimental feature and is not guaranteed to work with all SDK versions.

FFormDoubleSpacedWhen this flag is set, double-spaced layout is applied when the form is executed: one field takes two lines, as the label and the value field are on different lines.

menuA list of (title, callback) pairs, where each pair describes an item in the form's menu bar that is active while the dialog is being executed. title (Unicode) is the name of the item and callback the associated callable object.

save_hookThis attribute can be set to a callable object that receives one argument and returns a Boolean value. It gets called every time the users want to save the contents of an executing Form dialog. A candidate list for new form content - a list representing the currently visible state of the UI - is given as an argument. The list can be modified by save_hook. If save_hook returns True, the candidate list is set as the new contents of the form. Otherwise, the form UI is reset to reflect the field list contained in Form object.

Instances of Form type have the following methods:

execute()Executes the dialog by making it visible on the UI.

insert(index, field_descriptor)Inserts the field descriptor into the Form before the given index.

pop()Removes the last field descriptor from the Form and returns it.

length()the number of field descriptors in the form.

The subscript notation f[i] can be used to access or modify the i-th element of the form f. Same limitations as discussed above in the context of the flag FFormAutoFormEdit apply to modifying a form while it is executing. The ability to change the schema of a form while it is executing is an


s60 module referencezchab6a/v3/pys60/pys60-197.pdfs60 module reference 5.1.2 contactdb object 5.1.3...

Documents