gtk.TextIter
Prev | Chapter 2. Gtk API for Lua scripts | Next

## gtk.TextIter

### get_buffer()

    text_iter.get_buffer()

`Returns:` `gtk.TextBuffer`

### copy()

    text_iter.copy()

`Returns:` `gtk.TextIter`

### get_offset()

    text_iter.get_offset()

`Returns:` `integer index (1-based)`

### get_line()

    text_iter.get_line()

`Returns:` `integer index (1-based)`

### get_line_offset()

    text_iter.get_line_offset()

`Returns:` `integer index (1-based)`

### get_line_index()

    text_iter.get_line_index()

`Returns:` `integer index (1-based)`

### get_char()

    text_iter.get_char()

`Returns:` `string`

### get_text()

    text_iter.get_text(end)

`end` : | `gtk.TextIter`

`Returns:` `string`

### starts_line()

    text_iter.starts_line()

`Returns:` `bool`

### ends_line()

    text_iter.ends_line()

`Returns:` `bool`

### is_cursor_position()

    text_iter.is_cursor_position()

`Returns:` `bool`

### get_chars_in_line()

    text_iter.get_chars_in_line()

`Returns:` `integer`

### get_bytes_in_line()

    text_iter.get_bytes_in_line()

`Returns:` `integer`

### is_end()

    text_iter.is_end()

`Returns:` `bool`

### is_start()

    text_iter.is_start()

`Returns:` `bool`

### forward_char()

    text_iter.forward_char()

`Returns:` `bool`

### backward_char()

    text_iter.backward_char()

`Returns:` `bool`

### forward_chars()

    text_iter.forward_chars(count)

`count` : | `integer`

`Returns:` `bool`

### backward_chars()

    text_iter.backward_chars(count)

`count` : | `integer`

`Returns:` `bool`

### forward_line()

    text_iter.forward_line()

`Returns:` `bool`

### backward_line()

    text_iter.backward_line()

`Returns:` `bool`

### forward_lines()

    text_iter.forward_lines(count)

`count` : | `integer`

`Returns:` `bool`

### backward_lines()

    text_iter.backward_lines(count)

`count` : | `integer`

`Returns:` `bool`

### forward_cursor_position()

    text_iter.forward_cursor_position()

`Returns:` `bool`

### backward_cursor_position()

    text_iter.backward_cursor_position()

`Returns:` `bool`

### forward_cursor_positions()

    text_iter.forward_cursor_positions(count)

`count` : | `integer`

`Returns:` `bool`

### backward_cursor_positions()

    text_iter.backward_cursor_positions(count)

`count` : | `integer`

`Returns:` `bool`

### set_offset()

    text_iter.set_offset(char_offset)

`char_offset` : | `integer index (1-based)`

### set_line()

    text_iter.set_line(line_number)

`line_number` : | `integer index (1-based)`

### set_line_offset()

    text_iter.set_line_offset(char_on_line)

`char_on_line` : | `integer index (1-based)`

### set_line_index()

    text_iter.set_line_index(byte_on_line)

`byte_on_line` : | `integer index (1-based)`

### forward_to_end()

    text_iter.forward_to_end()

### forward_to_line_end()

    text_iter.forward_to_line_end()

`Returns:` `bool`

### equal()

    text_iter.equal(rhs)

`rhs` : | `gtk.TextIter`

`Returns:` `bool`

### compare()

    text_iter.compare(rhs)

`rhs` : | `gtk.TextIter`

`Returns:` `integer`

### in_range()

    text_iter.in_range(start, end)

`start` : | `gtk.TextIter`
`end` : | `gtk.TextIter`

`Returns:` `bool`

### order()

    text_iter.order(second)

`second` : | `gtk.TextIter`

Prev | Up | Next
gtk.TextBuffer | Home | gtk.TextView