<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Graphics.UI.Gtk.Multiline.TextMark</title><link href="ocean.css" rel="stylesheet" type="text/css" title="Ocean" /><script src="haddock-util.js" type="text/javascript"></script><script type="text/javascript">//<![CDATA[
window.onload = function () {pageLoad();setSynopsis("mini_Graphics-UI-Gtk-Multiline-TextMark.html");};
//]]>
</script></head><body><div id="package-header"><ul class="links" id="page-menu"><li><a href="src/Graphics-UI-Gtk-Multiline-TextMark.html">Source</a></li><li><a href="index.html">Contents</a></li><li><a href="doc-index.html">Index</a></li></ul><p class="caption">gtk-0.12.0: Binding to the Gtk+ graphical user interface library.</p></div><div id="content"><div id="module-header"><table class="info"><tr><th>Portability</th><td>portable (depends on GHC)</td></tr><tr><th>Stability</th><td>provisional</td></tr><tr><th>Maintainer</th><td>gtk2hs-users@lists.sourceforge.net</td></tr></table><p class="caption">Graphics.UI.Gtk.Multiline.TextMark</p></div><div id="table-of-contents"><p class="caption">Contents</p><ul><li><a href="#g:1">Detail
</a></li><li><a href="#g:2">Class Hierarchy
</a></li><li><a href="#g:3">Types
</a></li><li><a href="#g:4">Constructors
</a></li><li><a href="#g:5">Methods
</a></li><li><a href="#g:6">Attributes
</a></li></ul></div><div id="description"><p class="caption">Description</p><div class="doc"><p>A position in the buffer preserved across buffer modifications
</p></div></div><div id="synopsis"><p id="control.syn" class="caption expander" onclick="toggleSection('syn')">Synopsis</p><ul id="section.syn" class="hide" onclick="toggleSection('syn')"><li class="src short"><span class="keyword">data</span> <a href="#t:TextMark">TextMark</a> </li><li class="src short"><span class="keyword">class</span> <a href="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-GObject.html#t:GObjectClass">GObjectClass</a> o => <a href="#t:TextMarkClass">TextMarkClass</a> o </li><li class="src short"><a href="#v:castToTextMark">castToTextMark</a> :: <a href="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-GObject.html#t:GObjectClass">GObjectClass</a> obj => obj -> <a href="Graphics-UI-Gtk-Multiline-TextMark.html#t:TextMark">TextMark</a></li><li class="src short"><a href="#v:gTypeTextMark">gTypeTextMark</a> :: <a href="Graphics-UI-Gtk-Abstract-Widget.html#t:GType">GType</a></li><li class="src short"><a href="#v:toTextMark">toTextMark</a> :: <a href="Graphics-UI-Gtk-Multiline-TextMark.html#t:TextMarkClass">TextMarkClass</a> o => o -> <a href="Graphics-UI-Gtk-Multiline-TextMark.html#t:TextMark">TextMark</a></li><li class="src short"><span class="keyword">type</span> <a href="#t:MarkName">MarkName</a> = <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a></li><li class="src short"><a href="#v:textMarkNew">textMarkNew</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="Graphics-UI-Gtk-Multiline-TextMark.html#t:MarkName">MarkName</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Bool.html#t:Bool">Bool</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="Graphics-UI-Gtk-Multiline-TextMark.html#t:TextMark">TextMark</a></li><li class="src short"><a href="#v:textMarkSetVisible">textMarkSetVisible</a> :: <a href="Graphics-UI-Gtk-Multiline-TextMark.html#t:TextMarkClass">TextMarkClass</a> self => self -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Bool.html#t:Bool">Bool</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a></li><li class="src short"><a href="#v:textMarkGetVisible">textMarkGetVisible</a> :: <a href="Graphics-UI-Gtk-Multiline-TextMark.html#t:TextMarkClass">TextMarkClass</a> self => self -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Bool.html#t:Bool">Bool</a></li><li class="src short"><a href="#v:textMarkGetDeleted">textMarkGetDeleted</a> :: <a href="Graphics-UI-Gtk-Multiline-TextMark.html#t:TextMarkClass">TextMarkClass</a> self => self -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Bool.html#t:Bool">Bool</a></li><li class="src short"><a href="#v:textMarkGetName">textMarkGetName</a> :: <a href="Graphics-UI-Gtk-Multiline-TextMark.html#t:TextMarkClass">TextMarkClass</a> self => self -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> (<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="Graphics-UI-Gtk-Multiline-TextMark.html#t:MarkName">MarkName</a>)</li><li class="src short"><a href="#v:textMarkGetBuffer">textMarkGetBuffer</a> :: <a href="Graphics-UI-Gtk-Multiline-TextMark.html#t:TextMarkClass">TextMarkClass</a> self => self -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> (<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="Graphics-UI-Gtk-Multiline-TextBuffer.html#t:TextBuffer">TextBuffer</a>)</li><li class="src short"><a href="#v:textMarkGetLeftGravity">textMarkGetLeftGravity</a> :: <a href="Graphics-UI-Gtk-Multiline-TextMark.html#t:TextMarkClass">TextMarkClass</a> self => self -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Bool.html#t:Bool">Bool</a></li><li class="src short"><a href="#v:textMarkVisible">textMarkVisible</a> :: <a href="Graphics-UI-Gtk-Multiline-TextMark.html#t:TextMarkClass">TextMarkClass</a> self => <a href="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-Attributes.html#t:Attr">Attr</a> self <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Bool.html#t:Bool">Bool</a></li></ul></div><div id="interface"><h1 id="g:1">Detail
</h1><div class="doc"><p>You may wish to begin by reading the text widget conceptual overview
which gives an overview of all the objects and data types related to the
text widget and how they work together.
</p><p>A <code><a href="Graphics-UI-Gtk-Multiline-TextMark.html#t:TextMark">TextMark</a></code> is like a bookmark in a text buffer; it preserves a position
in the text. You can convert the mark to an iterator using
<code>textBufferGetIterAtMark</code>. Unlike
iterators, marks remain valid across buffer mutations, because their
behavior is defined when text is inserted or deleted. When text containing
a mark is deleted, the mark remains in the position originally occupied by
the deleted text. When text is inserted at a mark, a mark with left
gravity will be moved to the beginning of the newly-inserted text, and a
mark with right gravity will be moved to the end.
</p><p>Marks can be deleted from the buffer at any time with
<code>textBufferDeleteMark</code>. Once deleted
from the buffer, a mark is essentially useless.
</p><p>Marks optionally have names; these can be convenient to avoid passing the
<code><a href="Graphics-UI-Gtk-Multiline-TextMark.html#t:TextMark">TextMark</a></code> object around.
</p><p>Marks are typically created using the
<code>textBufferCreateMark</code> function.
</p></div><h1 id="g:2">Class Hierarchy
</h1><div class="doc"><pre>
| <code><a href="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-GObject.html#t:GObject">GObject</a></code>
| +----TextMark
</pre></div><h1 id="g:3">Types
</h1><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:TextMark" class="def">TextMark</a> <a href="src/Graphics-UI-Gtk-Types.html#TextMark" class="link">Source</a></p><div class="subs instances"><p id="control.i:TextMark" class="caption collapser" onclick="toggleSection('i:TextMark')">Instances</p><div id="section.i:TextMark" class="show"><table><tr><td class="src"><a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Eq.html#t:Eq">Eq</a> <a href="Graphics-UI-Gtk-Multiline-TextMark.html#t:TextMark">TextMark</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Ord.html#t:Ord">Ord</a> <a href="Graphics-UI-Gtk-Multiline-TextMark.html#t:TextMark">TextMark</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-GObject.html#t:GObjectClass">GObjectClass</a> <a href="Graphics-UI-Gtk-Multiline-TextMark.html#t:TextMark">TextMark</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Graphics-UI-Gtk-Multiline-TextMark.html#t:TextMarkClass">TextMarkClass</a> <a href="Graphics-UI-Gtk-Multiline-TextMark.html#t:TextMark">TextMark</a></td><td class="doc empty"> </td></tr></table></div></div></div><div class="top"><p class="src"><span class="keyword">class</span> <a href="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-GObject.html#t:GObjectClass">GObjectClass</a> o => <a name="t:TextMarkClass" class="def">TextMarkClass</a> o <a href="src/Graphics-UI-Gtk-Types.html#TextMarkClass" class="link">Source</a></p><div class="subs instances"><p id="control.i:TextMarkClass" class="caption collapser" onclick="toggleSection('i:TextMarkClass')">Instances</p><div id="section.i:TextMarkClass" class="show"><table><tr><td class="src"><a href="Graphics-UI-Gtk-Multiline-TextMark.html#t:TextMarkClass">TextMarkClass</a> <a href="Graphics-UI-Gtk-Multiline-TextMark.html#t:TextMark">TextMark</a></td><td class="doc empty"> </td></tr></table></div></div></div><div class="top"><p class="src"><a name="v:castToTextMark" class="def">castToTextMark</a> :: <a href="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-GObject.html#t:GObjectClass">GObjectClass</a> obj => obj -> <a href="Graphics-UI-Gtk-Multiline-TextMark.html#t:TextMark">TextMark</a><a href="src/Graphics-UI-Gtk-Types.html#castToTextMark" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:gTypeTextMark" class="def">gTypeTextMark</a> :: <a href="Graphics-UI-Gtk-Abstract-Widget.html#t:GType">GType</a><a href="src/Graphics-UI-Gtk-Types.html#gTypeTextMark" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:toTextMark" class="def">toTextMark</a> :: <a href="Graphics-UI-Gtk-Multiline-TextMark.html#t:TextMarkClass">TextMarkClass</a> o => o -> <a href="Graphics-UI-Gtk-Multiline-TextMark.html#t:TextMark">TextMark</a><a href="src/Graphics-UI-Gtk-Types.html#toTextMark" class="link">Source</a></p></div><div class="top"><p class="src"><span class="keyword">type</span> <a name="t:MarkName" class="def">MarkName</a> = <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a><a href="src/Graphics-UI-Gtk-Multiline-TextMark.html#MarkName" class="link">Source</a></p><div class="doc"><p>The name of a mark.
</p></div></div><h1 id="g:4">Constructors
</h1><div class="top"><p class="src"><a name="v:textMarkNew" class="def">textMarkNew</a><a href="src/Graphics-UI-Gtk-Multiline-TextMark.html#textMarkNew" class="link">Source</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="Graphics-UI-Gtk-Multiline-TextMark.html#t:MarkName">MarkName</a></td><td class="doc"><p><code>markName</code> - name for mark, or <code>Nothing</code>
</p></td></tr><tr><td class="src">-> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Bool.html#t:Bool">Bool</a></td><td class="doc"><p><code>leftGravity</code> - whether the mark has left gravity
</p></td></tr><tr><td class="src">-> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="Graphics-UI-Gtk-Multiline-TextMark.html#t:TextMark">TextMark</a></td><td class="doc empty"> </td></tr></table></div><div class="doc"><p>Creates a text mark. Add it to a buffer using <code>textBufferAddMark</code>. If
<code>name</code> is <code>Nothing</code>, the mark is anonymous; otherwise, the mark can be retrieved by
this name
using <code>textBufferGetMark</code>. If a mark has left gravity, and text is inserted
at the mark's current location, the mark will be moved to the left of the
newly-inserted text. If the mark has right gravity (<code>leftGravity</code> =
<code>False</code>), the mark will end up on the right of newly-inserted text. The
standard left-to-right cursor is a mark with right gravity (when you type,
the cursor stays on the right side of the text you're typing).
</p><ul><li> Available since Gtk+ version 2.12
</li></ul></div></div><h1 id="g:5">Methods
</h1><div class="top"><p class="src"><a name="v:textMarkSetVisible" class="def">textMarkSetVisible</a> :: <a href="Graphics-UI-Gtk-Multiline-TextMark.html#t:TextMarkClass">TextMarkClass</a> self => self -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Bool.html#t:Bool">Bool</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a><a href="src/Graphics-UI-Gtk-Multiline-TextMark.html#textMarkSetVisible" class="link">Source</a></p><div class="doc"><p>Sets the visibility of <code>mark</code>; the insertion point is normally visible,
i.e. you can see it as a vertical bar. Also, the text widget uses a visible
mark to indicate where a drop will occur when dragging-and-dropping text.
Most other marks are not visible. Marks are not visible by default.
</p></div></div><div class="top"><p class="src"><a name="v:textMarkGetVisible" class="def">textMarkGetVisible</a> :: <a href="Graphics-UI-Gtk-Multiline-TextMark.html#t:TextMarkClass">TextMarkClass</a> self => self -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Bool.html#t:Bool">Bool</a><a href="src/Graphics-UI-Gtk-Multiline-TextMark.html#textMarkGetVisible" class="link">Source</a></p><div class="doc"><p>Returns <code>True</code> if the mark is visible (i.e. a cursor is displayed for it)
</p></div></div><div class="top"><p class="src"><a name="v:textMarkGetDeleted" class="def">textMarkGetDeleted</a> :: <a href="Graphics-UI-Gtk-Multiline-TextMark.html#t:TextMarkClass">TextMarkClass</a> self => self -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Bool.html#t:Bool">Bool</a><a href="src/Graphics-UI-Gtk-Multiline-TextMark.html#textMarkGetDeleted" class="link">Source</a></p><div class="doc"><p>Returns <code>True</code> if the mark has been removed from its buffer with
<code>textBufferDeleteMark</code>. Marks can't
be used once deleted.
</p></div></div><div class="top"><p class="src"><a name="v:textMarkGetName" class="def">textMarkGetName</a> :: <a href="Graphics-UI-Gtk-Multiline-TextMark.html#t:TextMarkClass">TextMarkClass</a> self => self -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> (<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="Graphics-UI-Gtk-Multiline-TextMark.html#t:MarkName">MarkName</a>)<a href="src/Graphics-UI-Gtk-Multiline-TextMark.html#textMarkGetName" class="link">Source</a></p><div class="doc"><p>Returns the mark name; returns <code>Nothing</code> for anonymous marks.
</p></div></div><div class="top"><p class="src"><a name="v:textMarkGetBuffer" class="def">textMarkGetBuffer</a> :: <a href="Graphics-UI-Gtk-Multiline-TextMark.html#t:TextMarkClass">TextMarkClass</a> self => self -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> (<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="Graphics-UI-Gtk-Multiline-TextBuffer.html#t:TextBuffer">TextBuffer</a>)<a href="src/Graphics-UI-Gtk-Multiline-TextMark.html#textMarkGetBuffer" class="link">Source</a></p><div class="doc"><p>Gets the buffer this mark is located inside, or <code>Nothing</code> if the mark is
deleted.
</p></div></div><div class="top"><p class="src"><a name="v:textMarkGetLeftGravity" class="def">textMarkGetLeftGravity</a> :: <a href="Graphics-UI-Gtk-Multiline-TextMark.html#t:TextMarkClass">TextMarkClass</a> self => self -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Bool.html#t:Bool">Bool</a><a href="src/Graphics-UI-Gtk-Multiline-TextMark.html#textMarkGetLeftGravity" class="link">Source</a></p><div class="doc"><p>Determines whether the mark has left gravity.
</p><p>The name is misleading as Arabic, Hebrew and some other languages have the
beginning of a line towards the right.
</p></div></div><h1 id="g:6">Attributes
</h1><div class="top"><p class="src"><a name="v:textMarkVisible" class="def">textMarkVisible</a> :: <a href="Graphics-UI-Gtk-Multiline-TextMark.html#t:TextMarkClass">TextMarkClass</a> self => <a href="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-Attributes.html#t:Attr">Attr</a> self <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Bool.html#t:Bool">Bool</a><a href="src/Graphics-UI-Gtk-Multiline-TextMark.html#textMarkVisible" class="link">Source</a></p><div class="doc"><p>The 'visible' property. See <code><a href="Graphics-UI-Gtk-Multiline-TextMark.html#v:textMarkGetVisible">textMarkGetVisible</a></code> and <code><a href="Graphics-UI-Gtk-Multiline-TextMark.html#v:textMarkSetVisible">textMarkSetVisible</a></code>
</p></div></div></div></div><div id="footer"><p>Produced by <a href="http://www.haskell.org/haddock/">Haddock</a> version 2.9.2</p></div></body></html>
