[ruby-gnome2-doc-cvs] [Hiki] update - Gst::Type

Back to archive index

ruby-****@sourc***** ruby-****@sourc*****
2004年 3月 2日 (火) 05:54:49 JST


-------------------------
REMOTE_ADDR = 217.117.55.140
REMOTE_HOST = 
        URL = http://ruby-gnome2.sourceforge.jp/?Gst%3A%3AType
-------------------------
  = class Gst::Type
  Identifies the data.
  
+ == Object Hierarchy
+ * Object
+   * GLib::Boxed
+     * Gst::Type
+ 
  == Class Methods
- --- Gst::Type.each { |aTypeObject| block } 
+ --- Gst::Type.each { |type| ... }
      Calls the block for each registred types, passing a reference to
      the Gst::Type as parameter.
-     
-     Always returns nil.
+     * Returns: always nil.
  
- --- Gst::Type.find_by_id(aFixnum) 
-     Searches for a registered type of the given ID.  
-     If found, returns a Gst::Type object. Otherwise, returns nil.
+ --- Gst::Type.find_by_id(id)
+     Searches for a registered type of the given ID.
+     * id: a type ID.  
+     * Returns: a Gst::Type object if found, otherwise nil.
  
- --- Gst::Type.find_by_mime(aString) 
-     Searches for a registered type of the given MIME type.  
-     If found, returns a Gst::Type object.  Otherwise, returns nil.
+ --- Gst::Type.find_by_mime(mime)
+     Searches for a registered type of the given MIME type.
+     * mime: a mime type.  
+     * Returns: a Gst::Type object if found, otherwise nil.
  
- --- Gst::Type.types 
-     Returns a list of all registered types, in an array 
-     of Gst::Type objects.
+ --- Gst::Type.types
+     This method returns a list of all registered types, in an array  of Gst::Type objects.
+     * Returns: a list of all registered types, in an array  of Gst::Type objects.
  
- 
  == Instance Methods
- --- == aTypeObject 
+ --- ==(type)
      Checks if two Gst::Type objects are refered under the same ID number.
+     * type: a Gst::Type.  
+     * Returns: true on success, false on failure.
  
- --- exts 
-     Gets files extentions handled by the type, if there
-     are any, as a String.  This method may otherwise return nil.
+ --- exts
+     This method returns files extentions handled by the type, if there are any, otherwise return nil.
+     * Returns: files extentions handled by the type, if there are any, otherwise return nil.
  
- --- id 
-     Gets the ID number of the type, as a Fixnum.
+ --- id
+     This method returns the ID number of the type.
+     * Returns: the ID number of the type.
  
- --- mime 
-     Gets the MIME type of the type, as a String.
+ --- mime
+     This method returns the MIME type of the type.
+     * Returns: the MIME type of the type.
  
- 
+ == See Also
+ ((<Gst>)).
  
  - ((<lrz>))





ruby-gnome2-cvs メーリングリストの案内
Back to archive index