ruby-****@sourc*****
ruby-****@sourc*****
2003年 8月 29日 (金) 19:53:06 JST
-------------------------
REMOTE_ADDR = 61.204.181.66
REMOTE_HOST =
URL = http://ruby-gnome2.sourceforge.jp/?Gtk%3A%3ATextTag
-------------------------
= class Gtk::TextTag
- Collection of tags that can be used together.
+ You may wish to begin by reading ((<the text widget conceptual overview>)) which gives an overview of all the objects and data types related to the text widget and how they work together.
+ Tags should be in the GtkTextTagTable for a given GtkTextBuffer before using them with that buffer.
+
+ Gtk::TextBuffer#create_tag is the best way to create tags. See gtk-demo for numerous examples.
+
+ The "invisible" property was not implemented for GTK+ 2.0; it's planned to be implemented in future releases.
+
== Object Hierarchy
* Object
* GLib::Instantiatable
* GLib::Object
* Gtk::TextTag
- - ((<Masao>))
+ == Class Methods
+ --- Gtk::TextTag.new(name = nil)
+ Creates a Gtk::TextTag. Configure the tag using object arguments,
+ * name: tag name, or nil
+ * Returns: a new Gtk::TextTag
+
+
+ == Instance Methods
+ --- priority
+ Get the tag priority.
+ * Returns: The tag's priority.
+ --- priority=(priority)
+ Sets the priority of a Gtk::TextTag. Valid priorities are start at 0 and go to one less than Gtk::TextTagTable#size. Each tag in a table has a unique priority; setting the priority of one tag shifts the priorities of all the other tags in the table to maintain a unique priority for each tag. Higher priority tags "win" if two tags both set the same text attribute. When adding a tag to a tag table, it will be assigned the highest priority in the table by default; so normally the precedence of a set of tags is the order in which they were added to the table, or created with Gtk::TextBuffer#create_tag, which adds the tag to the buffer's table automatically.
+ * priority: the new priority
+ * Returns: priority
+ --- set_priority(priority)
+ Same as priority=.
+ * priority: the new priority
+ * Returns: self
+
+ --- event(event_object, event, iter)
+ Emits the "event" signal on the Gtk::TextTag.
+ * event_object: object that received the event, such as a widget
+ * event: the event
+ * iter: location where the event was received
+ * Returns : result of signal emission (true if the event was handled)
+
+ --- name
+ Gets the name of the tag, or nil for anonymous tags. Can only be set when the tag is created.
+ * Returns: the name of the tag.
+ --- name=(name)
+ Sets the name of the tag, or nil for anonymous tags. Can only be set when the tag is created.
+ * name: the name of the tag
+ * Returns: self
+ --- set_name(name)
+ Same as name=.
+ * name: the name of the tag
+ * Returns: self
+
+ --- background=(color)
+ Sets the background color, as a string such as "red" or "FFFFFF"
+ * color: a background color
+ * Returns: color
+ --- set_background(color)
+ Same as background=.
+ * color: a background color
+ * Returns: self
+
+ --- foreground=(color)
+ Sets the foreground color, as a string such as "red" or "FFFFFF"
+ * color: a foreground color
+ * Returns: color
+ --- set_foreground(color)
+ Same as foreground=.
+ * color: a foreground color
+ * Returns: self
+
+ --- background_gdk
+ Gets the background color, as a Gdk::Color. The color need not be allocated.
+ * Returns: a Gdk::Color
+ --- background_gdk=(color)
+ Sets the background color, as a Gdk::Color. The color need not be allocated.
+ * color: a Gdk::Color
+ * Returns: color
+ --- set_background_gdk(color)
+ Same as background_gdk=.
+ * color: a Gdk::Color
+ * Returns: self
+
+ --- foreground_gdk
+ Gets the foreground color, as a Gdk::Color. The color need not be allocated.
+ * Returns: a Gdk::Color
+ --- foreground_gdk=(color)
+ Sets the foreground color, as a Gdk::Color. The color need not be allocated.
+ * color: a Gdk::Color
+ * Returns: color
+ --- set_foreground_gdk(color)
+ Same as foreground_gdk=.
+ * color: a Gdk::Color
+ * Returns: self
+
+ --- background_stipple
+ Gets a Gdk::Pixmap(depth=1) to use for stippling the background color.
+ * Returns: a Gdk::Pixmap
+ --- background_stipple=(bitmap)
+ Sets a Gdk::Pixmap(depth=1) to use for stippling the background color.
+ * bitmap: a Gdk::Pixmap(depth=1)
+ * Returns: bitmap
+ --- set_background_stipple(bitmap)
+ Same as background_stipple=.
+ * bitmap: a Gdk::Pixmap(depth=1)
+ * Returns: self
+
+ --- foreground_stipple
+ Gets a Gdk::Pixmap(depth=1) to use for stippling the foreground color.
+ * Returns: a Gdk::Pixmap
+ --- foreground_stipple=(bitmap)
+ Sets a Gdk::Pixmap(depth=1) to use for stippling the foreground color.
+ * bitmap: a Gdk::Pixmap(depth=1)
+ * Returns: bitmap
+ --- set_foreground_stipple(bitmap)
+ Same as foreground_stipple=.
+ * bitmap: a Gdk::Pixmap(depth=1)
+ * Returns: self
+
+ --- font
+ Gets the font as a Pango font name, e.g. "Sans Italic 12"
+ * Returns: the font name.
+ --- font=(font)
+ Sets the font as a Pango font name, e.g. "Sans Italic 12"
+ * font: the font name.
+ * Returns: font.
+ --- set_font(font)
+ Same as font=.
+ * font: the font name.
+ * Returns: self
+
+ --- font_desc
+ Gets the font as a Pango::FontDescription.
+ * Returns: the font description.
+ --- font_desc=(desc)
+ Sets the font as a Pango::FontDescription.
+ * desc: the font description
+ * Returns: desc
+ --- set_font_desc(desc)
+ Same as font_desc=.
+ * desc: the font description
+ * Returns: self
+
+
+ --- background_full_height=
+
+ * Returns: self
+ --- background_full_height?
+
+ * Returns: self
+ --- background_full_height_set=
+
+ * Returns: self
+ --- background_full_height_set?
+
+ * Returns: self
+ --- background_set=
+
+ * Returns: self
+ --- background_set?
+
+ * Returns: self
+ --- background_stipple_set=
+
+ * Returns: self
+ --- background_stipple_set?
+
+ * Returns: self
+ --- direction
+
+ * Returns: self
+ --- direction=
+
+ * Returns: self
+ --- editable=
+
+ * Returns: self
+ --- editable?
+
+ * Returns: self
+ --- editable_set=
+
+ * Returns: self
+ --- editable_set?
+
+ * Returns: self
+ --- family
+
+ * Returns: self
+ --- family=
+
+ * Returns: self
+ --- family_set=
+
+ * Returns: self
+ --- family_set?
+
+ * Returns: self
+ --- foreground_gdk
+
+ * Returns: self
+ --- foreground_gdk=
+
+ * Returns: self
+ --- foreground_set=
+
+ * Returns: self
+ --- foreground_set?
+
+ * Returns: self
+ --- foreground_stipple_set=
+
+ * Returns: self
+ --- foreground_stipple_set?
+
+ * Returns: self
+ --- indent
+
+ * Returns: self
+ --- indent=
+
+ * Returns: self
+ --- indent_set=
+
+ * Returns: self
+ --- indent_set?
+
+ * Returns: self
+ --- invisible=
+
+ * Returns: self
+ --- invisible?
+
+ * Returns: self
+ --- invisible_set=
+
+ * Returns: self
+ --- invisible_set?
+
+ * Returns: self
+ --- justification
+
+ * Returns: self
+ --- justification=
+
+ * Returns: self
+ --- justification_set=
+
+ * Returns: self
+ --- justification_set?
+
+ * Returns: self
+ --- language
+
+ * Returns: self
+ --- language=
+
+ * Returns: self
+ --- language_set=
+
+ * Returns: self
+ --- language_set?
+
+ * Returns: self
+ --- left_margin
+
+ * Returns: self
+ --- left_margin=
+
+ * Returns: self
+ --- left_margin_set=
+
+ * Returns: self
+ --- left_margin_set?
+
+ * Returns: self
+ --- pixels_above_lines
+
+ * Returns: self
+ --- pixels_above_lines=
+
+ * Returns: self
+ --- pixels_above_lines_set=
+
+ * Returns: self
+ --- pixels_above_lines_set?
+
+ * Returns: self
+ --- pixels_below_lines
+
+ * Returns: self
+ --- pixels_below_lines=
+
+ * Returns: self
+ --- pixels_below_lines_set=
+
+ * Returns: self
+ --- pixels_below_lines_set?
+
+ * Returns: self
+ --- pixels_inside_wrap
+
+ * Returns: self
+ --- pixels_inside_wrap=
+
+ * Returns: self
+ --- pixels_inside_wrap_set=
+
+ * Returns: self
+ --- pixels_inside_wrap_set?
+
+ * Returns: self
+ --- right_margin
+
+ * Returns: self
+ --- right_margin=
+
+ * Returns: self
+ --- right_margin_set=
+
+ * Returns: self
+ --- right_margin_set?
+
+ * Returns: self
+ --- rise
+
+ * Returns: self
+ --- rise=
+
+ * Returns: self
+ --- rise_set=
+
+ * Returns: self
+ --- rise_set?
+
+ * Returns: self
+ --- scale
+
+ * Returns: self
+ --- scale=
+
+ * Returns: self
+ --- scale_set=
+
+ * Returns: self
+ --- scale_set?
+
+ * Returns: self
+ --- set_background_full_height
+
+ * Returns: self
+ --- set_background_full_height_set
+
+ * Returns: self
+ --- set_background_set
+
+ * Returns: self
+ --- set_background_stipple_set
+
+ * Returns: self
+ --- set_direction
+
+ * Returns: self
+ --- set_editable
+
+ * Returns: self
+ --- set_editable_set
+
+ * Returns: self
+ --- set_family
+
+ * Returns: self
+ --- set_family_set
+
+ * Returns: self
+ --- set_foreground_gdk
+
+ * Returns: self
+ --- set_foreground_set
+
+ * Returns: self
+ --- set_foreground_stipple_set
+
+ * Returns: self
+ --- set_indent
+
+ * Returns: self
+ --- set_indent_set
+
+ * Returns: self
+ --- set_invisible
+
+ * Returns: self
+ --- set_invisible_set
+
+ * Returns: self
+ --- set_justification
+
+ * Returns: self
+ --- set_justification_set
+
+ * Returns: self
+ --- set_language
+
+ * Returns: self
+ --- set_language_set
+
+ * Returns: self
+ --- set_left_margin
+
+ * Returns: self
+ --- set_left_margin_set
+
+ * Returns: self
+ --- set_pixels_above_lines
+
+ * Returns: self
+ --- set_pixels_above_lines_set
+
+ * Returns: self
+ --- set_pixels_below_lines
+
+ * Returns: self
+ --- set_pixels_below_lines_set
+
+ * Returns: self
+ --- set_pixels_inside_wrap
+
+ * Returns: self
+ --- set_pixels_inside_wrap_set
+
+ * Returns: self
+ --- set_right_margin
+
+ * Returns: self
+ --- set_right_margin_set
+
+ * Returns: self
+ --- set_rise
+
+ * Returns: self
+ --- set_rise_set
+
+ * Returns: self
+ --- set_scale
+
+ * Returns: self
+ --- set_scale_set
+
+ * Returns: self
+ --- set_size
+
+ * Returns: self
+ --- set_size_points
+
+ * Returns: self
+ --- set_size_set
+
+ * Returns: self
+ --- set_stretch
+
+ * Returns: self
+ --- set_stretch_set
+
+ * Returns: self
+ --- set_strikethrough
+
+ * Returns: self
+ --- set_strikethrough_set
+
+ * Returns: self
+ --- set_style
+
+ * Returns: self
+ --- set_style_set
+
+ * Returns: self
+ --- set_tabs
+
+ * Returns: self
+ --- set_tabs_set
+
+ * Returns: self
+ --- set_underline
+
+ * Returns: self
+ --- set_underline_set
+
+ * Returns: self
+ --- set_variant
+
+ * Returns: self
+ --- set_variant_set
+
+ * Returns: self
+ --- set_weight
+
+ * Returns: self
+ --- set_weight_set
+
+ * Returns: self
+ --- set_wrap_mode
+
+ * Returns: self
+ --- set_wrap_mode_set
+
+ * Returns: self
+ --- size
+
+ * Returns: self
+ --- size=
+
+ * Returns: self
+ --- size_points
+
+ * Returns: self
+ --- size_points=
+
+ * Returns: self
+ --- size_set=
+
+ * Returns: self
+ --- size_set?
+
+ * Returns: self
+ --- stretch
+
+ * Returns: self
+ --- stretch=
+
+ * Returns: self
+ --- stretch_set=
+
+ * Returns: self
+ --- stretch_set?
+
+ * Returns: self
+ --- strikethrough=
+
+ * Returns: self
+ --- strikethrough?
+
+ * Returns: self
+ --- strikethrough_set=
+
+ * Returns: self
+ --- strikethrough_set?
+
+ * Returns: self
+ --- style
+
+ * Returns: self
+ --- style=
+
+ * Returns: self
+ --- style_set=
+
+ * Returns: self
+ --- style_set?
+
+ * Returns: self
+ --- tabs
+
+ * Returns: self
+ --- tabs=
+
+ * Returns: self
+ --- tabs_set=
+
+ * Returns: self
+ --- tabs_set?
+
+ * Returns: self
+ --- underline
+
+ * Returns: self
+ --- underline=
+
+ * Returns: self
+ --- underline_set=
+
+ * Returns: self
+ --- underline_set?
+
+ * Returns: self
+ --- variant
+
+ * Returns: self
+ --- variant=
+
+ * Returns: self
+ --- variant_set=
+
+ * Returns: self
+ --- variant_set?
+
+ * Returns: self
+ --- weight
+
+ * Returns: self
+ --- weight=
+
+ * Returns: self
+ --- weight_set=
+
+ * Returns: self
+ --- weight_set?
+
+ * Returns: self
+ --- wrap_mode
+
+ * Returns: self
+ --- wrap_mode=
+
+ * Returns: self
+ --- wrap_mode_set=
+
+ * Returns: self
+ --- wrap_mode_set?
+
+ * Returns: self
+
+ == Constants
+ --- WRAP_CHAR
+ --- WRAP_NONE
+ --- WRAP_WORD
+
+ == Properties
+ --- background: String (Write)
+ Background color as a string
+
+ --- background-full-height: true or false (Read/Write)
+ Whether the background color fills the entire line height or only the height of the tagged characters
+
+ --- background-full-height-set: true or false (Read/Write)
+ Whether this tag affects background height
+
+ --- background-gdk: Gdk::Color (Read/Write)
+ Background color as a (possibly unallocated) Gdk::Color
+
+ --- background-set: true or false (Read/Write)
+ Whether this tag affects the background color
+
+ --- background-stipple: Gdk::Pixmap (Read/Write)
+ Bitmap to use as a mask when drawing the text background
+
+ --- background-stipple-set: true or false (Read/Write)
+ Whether this tag affects the background stipple
+
+ --- direction: Integer (Read/Write)
+ Text direction, e.g. right-to-left or left-to-right
+
+ --- editable: true or false (Read/Write)
+ Whether the text can be modified by the user
+
+ --- editable-set: true or false (Read/Write)
+ Whether this tag affects text editability
+
+ --- family: String (Read/Write)
+ Name of the font family, e.g. Sans, Helvetica, Times, Monospace
+
+ --- family-set: true or false (Read/Write)
+ Whether this tag affects the font family
+
+ --- font: String (Read/Write)
+ Font description as a string, e.g. "Sans Italic 12"
+
+ --- font-desc: Pango::FontDescription (Read/Write)
+ Font description as a PangoFontDescription struct
+
+ --- foreground: String (Write)
+ Foreground color as a string
+
+ --- foreground-gdk: Gdk::Color (Read/Write)
+ Foreground color as a (possibly unallocated) Gdk::Color
+
+ --- foreground-set: true or false (Read/Write)
+ Whether this tag affects the foreground color
+
+ --- foreground-stipple: Gdk::Pixmap (Read/Write)
+ Bitmap to use as a mask when drawing the text foreground
+
+ --- foreground-stipple-set: true or false (Read/Write)
+ Whether this tag affects the foreground stipple
+
+ --- indent: Integer (Read/Write)
+ Amount to indent the paragraph, in pixels
+
+ --- indent-set: true or false (Read/Write)
+ Whether this tag affects indentation
+
+ --- invisible: true or false (Read/Write)
+ Whether this text is hidden. Not implemented in GTK 2.0
+
+ --- invisible-set: true or false (Read/Write)
+ Whether this tag affects text visibility
+
+ --- justification: Integer (Read/Write)
+ Left, right, or center justification
+
+ --- justification-set: true or false (Read/Write)
+ Whether this tag affects paragraph justification
+
+ --- language: String (Read/Write)
+ The language this text is in, as an ISO code. Pango can use this as a hint when rendering the text. If you don't understand this parameter, you probably don't need it
+
+ --- language-set: true or false (Read/Write)
+ Whether this tag affects the language the text is rendered as
+
+ --- left-margin: Integer (Read/Write)
+ Width of the left margin in pixels
+
+ --- left-margin-set: true or false (Read/Write)
+ Whether this tag affects the left margin
+
+ --- name: String (Read/Write)
+ Name used to refer to the text tag. NULL for anonymous tags
+
+ --- pixels-above-lines: Integer (Read/Write)
+ Pixels of blank space above paragraphs
+
+ --- pixels-above-lines-set: true or false (Read/Write)
+ Whether this tag affects the number of pixels above lines
+
+ --- pixels-below-lines: Integer (Read/Write)
+ Pixels of blank space below paragraphs
+
+ --- pixels-below-lines-set: true or false (Read/Write)
+ Whether this tag affects the number of pixels above lines
+
+ --- pixels-inside-wrap: Integer (Read/Write)
+ Pixels of blank space between wrapped lines in a paragraph
+
+ --- pixels-inside-wrap-set: true or false (Read/Write)
+ Whether this tag affects the number of pixels between wrapped lines
+
+ --- right-margin: Integer (Read/Write)
+ Width of the right margin in pixels
+
+ --- right-margin-set: true or false (Read/Write)
+ Whether this tag affects the right margin
+
+ --- rise: Integer (Read/Write)
+ Offset of text above the baseline (below the baseline if rise is negative) in pixels
+
+ --- rise-set: true or false (Read/Write)
+ Whether this tag affects the rise
+
+ --- scale: Float (Read/Write)
+ Font size as a scale factor relative to the default font size. This properly adapts to theme changes etc. so is recommended. Pango predefines some scales such as PANGO_SCALE_X_LARGE
+
+ --- scale-set: true or false (Read/Write)
+ Whether this tag scales the font size by a factor
+
+ --- size: Integer (Read/Write)
+ Font size in Pango units
+
+ --- size-points: Float (Read/Write)
+ Font size in points
+
+ --- size-set: true or false (Read/Write)
+ Whether this tag affects the font size
+
+ --- stretch: Integer (Read/Write)
+ Font stretch as a PangoStretch, e.g. PANGO_STRETCH_CONDENSED
+
+ --- stretch-set: true or false (Read/Write)
+ Whether this tag affects the font stretch
+
+ --- strikethrough: true or false (Read/Write)
+ Whether to strike through the text
+
+ --- strikethrough-set: true or false (Read/Write)
+ Whether this tag affects strikethrough
+
+ --- style: Integer (Read/Write)
+ Font style as a PangoStyle, e.g. PANGO_STYLE_ITALIC
+
+ --- style-set: true or false (Read/Write)
+ Whether this tag affects the font style
+
+ --- tabs: Pango::TabArray (Read/Write)
+ Custom tabs for this text
+
+ --- tabs-set: true or false (Read/Write)
+ Whether this tag affects tabs
+
+ --- underline: Integer (Read/Write)
+ Style of underline for this text
+
+ --- underline-set: true or false (Read/Write)
+ Whether this tag affects underlining
+
+ --- variant: Integer (Read/Write)
+ Font variant as a PangoVariant, e.g. PANGO_VARIANT_SMALL_CAPS
+
+ --- variant-set: true or false (Read/Write)
+ Whether this tag affects the font variant
+
+ --- weight: Integer (Read/Write)
+ Font weight as an integer, see predefined values in PangoWeight; for example, PANGO_WEIGHT_BOLD
+
+ --- weight-set: true or false (Read/Write)
+ Whether this tag affects the font weight
+
+ --- wrap-mode: Integer (Read/Write)
+ Whether to wrap lines never, at word boundaries, or at character boundaries
+
+ --- wrap-mode-set: true or false (Read/Write)
+ Whether this tag affects line wrap mode
+
+ == Signals
+ --- event: self
+ * self:
+
+ == See Also