|
Server : Apache/2.2.17 (Unix) mod_ssl/2.2.17 OpenSSL/0.9.8e-fips-rhel5 DAV/2 PHP/5.2.17 System : Linux localhost 2.6.18-419.el5 #1 SMP Fri Feb 24 22:47:42 UTC 2017 x86_64 User : nobody ( 99) PHP Version : 5.2.17 Disable Function : NONE Directory : /usr/share/gtk-doc/html/gtk/ |
Upload File : |
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>GtkTextMark</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
<link rel="start" href="index.html" title="GTK+ Reference Manual">
<link rel="up" href="TextWidgetObjects.html" title="Multiline Text Editor">
<link rel="prev" href="gtk-GtkTextIter.html" title="GtkTextIter">
<link rel="next" href="GtkTextBuffer.html" title="GtkTextBuffer">
<meta name="generator" content="GTK-Doc V1.6 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="part" href="gtk.html" title="Part I. GTK+ Overview">
<link rel="part" href="gtkbase.html" title="Part II. GTK+ Core Reference">
<link rel="part" href="gtkobjects.html" title="Part III. GTK+ Widgets and Objects">
<link rel="chapter" href="ch01.html" title="Object Hierarchy">
<link rel="chapter" href="ch02.html" title="Widget Gallery">
<link rel="chapter" href="WindowWidgets.html" title="Windows">
<link rel="chapter" href="DisplayWidgets.html" title="Display Widgets">
<link rel="chapter" href="ButtonWidgets.html" title="Buttons and Toggles">
<link rel="chapter" href="NumericEntry.html" title="Numeric/Text Data Entry">
<link rel="chapter" href="TextWidgetObjects.html" title="Multiline Text Editor">
<link rel="chapter" href="TreeWidgetObjects.html" title="Tree, List and Icon Grid Widgets">
<link rel="chapter" href="MenusAndCombos.html" title="Menus, Combo Box, Toolbar">
<link rel="chapter" href="Actions.html" title="Action-based menus and toolbars">
<link rel="chapter" href="SelectorWidgets.html" title="Selectors (File/Font/Color/Input Devices)">
<link rel="chapter" href="LayoutContainers.html" title="Layout Containers">
<link rel="chapter" href="Ornaments.html" title="Ornaments">
<link rel="chapter" href="ScrollingWidgets.html" title="Scrolling">
<link rel="chapter" href="Printing.html" title="Printing">
<link rel="chapter" href="MiscObjects.html" title="Miscellaneous">
<link rel="chapter" href="AbstractObjects.html" title="Abstract Base Classes">
<link rel="chapter" href="PlugSocket.html" title="Cross-process Embedding">
<link rel="chapter" href="SpecialObjects.html" title="Special-purpose features">
<link rel="chapter" href="RecentDocuments.html" title="Recently Used Documents">
<link rel="chapter" href="DeprecatedObjects.html" title="Deprecated">
<link rel="part" href="migrating.html" title="Part IV. Migrating from Previous Versions of GTK+">
<link rel="chapter" href="gtk-migrating-checklist.html" title="Migration Checklist">
<link rel="chapter" href="gtk-migrating-GtkFileChooser.html" title="Migrating from GtkFileSelection to GtkFileChooser">
<link rel="chapter" href="gtk-migrating-GtkAction.html" title="Migrating from old menu and toolbar systems to GtkAction">
<link rel="chapter" href="gtk-migrating-GtkComboBox.html" title="Migrating from GtkOptionMenu and GtkCombo to GtkComboBox and
GtkComboBoxEntry">
<link rel="chapter" href="gtk-migrating-GtkIconView.html" title="Migrating from GnomeIconList to GtkIconView">
<link rel="chapter" href="gtk-migrating-GtkAboutDialog.html" title="Migrating from GnomeAbout to GtkAboutDialog">
<link rel="chapter" href="gtk-migrating-GtkColorButton.html" title="Migrating from GnomeColorPicker to GtkColorButton">
<link rel="chapter" href="gtk-migrating-GtkAssistant.html" title="Migrating from GnomeDruid to GtkAssistant">
<link rel="chapter" href="gtk-migrating-GtkRecentChooser.html" title="Migrating from EggRecent to GtkRecentChooser">
<link rel="chapter" href="gtk-migrating-GtkLinkButton.html" title="Migrating from GnomeHRef to GtkLinkButton">
<link rel="part" href="pt05.html" title="Part V. GTK+ Tools">
<link rel="glossary" href="glossary.html" title="Glossary">
<link rel="index" href="ix01.html" title="Index">
<link rel="index" href="ix02.html" title="Index of deprecated symbols">
<link rel="index" href="ix03.html" title="Index of new symbols in 2.2">
<link rel="index" href="ix04.html" title="Index of new symbols in 2.4">
<link rel="index" href="ix05.html" title="Index of new symbols in 2.6">
<link rel="index" href="ix06.html" title="Index of new symbols in 2.8">
<link rel="index" href="ix07.html" title="Index of new symbols in 2.10">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="gtk-GtkTextIter.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="TextWidgetObjects.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">GTK+ Reference Manual</th>
<td><a accesskey="n" href="GtkTextBuffer.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2997002" class="shortcut">Top</a>
 | 
