Freevo Plugin Writing HOWTO

Writing your own plugins for Freevo

Dirk Meyer

This document contains some usefull information on how to write a plugin for Freevo. This includes some documentation about the interbal structure of Freevo. This howto is not complete (and maybe never will be). If you have additional questions, please contact the developer list ().

Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.1 or any later version published by the Free Software Foundation; with no Invariant Sections, with no Front-Cover Texts, and with no Back-Cover Texts. A copy of the license can be obtained at http://www.gnu.org/licenses/fdl.html and is included as an appendix in this document.


Table of Contents
1. Introduction
1.1. Introduction
1.2. Disclaimer
1.3. Contact / Feedback
1.4. Revision History
2. Internal Structure
2.1. Plugin Location
2.2. Events
2.3. The Menu System
2.3.1. Menu
2.3.2. Item
2.3.3. MenuItem
2.3.4. MenuWidget
2.4. GUI Objects
3. The Different Types of Plugins
3.1. Basic Plugin
3.2. DaemonPlugin
3.2.1. Polling
3.2.2. Action on events
3.2.3. Drawing on the Screen
3.3. MainMenuPlugin
3.4. ItemPlugin
3.5. IdlebarPlugin
4. Notes for writing a plugin
4.1. General
4.2. Documenting the Plugin
4.3. Which files to Import
4.4. User Configuartion
4.4.1. Adding parameter to the constructor
4.4.2. Using local_conf.py
4.5. i18n support
5. Plugin Distribution
List of Tables
4-1. Module list