Back to Seed Clases

Gtk

Classes

Interfaces

Structs

Unions

DitherInfo

Enums

GObject.Object
parent-child marker Gtk.TextLayout

Class Gtk.TextLayout

Import line:	Gtk = imports.gi.Gtk;
GIR File:	Gtk-2.0.gir
C documentation:	GtkTextLayout
Class :	TextLayout
Extends:	GObject.Object
	Show / Hide Inherited methods, properties and signals

Properties
Properties		Defined By
	buffer : Gtk.TextBuffer read only	Gtk.TextLayout
	cursor_direction : Number read only	Gtk.TextLayout
	cursor_visible : Number read only	Gtk.TextLayout
	default_style : Gtk.TextAttributes read only	Gtk.TextLayout
	height : Number read only	Gtk.TextLayout
	keyboard_direction : Number read only	Gtk.TextLayout
	ltr_context : Pango.Context read only	Gtk.TextLayout
	one_display_cache : Gtk.TextLineDisplay read only	Gtk.TextLayout
	one_style_cache : Gtk.TextAttributes read only	Gtk.TextLayout
	overwrite_mode : Number read only	Gtk.TextLayout
	parent_instance : GObject.Object read only	Gtk.TextLayout
	preedit_attrs : Pango.AttrList read only	Gtk.TextLayout
	preedit_cursor : Number read only	Gtk.TextLayout
	preedit_len : Number read only	Gtk.TextLayout
	preedit_string : String read only	Gtk.TextLayout
	rtl_context : Pango.Context read only	Gtk.TextLayout
	screen_width : Number read only	Gtk.TextLayout
	width : Number read only	Gtk.TextLayout
	wrap_loop_count : Number read only	Gtk.TextLayout

