| Gtk2Hs | Contents | Index

Graphics.UI.Gtk.Multiline.TextIter

Portability | portable (depends on GHC)
Stability | provisional
Maintainer | gtk2hs-users@lists.sourceforge.net

Contents

Types
Methods
Attributes

Description
An iterator is an abstract datatype representing a pointer into a `TextBuffer`.
Synopsis

data TextIter

data TextSearchFlags

= TextSearchVisibleOnly
| TextSearchTextOnly

textIterCopy :: TextIter -> IO TextIter
textIterGetBuffer :: TextIter -> IO TextBuffer
textIterGetOffset :: TextIter -> IO Int
textIterGetLine :: TextIter -> IO Int
textIterGetLineOffset :: TextIter -> IO Int
textIterGetVisibleLineOffset :: TextIter -> IO Int
textIterGetChar :: TextIter -> IO (Maybe Char)
textIterGetSlice :: TextIter -> TextIter -> IO String
textIterGetText :: TextIter -> TextIter -> IO String
textIterGetVisibleSlice :: TextIter -> TextIter -> IO String
textIterGetVisibleText :: TextIter -> TextIter -> IO String
textIterGetPixbuf :: TextIter -> IO (Maybe Pixbuf)
textIterGetMarks :: TextIter -> IO [TextMark]
textIterGetToggledTags :: TextIter -> Bool -> IO [TextTag]
textIterBeginsTag :: TextIter -> Maybe TextTag -> IO Bool
textIterEndsTag :: TextIter -> Maybe TextTag -> IO Bool
textIterTogglesTag :: TextIter -> Maybe TextTag -> IO Bool
textIterHasTag :: TextIter -> Maybe TextTag -> IO Bool
textIterGetTags :: TextIter -> IO [TextTag]
textIterEditable :: TextIter -> Bool -> IO Bool
textIterCanInsert :: TextIter -> Bool -> IO Bool
textIterStartsWord :: TextIter -> IO Bool
textIterEndsWord :: TextIter -> IO Bool
textIterInsideWord :: TextIter -> IO Bool
textIterStartsLine :: TextIter -> IO Bool
textIterEndsLine :: TextIter -> IO Bool
textIterStartsSentence :: TextIter -> IO Bool
textIterEndsSentence :: TextIter -> IO Bool
textIterInsideSentence :: TextIter -> IO Bool
textIterIsCursorPosition :: TextIter -> IO Bool
textIterGetCharsInLine :: TextIter -> IO Int
textIterIsEnd :: TextIter -> IO Bool
textIterIsStart :: TextIter -> IO Bool
textIterForwardChar :: TextIter -> IO Bool
textIterBackwardChar :: TextIter -> IO Bool
textIterForwardChars :: TextIter -> Int -> IO Bool
textIterBackwardChars :: TextIter -> Int -> IO Bool
textIterForwardLine :: TextIter -> IO Bool
textIterBackwardLine :: TextIter -> IO Bool
textIterForwardLines :: TextIter -> Int -> IO Bool
textIterBackwardLines :: TextIter -> Int -> IO Bool
textIterForwardWordEnds :: TextIter -> Int -> IO Bool
textIterBackwardWordStarts :: TextIter -> Int -> IO Bool
textIterForwardWordEnd :: TextIter -> IO Bool
textIterBackwardWordStart :: TextIter -> IO Bool
textIterForwardCursorPosition :: TextIter -> IO Bool
textIterBackwardCursorPosition :: TextIter -> IO Bool
textIterForwardCursorPositions :: TextIter -> Int -> IO Bool
textIterBackwardCursorPositions :: TextIter -> Int -> IO Bool
textIterForwardSentenceEnds :: TextIter -> Int -> IO Bool
textIterBackwardSentenceStarts :: TextIter -> Int -> IO Bool
textIterForwardSentenceEnd :: TextIter -> IO Bool
textIterBackwardSentenceStart :: TextIter -> IO Bool
textIterSetOffset :: TextIter -> Int -> IO ()
textIterSetLine :: TextIter -> Int -> IO ()
textIterSetLineOffset :: TextIter -> Int -> IO ()
textIterSetVisibleLineOffset :: TextIter -> Int -> IO ()
textIterForwardToEnd :: TextIter -> IO ()
textIterForwardToLineEnd :: TextIter -> IO Bool
textIterForwardToTagToggle :: TextIter -> Maybe TextTag -> IO Bool
textIterBackwardToTagToggle :: TextIter -> Maybe TextTag -> IO Bool
textIterForwardFindChar :: TextIter -> (Char -> Bool) -> Maybe TextIter -> IO Bool
textIterBackwardFindChar :: TextIter -> (Char -> Bool) -> Maybe TextIter -> IO Bool
textIterForwardSearch :: TextIter -> String -> [TextSearchFlags] -> Maybe TextIter -> IO (Maybe (TextIter, TextIter))
textIterBackwardSearch :: TextIter -> String -> [TextSearchFlags] -> Maybe TextIter -> IO (Maybe (TextIter, TextIter))
textIterEqual :: TextIter -> TextIter -> IO Bool
textIterCompare :: TextIter -> TextIter -> IO Ordering
textIterForwardVisibleLine :: TextIter -> IO Bool
textIterBackwardVisibleLine :: TextIter -> IO Bool
textIterForwardVisibleLines :: TextIter -> Int -> IO Bool
textIterBackwardVisibleLines :: TextIter -> Int -> IO Bool
textIterVisibleLineOffset :: Attr TextIter Int
textIterOffset :: Attr TextIter Int
textIterLineOffset :: Attr TextIter Int
textIterLine :: Attr TextIter Int

