[ruby-gnome2-doc-cvs] [Ruby-GNOME2 Project Website] update - Pango::Layout

Back to archive index

ruby-****@sourc***** ruby-****@sourc*****
2005年 11月 10日 (木) 20:00:31 JST


-------------------------
REMOTE_ADDR = 15.211.169.100
REMOTE_HOST = 
REMOTE_USER = ruby-gnome2-hiki
        URL = /hiki.cgi?Pango%3A%3ALayout
-------------------------
@@ -74,12 +74,61 @@
     * Returns: self
 
 --- width
-    
-     * Returns: self
---- width=
+    Gets the width to which the lines of the Pango::Layout should be wrapped.
+    * Returns: the width  
+--- width=(width)
+    Sets the width to which the lines of the Pango::Layout should be wrapped.
+    * width : the desired width, or -1 to indicate that no wrapping should be performed.
+    * Returns: width
+--- set_width(width)
+    Same as Pango::Layout#width=.
+    * width: the desired width, or -1 to indicate that no wrapping should be performed.
+    * Returns: self
+
+--- wrap
+    Gets the wrap mode for the layout.
+    * Returns: Active wrap mode(Pango::Layout#WrapMode).  
+--- wrap=(wrap)
+    Sets the wrap mode; the wrap mode only has an effect if a width is set on the layout with Pango::Layout#width=. To turn off wrapping, set the width to -1.
+    * wrap: the wrap mode(Pango::Layout#WrapMode).
+    * Returns: wrap
+--- set_wrap(wrap)
+    Same as Pango::Layout#wrap=.
+    * wrap: the wrap mode(Pango::Layout#WrapMode).
+    * Returns: self
+
+--- ellipsize
+    Gets the type of ellipsization being performed for layout. See Pango::Layout#ellipsize=.
+    * Returns: the current ellipsization mode for layout (Pango::Layout#EllipzeMode)
+--- ellipsize=(ellipsize)
+    Sets the type of ellipsization being performed for layout. Depending on the ellipsization mode ellipsize text is removed from the start, middle, or end of lines so they fit within the width of layout set with Pango::Layout#width=. 
+    If the layout contains characters such as newlines that force it to be layed out in multiple lines, then each line is ellipsized separately. ((* Since 1.6 *))
+    * ellipsize: the new ellipsization mode for layout(Pango::Layout#EllipzeMode)
+    * Returns: ellipsize
+--- set_ellipsize(ellipsize)
+    Same as Pango::Layout#ellipsize=.  ((* Since 1.6 *))
+    * ellipsize: the new ellipsization mode for layout(Pango::Layout#EllipzeMode)
+    * Returns: self
+
+--- indent
+    Gets the paragraph indent width in pango units. A negative value indicates a hanging indent.
+    * Returns: the indent  
+--- indent=(indent)
+    Sets the width in pango units to indent each paragraph. A negative value of indent will produce a hanging indent. That is, the first line will have the full width, and subsequent lines will be indented by the absolute value of indent.
+    * indent: the amount by which to indentset (Integer)
+    * Returns: indent
+--- set_indent(indent)
+    Same as Pango::Layout#indent=. 
+    * indent: the amount by which to indentset (Integer)
+    * Returns: self
+
+--- spacing
+    Gets the amount of spacing between the lines of the layout.
+    * Returns: the spacing (in Pango::GlyphUnit)  ((*FIXME*))
+--- spacing=(spacing)
      
      * Returns: self
---- set_width
+--- set_spacing(spacing)
      
      * Returns: self
 
@@ -89,103 +138,138 @@
 --- alignment=
      
      * Returns: self
---- auto_dir=
+--- set_alignment
      
      * Returns: self
+
 --- auto_dir?
      
      * Returns: self
+--- auto_dir=(auto_dir)
+     
+     * Returns: self
+--- set_auto_dir(auto_dir)
+    Same as Pango::Layout#auto_dir=.
 
+    * Returns: self
+
 --- copy
      
      * Returns: self
---- ellipsize
-     
-     * Returns: self
---- ellipsize=
-     
-     * Returns: self
+
 --- extents
      
      * Returns: self
+
 --- get_clip_region
      
      * Returns: self
+
 --- get_cursor_pos
      
      * Returns: self
+
 --- get_extents
      
      * Returns: self
+
 --- get_line
      
      * Returns: self
 --- get_pixel_extents
      
      * Returns: self
---- indent
-     
-     * Returns: self
---- indent=
-     
-     * Returns: self
 --- index_to_pos
      
      * Returns: self
 --- iter
      
      * Returns: self
---- justify=
+
+--- justify?
      
      * Returns: self
---- justify?
+--- justify=
      
      * Returns: self
+--- set_justify
+    Same as Pango::Layout#justify=.
+     * Returns: self
+
 --- line_count
      
      * Returns: self
+
 --- lines
      
      * Returns: self
+
 --- log_attrs
      
      * Returns: self
+
 --- move_cursor_visually
      
      * Returns: self
+
 --- pixel_extents
      
      * Returns: self
 --- pixel_size
      
      * Returns: self
---- set_alignment
-     
-     * Returns: self
---- set_auto_dir
-     
-     * Returns: self
---- set_ellipsize
-     
-     * Returns: self
---- set_indent
-     
-     * Returns: self
---- set_justify
-     
-     * Returns: self
 --- set_single_paragraph_mode
      
      * Returns: self
---- set_spacing
-     
-     * Returns: self
---- set_tabs
-     
-     * Returns: self
---- set_wrap
-     
-     * Returns: self
 --- single_paragraph_mode=
      
      * Returns: self
@@ -195,42 +230,79 @@
 --- size
      
      * Returns: self
---- spacing
-     
-     * Returns: self
---- spacing=
-     
-     * Returns: self
 --- tabs
      
      * Returns: self
---- tabs=
+--- tabs=(tabs)
      
      * Returns: self
---- wrap
-     
-     * Returns: self
---- wrap=
-     
-     * Returns: self
+--- set_tabs(tabs)
+    Same as Pango::Layout#tabs=.
+    * Returns: self
 --- xy_to_index
      
      * Returns: self
 
 == Constants
+=== WrapMode
+A WrapMode describes how to wrap the lines of a Pango::Layout to the desired width. 
+--- WRAP_WORD
+    wrap lines at word boundaries. 
+--- WRAP_CHAR
+    wrap lines at character boundaries. 
+--- WRAP_WORD_CHAR
+    wrap lines at word boundaries, but fall back to character boundaries if there is not enough space for a full word. 
+
+=== EllipsizeMode
+The EllipsizeMode type describes what sort of (if any) ellipsization should be applied to a line of text. In the ellipsization process characters are removed from the text in order to make it fit to a given width and replaced with an ellipsis.
+--- ELLIPSIZE_NONE
+    No ellipsization 
+--- ELLIPSIZE_START
+    Omit characters at the start of the text 
+--- ELLIPSIZE_MIDDLE
+    Omit characters in the middle of the text 
+--- ELLIPSIZE_END
+    Omit characters at the end of the text 
+
 --- ALIGN_CENTER
 --- ALIGN_LEFT
 --- ALIGN_RIGHT
 --- Alignment
---- ELLIPSIZE_END
---- ELLIPSIZE_MIDDLE
---- ELLIPSIZE_NONE
---- ELLIPSIZE_START
---- EllipsizeMode
---- WRAP_CHAR
---- WRAP_WORD
---- WRAP_WORD_CHAR
---- WrapMode
 
 == See Also
 





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