/usr/share/doc/freevo/plugin

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN""http://www.w3.org/TR/html4/loose.dtd">
<HTML
><HEAD
><TITLE
>ItemPlugin</TITLE
><META
NAME="GENERATOR"
CONTENT="Modular DocBook HTML Stylesheet Version 1.79"><LINK
REL="HOME"
TITLE="Freevo Plugin Writing HOWTO"
HREF="index.html"><LINK
REL="UP"
TITLE="The Different Types of Plugins"
HREF="c145.html"><LINK
REL="PREVIOUS"
TITLE="MainMenuPlugin"
HREF="x187.html"><LINK
REL="NEXT"
TITLE="IdlebarPlugin"
HREF="x211.html"></HEAD
><BODY
CLASS="SECT1"
BGCOLOR="#FFFFFF"
TEXT="#000000"
LINK="#0000FF"
VLINK="#840084"
ALINK="#0000FF"
><DIV
CLASS="NAVHEADER"
><TABLE
SUMMARY="Header navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TH
COLSPAN="3"
ALIGN="center"
>Freevo Plugin Writing HOWTO: Writing your own plugins for Freevo</TH
></TR
><TR
><TD
WIDTH="10%"
ALIGN="left"
VALIGN="bottom"
><A
HREF="x187.html"
ACCESSKEY="P"
>Prev</A
></TD
><TD
WIDTH="80%"
ALIGN="center"
VALIGN="bottom"
>Chapter 3. The Different Types of Plugins</TD
><TD
WIDTH="10%"
ALIGN="right"
VALIGN="bottom"
><A
HREF="x211.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
></TABLE
><HR
ALIGN="LEFT"
WIDTH="100%"></DIV
><DIV
CLASS="SECT1"
><H1
CLASS="SECT1"
><A
NAME="AEN200"
>3.4. ItemPlugin</A
></H1
><P
>	An ItemPlugin adds something to the submenu of an item. You get this
	menu by pressing <CODE
CLASS="VARNAME"
>ENTER</CODE
> on an item. When the submenu
	is generated, all global ItemPlugins and for this media type are
	called. 
      </P
><P
>	The function to be called is 
	<PRE
CLASS="PROGRAMLISTING"
>def actions(self, item):</PRE
> 
	and should return
	a list of actions. The function can check all attributes of the item to
	decide what actions to return. On action can either be a MenuItem (from
	file <TT
CLASS="FILENAME"
>menu.py</TT
>) or a list. This list conatins a
	callback function, a text for the menu and optional a shortcut which
	can be put on a button for the remote. 
      </P
><P
>	Examples for this kind of plugin are the coversearch and the imdb
	plugin. They check if it makes sense to call the function and return
	actions.
      </P
><P
>	Here is a simple example for an ItemPlugin. It checks if it's a
	video item and adds two actions to turn the software scaler on and off
	(by changing the global config variable, Ouch):
	<PRE
CLASS="PROGRAMLISTING"
>import plugin
import config

class PluginInterface(plugin.ItemPlugin):
    def actions(self, item):
        if item.type == 'video':
            return [ (self.remove_sws, 'Remove Software Scaler'),
                     (self.sws, 'Use Software Scaler') ]
        else:
            return []

    def remove_sws(self, menuw=None, arg=None):
        config.MPLAYER_SOFTWARE_SCALER = ''
        menuw.back_one_menu()

    def sws(self, menuw=None, arg=None):
        config.MPLAYER_SOFTWARE_SCALER = "-subfont-text-scale 15 -fs -sws 0 "\
                                         "-vf scale=%s:-3"\
                                         " -font /usr/share/mplayer/fonts/"\
                                         "font-arial-28-iso-8859-2/font.desc" % \
                                         config.CONF.width
        menuw.back_one_menu()
	</PRE
>
      </P
></DIV
><DIV
CLASS="NAVFOOTER"
><HR
ALIGN="LEFT"
WIDTH="100%"><TABLE
SUMMARY="Footer navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
><A
HREF="x187.html"
ACCESSKEY="P"
>Prev</A
></TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="index.html"
ACCESSKEY="H"
>Home</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
><A
HREF="x211.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
>MainMenuPlugin</TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="c145.html"
ACCESSKEY="U"
>Up</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
>IdlebarPlugin</TD
></TR
></TABLE
></DIV
></BODY
></HTML
>
freevo-doc 1.9.2b2-4.2 / usr / share / doc / freevo / plugin_writing / x200.html