<a href="#id2997189" class="shortcut">Description</a>
 | 
<a href="#id2997164" class="shortcut">Object Hierarchy</a></nobr></td></tr>
</table>
<div class="refentry" lang="en">
<a name="GtkTextMark"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2>
<a name="id2997002"></a><span class="refentrytitle">GtkTextMark</span>
</h2>
<p>GtkTextMark —
A position in the buffer preserved across buffer modifications</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<h2>Synopsis</h2>
<pre class="synopsis">
#include <gtk/gtk.h>
<a href="GtkTextMark.html#GtkTextMark-struct">GtkTextMark</a>;
void <a href="GtkTextMark.html#gtk-text-mark-set-visible">gtk_text_mark_set_visible</a> (<a href="GtkTextMark.html" title="GtkTextMark">GtkTextMark</a> *mark,
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> setting);
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> <a href="GtkTextMark.html#gtk-text-mark-get-visible">gtk_text_mark_get_visible</a> (<a href="GtkTextMark.html" title="GtkTextMark">GtkTextMark</a> *mark);
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> <a href="GtkTextMark.html#gtk-text-mark-get-deleted">gtk_text_mark_get_deleted</a> (<a href="GtkTextMark.html" title="GtkTextMark">GtkTextMark</a> *mark);
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a>* <a href="GtkTextMark.html#gtk-text-mark-get-name">gtk_text_mark_get_name</a> (<a href="GtkTextMark.html" title="GtkTextMark">GtkTextMark</a> *mark);
<a href="GtkTextBuffer.html" title="GtkTextBuffer">GtkTextBuffer</a>* <a href="GtkTextMark.html#gtk-text-mark-get-buffer">gtk_text_mark_get_buffer</a> (<a href="GtkTextMark.html" title="GtkTextMark">GtkTextMark</a> *mark);
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> <a href="GtkTextMark.html#gtk-text-mark-get-left-gravity">gtk_text_mark_get_left_gravity</a> (<a href="GtkTextMark.html" title="GtkTextMark">GtkTextMark</a> *mark);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2997164"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
<a
href="../gobject/gobject-The-Base-Object-Type.html#GObject"
>GObject</a>
+----GtkTextMark
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2997189"></a><h2>Description</h2>
<p>
You may wish to begin by reading the <a href="TextWidget.html" title="Text Widget Overview">text widget
conceptual overview</a> which gives an overview of all the objects and data
types related to the text widget and how they work together.
</p>
<p>
A <a href="GtkTextMark.html" title="GtkTextMark"><span class="type">GtkTextMark</span></a> is like a bookmark in a text buffer; it preserves a position in
the text. You can convert the mark to an iterator using
<a href="GtkTextBuffer.html#gtk-text-buffer-get-iter-at-mark"><code class="function">gtk_text_buffer_get_iter_at_mark()</code></a>. 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 <em class="firstterm">left gravity</em> will be moved to the
beginning of the newly-inserted text, and a mark with <em class="firstterm">right
gravity</em> will be moved to the end.
<sup>[<a name="id2997251" href="#ftn.id2997251">3</a>]</sup>
</p>
<p>
Marks are reference counted, but the reference count only controls the validity
of the memory; marks can be deleted from the buffer at any time with
<a href="GtkTextBuffer.html#gtk-text-buffer-delete-mark"><code class="function">gtk_text_buffer_delete_mark()</code></a>. Once deleted from the buffer, a mark is
essentially useless.
</p>
<p>
Marks optionally have names; these can be convenient to avoid passing the
<a href="GtkTextMark.html" title="GtkTextMark"><span class="type">GtkTextMark</span></a> object around.
</p>
<p>
Marks are typically created using the <a href="GtkTextBuffer.html#gtk-text-buffer-create-mark"><code class="function">gtk_text_buffer_create_mark()</code></a> function.
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2997311"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id2997322"></a><h3>
<a name="GtkTextMark-struct"></a>GtkTextMark</h3>
<a class="indexterm" name="id2997334"></a><pre class="programlisting">typedef struct _GtkTextMark GtkTextMark;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2997349"></a><h3>
<a name="gtk-text-mark-set-visible"></a>gtk_text_mark_set_visible ()</h3>
<a class="indexterm" name="id2997363"></a><pre class="programlisting">void gtk_text_mark_set_visible (<a href="GtkTextMark.html" title="GtkTextMark">GtkTextMark</a> *mark,
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> setting);</pre>
<p>
Sets the visibility of <em class="parameter"><code>mark</code></em>; 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>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>mark</code></em> :</span></td>
<td> a <a href="GtkTextMark.html" title="GtkTextMark"><span class="type">GtkTextMark</span></a>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>setting</code></em> :</span></td>
<td> visibility of mark
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2997452"></a><h3>
<a name="gtk-text-mark-get-visible"></a>gtk_text_mark_get_visible ()</h3>
<a class="indexterm" name="id2997465"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> gtk_text_mark_get_visible (<a href="GtkTextMark.html" title="GtkTextMark">GtkTextMark</a> *mark);</pre>
<p>
Returns <a
href="../glib/glib-Standard-Macros.html#TRUE:CAPS"
><code class="literal">TRUE</code></a> if the mark is visible (i.e. a cursor is displayed
for it)</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>mark</code></em> :</span></td>
<td> a <a href="GtkTextMark.html" title="GtkTextMark"><span class="type">GtkTextMark</span></a>
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> <a
href="../glib/glib-Standard-Macros.html#TRUE:CAPS"
><code class="literal">TRUE</code></a> if visible
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2997553"></a><h3>
<a name="gtk-text-mark-get-deleted"></a>gtk_text_mark_get_deleted ()</h3>
<a class="indexterm" name="id2997567"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> gtk_text_mark_get_deleted (<a href="GtkTextMark.html" title="GtkTextMark">GtkTextMark</a> *mark);</pre>
<p>
Returns <a
href="../glib/glib-Standard-Macros.html#TRUE:CAPS"
><code class="literal">TRUE</code></a> if the mark has been removed from its buffer
with <a href="GtkTextBuffer.html#gtk-text-buffer-delete-mark"><code class="function">gtk_text_buffer_delete_mark()</code></a>. Marks can't be used
once deleted.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>mark</code></em> :</span></td>
<td> a <a href="GtkTextMark.html" title="GtkTextMark"><span class="type">GtkTextMark</span></a>
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> whether the mark is deleted
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2997658"></a><h3>
<a name="gtk-text-mark-get-name"></a>gtk_text_mark_get_name ()</h3>
<a class="indexterm" name="id2997670"></a><pre class="programlisting">const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a>* gtk_text_mark_get_name (<a href="GtkTextMark.html" title="GtkTextMark">GtkTextMark</a> *mark);</pre>
<p>
Returns the mark name; returns NULL for anonymous marks.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>mark</code></em> :</span></td>
<td> a <a href="GtkTextMark.html" title="GtkTextMark"><span class="type">GtkTextMark</span></a>
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> mark name
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2997740"></a><h3>
<a name="gtk-text-mark-get-buffer"></a>gtk_text_mark_get_buffer ()</h3>
<a class="indexterm" name="id2997752"></a><pre class="programlisting"><a href="GtkTextBuffer.html" title="GtkTextBuffer">GtkTextBuffer</a>* gtk_text_mark_get_buffer (<a href="GtkTextMark.html" title="GtkTextMark">GtkTextMark</a> *mark);</pre>
<p>
Gets the buffer this mark is located inside,
or NULL if the mark is deleted.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>mark</code></em> :</span></td>
<td> a <a href="GtkTextMark.html" title="GtkTextMark"><span class="type">GtkTextMark</span></a>
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> the mark's <a href="GtkTextBuffer.html" title="GtkTextBuffer"><span class="type">GtkTextBuffer</span></a>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2997830"></a><h3>
<a name="gtk-text-mark-get-left-gravity"></a>gtk_text_mark_get_left_gravity ()</h3>
<a class="indexterm" name="id2997843"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> gtk_text_mark_get_left_gravity (<a href="GtkTextMark.html" title="GtkTextMark">GtkTextMark</a> *mark);</pre>
<p>
Determines whether the mark has left gravity.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>mark</code></em> :</span></td>
<td> a <a href="GtkTextMark.html" title="GtkTextMark"><span class="type">GtkTextMark</span></a>
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> <a
href="../glib/glib-Standard-Macros.html#TRUE:CAPS"
><code class="literal">TRUE</code></a> if the mark has left gravity, <a
href="../glib/glib-Standard-Macros.html#FALSE:CAPS"
><code class="literal">FALSE</code></a> otherwise
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="footnotes">
<br><hr width="100" align="left">
<div class="footnote"><p><sup>[<a name="ftn.id2997251" href="#id2997251">3</a>] </sup>
"left" and "right" here refer to logical direction (left is the toward the start
of the buffer); in some languages such as Hebrew the logically-leftmost text is
not actually on the left when displayed.
</p></div>
</div>
</div>
</body>
</html>