Add support for modules help strings (Closes:#413)
authorClément Stenac <zorglub@videolan.org>
Wed, 19 Jul 2006 11:53:51 +0000 (11:53 +0000)
committerClément Stenac <zorglub@videolan.org>
Wed, 19 Jul 2006 11:53:51 +0000 (11:53 +0000)
include/modules_inner.h
modules/LIST
modules/audio_filter/channel_mixer/headphone.c
modules/gui/qt4/components/preferences.cpp

index 5b98d2b..6d1f554 100644 (file)
         p_module->psz_object_name = MODULE_STRING;                            \
         p_module->psz_shortname = NULL;                                       \
         p_module->psz_longname = MODULE_STRING;                               \
+        p_module->psz_help = NULL;                                            \
         p_module->pp_shortcuts[ 0 ] = MODULE_STRING;                          \
         p_module->i_cpu = 0;                                                  \
         p_module->psz_program = NULL;                                         \
 #define set_description( desc )                                               \
     p_submodule->psz_longname = desc
 
+#define set_help( help )                                                      \
+    p_submodule->psz_help = help
+
 #define set_capability( cap, score )                                          \
     p_submodule->psz_capability = cap;                                        \
     p_submodule->i_score = score
index ad204ec..5e9b0d8 100644 (file)
@@ -57,7 +57,6 @@ $Id$
  * dirac: BBC Dirac codec
  * directfb: Direct Framebuffer video output
  * directory : input module to read files in a directory
- * distort: miscellaneous image effects filter.
  * dmo: a DirectMediaObject decoder that uses DirectMedia to decode video (WMV3)
  * dolby_surround_decoder: simple decoder for dolby surround encoded streams
  * dshow: DirectShow access plugin for encoding cards under Windows
@@ -132,11 +131,10 @@ $Id$
  * libmpeg2: Mpeg2 video decoder using libmpeg2
  * linear_resampler: linear audio resampler
  * lirc: Linux infrared control module
- * livedotcom: rtp demux based on liveMedia (live.com)
+ * live555: rtp demux based on liveMedia (live555.com)
  * logger: file logger plugin
  * logo: video filter to put a logo on the video
  * lpcm: LPCM decoder
- * m3u: PLS, M3U, ASX and B4S playlist parser
  * m4a: MPEG-4 Audio Stream demuxer
  * m4v: MPEG-4 Video Stream demuxer
  * macosx: Video output, and interface module for Mac OS X.
@@ -218,7 +216,6 @@ $Id$
  * screen: a input module that takes screenshots of the primary monitor
  * screensaver: screensaver disabling module
  * sdl_image: SDL-based image decoder
- * sgimb: SGIMB referrer files parser
  * shout: Shoutcast services discovery
  * showintf: shows the main interface
  * simple_channel_mixer: channel mixer
index 150035f..af1e123 100644 (file)
@@ -71,6 +71,7 @@ static void DoWork    ( aout_instance_t *, aout_filter_t *, aout_buffer_t *,
 vlc_module_begin();
     set_description( N_("Headphone virtual spatialization effect") );
     set_shortname( _("Headphone effect") );
+    set_help( MODULE_DESCRIPTION );
     set_category( CAT_AUDIO );
     set_subcategory( SUBCAT_AUDIO_AFILTER );
 
index e7de207..6b9aa38 100644 (file)
@@ -384,7 +384,14 @@ PrefsPanel::PrefsPanel( intf_thread_t *_p_intf, QWidget *_parent,
         p_item++; // Why that ?
     }
     else
-        head = QString( p_module->psz_longname );
+    {
+        head = QString( qfu(p_module->psz_longname) );
+        if( p_module->psz_help ) 
+        {
+            head.append( "\n" );
+            head.append( qfu( p_module->psz_help ) );
+        }
+    }
 
     QLabel *label = new QLabel( head, this );
     QFont font = label->font();