1
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2
<html xmlns="http://www.w3.org/1999/xhtml">
4
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5
<title>gtkmm: Gtk::TextMark Class Reference</title>
6
<link href="tabs.css" rel="stylesheet" type="text/css"/>
7
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
10
<!-- Generated by Doxygen 1.7.3 -->
13
<table cellspacing="0" cellpadding="0">
15
<tr style="height: 56px;">
16
<td style="padding-left: 0.5em;">
17
<div id="projectname">gtkmm <span id="projectnumber">2.24.2</span></div>
23
<div id="navrow1" class="tabs">
25
<li><a href="index.html"><span>Main Page</span></a></li>
26
<li><a href="pages.html"><span>Related Pages</span></a></li>
27
<li><a href="modules.html"><span>Modules</span></a></li>
28
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
29
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
32
<div id="navrow2" class="tabs2">
34
<li><a href="annotated.html"><span>Class List</span></a></li>
35
<li><a href="classes.html"><span>Class Index</span></a></li>
36
<li><a href="inherits.html"><span>Class Hierarchy</span></a></li>
37
<li><a href="functions.html"><span>Class Members</span></a></li>
40
<div id="nav-path" class="navpath">
42
<li class="navelem"><a class="el" href="namespaceGtk.html">Gtk</a> </li>
43
<li class="navelem"><a class="el" href="classGtk_1_1TextMark.html">TextMark</a> </li>
49
<a href="#pub-methods">Public Member Functions</a> |
50
<a href="#pub-static-methods">Static Public Member Functions</a> |
51
<a href="#pro-methods">Protected Member Functions</a> |
52
<a href="#related">Related Functions</a> </div>
53
<div class="headertitle">
54
<h1>Gtk::TextMark Class Reference<div class="ingroups"><a class="el" href="group__TextView.html">TextView Classes</a></div></h1> </div>
56
<div class="contents">
57
<!-- doxytag: class="Gtk::TextMark" --><!-- doxytag: inherits="Glib::Object" -->
58
<p>Typedefed as <a class="el" href="classGtk_1_1TextBuffer.html#ae8dd977bbf98a58d400f880ed30a946e">Gtk::TextBuffer::Mark</a>. <a href="#_details">More...</a></p>
59
<div class="dynheader">
60
Inheritance diagram for Gtk::TextMark:</div>
61
<div class="dyncontent">
62
<div class="center"><img src="classGtk_1_1TextMark__inherit__graph.png" border="0" usemap="#Gtk_1_1TextMark_inherit__map" alt="Inheritance graph"/></div>
63
<map name="Gtk_1_1TextMark_inherit__map" id="Gtk_1_1TextMark_inherit__map">
64
<area shape="rect" id="node2" href="../../../glibmm-2.4/reference/html/classGlib_1_1Object.html" title="Glib::Object" alt="" coords="20,166,111,197"/><area shape="rect" id="node4" href="../../../glibmm-2.4/reference/html/classGlib_1_1ObjectBase.html" title="Glib::ObjectBase" alt="" coords="5,86,125,117"/><area shape="rect" id="node6" href="../../../libsigc++-2.0/reference/html/structsigc_1_1trackable.html" title="sigc::trackable" alt="" coords="12,6,119,37"/></map>
65
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
66
<div class="dynheader">
67
Collaboration diagram for Gtk::TextMark:</div>
68
<div class="dyncontent">
69
<div class="center"><img src="classGtk_1_1TextMark__coll__graph.png" border="0" usemap="#Gtk_1_1TextMark_coll__map" alt="Collaboration graph"/></div>
70
<map name="Gtk_1_1TextMark_coll__map" id="Gtk_1_1TextMark_coll__map">
71
<area shape="rect" id="node2" href="../../../glibmm-2.4/reference/html/classGlib_1_1Object.html" title="Glib::Object" alt="" coords="20,166,111,197"/><area shape="rect" id="node4" href="../../../glibmm-2.4/reference/html/classGlib_1_1ObjectBase.html" title="Glib::ObjectBase" alt="" coords="5,86,125,117"/><area shape="rect" id="node6" href="../../../libsigc++-2.0/reference/html/structsigc_1_1trackable.html" title="sigc::trackable" alt="" coords="12,6,119,37"/></map>
72
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
74
<p><a href="classGtk_1_1TextMark-members.html">List of all members.</a></p>
75
<table class="memberdecls">
76
<tr><td colspan="2"><h2><a name="pub-methods"></a>
77
Public Member Functions</h2></td></tr>
78
<tr><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1TextMark.html#a57eee14b77021e8df4664a15a28db58c">~TextMark</a> ()</td></tr>
79
<tr><td class="memItemLeft" align="right" valign="top">GtkTextMark* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1TextMark.html#a2375cdcf56f135b5caeb1d335c078801">gobj</a> ()</td></tr>
80
<tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C GObject. <a href="#a2375cdcf56f135b5caeb1d335c078801"></a><br/></td></tr>
81
<tr><td class="memItemLeft" align="right" valign="top">const GtkTextMark* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1TextMark.html#aab9399f7ecc8539ccf11191cc64a885b">gobj</a> () const </td></tr>
82
<tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C GObject. <a href="#aab9399f7ecc8539ccf11191cc64a885b"></a><br/></td></tr>
83
<tr><td class="memItemLeft" align="right" valign="top">GtkTextMark* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1TextMark.html#ad69a5cb3437143cee49ce6dbb6f9d92b">gobj_copy</a> ()</td></tr>
84
<tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. <a href="#ad69a5cb3437143cee49ce6dbb6f9d92b"></a><br/></td></tr>
85
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1TextMark.html#a81500d6abd3ae31baf1494476b304ed9">set_visible</a> (bool setting=true)</td></tr>
86
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the visibility of <em>mark</em>; the insertion point is normally visible, i.e. you can see it as a vertical bar. <a href="#a81500d6abd3ae31baf1494476b304ed9"></a><br/></td></tr>
87
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1TextMark.html#a82ac4758d758dce5e9207f97024c7b05">get_visible</a> () const </td></tr>
88
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns <code>true</code> if the mark is visible (i.e. a cursor is displayed for it). <a href="#a82ac4758d758dce5e9207f97024c7b05"></a><br/></td></tr>
89
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1TextMark.html#aa00c93df844bcb94515c13e12d01ea14">get_name</a> () const </td></tr>
90
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the mark name; returns <code>0</code> for anonymous marks. <a href="#aa00c93df844bcb94515c13e12d01ea14"></a><br/></td></tr>
91
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1TextMark.html#aec24e44776091f4b8ae323fabdb536e9">get_deleted</a> () const </td></tr>
92
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns <code>true</code> if the mark has been removed from its buffer with <a class="el" href="classGtk_1_1TextBuffer.html#a1582cb666cbe6c857f6f742557e19295" title="Deletes mark, so that it's no longer located anywhere in the buffer.">Gtk::TextBuffer::delete_mark()</a>. <a href="#aec24e44776091f4b8ae323fabdb536e9"></a><br/></td></tr>
93
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a>< <a class="el" href="classGtk_1_1TextBuffer.html">TextBuffer</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1TextMark.html#a2d355fbee36a734b25086ab7ff724f95">get_buffer</a> ()</td></tr>
94
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets the buffer this mark is located inside, or <code>0</code> if the mark is deleted. <a href="#a2d355fbee36a734b25086ab7ff724f95"></a><br/></td></tr>
95
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a>< const <a class="el" href="classGtk_1_1TextBuffer.html">TextBuffer</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1TextMark.html#a829fa229e2b4fef7de10ada96ee7cf77">get_buffer</a> () const </td></tr>
96
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets the buffer this mark is located inside, or <code>0</code> if the mark is deleted. <a href="#a829fa229e2b4fef7de10ada96ee7cf77"></a><br/></td></tr>
97
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1TextMark.html#a67a222e297c03bd220024952e5ee9ca5">get_left_gravity</a> () const </td></tr>
98
<tr><td class="mdescLeft"> </td><td class="mdescRight">Determines whether the mark has left gravity. <a href="#a67a222e297c03bd220024952e5ee9ca5"></a><br/></td></tr>
99
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classGtk_1_1TextIter.html">TextIter</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1TextMark.html#a1ed8d8769cf46a34769fb4ec76c50371">get_iter</a> ()</td></tr>
100
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1PropertyProxy__ReadOnly.html">Glib::PropertyProxy_ReadOnly</a><br class="typebreak"/>
101
< <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1TextMark.html#a5ee676ad180ab9493d40ac1781c1fe34">property_name</a> () const </td></tr>
102
<tr><td class="mdescLeft"> </td><td class="mdescRight">Mark name. <a href="#a5ee676ad180ab9493d40ac1781c1fe34"></a><br/></td></tr>
103
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1PropertyProxy__ReadOnly.html">Glib::PropertyProxy_ReadOnly</a><br class="typebreak"/>
104
< bool > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1TextMark.html#af96f82ce679613c88ac0bc7cf7fd41f6">property_left_gravity</a> () const </td></tr>
105
<tr><td class="mdescLeft"> </td><td class="mdescRight">Whether the mark has left gravity. <a href="#af96f82ce679613c88ac0bc7cf7fd41f6"></a><br/></td></tr>
106
<tr><td colspan="2"><h2><a name="pub-static-methods"></a>
107
Static Public Member Functions</h2></td></tr>
108
<tr><td class="memItemLeft" align="right" valign="top">static <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a>< <a class="el" href="classGtk_1_1TextMark.html">TextMark</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1TextMark.html#a535324f93ccc7f594ec4fcb29baeb3e3">create</a> (bool left_gravity=true)</td></tr>
109
<tr><td class="mdescLeft"> </td><td class="mdescRight">Creates an anoymous text mark. <a href="#a535324f93ccc7f594ec4fcb29baeb3e3"></a><br/></td></tr>
110
<tr><td class="memItemLeft" align="right" valign="top">static <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a>< <a class="el" href="classGtk_1_1TextMark.html">TextMark</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1TextMark.html#aca937ffe910b0e20e1421e4a0497dd41">create</a> (const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a>& name, bool left_gravity=true)</td></tr>
111
<tr><td class="mdescLeft"> </td><td class="mdescRight">Creates a text mark. <a href="#aca937ffe910b0e20e1421e4a0497dd41"></a><br/></td></tr>
112
<tr><td colspan="2"><h2><a name="pro-methods"></a>
113
Protected Member Functions</h2></td></tr>
114
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1TextMark.html#ad78023d251297a807414d9f6e675d10b">TextMark</a> (bool left_gravity=true)</td></tr>
115
<tr><td class="mdescLeft"> </td><td class="mdescRight">Creates an anoymous text mark. <a href="#ad78023d251297a807414d9f6e675d10b"></a><br/></td></tr>
116
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1TextMark.html#a938c7595b3d39c1a58ac679a9fcebc24">TextMark</a> (const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a>& name, bool left_gravity=true)</td></tr>
117
<tr><td class="mdescLeft"> </td><td class="mdescRight">Creates a text mark. <a href="#a938c7595b3d39c1a58ac679a9fcebc24"></a><br/></td></tr>
118
<tr><td colspan="2"><h2><a name="related"></a>
119
Related Functions</h2></td></tr>
120
<tr><td colspan="2">(Note that these are not member functions.) <br/></td></tr>
121
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a>< <a class="el" href="classGtk_1_1TextMark.html">Gtk::TextMark</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1TextMark.html#a527b171c0f845bd9410c2b7e93432519">wrap</a> (GtkTextMark* object, bool take_copy=false)</td></tr>
122
<tr><td class="mdescLeft"> </td><td class="mdescRight">A <a class="elRef" href="../../../glibmm-2.4/reference/html/namespaceGlib.html#a671306f4a3a0cae5ab4d7a9d54886592">Glib::wrap()</a> method for this object. <a href="#a527b171c0f845bd9410c2b7e93432519"></a><br/></td></tr>
124
<hr/><a name="_details"></a><h2>Detailed Description</h2>
125
<div class="textblock"><p>Typedefed as <a class="el" href="classGtk_1_1TextBuffer.html#ae8dd977bbf98a58d400f880ed30a946e">Gtk::TextBuffer::Mark</a>. </p>
126
<p>A position in the buffer, preserved across buffer modifications.</p>
127
<p>A Mark is like a bookmark in a text buffer; it preserves a position in the text. 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. The standard text cursor in left-to-right languages is a mark with right gravity, because it stays to the right of inserted text.</p>
128
<p>Like tags, marks can be either named or anonymous. There are two marks built-in to <a class="el" href="classGtk_1_1TextBuffer.html" title="Multi-line attributed text that can be displayed by one or more Gtk::TextView widgets.">Gtk::TextBuffer</a>; these are named "insert" and "selection_bound" and refer to the insertion point and the boundary of the selection which is not the insertion point, respectively. If no text is selected, these two marks will be in the same position. You can manipulate what is selected and where the cursor appears by moving these marks around.</p>
129
<p>"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>
130
<p>You can convert the mark to an <a class="el" href="classGtk_1_1TextIter.html">iterator</a> using <a class="el" href="classGtk_1_1TextBuffer.html#a331fadf0c7c6c470b709802fbc09984a" title="Get the current position of a mark.">Gtk::TextBuffer::get_iter_at_mark()</a>.</p>
131
<p>Marks can be deleted from the buffer at any time with <a class="el" href="classGtk_1_1TextBuffer.html#a1582cb666cbe6c857f6f742557e19295" title="Deletes mark, so that it's no longer located anywhere in the buffer.">Gtk::TextBuffer::delete_mark()</a>. Once deleted from the buffer, a mark is essentially useless.</p>
132
<p>Marks optionally have names; these can be convenient to avoid passing the <a class="el" href="classGtk_1_1TextBuffer.html#ae8dd977bbf98a58d400f880ed30a946e">Gtk::TextBuffer::Mark</a> object around.</p>
133
<p>Marks are typically created using the <a class="el" href="classGtk_1_1TextBuffer.html#aa355a0cc0a3c1d7f7f9ded9cc157feb5" title="Creates a mark at position where.">Gtk::TextBuffer::create_mark()</a> function. </p>
134
</div><hr/><h2>Constructor & Destructor Documentation</h2>
135
<a class="anchor" id="a57eee14b77021e8df4664a15a28db58c"></a><!-- doxytag: member="Gtk::TextMark::~TextMark" ref="a57eee14b77021e8df4664a15a28db58c" args="()" -->
136
<div class="memitem">
137
<div class="memproto">
138
<table class="memname">
140
<td class="memname">virtual Gtk::TextMark::~TextMark </td>
142
<td class="paramname"></td><td>)</td>
143
<td><code> [virtual]</code></td>
151
<a class="anchor" id="ad78023d251297a807414d9f6e675d10b"></a><!-- doxytag: member="Gtk::TextMark::TextMark" ref="ad78023d251297a807414d9f6e675d10b" args="(bool left_gravity=true)" -->
152
<div class="memitem">
153
<div class="memproto">
154
<table class="memname">
156
<td class="memname">Gtk::TextMark::TextMark </td>
158
<td class="paramtype">bool </td>
159
<td class="paramname"><em>left_gravity</em> = <code>true</code></td><td>)</td>
160
<td><code> [explicit, protected]</code></td>
166
<p>Creates an anoymous text mark. </p>
167
<p>Add it to a buffer using <a class="el" href="classGtk_1_1TextBuffer.html#a5b40599bc4daf29b2dd923deafc05e7e" title="Adds the mark at position where.">Gtk::TextBuffer::add_mark()</a>. 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 (<em>left_gravity</em> = false), 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>
168
<dl><dt><b>Parameters:</b></dt><dd>
169
<table class="params">
170
<tr><td class="paramname">name</td><td>mark name. </td></tr>
171
<tr><td class="paramname">left_gravity</td><td>Whether the mark should have left gravity. </td></tr>
175
<dl class="since_2_12"><dt><b><a class="el" href="since_2_12.html#_since_2_12000088">Since gtkmm 2.12:</a></b></dt><dd></dd></dl>
179
<a class="anchor" id="a938c7595b3d39c1a58ac679a9fcebc24"></a><!-- doxytag: member="Gtk::TextMark::TextMark" ref="a938c7595b3d39c1a58ac679a9fcebc24" args="(const Glib::ustring &name, bool left_gravity=true)" -->
180
<div class="memitem">
181
<div class="memproto">
182
<table class="memname">
184
<td class="memname">Gtk::TextMark::TextMark </td>
186
<td class="paramtype">const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a> & </td>
187
<td class="paramname"><em>name</em>, </td>
190
<td class="paramkey"></td>
192
<td class="paramtype">bool </td>
193
<td class="paramname"><em>left_gravity</em> = <code>true</code> </td>
198
<td></td><td><code> [explicit, protected]</code></td>
204
<p>Creates a text mark. </p>
205
<p>Add it to a buffer using <a class="el" href="classGtk_1_1TextBuffer.html#a5b40599bc4daf29b2dd923deafc05e7e" title="Adds the mark at position where.">Gtk::TextBuffer::add_mark()</a>. The mark can be retrieved by name using <a class="el" href="classGtk_1_1TextBuffer.html#a2fcefaf023f05dd2e18ffa3de6063fd0" title="Returns the mark named name in buffer buffer, or 0 if no such mark exists in the buffer.">Gtk::TextBuffer::get_mark()</a>. 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 (<em>left_gravity</em> = false), 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>
206
<dl><dt><b>Parameters:</b></dt><dd>
207
<table class="params">
208
<tr><td class="paramname">name</td><td>mark name. </td></tr>
209
<tr><td class="paramname">left_gravity</td><td>Whether the mark should have left gravity. </td></tr>
213
<dl class="since_2_12"><dt><b><a class="el" href="since_2_12.html#_since_2_12000089">Since gtkmm 2.12:</a></b></dt><dd></dd></dl>
217
<hr/><h2>Member Function Documentation</h2>
218
<a class="anchor" id="a535324f93ccc7f594ec4fcb29baeb3e3"></a><!-- doxytag: member="Gtk::TextMark::create" ref="a535324f93ccc7f594ec4fcb29baeb3e3" args="(bool left_gravity=true)" -->
219
<div class="memitem">
220
<div class="memproto">
221
<table class="memname">
223
<td class="memname">static <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a><<a class="el" href="classGtk_1_1TextMark.html">TextMark</a>> Gtk::TextMark::create </td>
225
<td class="paramtype">bool </td>
226
<td class="paramname"><em>left_gravity</em> = <code>true</code></td><td>)</td>
227
<td><code> [static]</code></td>
233
<p>Creates an anoymous text mark. </p>
234
<p>Add it to a buffer using <a class="el" href="classGtk_1_1TextBuffer.html#a5b40599bc4daf29b2dd923deafc05e7e" title="Adds the mark at position where.">Gtk::TextBuffer::add_mark()</a>. 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 (<em>left_gravity</em> = false), 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>
235
<dl><dt><b>Parameters:</b></dt><dd>
236
<table class="params">
237
<tr><td class="paramname">name</td><td>mark name. </td></tr>
238
<tr><td class="paramname">left_gravity</td><td>Whether the mark should have left gravity. </td></tr>
242
<dl class="return"><dt><b>Returns:</b></dt><dd>A RefPtr to a new text mark. </dd></dl>
243
<dl class="since_2_12"><dt><b><a class="el" href="since_2_12.html#_since_2_12000090">Since gtkmm 2.12:</a></b></dt><dd></dd></dl>
247
<a class="anchor" id="aca937ffe910b0e20e1421e4a0497dd41"></a><!-- doxytag: member="Gtk::TextMark::create" ref="aca937ffe910b0e20e1421e4a0497dd41" args="(const Glib::ustring &name, bool left_gravity=true)" -->
248
<div class="memitem">
249
<div class="memproto">
250
<table class="memname">
252
<td class="memname">static <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a><<a class="el" href="classGtk_1_1TextMark.html">TextMark</a>> Gtk::TextMark::create </td>
254
<td class="paramtype">const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a> & </td>
255
<td class="paramname"><em>name</em>, </td>
258
<td class="paramkey"></td>
260
<td class="paramtype">bool </td>
261
<td class="paramname"><em>left_gravity</em> = <code>true</code> </td>
266
<td></td><td><code> [static]</code></td>
272
<p>Creates a text mark. </p>
273
<p>Add it to a buffer using <a class="el" href="classGtk_1_1TextBuffer.html#a5b40599bc4daf29b2dd923deafc05e7e" title="Adds the mark at position where.">Gtk::TextBuffer::add_mark()</a>. The mark can be retrieved by name using <a class="el" href="classGtk_1_1TextBuffer.html#a2fcefaf023f05dd2e18ffa3de6063fd0" title="Returns the mark named name in buffer buffer, or 0 if no such mark exists in the buffer.">Gtk::TextBuffer::get_mark()</a>. 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 (<em>left_gravity</em> = false), 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>
274
<dl><dt><b>Parameters:</b></dt><dd>
275
<table class="params">
276
<tr><td class="paramname">name</td><td>mark name. </td></tr>
277
<tr><td class="paramname">left_gravity</td><td>Whether the mark should have left gravity. </td></tr>
281
<dl class="return"><dt><b>Returns:</b></dt><dd>A RefPtr to a new text mark. </dd></dl>
282
<dl class="since_2_12"><dt><b><a class="el" href="since_2_12.html#_since_2_12000091">Since gtkmm 2.12:</a></b></dt><dd></dd></dl>
286
<a class="anchor" id="a2d355fbee36a734b25086ab7ff724f95"></a><!-- doxytag: member="Gtk::TextMark::get_buffer" ref="a2d355fbee36a734b25086ab7ff724f95" args="()" -->
287
<div class="memitem">
288
<div class="memproto">
289
<table class="memname">
291
<td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a><<a class="el" href="classGtk_1_1TextBuffer.html">TextBuffer</a>> Gtk::TextMark::get_buffer </td>
293
<td class="paramname"></td><td>)</td>
300
<p>Gets the buffer this mark is located inside, or <code>0</code> if the mark is deleted. </p>
301
<dl class="return"><dt><b>Returns:</b></dt><dd>The mark's <a class="el" href="classGtk_1_1TextBuffer.html" title="Multi-line attributed text that can be displayed by one or more Gtk::TextView widgets.">Gtk::TextBuffer</a>. </dd></dl>
305
<a class="anchor" id="a829fa229e2b4fef7de10ada96ee7cf77"></a><!-- doxytag: member="Gtk::TextMark::get_buffer" ref="a829fa229e2b4fef7de10ada96ee7cf77" args="() const " -->
306
<div class="memitem">
307
<div class="memproto">
308
<table class="memname">
310
<td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a><const <a class="el" href="classGtk_1_1TextBuffer.html">TextBuffer</a>> Gtk::TextMark::get_buffer </td>
312
<td class="paramname"></td><td>)</td>
319
<p>Gets the buffer this mark is located inside, or <code>0</code> if the mark is deleted. </p>
320
<dl class="return"><dt><b>Returns:</b></dt><dd>The mark's <a class="el" href="classGtk_1_1TextBuffer.html" title="Multi-line attributed text that can be displayed by one or more Gtk::TextView widgets.">Gtk::TextBuffer</a>. </dd></dl>
324
<a class="anchor" id="aec24e44776091f4b8ae323fabdb536e9"></a><!-- doxytag: member="Gtk::TextMark::get_deleted" ref="aec24e44776091f4b8ae323fabdb536e9" args="() const " -->
325
<div class="memitem">
326
<div class="memproto">
327
<table class="memname">
329
<td class="memname">bool Gtk::TextMark::get_deleted </td>
331
<td class="paramname"></td><td>)</td>
338
<p>Returns <code>true</code> if the mark has been removed from its buffer with <a class="el" href="classGtk_1_1TextBuffer.html#a1582cb666cbe6c857f6f742557e19295" title="Deletes mark, so that it's no longer located anywhere in the buffer.">Gtk::TextBuffer::delete_mark()</a>. </p>
339
<p>See <a class="el" href="classGtk_1_1TextBuffer.html#a5b40599bc4daf29b2dd923deafc05e7e" title="Adds the mark at position where.">Gtk::TextBuffer::add_mark()</a> for a way to add it to a buffer again. </p>
340
<dl class="return"><dt><b>Returns:</b></dt><dd>Whether the mark is deleted. </dd></dl>
344
<a class="anchor" id="a1ed8d8769cf46a34769fb4ec76c50371"></a><!-- doxytag: member="Gtk::TextMark::get_iter" ref="a1ed8d8769cf46a34769fb4ec76c50371" args="()" -->
345
<div class="memitem">
346
<div class="memproto">
347
<table class="memname">
349
<td class="memname"><a class="el" href="classGtk_1_1TextIter.html">TextIter</a> Gtk::TextMark::get_iter </td>
351
<td class="paramname"></td><td>)</td>
360
<a class="anchor" id="a67a222e297c03bd220024952e5ee9ca5"></a><!-- doxytag: member="Gtk::TextMark::get_left_gravity" ref="a67a222e297c03bd220024952e5ee9ca5" args="() const " -->
361
<div class="memitem">
362
<div class="memproto">
363
<table class="memname">
365
<td class="memname">bool Gtk::TextMark::get_left_gravity </td>
367
<td class="paramname"></td><td>)</td>
374
<p>Determines whether the mark has left gravity. </p>
375
<dl class="return"><dt><b>Returns:</b></dt><dd><code>true</code> if the mark has left gravity, <code>false</code> otherwise. </dd></dl>
379
<a class="anchor" id="aa00c93df844bcb94515c13e12d01ea14"></a><!-- doxytag: member="Gtk::TextMark::get_name" ref="aa00c93df844bcb94515c13e12d01ea14" args="() const " -->
380
<div class="memitem">
381
<div class="memproto">
382
<table class="memname">
384
<td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a> Gtk::TextMark::get_name </td>
386
<td class="paramname"></td><td>)</td>
393
<p>Returns the mark name; returns <code>0</code> for anonymous marks. </p>
394
<dl class="return"><dt><b>Returns:</b></dt><dd>Mark name. </dd></dl>
398
<a class="anchor" id="a82ac4758d758dce5e9207f97024c7b05"></a><!-- doxytag: member="Gtk::TextMark::get_visible" ref="a82ac4758d758dce5e9207f97024c7b05" args="() const " -->
399
<div class="memitem">
400
<div class="memproto">
401
<table class="memname">
403
<td class="memname">bool Gtk::TextMark::get_visible </td>
405
<td class="paramname"></td><td>)</td>
412
<p>Returns <code>true</code> if the mark is visible (i.e. a cursor is displayed for it). </p>
413
<dl class="return"><dt><b>Returns:</b></dt><dd><code>true</code> if visible. </dd></dl>
417
<a class="anchor" id="aab9399f7ecc8539ccf11191cc64a885b"></a><!-- doxytag: member="Gtk::TextMark::gobj" ref="aab9399f7ecc8539ccf11191cc64a885b" args="() const " -->
418
<div class="memitem">
419
<div class="memproto">
420
<table class="memname">
422
<td class="memname">const GtkTextMark* Gtk::TextMark::gobj </td>
424
<td class="paramname"></td><td>)</td>
425
<td> const<code> [inline]</code></td>
431
<p>Provides access to the underlying C GObject. </p>
433
<p>Reimplemented from <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ObjectBase.html#a778a94181132976bbfb0519793f3b32e">Glib::ObjectBase</a>.</p>
437
<a class="anchor" id="a2375cdcf56f135b5caeb1d335c078801"></a><!-- doxytag: member="Gtk::TextMark::gobj" ref="a2375cdcf56f135b5caeb1d335c078801" args="()" -->
438
<div class="memitem">
439
<div class="memproto">
440
<table class="memname">
442
<td class="memname">GtkTextMark* Gtk::TextMark::gobj </td>
444
<td class="paramname"></td><td>)</td>
445
<td><code> [inline]</code></td>
451
<p>Provides access to the underlying C GObject. </p>
453
<p>Reimplemented from <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ObjectBase.html#a4c6efc18be8cb9c56e58fc0bd20fafbe">Glib::ObjectBase</a>.</p>
457
<a class="anchor" id="ad69a5cb3437143cee49ce6dbb6f9d92b"></a><!-- doxytag: member="Gtk::TextMark::gobj_copy" ref="ad69a5cb3437143cee49ce6dbb6f9d92b" args="()" -->
458
<div class="memitem">
459
<div class="memproto">
460
<table class="memname">
462
<td class="memname">GtkTextMark* Gtk::TextMark::gobj_copy </td>
464
<td class="paramname"></td><td>)</td>
471
<p>Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. </p>
475
<a class="anchor" id="af96f82ce679613c88ac0bc7cf7fd41f6"></a><!-- doxytag: member="Gtk::TextMark::property_left_gravity" ref="af96f82ce679613c88ac0bc7cf7fd41f6" args="() const " -->
476
<div class="memitem">
477
<div class="memproto">
478
<table class="memname">
480
<td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1PropertyProxy__ReadOnly.html">Glib::PropertyProxy_ReadOnly</a><bool> Gtk::TextMark::property_left_gravity </td>
482
<td class="paramname"></td><td>)</td>
489
<p>Whether the mark has left gravity. </p>
490
<p>You rarely need to use properties because there are get_ and set_ methods for almost all of them. </p>
491
<dl class="return"><dt><b>Returns:</b></dt><dd>A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes. </dd></dl>
495
<a class="anchor" id="a5ee676ad180ab9493d40ac1781c1fe34"></a><!-- doxytag: member="Gtk::TextMark::property_name" ref="a5ee676ad180ab9493d40ac1781c1fe34" args="() const " -->
496
<div class="memitem">
497
<div class="memproto">
498
<table class="memname">
500
<td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1PropertyProxy__ReadOnly.html">Glib::PropertyProxy_ReadOnly</a><<a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a>> Gtk::TextMark::property_name </td>
502
<td class="paramname"></td><td>)</td>
510
<p>You rarely need to use properties because there are get_ and set_ methods for almost all of them. </p>
511
<dl class="return"><dt><b>Returns:</b></dt><dd>A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes. </dd></dl>
515
<a class="anchor" id="a81500d6abd3ae31baf1494476b304ed9"></a><!-- doxytag: member="Gtk::TextMark::set_visible" ref="a81500d6abd3ae31baf1494476b304ed9" args="(bool setting=true)" -->
516
<div class="memitem">
517
<div class="memproto">
518
<table class="memname">
520
<td class="memname">void Gtk::TextMark::set_visible </td>
522
<td class="paramtype">bool </td>
523
<td class="paramname"><em>setting</em> = <code>true</code></td><td>)</td>
530
<p>Sets the visibility of <em>mark</em>; the insertion point is normally visible, i.e. you can see it as a vertical bar. </p>
531
<p>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>
532
<dl><dt><b>Parameters:</b></dt><dd>
533
<table class="params">
534
<tr><td class="paramname">setting</td><td>Visibility of mark. </td></tr>
541
<hr/><h2>Friends And Related Function Documentation</h2>
542
<a class="anchor" id="a527b171c0f845bd9410c2b7e93432519"></a><!-- doxytag: member="Gtk::TextMark::wrap" ref="a527b171c0f845bd9410c2b7e93432519" args="(GtkTextMark *object, bool take_copy=false)" -->
543
<div class="memitem">
544
<div class="memproto">
545
<table class="memname">
547
<td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a>< <a class="el" href="classGtk_1_1TextMark.html">Gtk::TextMark</a> > wrap </td>
549
<td class="paramtype">GtkTextMark * </td>
550
<td class="paramname"><em>object</em>, </td>
553
<td class="paramkey"></td>
555
<td class="paramtype">bool </td>
556
<td class="paramname"><em>take_copy</em> = <code>false</code> </td>
561
<td></td><td><code> [related]</code></td>
567
<p>A <a class="elRef" href="../../../glibmm-2.4/reference/html/namespaceGlib.html#a671306f4a3a0cae5ab4d7a9d54886592">Glib::wrap()</a> method for this object. </p>
568
<dl><dt><b>Parameters:</b></dt><dd>
569
<table class="params">
570
<tr><td class="paramname">object</td><td>The C instance. </td></tr>
571
<tr><td class="paramname">take_copy</td><td>False if the result should take ownership of the C instance. True if it should take a new copy or ref. </td></tr>
575
<dl class="return"><dt><b>Returns:</b></dt><dd>A C++ instance that wraps this C instance. </dd></dl>
579
<hr/>The documentation for this class was generated from the following file:<ul>
580
<li>gtkmm/textmark.h</li>
583
<hr class="footer"/><address class="footer"><small>Generated on Fri Jul 8 2011 13:31:47 for gtkmm by 
584
<a href="http://www.doxygen.org/index.html">
585
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.3 </small></address>
added
removed
share/doc/gtkmm-2.4/reference/html/classGtk_1_1TextMark.html
