gnomemm r1442 - in gstreamermm/trunk: . gstreamer/src

[jaalburqu svn gnome org]

Author: jaalburqu
Date: Fri Apr  4 21:49:38 2008
New Revision: 1442
URL: http://svn.gnome.org/viewvc/gnomemm?rev=1442&view=rev

Log:
2008-04-04  Josà Alburquerque  <jaalburqu svn gnome org>

	* gstreamer/src/bus.hg:
	* gstreamer/src/clock.hg:
	* gstreamer/src/filter.hg:
	* gstreamer/src/index.hg:
	* gstreamer/src/plugin.hg:
	* gstreamer/src/pluginfeature.hg:
	* gstreamer/src/structure.hg: Added comments in slot docs to clear up
	what bool returns mean

Modified:
   gstreamermm/trunk/ChangeLog
   gstreamermm/trunk/gstreamer/src/bus.hg
   gstreamermm/trunk/gstreamer/src/clock.hg
   gstreamermm/trunk/gstreamer/src/filter.hg
   gstreamermm/trunk/gstreamer/src/index.hg
   gstreamermm/trunk/gstreamer/src/plugin.hg
   gstreamermm/trunk/gstreamer/src/pluginfeature.hg
   gstreamermm/trunk/gstreamer/src/structure.hg

Modified: gstreamermm/trunk/gstreamer/src/bus.hg
==============================================================================
--- gstreamermm/trunk/gstreamer/src/bus.hg	(original)
+++ gstreamermm/trunk/gstreamer/src/bus.hg	Fri Apr  4 21:49:38 2008
@@ -89,6 +89,8 @@
   /** For example,
    * bool on_bus_message(const Glib::RefPtr<Bus>& bus, const
    * Glib::RefPtr<Message>& message);
+   * The message function should return true if it wants to continue to receive
+   * messages, false otherwise.
    */
   typedef sigc::slot< bool, const Glib::RefPtr<Bus>&, const Glib::RefPtr<Message>& > SlotMessage;
 

Modified: gstreamermm/trunk/gstreamer/src/clock.hg
==============================================================================
--- gstreamermm/trunk/gstreamer/src/clock.hg	(original)
+++ gstreamermm/trunk/gstreamer/src/clock.hg	Fri Apr  4 21:49:38 2008
@@ -51,6 +51,7 @@
   /** For example,
    * bool on_clock(const Glib::RefPtr<Clock>& clock, ClockTime time, const
    * Glib::RefPtr<ClockID>& id);
+   * The clock function return value is currently unused (see GstClockCallback)
    */
   typedef sigc::slot< bool, const Glib::RefPtr<Clock>&, ClockTime, const Glib::RefPtr<ClockID>& > SlotClock;
 

Modified: gstreamermm/trunk/gstreamer/src/filter.hg
==============================================================================
--- gstreamermm/trunk/gstreamer/src/filter.hg	(original)
+++ gstreamermm/trunk/gstreamer/src/filter.hg	Fri Apr  4 21:49:38 2008
@@ -30,7 +30,9 @@
 {
 
 public:
-  /** For example, bool on_filter(const Glib::RefPtr<Glib::Object>& object)
+  /** For example, bool on_filter(const Glib::RefPtr<Glib::Object>& object);
+   * The filter function should return true if object is a match, false
+   * otherwise.
    */
   typedef sigc::slot<bool, const Glib::RefPtr<Glib::Object>& > SlotFilter;
 

Modified: gstreamermm/trunk/gstreamer/src/index.hg
==============================================================================
--- gstreamermm/trunk/gstreamer/src/index.hg	(original)
+++ gstreamermm/trunk/gstreamer/src/index.hg	Fri Apr  4 21:49:38 2008
@@ -90,13 +90,18 @@
 
   /** For example,
    * bool on_filter(const Glib::RefPtr<Index>& index, IndexEntry entry);
+   * The filter function should return true if the entry is to be added to the
+   * index, false otherwise.
    */ 
   typedef sigc::slot<bool, const Glib::RefPtr<Index>&, IndexEntry> SlotFilter;
 
   void set_filter(const SlotFilter& slot);
 
   /** For example,
-   * bool on_resolve(const Glib::RefPtr<Gst::Object>& writer, Glib::ustring& writer_string);
+   * bool on_resolve(const Glib::RefPtr<Gst::Object>& writer, Glib::ustring&
+   * writer_string);
+   * The resolve function should return true if an id could be assigned to
+   * writer.
    */ 
   typedef sigc::slot<bool, const Glib::RefPtr<Index>&, const Glib::RefPtr<Gst::Object>&, Glib::ustring&> SlotResolver;
 

Modified: gstreamermm/trunk/gstreamer/src/plugin.hg
==============================================================================
--- gstreamermm/trunk/gstreamer/src/plugin.hg	(original)
+++ gstreamermm/trunk/gstreamer/src/plugin.hg	Fri Apr  4 21:49:38 2008
@@ -60,6 +60,8 @@
 public:
   /** For example,
    * bool on_plugin_filter(const Glib::RefPtr<Plugin>& plugin);
+   * The filter function should return true if plugin is a match, false
+   * otherwise.
    */
   typedef sigc::slot< bool, const Glib::RefPtr<Plugin>& > SlotFilter;
 

Modified: gstreamermm/trunk/gstreamer/src/pluginfeature.hg
==============================================================================
--- gstreamermm/trunk/gstreamer/src/pluginfeature.hg	(original)
+++ gstreamermm/trunk/gstreamer/src/pluginfeature.hg	Fri Apr  4 21:49:38 2008
@@ -40,6 +40,8 @@
 public:
   /** For example,
    * bool on_filter(const Glib::RefPtr<PluginFeature>& feature);
+   * The filter function should return true if the feature is a match, false
+   * otherwise.
    */
   typedef sigc::slot< bool, const Glib::RefPtr<PluginFeature>& > SlotFilter;
 

Modified: gstreamermm/trunk/gstreamer/src/structure.hg
==============================================================================
--- gstreamermm/trunk/gstreamer/src/structure.hg	(original)
+++ gstreamermm/trunk/gstreamer/src/structure.hg	Fri Apr  4 21:49:38 2008
@@ -50,11 +50,15 @@
 public:
   /** For example,
    * bool on_foreach(const Glib::QueryQuark& id, const Glib::ValueBase& value);
+   * The foreach function should return true if foreach operation should
+   * continue, false if operation should stop with false.
    */
   typedef sigc::slot<bool, const Glib::QueryQuark&, const Glib::ValueBase&> SlotForeach;
 
   /** For example,
    * bool on_map(const Glib::QueryQuark& id, Glib::ValueBase& value);
+   * The map function should return true if map operation should continue,
+   * false if operation should stop with false.
    */
   typedef sigc::slot<bool, const Glib::QueryQuark&, Glib::ValueBase&> SlotMap;