Types
data TextIter
data TextSearchFlags

Specify the way the search function for Graphics.UI.Gtk.Multiline.TextBuffer works.
Constructors

TextSearchVisibleOnly |
TextSearchTextOnly |

Instances

Bounded TextSearchFlags
Enum TextSearchFlags
Eq TextSearchFlags
Show TextSearchFlags
Flags TextSearchFlags

Methods
textIterCopy :: TextIter -> IO TextIter
Copy the iterator.
textIterGetBuffer :: TextIter -> IO TextBuffer
Return the `TextBuffer` this iterator is associated with.
textIterGetOffset :: TextIter -> IO Int
Returns the character offset of an iterator. Each character in a `TextBuffer` has an offset, starting with 0 for the first character in the buffer. Use Graphics.UI.Gtk.Multiline.TextBuffer.textBufferGetIterAtOffset to convert an offset back into an iterator.
textIterGetLine :: TextIter -> IO Int
Returns the line number containing the iterator. Lines in a `TextBuffer` are numbered beginning with 0 for the first line in the buffer.
textIterGetLineOffset :: TextIter -> IO Int
Returns the character offset of the iterator, counting from the start of a newline-terminated line. The first character on the line has offset 0.
textIterGetVisibleLineOffset :: TextIter -> IO Int
Returns the offset in characters from the start of the line to the given `iter`, not counting characters that are invisible due to tags with the "invisible" flag toggled on.
textIterGetChar :: TextIter -> IO (Maybe Char)
Returns the Unicode character at this iterator. If the element at this iterator is a non-character element, such as an image embedded in the buffer, the Unicode "unknown" character 0xFFFC is returned. If invoked on the end iterator, `Nothigng` is returned.
textIterGetSlice :: TextIter -> TextIter -> IO String

Returns the text in the given range. A "slice" is a list of characters, including the Unicode "unknown" character 0xFFFC for iterable non-character elements in the buffer, such as images. Because images are encoded in the slice, offsets in the returned array will correspond to offsets in the text buffer. Note that 0xFFFC can occur in normal text as well, so it is not a reliable indicator that a pixbuf or widget is in the buffer.

textIterGetText :: TextIter -> TextIter -> IO String

Return the text in a given range.

- Pictures (and other objects) are stripped form the output. Thus, this function does not preserve offsets.

