Main Page | Modules | Data Structures | File List | Data Fields | Globals | Related Pages

Song Info
[Applications]


Detailed Description

song info application displays music information.

The song-info application is used to display current playing music information. It could be displayed in two modes maximized and minimized.

Normal behaviour is to have only one instance of a song-info application. It is stored in the global variable song_info.

Author:
benjamin gerard


Files

file  song_info.lua
 Song info application.


Functions

 song_info_create_icons (var si)
 Creates song-info sprite icons.

 song_info_create (var owner, var name, var style)
 Create a song-info application.

 song_info_toggle_help (var si, var timeout)
 song_set_time_str (var si, var s)
 song_info_update_info (var si)
 Default song-info update.

 song_info_update (var si, var frametime)
 Default song-info update.

 song_info_handle (var si, var evt)
 Default song-info handle.

 song_info_open (var si)
 Default song-info open.

 song_info_close (var si)
 Default song-info close.

 song_info_minimize (var si)
 Default song-info minimize.

 song_info_maximize (var si)
 Default song-info minimize.

 song_info_toggle (var si)
 Default song-info minimize/maximize toggle.

 song_info_set_color (var si, var a, var r, var g, var b)
 Default song-info set color.

 song_info_draw (var si)
 Default song-info draw.

 song_info_shutdown (var si)
 Default song-info shutdown.

 song_info_menucreator (var target)
 song_info_draw_help (var si)
 song_info_draw_field (var si, var field)
 song_info_field (var label, var box, var x, var y)
 song_info_kill (var si)
 Kill a song-info application.


Variables

application song_info
 Global song_info application.


Function Documentation

song_info_create var  owner,
var  name,
var  style
 

Create a song-info application.

Parameters:
owner Owner application (nil for desktop).
name Application name (nil for "song info").
style drwing style.
Returns:
song-info application
Return values:
nil error

song_info_kill var  si  ) 
 

Kill a song-info application.

The song_info_kill() function kills the given application by calling sending the evt_shutdown_app() function. If the given application is nil or song_info the default song-info (song_info) is killed and the global variable song_info is set to nil.

Parameters:
si application to kill (default to song_info)


dcplaya documentation version 2.0 Generated on November 2004 by doxygen 1.3.6