Methods / Constructors
Method / Constructor		Defined By
	new Gtk.TextLayout (Object *properties) Create a new Gtk.TextLayout Create a new Gtk.TextLayout Parameters: Object properties*
	changed (Number y, Number *old_height, Number new_height) : none Parameters: Number y Required (not null) Number old_height* Required (not null) Number new_height Required (not null) Returns: none	Gtk.TextLayout
	clamp_iter_to_vrange (TextIter *iter, Number top, Number bottom) : Boolean If the iterator is not fully in the range top* <= y < bottom, then, if possible, move it the minimum distance so that the iterator in this range. If the iterator is not fully in the range top <= y < bottom, then, if possible, move it the minimum distance so that the iterator in this range. Parameters: Gtk.TextIter iter Required (not null) Number top Required (not null) Number bottom Required (not null) Returns: Boolean	Gtk.TextLayout
	cursors_changed (Number y, Number *old_height, Number new_height) : none Parameters: Number y Required (not null) Number old_height* Required (not null) Number new_height Required (not null) Returns: none	Gtk.TextLayout
	default_style_changed () : none Returns: none	Gtk.TextLayout
	free_line_data (TextLine *line, TextLineData line_data) : none Parameters: Gtk.TextLine line* Required (not null) Gtk.TextLineData line_data Required (not null) Returns: none	Gtk.TextLayout
	free_line_display (TextLineDisplay *display) : none Parameters: Gtk.TextLineDisplay display* Required (not null) Returns: none	Gtk.TextLayout
	get_buffer () : Gtk.TextBuffer Gets the text buffer used by the layout. Gets the text buffer used by the layout. See gtk_text_layout_set_buffer(). Returns: Gtk.TextBuffer	Gtk.TextLayout
	get_cursor_locations (TextIter *iter, Rectangle strong_pos, Rectangle weak_pos) : none Given an iterator within a text layout, determine the positions of the strong and weak cursors if the insertion point is at that iterator. Given an iterator within a text layout, determine the positions of the strong and weak cursors if the insertion point is at that iterator. The position of each cursor is stored as a zero-width rectangle. The strong cursor location is the location where characters of the directionality equal to the base direction of the paragraph are inserted. The weak cursor location is the location where characters of the directionality opposite to the base direction of the paragraph are inserted. Parameters: Gtk.TextIter iter* Required (not null) Gdk.Rectangle strong_pos Gdk.Rectangle weak_pos Returns: none	Gtk.TextLayout
	get_cursor_visible () : Boolean Returns whether the insertion cursor will be shown. Returns whether the insertion cursor will be shown. shown, even if the text is editable. Returns: Boolean	Gtk.TextLayout
	get_iter_at_line (TextIter *iter, TextLine line, Number byte_offset) : none Parameters: Gtk.TextIter iter* Required (not null) Gtk.TextLine line Required (not null) Number byte_offset Required (not null) Returns: none	Gtk.TextLayout
	get_iter_at_pixel (TextIter *iter, Number x, Number y) : none Parameters: Gtk.TextIter iter* Required (not null) Number x Required (not null) Number y Required (not null) Returns: none	Gtk.TextLayout
	get_iter_at_position (TextIter *iter, Number trailing, Number x, Number y) : Number Parameters: Gtk.TextIter iter* Required (not null) Number trailing Required (not null) Number x Required (not null) Number y Required (not null) Returns: Number	Gtk.TextLayout
	get_iter_location (TextIter *iter, Rectangle rect) : none Parameters: Gtk.TextIter iter* Required (not null) Gdk.Rectangle rect Required (not null) Returns: none	Gtk.TextLayout
	get_line_at_y (TextIter *target_iter, Number y) : Number Get the iter at the beginning of the line which is displayed at the given y. Get the iter at the beginning of the line which is displayed at the given y. Parameters: Gtk.TextIter target_iter* Required (not null) Number y Required (not null) Returns: Number	Gtk.TextLayout
	get_line_display (TextLine *line, Boolean size_only) : Gtk.TextLineDisplay Parameters: Gtk.TextLine line* Required (not null) Boolean size_only Required (not null) Returns: Gtk.TextLineDisplay	Gtk.TextLayout
	get_line_yrange (TextIter *iter) : Object Find the range of y coordinates for the paragraph containing the given iter. Find the range of y coordinates for the paragraph containing the given iter. Parameters: Gtk.TextIter iter* Required (not null) Returns: y: Number height: Number	Gtk.TextLayout
	get_lines (Number *top_y, Number bottom_y, Object out_values) : Array Parameters: Number top_y* Required (not null) Number bottom_y Required (not null) Object out_values Number first_line_y Returns: Array	Gtk.TextLayout
	get_size () : Object Returns: width: Number height: Number	Gtk.TextLayout
	invalidate (TextIter *start, TextIter end) : none Parameters: Gtk.TextIter start* Required (not null) Gtk.TextIter end Required (not null) Returns: none	Gtk.TextLayout
	invalidate_cursors (TextIter *start, TextIter end) : none Parameters: Gtk.TextIter start* Required (not null) Gtk.TextIter end Required (not null) Returns: none	Gtk.TextLayout
	is_valid () : Boolean Check if there are any invalid regions in a GtkTextLayout's buffer Check if there are any invalid regions in a GtkTextLayout's buffer Returns: Boolean	Gtk.TextLayout
	iter_starts_line (TextIter *iter) : Boolean Tests whether an iterator is at the start of a display line. Tests whether an iterator is at the start of a display line. Parameters: Gtk.TextIter iter* Required (not null) Returns: Boolean	Gtk.TextLayout
	move_iter_to_line_end (TextIter *iter, Number direction) : Boolean Move to the beginning or end of a display line. Move to the beginning or end of a display line. Parameters: Gtk.TextIter iter* Required (not null) Number direction Required (not null) ve to end of line. Returns: Boolean	Gtk.TextLayout
	move_iter_to_next_line (TextIter *iter) : Boolean Move the iterator to the beginning of the next line. Move the iterator to the beginning of the next line. The lines of a wrapped paragraph are treated as distinct for this operation. Parameters: Gtk.TextIter iter* Required (not null) Returns: Boolean	Gtk.TextLayout
	move_iter_to_previous_line (TextIter *iter) : Boolean Move the iterator to the beginning of the previous line. Move the iterator to the beginning of the previous line. The lines of a wrapped paragraph are treated as distinct for this operation. Parameters: Gtk.TextIter iter* Required (not null) Returns: Boolean	Gtk.TextLayout
	move_iter_to_x (TextIter *iter, Number x) : none Keeping the iterator on the same line of the layout, move it to the specified X coordinate. Keeping the iterator on the same line of the layout, move it to the specified X coordinate. The lines of a wrapped paragraph are treated as distinct for this operation. Parameters: Gtk.TextIter iter* Required (not null) Number x Required (not null) Returns: none	Gtk.TextLayout
	move_iter_visually (TextIter *iter, Number count) : Boolean Move the iterator a given number of characters visually, treating it as the strong cursor position. Move the iterator a given number of characters visually, treating it as the strong cursor position. If count* is positive, then the new strong cursor position will be count positions to the right of the old cursor position. If count is negative then the new strong cursor position will be count positions to the left of the old cursor position. In the presence of bidirection text, the correspondence between logical and visual order will depend on the direction of the current run, and there may be jumps when the cursor is moved off of the end of a run. Parameters: Gtk.TextIter iter Required (not null) Number count Required (not null) Returns: Boolean	Gtk.TextLayout
	set_buffer (TextBuffer *buffer) : none Parameters: Gtk.TextBuffer buffer* Returns: none	Gtk.TextLayout
	set_contexts (Context *ltr_context, Context rtl_context) : none Parameters: Pango.Context ltr_context* Required (not null) Pango.Context rtl_context Required (not null) Returns: none	Gtk.TextLayout
	set_cursor_direction (TextDirection *direction) : none Sets which text directions (left-to-right and/or right-to-left) for which cursors will be drawn for the insertion point. Sets which text directions (left-to-right and/or right-to-left) for which cursors will be drawn for the insertion point. The visual point at which new text is inserted depends on whether the new text is right-to-left or left-to-right, so it may be desired to make the drawn position of the cursor depend on the keyboard state. Parameters: Gtk.TextDirection direction* Required (not null) for which to draw cursors. GTK_TEXT_DIR_NONE means draw cursors for both left-to-right insertion and right-to-left insertion. (The two cursors will be visually distinguished.) Returns: none	Gtk.TextLayout
	set_cursor_visible (Boolean *cursor_visible) : none Sets whether the insertion cursor should be shown. Sets whether the insertion cursor should be shown. Generally, widgets using GtkTextLayout* will hide the cursor when the widget does not have the input focus. Parameters: Boolean cursor_visible Required (not null) be shown, even if the text is editable. Returns: none	Gtk.TextLayout
	set_default_style (TextAttributes *values) : none Parameters: Gtk.TextAttributes values* Required (not null) Returns: none	Gtk.TextLayout
	set_keyboard_direction (TextDirection *keyboard_dir) : none Sets the keyboard direction; this is used as for the bidirectional base direction for the line with the cursor if the line contains only neutral characters. Sets the keyboard direction; this is used as for the bidirectional base direction for the line with the cursor if the line contains only neutral characters. Parameters: Gtk.TextDirection keyboard_dir* Required (not null) Returns: none	Gtk.TextLayout
	set_overwrite_mode (Boolean *overwrite) : none Sets overwrite mode Sets overwrite mode Parameters: Boolean overwrite* Required (not null) Returns: none	Gtk.TextLayout
	set_preedit_string (String *preedit_string, AttrList preedit_attrs, Number cursor_pos) : none Set the preedit string and attributes. Set the preedit string and attributes. The preedit string is a string showing text that is currently being edited and not yet committed into the buffer. Parameters: String preedit_string* Required (not null) Pango.AttrList preedit_attrs Required (not null) Number cursor_pos Required (not null) Returns: none	Gtk.TextLayout
	set_screen_width (Number *width) : none Parameters: Number width* Required (not null) Returns: none	Gtk.TextLayout
	spew () : none Returns: none	Gtk.TextLayout
	validate (Number *max_pixels) : none Validate regions of a GtkTextLayout. Validate regions of a GtkTextLayout. The ::changed signal will be emitted for each region validated. Parameters: Number max_pixels* Required (not null) than one paragraph beyond this limit will be validated) Returns: none	Gtk.TextLayout
	validate_yrange (TextIter *anchor_line, Number y0_, Number y1_) : none Ensure that a region of a GtkTextLayout* is valid. Ensure that a region of a GtkTextLayout is valid. The ::changed signal will be emitted if any lines are validated. Parameters: Gtk.TextIter anchor_line Required (not null) Number y0_ Required (not null) which to begin validation. (The offset here is in pixels after validation.) Number y1_ Required (not null) which to end validation. (The offset here is in pixels after validation.) Returns: none	Gtk.TextLayout
	wrap (TextLine *line, TextLineData line_data) : Gtk.TextLineData Parameters: Gtk.TextLine line* Required (not null) Gtk.TextLineData line_data Required (not null) Returns: Gtk.TextLineData	Gtk.TextLayout
	wrap_loop_end () : none Returns: none	Gtk.TextLayout
	wrap_loop_start () : none Returns: none	Gtk.TextLayout

Events - usage syntax: this.signals.EVENTNAME.connect( Function )
Event		Defined By
	allocate_child (TextLayout *self, Object object, Number p0, Number p1) : none Parameters: Gtk.TextLayout self* Gtk.Object object Number p0 Number p1 Returns: {none}	Gtk.TextLayout
	changed (TextLayout *self, Number object, Number p0, Number p1) : none Parameters: Gtk.TextLayout self* Number object Number p0 Number p1 Returns: {none}	Gtk.TextLayout
	invalidated (TextLayout *self) : none Parameters: Gtk.TextLayout self* Returns: {none}	Gtk.TextLayout

Used by These Methods / Signals / Properties
Class / Namespace	Method / Signal / Properties
Gtk Method	Gtk.text_anchored_child_set_layout (Widget *child, TextLayout layout*) : none
Gtk.TextChildAnchor Method	register_child (Widget *child, TextLayout layout*) : none
Gtk.TextChildAnchor Method	queue_resize (TextLayout *layout*) : none

Un-official Seed Documentation

Gtk

Classes

Interfaces

Structs

Unions

Enums

Class Gtk.TextLayout