Menu
▾
▴
[Gtk2hs-commit] (main branch): gstreamer: document M.S.G.Core.Bin
|
From: <du...@co...> - 2008-05-22 19:24:01
|
Sat May 17 15:47:36 EDT 2008 Peter Gavin <pg...@gm...>
* gstreamer: document M.S.G.Core.Bin
hunk ./gstreamer/Media/Streaming/GStreamer/Core/Bin.chs.pp 104
--- | Creates a new 'Bin' with the given name.
-binNew :: String -- ^ the name of the new bin
- -> IO Bin -- ^ the new bin
+-- | Create a new 'Bin' with the given name.
+binNew :: String -- ^ @name@ - the name to give the new 'Bin'
+ -> IO Bin -- ^ the new 'Bin'
hunk ./gstreamer/Media/Streaming/GStreamer/Core/Bin.chs.pp 110
--- | Adds the given 'Element' to the 'Bin'. Sets the element's parent. An
--- element can only be added to one bin.
+-- | Add @element@ to @bin@, and set @element@'s parent to
+-- @bin@. An 'Element' can only be added to one 'Bin' at a time.
hunk ./gstreamer/Media/Streaming/GStreamer/Core/Bin.chs.pp 113
--- If the element's pads are linked to other pads, the pads will be
--- unlinked before the element is added to the bin.
+-- If any of @element@'s pads are linked to other 'Pad's, they will be
+-- unlinked before @element@ is added to @bin@.
hunk ./gstreamer/Media/Streaming/GStreamer/Core/Bin.chs.pp 116
- => bin -- ^ a bin
- -> element -- ^ the element to be added
+ => bin -- ^ @bin@ - a 'Bin'
+ -> element -- ^ @element@ - the element to add
hunk ./gstreamer/Media/Streaming/GStreamer/Core/Bin.chs.pp 123
--- | Removes the given 'Element' from the 'Bin', unparenting it as well.
+-- | Remove @element@ from @bin@, unparenting it as well.
hunk ./gstreamer/Media/Streaming/GStreamer/Core/Bin.chs.pp 125
--- If the element's pads are linked to other pads, the pads will be
--- unlinked before the element is removed from the bin.
+-- If any @element@'s pads are linked to other pads, they will be
+-- unlinked before @element@ is added to @bin@.
hunk ./gstreamer/Media/Streaming/GStreamer/Core/Bin.chs.pp 128
- => bin -- ^ a bin
- -> element -- ^ the element to remove
- -> IO Bool -- ^ 'True' if the element could be removed, 'False'
- -- if the bin does not want to remove the element
+ => bin -- ^ @bin@ - a 'Bin'
+ -> element -- ^ @element@ - the element to remove
+ -> IO Bool -- ^ 'True' if @element@ could be removed, otherwise 'False'
hunk ./gstreamer/Media/Streaming/GStreamer/Core/Bin.chs.pp 134
--- | Gets the 'Element' with the given name from a 'Bin'. This
--- function recurses into child bins. Returns 'Nothing' if no element
--- with the given name is found in the bin.
+-- | Get the 'Element' with the given name @name@ from @bin@,
+-- recursing down through @bin@'s children. 'Nothing' is returned if no
+-- 'Element' with the given name is found.
hunk ./gstreamer/Media/Streaming/GStreamer/Core/Bin.chs.pp 138
- => bin -- ^ a bin
- -> String -- ^ the element name to search for
- -> IO (Maybe Element) -- ^ the element with the given name, or 'Nothing'
+ => bin -- ^ @bin@ - a 'Bin'
+ -> String -- ^ @name@ - the name to search for
+ -> IO (Maybe Element) -- ^ the 'Element' with the name @name@, or 'Nothing'
hunk ./gstreamer/Media/Streaming/GStreamer/Core/Bin.chs.pp 144
--- | Gets the element with the given name from this bin. If the
--- element is not found, a recursion is performed on the parent
--- bin. Returns 'Nothing' if no element with the given name is
--- found.
+-- | Get the 'Element' with the given name @name@ from @bin@,
+-- recursing up through @bin@'s parents. Returns 'Nothing' if no
+-- element with the given name is found.
hunk ./gstreamer/Media/Streaming/GStreamer/Core/Bin.chs.pp 148
- => bin -- ^ a bin
- -> String -- ^ the element name to search for
- -> IO (Maybe Element) -- ^ the element with the given name, or 'Nothing'
+ => bin -- ^ @bin@ - a 'Bin'
+ -> String -- ^ @element@ - the name to search for
+ -> IO (Maybe Element) -- ^ the 'Element' with the given name, or 'Nothing'
hunk ./gstreamer/Media/Streaming/GStreamer/Core/Bin.chs.pp 155
--- | Looks for an element inside the bin that implements the given
--- interface. If such an element is found, it returns the
--- element. You can case this element to the given interface
--- afterwards. If you want all the elements that implement an
+-- | Find an 'Element' inside @bin@ that implements the interface
+-- given by @iface@. The returned 'Element' can be casted to
+-- @iface@'s type. If you want all the 'Element's that implement an
hunk ./gstreamer/Media/Streaming/GStreamer/Core/Bin.chs.pp 162
- => bin -- ^ a bin
- -> GType -- ^ the interface's type
- -> IO (Maybe Element) -- ^ an element inside the bin implementing the interface, or 'Nothing'
+ => bin -- ^ @bin@ - a 'Bin'
+ -> GType -- ^ @iface@ - the type of the requested interface
+ -> IO (Maybe Element) -- ^ the 'Element' inside @bin@ that implements @iface@, or 'Nothing'
hunk ./gstreamer/Media/Streaming/GStreamer/Core/Bin.chs.pp 169
--- | Gets an 'Iterator' for the 'Element's in this 'Bin'.
+-- | Get an 'Iterator' over the 'Element's in @bin@.
hunk ./gstreamer/Media/Streaming/GStreamer/Core/Bin.chs.pp 171
- => bin -- ^ a bin
- -> IO (Maybe (Iterator Element)) -- ^ an iterator on elements, or 'Nothing'
+ => bin -- ^ @bin@ - a 'Bin'
+ -> IO (Maybe (Iterator Element)) -- ^ an 'Iterator' over the 'Element's in @bin@,
+ -- or 'Nothing'
hunk ./gstreamer/Media/Streaming/GStreamer/Core/Bin.chs.pp 178
--- | Gets an 'Iterator' for the 'Element's in this 'Bin'. This
--- iterator recurses into the bin's children.
+-- | Get an 'Iterator' over the 'Element's in @bin@. This
+-- iterator recurses into @bin@'s children.
hunk ./gstreamer/Media/Streaming/GStreamer/Core/Bin.chs.pp 181
- => bin -- ^ a bin
- -> IO (Maybe (Iterator Element)) -- ^ an iterator on elements, or 'Nothing'
+ => bin -- ^ @bin@ - a 'Bin'
+ -> IO (Maybe (Iterator Element)) -- ^ an 'Iterator' over the 'Element's in @bin@
+ -- and its descendents, or 'Nothing'
hunk ./gstreamer/Media/Streaming/GStreamer/Core/Bin.chs.pp 188
--- | Gets an iterator for all elements in the bin that have the
+-- | Get an iterator over the 'Element's in @bin@ that have the
hunk ./gstreamer/Media/Streaming/GStreamer/Core/Bin.chs.pp 191
- => bin -- ^ a bin
- -> IO (Maybe (Iterator Element)) -- ^ an iterator on elements, or 'Nothing'
+ => bin -- ^ @bin@ - a 'Bin'
+ -> IO (Maybe (Iterator Element)) -- ^ an 'Iterator' over the sinks in @bin@, or 'Nothing'
hunk ./gstreamer/Media/Streaming/GStreamer/Core/Bin.chs.pp 204
- => bin -- ^ a bin
- -> IO (Maybe (Iterator Element)) -- ^ an iterator on elements, or 'Nothing'
+ => bin -- ^ @bin@ - a 'Bin'
+ -> IO (Maybe (Iterator Element)) -- ^ an 'Iterator' over the 'Element's in @bin@, or 'Nothing'
hunk ./gstreamer/Media/Streaming/GStreamer/Core/Bin.chs.pp 213
- => bin -- ^ a bin
- -> IO (Maybe (Iterator Element)) -- ^ an iterator on elements, or 'Nothing'
+ => bin -- ^ @bin@ - a 'Bin'
+ -> IO (Maybe (Iterator Element)) -- ^ an 'Iterator' on elements, or 'Nothing'
hunk ./gstreamer/Media/Streaming/GStreamer/Core/Bin.chs.pp 223
- => bin -- ^ a bin
- -> GType -- ^ the interface's type
- -> IO (Maybe (Iterator Element)) -- ^ an iterator on elements, or 'Nothing'
+ => bin -- ^ @bin@ - a 'Bin'
+ -> GType -- ^ @iface@ - the interface's 'GType'
+ -> IO (Maybe (Iterator Element)) -- ^ an 'Iterator' on elements, or 'Nothing'
hunk ./gstreamer/Media/Streaming/GStreamer/Core/Bin.chs.pp 235
- => bin -- ^ a bin
- -> PadDirection -- ^ whether to look for a source pad or a sink pad
- -> IO (Maybe Pad) -- ^ an unconnected pad or 'Nothing'
+ => bin -- ^ @bin@ - a 'Bin'
+ -> PadDirection -- ^ @direction@ - the direction of the requested 'Pad'
+ -> IO (Maybe Pad) -- ^ an unconnected 'Pad', or 'Nothing'
|
