[ruby-gnome2-doc-cvs] [Hiki] update - Gnome::PrintPaper

Back to archive index

ruby-****@sourc***** ruby-****@sourc*****
2005年 6月 9日 (木) 00:24:08 JST


-------------------------
REMOTE_ADDR = 219.53.36.42
REMOTE_HOST = 
REMOTE_USER = ruby-gnome2-hiki        URL = http://ruby-gnome2.sourceforge.jp/cgi-bin/hiki/hiki.cgi?Gnome%3A%3APrintPaper
-------------------------
@@ -1,40 +1,76 @@
 = class Gnome::PrintPaper
 
+== Object Hierarchy
+* Object
+  * GLib::Boxed
+    * Gnome::PrintPaper
+
 == Class Methods
 
---- default
-     * Returns: default paper.
+--- Gnome::PrintPaper.default
+    
+     Get the default paper for the system.
 
---- get(name)
-     * name: the name of paper.
-     * Returns: specified Gnome::PrintPaper, nil if not found.
+     * Returns: the default Gnome::PrintPaper
 
---- get(width, height)
-     * width: the width of paper.
-     * height: the heiht of paper.
-     * Returns: specified Gnome::PrintPaper, nil if not found.
+--- Gnome::PrintPaper.get(name)
+    
+     Gets the paper represented by name ((|name|)), for
+     example: "A4".
 
---- get(width, height, must_fit)
-     * width: the width of paper.
-     * height: the heiht of paper.
-     * must_fit: should ((|width|)) and ((|height|)) fit within paper.
-     * Returns: specified Gnome::PrintPaper, nil if not found.
+     * name: The name of the paper to get
+     * Returns: the Gnome::PrintPaper, (({nil})) if not found.
+     
+--- Gnome::PrintPaper.get(width, height)
 
---- list
-     * Returns: an array of available papers.
+     Gets the paper with width ((|width|)) and height
+     ((|height|)).
 
+     * width: The width of the paper
+     * height: The width of the paper
+     * Returns: the Gnome::PrintPaper, (({nil})) if not found.
+
+--- Gnome::PrintPaper.get(width, height, must_fit)
+
+     Gets the paper with dimensions closest to width
+     ((|width|)) and height ((|height|)). If ((|must_fit|))
+     is (({true})) then width and height must fit within the
+     dimensions of the returned paper.
+
+     * width: The width of the paper
+     * height: The width of the paper
+     * must_fit: Should ((|width|)) and ((|height|)) fit
+       within paper
+     * Returns: the Gnome::PrintPaper, (({nil})) if not found.
+
+--- Gnome::PrintPaper.list
+     
+     Get an array of all the papers available on the system.
+
+     * Returns: The array of papers
+
 == Instance Methods
 
+--- height
+     
+     * Returns: height of the paper
+
 --- name
-     * Returns: the name of paper.
+     
+     * Returns: name of the paper
 
+--- version
+     
+     * Returns: version of the paper
+
 --- width
-     * Returns: the width of paper.
+     
+     * Returns: width of the paper
 
---- height
-     * Returns: the height of paper.
-
-== Constants
 == See Also
+
+== ChangeLog
+
+* 2005-06-09 ((<kou>)): completed
 
-- kou
\ No newline at end of file
+- ((<kou>))





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