Gtk::TextTag Class Reference
[TextView Classes]

Inheritance diagram for Gtk::TextTag:

[legend]

List of all members.

---

Detailed Description

Typedefed as Gtk::TextBuffer::Tag.

Text in a buffer can be marked with tags. A tag is an attribute that can be applied to some range of text. For example, a tag might be called "bold" and might make the text inside the tag bold. However, the tag concept is more general than that; tags don't have to affect appearance. They can instead affect the behavior of mouse and key presses, "lock" a range of text so the user can't edit it, or countless other things. One tag can be applied to any number of text ranges in any number of Gtk::TextBuffers.

Each tag is stored in a Gtk::TextBuffer::TagTable, and Tags should be in the Gtk::TextBuffer::TagTable for a given Gtk::TextBuffer before using them with that buffer.

Tags can have names, which is convenient sometimes (for example, you can name your tag that makes things bold "bold"), but they can also be anonymous (which is convenient if you're creating tags on-the-fly).

Gtk::TextBuffer::create_tag() is the best way to create tags. See the demo for numerous examples.

Public Member Functions
bool	event (const Glib::RefPtr<Glib::Object>& event_object, GdkEvent* event, const TextIter& iter)
	Emits the "event" signal on the Gtk::TextTag.
int	get_priority () const
	Get the tag priority.
const GtkTextTag*	gobj () const
	Provides access to the underlying C GObject.
GtkTextTag*	gobj ()
	Provides access to the underlying C GObject.
GtkTextTag*	gobj_copy ()
	Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.
Glib::PropertyProxy_ReadOnly <bool>	property_accumulative_margin () const
	Whether left and right margins accumulate.
Glib::PropertyProxy<bool>	property_accumulative_margin ()
	Whether left and right margins accumulate.
Glib::PropertyProxy_WriteOnly <Glib::ustring>	property_background ()
	Background color as a string.
Glib::PropertyProxy_ReadOnly <bool>	property_background_full_height () const
	Whether the background color fills the entire line height or only the height of the tagged characters.
Glib::PropertyProxy<bool>	property_background_full_height ()
	Whether the background color fills the entire line height or only the height of the tagged characters.
Glib::PropertyProxy_ReadOnly <bool>	property_background_full_height_set () const
	Whether this tag affects background height.
Glib::PropertyProxy<bool>	property_background_full_height_set ()
	Whether this tag affects background height.
Glib::PropertyProxy_ReadOnly <Gdk::Color>	property_background_gdk () const
	Background color as a (possibly unallocated) GdkColor.
Glib::PropertyProxy<Gdk::Color>	property_background_gdk ()
	Background color as a (possibly unallocated) GdkColor.
Glib::PropertyProxy_ReadOnly <bool>	property_background_set () const
	Whether this tag affects the background color.
Glib::PropertyProxy<bool>	property_background_set ()
	Whether this tag affects the background color.
Glib::PropertyProxy_ReadOnly <Glib::RefPtr<Gdk::Bitmap>>	property_background_stipple () const
	Bitmap to use as a mask when drawing the text background.
Glib::PropertyProxy <Glib::RefPtr<Gdk::Bitmap>>	property_background_stipple ()
	Bitmap to use as a mask when drawing the text background.
Glib::PropertyProxy_ReadOnly <bool>	property_background_stipple_set () const
	Whether this tag affects the background stipple.
Glib::PropertyProxy<bool>	property_background_stipple_set ()
	Whether this tag affects the background stipple.
Glib::PropertyProxy_ReadOnly <TextDirection>	property_direction () const
	Text direction.
Glib::PropertyProxy <TextDirection>	property_direction ()
	Text direction.
Glib::PropertyProxy_ReadOnly <bool>	property_editable () const
	Whether the text can be modified by the user.
Glib::PropertyProxy<bool>	property_editable ()
	Whether the text can be modified by the user.
Glib::PropertyProxy_ReadOnly <bool>	property_editable_set () const
	Whether this tag affects text editability.
Glib::PropertyProxy<bool>	property_editable_set ()
	Whether this tag affects text editability.
Glib::PropertyProxy_ReadOnly <Glib::ustring>	property_family () const
	Name of the font family.
Glib::PropertyProxy <Glib::ustring>	property_family ()
	Name of the font family.
Glib::PropertyProxy_ReadOnly <bool>	property_family_set () const
	Whether this tag affects the font family.
Glib::PropertyProxy<bool>	property_family_set ()
	Whether this tag affects the font family.
Glib::PropertyProxy_ReadOnly <Glib::ustring>	property_font () const
	Font description as a string.
Glib::PropertyProxy <Glib::ustring>	property_font ()
	Font description as a string.
Glib::PropertyProxy_ReadOnly <Pango::FontDescription>	property_font_desc () const
	Font description as a PangoFontDescription struct.
Glib::PropertyProxy <Pango::FontDescription>	property_font_desc ()
	Font description as a PangoFontDescription struct.
Glib::PropertyProxy_WriteOnly <Glib::ustring>	property_foreground ()
	Foreground color as a string.
Glib::PropertyProxy_ReadOnly <Gdk::Color>	property_foreground_gdk () const
	Foreground color as a (possibly unallocated) GdkColor.
Glib::PropertyProxy<Gdk::Color>	property_foreground_gdk ()
	Foreground color as a (possibly unallocated) GdkColor.
Glib::PropertyProxy_ReadOnly <bool>	property_foreground_set () const
	Whether this tag affects the foreground color.
Glib::PropertyProxy<bool>	property_foreground_set ()
	Whether this tag affects the foreground color.
Glib::PropertyProxy_ReadOnly <Glib::RefPtr<Gdk::Bitmap>>	property_foreground_stipple () const
	Bitmap to use as a mask when drawing the text foreground.
Glib::PropertyProxy <Glib::RefPtr<Gdk::Bitmap>>	property_foreground_stipple ()
	Bitmap to use as a mask when drawing the text foreground.
Glib::PropertyProxy_ReadOnly <bool>	property_foreground_stipple_set () const
	Whether this tag affects the foreground stipple.
Glib::PropertyProxy<bool>	property_foreground_stipple_set ()
	Whether this tag affects the foreground stipple.
Glib::PropertyProxy_ReadOnly<int>	property_indent () const
	Amount to indent the paragraph.
Glib::PropertyProxy<int>	property_indent ()
	Amount to indent the paragraph.
Glib::PropertyProxy_ReadOnly <bool>	property_indent_set () const
	Whether this tag affects indentation.
Glib::PropertyProxy<bool>	property_indent_set ()
	Whether this tag affects indentation.
Glib::PropertyProxy_ReadOnly <bool>	property_invisible () const
	Whether this text is hidden.
Glib::PropertyProxy<bool>	property_invisible ()
	Whether this text is hidden.
Glib::PropertyProxy_ReadOnly <bool>	property_invisible_set () const
	Whether this tag affects text visibility.
Glib::PropertyProxy<bool>	property_invisible_set ()
	Whether this tag affects text visibility.
Glib::PropertyProxy_ReadOnly <Justification>	property_justification () const
	Left.
Glib::PropertyProxy <Justification>	property_justification ()
	Left.
Glib::PropertyProxy_ReadOnly <bool>	property_justification_set () const
	Whether this tag affects paragraph justification.
Glib::PropertyProxy<bool>	property_justification_set ()
	Whether this tag affects paragraph justification.
Glib::PropertyProxy_ReadOnly <Glib::ustring>	property_language () const
	The language this text is in.
Glib::PropertyProxy <Glib::ustring>	property_language ()
	The language this text is in.
Glib::PropertyProxy_ReadOnly <bool>	property_language_set () const
	Whether this tag affects the language the text is rendered as.
Glib::PropertyProxy<bool>	property_language_set ()
	Whether this tag affects the language the text is rendered as.
Glib::PropertyProxy_ReadOnly<int>	property_left_margin () const
	Width of the left margin in pixels.
Glib::PropertyProxy<int>	property_left_margin ()
	Width of the left margin in pixels.
Glib::PropertyProxy_ReadOnly <bool>	property_left_margin_set () const
	Whether this tag affects the left margin.
Glib::PropertyProxy<bool>	property_left_margin_set ()
	Whether this tag affects the left margin.
Glib::PropertyProxy_ReadOnly <Glib::ustring>	property_name () const
	Name used to refer to the text tag.
Glib::PropertyProxy_WriteOnly <Glib::ustring>	property_paragraph_background ()
	Paragraph background color as a string.
Glib::PropertyProxy_ReadOnly <Gdk::Color>	property_paragraph_background_gdk () const
	Paragraph background color as a (possibly unallocated) GdkColor.
Glib::PropertyProxy<Gdk::Color>	property_paragraph_background_gdk ()
	Paragraph background color as a (possibly unallocated) GdkColor.
Glib::PropertyProxy_ReadOnly <bool>	property_paragraph_background_set () const
	Whether this tag affects the paragraph background color.
Glib::PropertyProxy<bool>	property_paragraph_background_set ()
	Whether this tag affects the paragraph background color.
Glib::PropertyProxy_ReadOnly<int>	property_pixels_above_lines () const
	Pixels of blank space above paragraphs.
Glib::PropertyProxy<int>	property_pixels_above_lines ()
	Pixels of blank space above paragraphs.
Glib::PropertyProxy_ReadOnly <bool>	property_pixels_above_lines_set () const
	Whether this tag affects the number of pixels above lines.
Glib::PropertyProxy<bool>	property_pixels_above_lines_set ()
	Whether this tag affects the number of pixels above lines.
Glib::PropertyProxy_ReadOnly<int>	property_pixels_below_lines () const
	Pixels of blank space below paragraphs.
Glib::PropertyProxy<int>	property_pixels_below_lines ()
	Pixels of blank space below paragraphs.
Glib::PropertyProxy_ReadOnly <bool>	property_pixels_below_lines_set () const
	Whether this tag affects the number of pixels above lines.
Glib::PropertyProxy<bool>	property_pixels_below_lines_set ()
	Whether this tag affects the number of pixels above lines.
Glib::PropertyProxy_ReadOnly<int>	property_pixels_inside_wrap () const
	Pixels of blank space between wrapped lines in a paragraph.
Glib::PropertyProxy<int>	property_pixels_inside_wrap ()
	Pixels of blank space between wrapped lines in a paragraph.
Glib::PropertyProxy_ReadOnly <bool>	property_pixels_inside_wrap_set () const
	Whether this tag affects the number of pixels between wrapped lines.
Glib::PropertyProxy<bool>	property_pixels_inside_wrap_set ()
	Whether this tag affects the number of pixels between wrapped lines.
Glib::PropertyProxy_ReadOnly<int>	property_right_margin () const
	Width of the right margin in pixels.
Glib::PropertyProxy<int>	property_right_margin ()
	Width of the right margin in pixels.
Glib::PropertyProxy_ReadOnly <bool>	property_right_margin_set () const
	Whether this tag affects the right margin.
Glib::PropertyProxy<bool>	property_right_margin_set ()
	Whether this tag affects the right margin.
Glib::PropertyProxy_ReadOnly<int>	property_rise () const
	Offset of text above the baseline (below the baseline if rise is negative) in Pango units.
Glib::PropertyProxy<int>	property_rise ()
	Offset of text above the baseline (below the baseline if rise is negative) in Pango units.
Glib::PropertyProxy_ReadOnly <bool>	property_rise_set () const
	Whether this tag affects the rise.
Glib::PropertyProxy<bool>	property_rise_set ()
	Whether this tag affects the rise.
Glib::PropertyProxy_ReadOnly <double>	property_scale () const
	Font size as a scale factor relative to the default font size.
Glib::PropertyProxy<double>	property_scale ()
	Font size as a scale factor relative to the default font size.
Glib::PropertyProxy_ReadOnly <bool>	property_scale_set () const
	Whether this tag scales the font size by a factor.
Glib::PropertyProxy<bool>	property_scale_set ()
	Whether this tag scales the font size by a factor.
Glib::PropertyProxy_ReadOnly<int>	property_size () const
	Font size in Pango units.
Glib::PropertyProxy<int>	property_size ()
	Font size in Pango units.
Glib::PropertyProxy_ReadOnly <double>	property_size_points () const
	Font size in points.
Glib::PropertyProxy<double>	property_size_points ()
	Font size in points.
Glib::PropertyProxy_ReadOnly <bool>	property_size_set () const
	Whether this tag affects the font size.
Glib::PropertyProxy<bool>	property_size_set ()
	Whether this tag affects the font size.
Glib::PropertyProxy_ReadOnly <Pango::Stretch>	property_stretch () const
	Font stretch as a PangoStretch.
Glib::PropertyProxy <Pango::Stretch>	property_stretch ()
	Font stretch as a PangoStretch.
Glib::PropertyProxy_ReadOnly <bool>	property_stretch_set () const
	Whether this tag affects the font stretch.
Glib::PropertyProxy<bool>	property_stretch_set ()
	Whether this tag affects the font stretch.
Glib::PropertyProxy_ReadOnly <bool>	property_strikethrough () const
	Whether to strike through the text.
Glib::PropertyProxy<bool>	property_strikethrough ()
	Whether to strike through the text.
Glib::PropertyProxy_ReadOnly <bool>	property_strikethrough_set () const
	Whether this tag affects strikethrough.
Glib::PropertyProxy<bool>	property_strikethrough_set ()
	Whether this tag affects strikethrough.
Glib::PropertyProxy_ReadOnly <Pango::Style>	property_style () const
	Font style as a PangoStyle.
Glib::PropertyProxy<Pango::Style>	property_style ()
	Font style as a PangoStyle.
Glib::PropertyProxy_ReadOnly <bool>	property_style_set () const
	Whether this tag affects the font style.
Glib::PropertyProxy<bool>	property_style_set ()
	Whether this tag affects the font style.
Glib::PropertyProxy_ReadOnly <Pango::TabArray>	property_tabs () const
	Custom tabs for this text.
Glib::PropertyProxy <Pango::TabArray>	property_tabs ()
	Custom tabs for this text.
Glib::PropertyProxy_ReadOnly <bool>	property_tabs_set () const
	Whether this tag affects tabs.
Glib::PropertyProxy<bool>	property_tabs_set ()
	Whether this tag affects tabs.
Glib::PropertyProxy_ReadOnly <Pango::Underline>	property_underline () const
	Style of underline for this text.
Glib::PropertyProxy <Pango::Underline>	property_underline ()
	Style of underline for this text.
Glib::PropertyProxy_ReadOnly <bool>	property_underline_set () const
	Whether this tag affects underlining.
Glib::PropertyProxy<bool>	property_underline_set ()
	Whether this tag affects underlining.
Glib::PropertyProxy_ReadOnly <Pango::Variant>	property_variant () const
	Font variant as a PangoVariant.
Glib::PropertyProxy <Pango::Variant>	property_variant ()
	Font variant as a PangoVariant.
Glib::PropertyProxy_ReadOnly <bool>	property_variant_set () const
	Whether this tag affects the font variant.
Glib::PropertyProxy<bool>	property_variant_set ()
	Whether this tag affects the font variant.
Glib::PropertyProxy_ReadOnly<int>	property_weight () const
	Font weight as an integer.
Glib::PropertyProxy<int>	property_weight ()
	Font weight as an integer.
Glib::PropertyProxy_ReadOnly <bool>	property_weight_set () const
	Whether this tag affects the font weight.
Glib::PropertyProxy<bool>	property_weight_set ()
	Whether this tag affects the font weight.
Glib::PropertyProxy_ReadOnly <WrapMode>	property_wrap_mode () const
	Whether to wrap lines never.
Glib::PropertyProxy<WrapMode>	property_wrap_mode ()
	Whether to wrap lines never.
Glib::PropertyProxy_ReadOnly <bool>	property_wrap_mode_set () const
	Whether this tag affects line wrap mode.
Glib::PropertyProxy<bool>	property_wrap_mode_set ()
	Whether this tag affects line wrap mode.
void	set_priority (int priority)
	Sets the priority of a Gtk::TextTag.
Glib::SignalProxy3< bool, const Glib::RefPtr < Glib::Object > &, GdkEvent *, const TextIter& >	signal_event ()
virtual	~TextTag ()
Static Public Member Functions
static Glib::RefPtr<TextTag>	create (const Glib::ustring& name)
static Glib::RefPtr<TextTag>	create ()
Protected Member Functions
virtual bool	on_event (const Glib::RefPtr<Glib::Object>& event_object, GdkEvent* event, const TextIter& iter)
	TextTag (const Glib::ustring& name)
	TextTag ()
Related Functions
(Note that these are not member functions.)
Glib::RefPtr<Gtk::TextTag>	wrap (GtkTextTag* object, bool take_copy=false)
	A Glib::wrap() method for this object.

---

Constructor & Destructor Documentation

virtual Gtk::TextTag::~TextTag

(

)

[virtual]

Gtk::TextTag::TextTag

(

)

[protected]

Gtk::TextTag::TextTag

(

const Glib::ustring &

name

)

[explicit, protected]

---

Member Function Documentation

static Glib::RefPtr<TextTag> Gtk::TextTag::create

(

const Glib::ustring &

name

)

[static]

static Glib::RefPtr<TextTag> Gtk::TextTag::create

(

)

[static]

bool Gtk::TextTag::event	(	const Glib::RefPtr< Glib::Object > &	event_object,
		GdkEvent *	event,
		const TextIter&	iter
	)

Emits the "event" signal on the Gtk::TextTag.

Parameters:

	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 (whether the event was handled).

int Gtk::TextTag::get_priority

(

)

const

Get the tag priority.

Returns:

The tag's priority.

const GtkTextTag* Gtk::TextTag::gobj

(

)

const [inline]

Provides access to the underlying C GObject.

Reimplemented from Glib::ObjectBase.

GtkTextTag* Gtk::TextTag::gobj

(

)

[inline]

Provides access to the underlying C GObject.

Reimplemented from Glib::ObjectBase.

GtkTextTag* Gtk::TextTag::gobj_copy

(

)

Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.

virtual bool Gtk::TextTag::on_event	(	const Glib::RefPtr< Glib::Object > &	event_object,
		GdkEvent *	event,
		const TextIter&	iter
	)			[protected, virtual]

Glib::PropertyProxy_ReadOnly<bool> Gtk::TextTag::property_accumulative_margin

(

)

const

Whether left and right margins accumulate.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:

A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

Glib::PropertyProxy<bool> Gtk::TextTag::property_accumulative_margin

(

)

Whether left and right margins accumulate.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:

A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

Glib::PropertyProxy_WriteOnly<Glib::ustring> Gtk::TextTag::property_background

(

)

Background color as a string.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:

A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

Glib::PropertyProxy_ReadOnly<bool> Gtk::TextTag::property_background_full_height

(

)

const

Whether the background color fills the entire line height or only the height of the tagged characters.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:

A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

Glib::PropertyProxy<bool> Gtk::TextTag::property_background_full_height

(

)

Whether the background color fills the entire line height or only the height of the tagged characters.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:

A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

Glib::PropertyProxy_ReadOnly<bool> Gtk::TextTag::property_background_full_height_set

(

)

const

Whether this tag affects background height.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:

A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

Glib::PropertyProxy<bool> Gtk::TextTag::property_background_full_height_set

(

)

Whether this tag affects background height.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:

A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

Glib::PropertyProxy_ReadOnly<Gdk::Color> Gtk::TextTag::property_background_gdk

(

)

const

Background color as a (possibly unallocated) GdkColor.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:

A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

Glib::PropertyProxy<Gdk::Color> Gtk::TextTag::property_background_gdk

(

)

Background color as a (possibly unallocated) GdkColor.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:

A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

Glib::PropertyProxy_ReadOnly<bool> Gtk::TextTag::property_background_set

(

)

const

Whether this tag affects the background color.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:

A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

Glib::PropertyProxy<bool> Gtk::TextTag::property_background_set

(

)

Whether this tag affects the background color.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:

A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

Glib::PropertyProxy_ReadOnly<Glib::RefPtr<Gdk::Bitmap>> Gtk::TextTag::property_background_stipple

(

)

const

Bitmap to use as a mask when drawing the text background.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:

A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

Glib::PropertyProxy<Glib::RefPtr<Gdk::Bitmap>> Gtk::TextTag::property_background_stipple

(

)

Bitmap to use as a mask when drawing the text background.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:

A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

Glib::PropertyProxy_ReadOnly<bool> Gtk::TextTag::property_background_stipple_set

(

)

const

Whether this tag affects the background stipple.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:

A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

Glib::PropertyProxy<bool> Gtk::TextTag::property_background_stipple_set

(

)

Whether this tag affects the background stipple.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:

A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

Glib::PropertyProxy_ReadOnly<TextDirection> Gtk::TextTag::property_direction

(

)

const

Text direction.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:

A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

Glib::PropertyProxy<TextDirection> Gtk::TextTag::property_direction

(

)

Text direction.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:

A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

Glib::PropertyProxy_ReadOnly<bool> Gtk::TextTag::property_editable

(

)

const

Whether the text can be modified by the user.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:

A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.