Back to Seed Clases

Atk

Classes

Interfaces

Structs

Unions

Enums

Interface Atk.Text

Import line:	Atk = imports.gi.Atk;
GIR File:	Atk-1.0.gir
C documentation:	AtkText
Interface :	Text
Implementations:	Atk.NoOpObject
	Show / Hide Inherited methods, properties and signals

Properties
None

Methods / Constructors
Method / Constructor		Defined By
	add_selection (Number *start_offset, Number end_offset) : Boolean Adds a selection bounded by the specified offsets. Adds a selection bounded by the specified offsets. Parameters: Number start_offset* Required (not null) Number end_offset Required (not null) Returns: Boolean	Atk.Text
	get_bounded_ranges (TextRectangle *rect, CoordType coord_type, TextClipType x_clip_type, TextClipType y_clip_type) : Atk.TextRange Get the ranges of text in the specified bounding box. Get the ranges of text in the specified bounding box. by this function will be NULL. Parameters: Atk.TextRectangle rect* Required (not null) Atk.CoordType coord_type Required (not null) Atk.TextClipType x_clip_type Required (not null) Atk.TextClipType y_clip_type Required (not null) Returns: Atk.TextRange	Atk.Text
	get_caret_offset () : Number Gets the offset position of the caret (cursor). Gets the offset position of the caret (cursor). Returns: Number	Atk.Text
	get_character_at_offset (Number *offset) : Number Gets the specified text. Gets the specified text. Parameters: Number offset* Required (not null) Returns: Number	Atk.Text
	get_character_count () : Number Gets the character count. Gets the character count. Returns: Number	Atk.Text
	get_character_extents (Number *offset, Number x, Number y, Number width, Number height, CoordType coords) : Object Get the bounding box containing the glyph representing the character at a particular text offset. Get the bounding box containing the glyph representing the character at a particular text offset. Parameters: Number offset* Required (not null) Number x Required (not null) Number y Required (not null) Number width Required (not null) Number height Required (not null) Atk.CoordType coords Required (not null) Returns: x: Number y: Number width: Number height: Number	Atk.Text
	get_default_attributes () : Array Returns: Array	Atk.Text
	get_n_selections () : Number Gets the number of selected regions. Gets the number of selected regions. occurred. Returns: Number	Atk.Text
	get_offset_at_point (Number x, Number y, CoordType *coords) : Number Gets the offset of the character located at coordinates x and y. Gets the offset of the character located at coordinates x and y. x and y are interpreted as being relative to the screen or this widget's window depending on coords. the specified x and y coordinates. Parameters: Number x Required (not null) Number y Required (not null) Atk.CoordType coords* Required (not null) widget window Returns: Number	Atk.Text
	get_range_extents (Number *start_offset, Number end_offset, CoordType coord_type, TextRectangle rect) : none Get the bounding box for text within the specified range. Get the bounding box for text within the specified range. Parameters: Number start_offset* Required (not null) information is required. Number end_offset Required (not null) for which boundary information is required. Atk.CoordType coord_type Required (not null) Atk.TextRectangle rect Required (not null) Returns: none	Atk.Text
	get_run_attributes (Number *offset, Object out_values) : Array Parameters: Number offset* Required (not null) Object out_values Number start_offset Number end_offset Returns: Array	Atk.Text
	get_selection (Number *selection_num, Object out_values) : String Gets the text from the specified selection. Gets the text from the specified selection. Parameters: Number selection_num* Required (not null) assigned numbers that correspond to how far the region is from the start of the text. The selected region closest to the beginning of the text region is assigned the number 0, etc. Note that adding, moving or deleting a selected region can change the numbering. Object out_values Number start_offset Number end_offset Returns: String	Atk.Text
	get_text (Number *start_offset, Number end_offset) : String Gets the specified text. Gets the specified text. Parameters: Number start_offset* Required (not null) Number end_offset Required (not null) Returns: String	Atk.Text
	get_text_after_offset (Number *offset, TextBoundary boundary_type, Object out_values) : String Gets the specified text. Gets the specified text. If the boundary_type if ATK_TEXT_BOUNDARY_CHAR the character after the offset is returned. If the boundary_type is ATK_TEXT_BOUNDARY_WORD_START the returned string is from the word start after the offset to the next word start. The returned string will contain the word after the offset if the offset is inside a word or if the offset is not inside a word. If the boundary_type is ATK_TEXT_BOUNDARY_WORD_END the returned string is from the word end at or after the offset to the next work end. The returned string will contain the word after the offset if the offset is inside a word and will contain the word after the word after the offset if the offset is not inside a word. If the boundary type is ATK_TEXT_BOUNDARY_SENTENCE_START the returned string is from the sentence start after the offset to the next sentence start. The returned string will contain the sentence after the offset if the offset is inside a sentence or if the offset is not inside a sentence. If the boundary_type is ATK_TEXT_BOUNDARY_SENTENCE_END the returned string is from the sentence end at or after the offset to the next sentence end. The returned string will contain the sentence after the offset if the offset is inside a sentence and will contain the sentence after the sentence after the offset if the offset is not inside a sentence. If the boundary type is ATK_TEXT_BOUNDARY_LINE_START the returned string is from the line start after the offset to the next line start. If the boundary_type is ATK_TEXT_BOUNDARY_LINE_END the returned string is from the line end at or after the offset to the next line start. Parameters: Number offset* Required (not null) Atk.TextBoundary boundary_type Required (not null) Object out_values Number start_offset Number end_offset Returns: String	Atk.Text
	get_text_at_offset (Number *offset, TextBoundary boundary_type, Object out_values) : String Gets the specified text. Gets the specified text. If the boundary_type if ATK_TEXT_BOUNDARY_CHAR the character at the offset is returned. If the boundary_type is ATK_TEXT_BOUNDARY_WORD_START the returned string is from the word start at or before the offset to the word start after the offset. The returned string will contain the word at the offset if the offset is inside a word and will contain the word before the offset if the offset is not inside a word. If the boundary_type is ATK_TEXT_BOUNDARY_WORD_END the returned string is from the word end before the offset to the word end at or after the offset. The returned string will contain the word at the offset if the offset is inside a word and will contain the word after to the offset if the offset is not inside a word. If the boundary type is ATK_TEXT_BOUNDARY_SENTENCE_START the returned string is from the sentence start at or before the offset to the sentence start after the offset. The returned string will contain the sentence at the offset if the offset is inside a sentence and will contain the sentence before the offset if the offset is not inside a sentence. If the boundary_type is ATK_TEXT_BOUNDARY_SENTENCE_END the returned string is from the sentence end before the offset to the sentence end at or after the offset. The returned string will contain the sentence at the offset if the offset is inside a sentence and will contain the sentence after the offset if the offset is not inside a sentence. If the boundary type is ATK_TEXT_BOUNDARY_LINE_START the returned string is from the line start at or before the offset to the line start after the offset. If the boundary_type is ATK_TEXT_BOUNDARY_LINE_END the returned string is from the line end before the offset to the line end at or after the offset. Parameters: Number offset* Required (not null) Atk.TextBoundary boundary_type Required (not null) Object out_values Number start_offset Number end_offset Returns: String	Atk.Text
	get_text_before_offset (Number *offset, TextBoundary boundary_type, Object out_values) : String Gets the specified text. Gets the specified text. If the boundary_type if ATK_TEXT_BOUNDARY_CHAR the character before the offset is returned. If the boundary_type is ATK_TEXT_BOUNDARY_WORD_START the returned string is from the word start before the word start before the offset to the word start before the offset. The returned string will contain the word before the offset if the offset is inside a word and will contain the word before the word before the offset if the offset is not inside a word. If the boundary_type is ATK_TEXT_BOUNDARY_WORD_END the returned string is from the word end before the word end at or before the offset to the word end at or before the offset. The returned string will contain the word before the offset if the offset is inside a word or if the offset is not inside a word. If the boundary type is ATK_TEXT_BOUNDARY_SENTENCE_START the returned string is from the sentence start before the sentence start before the offset to the sentence start before the offset. The returned string will contain the sentence before the offset if the offset is inside a sentence and will contain the sentence before the sentence before the offset if the offset is not inside a sentence. If the boundary_type is ATK_TEXT_BOUNDARY_SENTENCE_END the returned string is from the sentence end before the sentence end at or before the offset to the sentence end at or before the offset. The returned string will contain the sentence before the offset if the offset is inside a sentence or if the offset is not inside a sentence. If the boundary type is ATK_TEXT_BOUNDARY_LINE_START the returned string is from the line start before the line start ar or before the offset to the line start ar or before the offset. If the boundary_type is ATK_TEXT_BOUNDARY_LINE_END the returned string is from the line end before the line end before the offset to the line end before the offset. Parameters: Number offset* Required (not null) Atk.TextBoundary boundary_type Required (not null) Object out_values Number start_offset Number end_offset Returns: String	Atk.Text
	remove_selection (Number *selection_num) : Boolean Removes the specified selection. Removes the specified selection. Parameters: Number selection_num* Required (not null) assigned numbers that correspond to how far the region is from the start of the text. The selected region closest to the beginning of the text region is assigned the number 0, etc. Note that adding, moving or deleting a selected region can change the numbering. Returns: Boolean	Atk.Text
	set_caret_offset (Number *offset) : Boolean Sets the caret (cursor) position to the specified offset. Sets the caret (cursor) position to the specified offset. Parameters: Number offset* Required (not null) Returns: Boolean	Atk.Text
	set_selection (Number *selection_num, Number start_offset, Number end_offset) : Boolean Changes the start and end offset of the specified selection. Changes the start and end offset of the specified selection. Parameters: Number selection_num* Required (not null) assigned numbers that correspond to how far the region is from the start of the text. The selected region closest to the beginning of the text region is assigned the number 0, etc. Note that adding, moving or deleting a selected region can change the numbering. Number start_offset Required (not null) Number end_offset Required (not null) the selection Returns: Boolean	Atk.Text

Events - usage syntax: this.signals.EVENTNAME.connect( Function )
Event		Defined By
	text_attributes_changed (Text *self) : none Parameters: Atk.Text self* Returns: {none}	Atk.Text
	text_caret_moved (Text *self, Number object) : none Parameters: Atk.Text self* Number object Returns: {none}	Atk.Text
	text_changed (Text *self, Number object, Number p0) : none Parameters: Atk.Text self* Number object Number p0 Returns: {none}	Atk.Text
	text_selection_changed (Text *self) : none Parameters: Atk.Text self* Returns: {none}	Atk.Text

Documentation generated by Introspection Doc Generator Loosely Based on JsDoc Toolkit on Tue Jun 22 2010 16:32:30 GMT+0800 (HKT)