textIterGetVisibleSlice :: TextIter -> TextIter -> IO String
Like `textIterGetSlice`, but invisible text is not included. Invisible text is usually invisible because a `TextTag` with the "invisible" attribute turned on has been applied to it.
textIterGetVisibleText :: TextIter -> TextIter -> IO String
Like `textIterGetText`, but invisible text is not included. Invisible text is usually invisible because a `TextTag` with the "invisible" attribute turned on has been applied to it.
textIterGetPixbuf :: TextIter -> IO (Maybe Pixbuf)
Get the `Pixbuf` under the iterator.
textIterGetMarks

:: TextIter |
-> IO [TextMark] | returns list of `TextMark`
Returns a list of all `TextMark` at this location. Because marks are not iterable (they don't take up any "space" in the buffer, they are just marks in between iterable locations), multiple marks can exist in the same place. The returned list is not in any meaningful order.

textIterGetToggledTags

:: TextIter |
-> Bool | `toggledOn` - `True` to get toggled-on tags
-> IO [TextTag] | returns tags toggled at this point
Returns a list of `TextTag` that are toggled on or off at this point. (If `toggledOn` is `True`, the list contains tags that are toggled on.) If a tag is toggled on at `iter`, then some non-empty range of characters following `iter` has that tag applied to it. If a tag is toggled off, then some non-empty range following `iter` does not have the tag applied to it.

textIterBeginsTag :: TextIter -> Maybe TextTag -> IO Bool
Returns `True` if `tag` is toggled on at exactly this point. If `tag` is `Nothing`, returns `True` if any tag is toggled on at this point. Note that the `textIterBeginsTag` returns `True` if `iter` is the start of the tagged range; `textIterHasTag` tells you whether an iterator is within a tagged range.
textIterEndsTag :: TextIter -> Maybe TextTag -> IO Bool
Returns `True` if `tag` is toggled off at exactly this point. If `tag` is `Notihng`, returns `True` if any tag is toggled off at this point. Note that the `textIterEndsTag` returns `True` if `iter` is the end of the tagged range; `textIterHasTag` tells you whether an iterator is within a tagged range.
textIterTogglesTag :: TextIter -> Maybe TextTag -> IO Bool
Query if the `TextIter` is at the beginning or the end of a `TextTag`. This is equivalent to (`textIterBeginsTag` || `textIterEndsTag`), i.e. it tells you whether a range with `tag` applied to it begins or ends at `iter`.
textIterHasTag :: TextIter -> Maybe TextTag -> IO Bool
Check if `TextIter` is within a range tagged with tag.
textIterGetTags

:: TextIter |
-> IO [TextTag] | returns list of `TextTag`
Returns a list of tags that apply to `iter`, in ascending order of priority (highest-priority tags are last).

textIterEditable :: TextIter -> Bool -> IO Bool

Returns whether the character at `iter` is within an editable region of text. Non-editable text is "locked" and can't be changed by the user via `TextView`. This function is simply a convenience wrapper around `textIterGetAttributes`. If no tags applied to this text affect editability, `defaultSetting` will be returned.

You don't want to use this function to decide whether text can be inserted at `iter`, because for insertion you don't want to know whether the char at `iter` is inside an editable range, you want to know whether a new character inserted at `iter` would be inside an editable range. Use `textIterCanInsert` to handle this case.

textIterCanInsert :: TextIter -> Bool -> IO Bool

Check if new text can be inserted at `TextIter`.

- Considering the default editability of the buffer, and tags that affect editability, determines whether text inserted at `iter` would be editable. If text inserted at `iter` would be editable then the user should be allowed to insert text at `iter`. Graphics.UI.Gtk.Multiline.TextBuffer.textBufferInsertInteractive uses this function to decide whether insertions are allowed at a given position.
- Use Graphics.UI.Gtk.Multiline.TextBuffer.textBufferInsertInteractive if you want to insert text depending on the current editable status.

textIterStartsWord :: TextIter -> IO Bool
Determine if `TextIter` begins a new natural-language word.
textIterEndsWord :: TextIter -> IO Bool
Determine if `TextIter` ends a new natural-language word.
textIterInsideWord :: TextIter -> IO Bool
Determine if `TextIter` is inside a word.
textIterStartsLine :: TextIter -> IO Bool
Determine if `TextIter` begins a new line.
textIterEndsLine :: TextIter -> IO Bool

Returns `True` if `iter` points to the start of the paragraph delimiter characters for a line (delimiters will be either a newline, a carriage return, a carriage return followed by a newline, or a Unicode paragraph separator character). Note that an iterator pointing to the n of a rn pair will not be counted as the end of a line, the line ends before the r. The end iterator is considered to be at the end of a line, even though there are no paragraph delimiter chars there.

textIterStartsSentence :: TextIter -> IO Bool
Determine if `TextIter` starts a sentence.
textIterEndsSentence :: TextIter -> IO Bool
Determine if `TextIter` ends a sentence.
textIterInsideSentence :: TextIter -> IO Bool
Determine if `TextIter` is inside a sentence.
textIterIsCursorPosition :: TextIter -> IO Bool
Determine if `TextIter` is at a cursor position.
textIterGetCharsInLine :: TextIter -> IO Int

Return number of characters in this line.

- The return value includes delimiters.

textIterIsEnd :: TextIter -> IO Bool

Get the text attributes at the iterator.

- The `ta` argument gives the default values if no specific attributes are set at that specific location.
- The function returns `Nothing` if the text at the iterator has the same attributes.

Determine if `TextIter` is at the end of the buffer.

textIterIsStart :: TextIter -> IO Bool
Determine if `TextIter` is at the beginning of the buffer.
textIterForwardChar :: TextIter -> IO Bool

Move `TextIter` forwards.

- Retuns True if the iterator is pointing to a character.

textIterBackwardChar :: TextIter -> IO Bool

Move `TextIter` backwards.

- Retuns True if the movement was possible.

textIterForwardChars :: TextIter -> Int -> IO Bool

Move `TextIter` forwards by `n` characters.

- Retuns `True` if the iterator is pointing to a new character (and `False` if the iterator points to a picture or has not moved).
- Note that images embedded in the buffer occupy 1 character slot, so `textIterForwardChar` may actually move onto an image instead of a character.

textIterBackwardChars :: TextIter -> Int -> IO Bool

Move `TextIter` backwards by `n` characters.

- Retuns `True` if the iterator is pointing to a new character (and `False` if the iterator points to a picture or has not moved).

textIterForwardLine :: TextIter -> IO Bool

Move `TextIter` forwards.

- Retuns True if the iterator is pointing to a new line (and False if the iterator points to a picture or has not moved).
- If `TextIter` is on the first line, it will be moved to the beginning of the buffer.

textIterBackwardLine :: TextIter -> IO Bool

Move `TextIter` backwards.

- Retuns True if the iterator is pointing to a new line (and False if the iterator points to a picture or has not moved).
- If `TextIter` is on the first line, it will be moved to the end of the buffer.

textIterForwardLines :: TextIter -> Int -> IO Bool

Move `TextIter` forwards by `n` lines.

- Retuns True if the iterator is pointing to a new line (and False if the iterator points to a picture or has not moved).
- If `TextIter` is on the first line, it will be moved to the beginning of the buffer.
- `n` can be negative.

textIterBackwardLines :: TextIter -> Int -> IO Bool

Move `TextIter` backwards by `n` lines.

- Retuns True if the iterator is pointing to a new line (and False if the iterator points to a picture or has not moved).
- If `TextIter` is on the first line, it will be moved to the end of the buffer.
- `n` can be negative.

textIterForwardWordEnds :: TextIter -> Int -> IO Bool

Move `TextIter` forwards by `n` word ends.

- Retuns True if the iterator is pointing to a new word end.

textIterBackwardWordStarts :: TextIter -> Int -> IO Bool

Move `TextIter` backwards by `n` word beginnings.

- Retuns True if the iterator is pointing to a new word start.

textIterForwardWordEnd :: TextIter -> IO Bool

Move `TextIter` forwards to the next word end.

- Retuns True if the iterator has moved to a new word end.

textIterBackwardWordStart :: TextIter -> IO Bool

Move `TextIter` backwards to the next word beginning.

- Retuns True if the iterator has moved to a new word beginning.

textIterForwardCursorPosition :: TextIter -> IO Bool

Move `TextIter` forwards to the next cursor position.

- Some characters are composed of two Unicode codes. This function ensures that `TextIter` does not point inbetween such double characters.
- Returns True if `TextIter` moved and points to a character (not to an object).

textIterBackwardCursorPosition :: TextIter -> IO Bool

Move `TextIter` backwards to the next cursor position.

- Some characters are composed of two Unicode codes. This function ensures that `TextIter` does not point inbetween such double characters.
- Returns True if `TextIter` moved and points to a character (not to an object).

textIterForwardCursorPositions :: TextIter -> Int -> IO Bool

Move `TextIter` forwards by `n` cursor positions.

- Returns True if `TextIter` moved and points to a character (not to an object).

textIterBackwardCursorPositions :: TextIter -> Int -> IO Bool

Move `TextIter` backwards by `n` cursor positions.

- Returns True if `TextIter` moved and points to a character (not to an object).

textIterForwardSentenceEnds :: TextIter -> Int -> IO Bool

Move `TextIter` forwards by `n` sentence ends.

- Retuns True if the iterator is pointing to a new sentence end.

textIterBackwardSentenceStarts :: TextIter -> Int -> IO Bool

Move `TextIter` backwards by `n` sentence beginnings.

- Retuns True if the iterator is pointing to a new sentence start.

textIterForwardSentenceEnd :: TextIter -> IO Bool

Move `TextIter` forwards to the next sentence end.

- Retuns True if the iterator has moved to a new sentence end.

textIterBackwardSentenceStart :: TextIter -> IO Bool

Move `TextIter` backwards to the next sentence beginning.

- Retuns True if the iterator has moved to a new sentence beginning.

textIterSetOffset :: TextIter -> Int -> IO ()
Set `TextIter` to an offset within the buffer.
textIterSetLine :: TextIter -> Int -> IO ()

Set `TextIter` to a line within the buffer.

- If number is negative or larger than the number of lines in the buffer, moves `iter` to the start of the last line in the buffer.

textIterSetLineOffset :: TextIter -> Int -> IO ()

Set `TextIter` to an offset within the line.

- The given character offset must be less than or equal to the number of characters in the line; if equal, the iterator moves to the start of the next line.

textIterSetVisibleLineOffset :: TextIter -> Int -> IO ()
Like `textIterSetLineOffset`, but the offset is in visible characters, i.e. text with a tag making it invisible is not counted in the offset.
textIterForwardToEnd :: TextIter -> IO ()
Moves `iter` forward to the "end iterator," which points one past the last valid character in the buffer.
textIterForwardToLineEnd :: TextIter -> IO Bool

Moves the iterator to point to the paragraph delimiter characters, which will be either a newline, a carriage return, a carriage return/newline in sequence, or the Unicode paragraph separator character. If the iterator is already at the paragraph delimiter characters, moves to the paragraph delimiter characters for the next line. If `iter` is on the last line in the buffer, which does not end in paragraph delimiters, moves to the end iterator (end of the last line), and returns `False`.

textIterForwardToTagToggle :: TextIter -> Maybe TextTag -> IO Bool

Moves `TextIter` forward to the next change of a `TextTag`.

- If Nothing is supplied, any `TextTag` will be matched.
- Returns `True` if there was a tag toggle after `TextIter`.

textIterBackwardToTagToggle :: TextIter -> Maybe TextTag -> IO Bool

Moves `TextIter` backward to the next change of a `TextTag`.

- If `Nothing` is supplied, any `TextTag` will be matched.
- Returns `True` if there was a tag toggle before `TextIter`.

textIterForwardFindChar :: TextIter -> (Char -> Bool) -> Maybe TextIter -> IO Bool

Move `TextIter` forward until a predicate function returns True.

- If `pred` returns True before `limit` is reached, the search is stopped and the return value is True.
- If `limit` is Nothing, the search stops at the end of the buffer.

textIterBackwardFindChar :: TextIter -> (Char -> Bool) -> Maybe TextIter -> IO Bool

Move `TextIter` backward until a predicate function returns True.

- If `pred` returns True before `limit` is reached, the search is stopped and the return value is True.
- If `limit` is Nothing, the search stops at the end of the buffer.

textIterForwardSearch :: TextIter -> String -> [TextSearchFlags] -> Maybe TextIter -> IO (Maybe (TextIter, TextIter))

Search forward for a specific string.

- If specified, the last character which is tested against that start of the search pattern will be `limit`.
- `TextSearchFlags` may be empty.
- Returns the start and end position of the string found.

textIterBackwardSearch :: TextIter -> String -> [TextSearchFlags] -> Maybe TextIter -> IO (Maybe (TextIter, TextIter))

Search backward for a specific string.

- If specified, the last character which is tested against that start of the search pattern will be `limit`.
- `TextSearchFlags` my be empty.
- Returns the start and end position of the string found.

textIterEqual :: TextIter -> TextIter -> IO Bool
Compare two `TextIter` for equality.
textIterCompare :: TextIter -> TextIter -> IO Ordering
Compare two `TextIter`.
textIterForwardVisibleLine

:: TextIter |
-> IO Bool | returns whether `iter` can be dereferenced

Moves `iter` to the start of the next visible line. Returns `True` if there was a next line to move to, and `False` if `iter` was simply moved to the end of the buffer and is now not dereferenceable, or if `iter` was already at the end of the buffer.

- Available since Gtk+ version 2.8

textIterBackwardVisibleLine

:: TextIter |
-> IO Bool | returns whether `iter` moved

Moves `iter` to the start of the previous visible line. Returns `True` if `iter` could be moved; i.e. if `iter` was at character offset 0, this function returns `False`. Therefore if `iter` was already on line 0, but not at the start of the line, `iter` is snapped to the start of the line and the function returns `True`. (Note that this implies that in a loop calling this function, the line number may not change on every iteration, if your first iteration is on line 0.)

- Available since Gtk+ version 2.8

textIterForwardVisibleLines

:: TextIter |
-> Int | `count` - number of lines to move forward
-> IO Bool | returns whether `iter` moved and is dereferenceable

Moves `count` visible lines forward, if possible (if `count` would move past the start or end of the buffer, moves to the start or end of the buffer). The return value indicates whether the iterator moved onto a dereferenceable position; if the iterator didn't move, or moved onto the end iterator, then `False` is returned. If `count` is 0, the function does nothing and returns `False`. If `count` is negative, moves backward by 0 - `count` lines.

- Available since Gtk+ version 2.8

textIterBackwardVisibleLines

:: TextIter |
-> Int | `count` - number of lines to move backward
-> IO Bool | returns whether `iter` moved and is dereferenceable

Moves `count` visible lines backward, if possible (if `count` would move past the start or end of the buffer, moves to the start or end of the buffer). The return value indicates whether the iterator moved onto a dereferenceable position; if the iterator didn't move, or moved onto the end iterator, then `False` is returned. If `count` is 0, the function does nothing and returns `False`. If `count` is negative, moves forward by 0 - `count` lines.

- Available since Gtk+ version 2.8

Attributes
textIterVisibleLineOffset :: Attr TextIter Int
'visibleLineOffset' property. See `textIterGetVisibleLineOffset` and `textIterSetVisibleLineOffset`
textIterOffset :: Attr TextIter Int
'offset' property. See `textIterGetOffset` and `textIterSetOffset`
textIterLineOffset :: Attr TextIter Int
'lineOffset' property. See `textIterGetLineOffset` and `textIterSetLineOffset`
textIterLine :: Attr TextIter Int
'line' property. See `textIterGetLine` and `textIterSetLine`
Produced by Haddock version 2.4.2