1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta content="text/html; charset=ISO-8859-1"
http-equiv="content-type">
<title>GTK+ Foundation Classes</title>
<link href="gfc.css" rel="stylesheet" type="text/css">
<meta content="The GFC Development Team" name="author">
<meta content="Core Library Reference Manual" name="description">
</head>
<body style="color: rgb(0, 0, 0); background-color: rgb(243, 244, 248);"
alink="#000099" link="#000099" vlink="#990099">
<table style="text-align: left; width: 1227px; height: 117px;"
border="0" cellpadding="0" cellspacing="0">
<tbody>
<tr>
<td
style="text-align: center; background-color: rgb(255, 255, 255); width: 220px; vertical-align: top;"><img
alt="GFC Logo" src="../images/gfc.png"
style="width: 207px; height: 92px;"></td>
<td
style="text-align: center; background-color: rgb(87, 107, 152); vertical-align: middle;"><img
alt="GFC Title Logo" src="../images/gfc-title.png"
style="width: 418px; height: 76px;"><br>
</td>
</tr>
<tr>
<td
style="text-align: center; background-color: rgb(65, 77, 104); vertical-align: middle;"><big><span
style="color: rgb(255, 255, 153); font-weight: bold;">Reference Manual</span></big><br>
</td>
<td
style="text-align: center; background-color: rgb(148, 164, 200); vertical-align: middle;"><small
style="font-family: helvetica,arial,sans-serif;"><a
href="../html/index.html">Main Page</a> | <a
href="../html/namespaces.html">Namespace List</a> | <a
href="classes.html">Alphabetical List</a> | <a
href="../html/annotated.html">Class List</a> | <a
href="../html/files.html">File List</a></small><br>
</td>
</tr>
</tbody>
</table>
<small> </small>
</body>
</html>
<!-- Generated by Doxygen 1.3.8 -->
<h1>GFC::Gtk::TextMark Class Reference</h1>A GtkTextMark C++ wrapper class.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="textbuffer_8hh-source.html">gfc/gtk/textbuffer.hh</a>></code>
<p>
<p>Inheritance diagram for GFC::Gtk::TextMark:
<p><center><img src="classGFC_1_1Gtk_1_1TextMark.png" usemap="#GFC::Gtk::TextMark_map" border="0" alt=""></center>
<map name="GFC::Gtk::TextMark_map">
<area doxygen="gfccore.tag:" href="classGFC_1_1G_1_1Object.html" alt="GFC::G::Object" shape="rect" coords="0,112,134,136">
<area doxygen="gfccore.tag:" href="classGFC_1_1G_1_1TypeInstance.html" alt="GFC::G::TypeInstance" shape="rect" coords="0,56,134,80">
<area doxygen="gfccore.tag:" href="classGFC_1_1Trackable.html" alt="GFC::Trackable" shape="rect" coords="0,0,134,24">
</map>
<a href="classGFC_1_1Gtk_1_1TextMark-members.html">List of all members.</a><h2>Public Member Functions</h2>
<tr><td colspan="2"><div class="groupHeader">Constructors</div></td></tr>
<ul>
<li><a class="anchor" name="z859_0" doxytag="GFC::Gtk::TextMark::~TextMark" ></a>
virtual <a class="el" href="classGFC_1_1Gtk_1_1TextMark.html#z859_0">~TextMark</a> ()
<dl class="el"><dd class="mdescRight">Destructor. <br></dl></ul>
<tr><td colspan="2"><div class="groupHeader">Accessors</div></td></tr>
<ul>
<li><a class="anchor" name="z860_0" doxytag="GFC::Gtk::TextMark::gtk_text_mark" ></a>
GtkTextMark * <a class="el" href="classGFC_1_1Gtk_1_1TextMark.html#z860_0">gtk_text_mark</a> () const
<dl class="el"><dd class="mdescRight">Get a pointer to the GtkTextMark structure. <br></dl><li><a class="anchor" name="z860_1" doxytag="GFC::Gtk::TextMark::operator GtkTextMark *" ></a>
<a class="el" href="classGFC_1_1Gtk_1_1TextMark.html#z860_1">operator GtkTextMark *</a> () const
<dl class="el"><dd class="mdescRight">Conversion operator; safely converts a <a class="el" href="classGFC_1_1Gtk_1_1TextMark.html">TextMark</a> to a GtkTextMark pointer. <br></dl><li><a class="anchor" name="z860_2" doxytag="GFC::Gtk::TextMark::get_visible" ></a>
bool <a class="el" href="classGFC_1_1Gtk_1_1TextMark.html#z860_2">get_visible</a> () const
<dl class="el"><dd class="mdescRight">Returns true if the mark is visible (that is, a cursor is displayed for it). <br></dl><li><a class="anchor" name="z860_3" doxytag="GFC::Gtk::TextMark::get_name" ></a>
<a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1String.html">String</a> <a class="el" href="classGFC_1_1Gtk_1_1TextMark.html#z860_3">get_name</a> () const
<dl class="el"><dd class="mdescRight">Returns the mark name; or a null <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1String.html">String</a> for anonymous marks. <br></dl><li>bool <a class="el" href="classGFC_1_1Gtk_1_1TextMark.html#z860_4">get_deleted</a> () const
<dl class="el"><dd class="mdescRight">Returns true if the mark has been removed from its buffer with delete_mark(). <a href="#z860_4"></a><br></dl><li><a class="anchor" name="z860_5" doxytag="GFC::Gtk::TextMark::get_buffer" ></a>
<a class="el" href="classGFC_1_1Gtk_1_1TextBuffer.html">TextBuffer</a> * <a class="el" href="classGFC_1_1Gtk_1_1TextMark.html#z860_5">get_buffer</a> () const
<dl class="el"><dd class="mdescRight">Gets the buffer this mark is located inside, or null if the mark is deleted. <br></dl><li><a class="anchor" name="z860_6" doxytag="GFC::Gtk::TextMark::get_left_gravity" ></a>
bool <a class="el" href="classGFC_1_1Gtk_1_1TextMark.html#z860_6">get_left_gravity</a> () const
<dl class="el"><dd class="mdescRight">Determines whether the mark has left gravity. <br></dl></ul>
<tr><td colspan="2"><div class="groupHeader">Methods</div></td></tr>
<ul>
<li>void <a class="el" href="classGFC_1_1Gtk_1_1TextMark.html#z861_0">set_visible</a> (bool setting)
<dl class="el"><dd class="mdescRight">Sets the visibility of mark; the insertion point is normally visible, that is, you can see it as a vertical bar. <a href="#z861_0"></a><br></dl></ul>
<h2>Protected Member Functions</h2>
<tr><td colspan="2"><div class="groupHeader">Constructors</div></td></tr>
<ul>
<li><a class="el" href="classGFC_1_1Gtk_1_1TextMark.html#z858_0">TextMark</a> (GtkTextMark *mark, bool <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1Trackable.html#z143_1">owns_reference</a>=false)
<dl class="el"><dd class="mdescRight">Construct a new <a class="el" href="classGFC_1_1Gtk_1_1TextMark.html">TextMark</a> from an existing GtkTextMark. <a href="#z858_0"></a><br></dl></ul>
<hr><a name="_details"></a><h2>Detailed Description</h2>
A GtkTextMark C++ wrapper class.
<p>
A <a class="el" href="classGFC_1_1Gtk_1_1TextMark.html">TextMark</a> is like a bookmark in a text buffer; it preserves a position in the text across text buffer modifications. You can convert the mark to an iterator using <a class="el" href="classGFC_1_1Gtk_1_1TextBuffer.html#z868_18">Gtk::TextBuffer::get_iter_at_mark()</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 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>
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 class="el" href="classGFC_1_1Gtk_1_1TextBuffer.html#z869_32">Gtk::TextBuffer::delete_mark()</a>. Once deleted from the buffer, a mark is essentially useless. Marks optionally have names. There are two marks built-in to <a class="el" href="classGFC_1_1Gtk_1_1TextBuffer.html">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>
TextMarks can optionally have names. These names can be convenient to avoid passing the <a class="el" href="classGFC_1_1Gtk_1_1TextMark.html">TextMark</a> object around. Marks are typically created using the <a class="el" href="classGFC_1_1Gtk_1_1TextBuffer.html#z869_28">Gtk::TextBuffer::create_mark()</a> method.
<p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="z858_0" doxytag="GFC::Gtk::TextMark::TextMark" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> GFC::Gtk::TextMark::TextMark </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">GtkTextMark * </td>
<td class="mdname" nowrap> <em>mark</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>bool </td>
<td class="mdname" nowrap> <em>owns_reference</em> = <code>false</code></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"><code> [explicit, protected]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Construct a new <a class="el" href="classGFC_1_1Gtk_1_1TextMark.html">TextMark</a> from an existing GtkTextMark.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>mark</em> </td><td>A pointer to a GtkTextMark. </td></tr>
<tr><td></td><td valign=top><em>owns_reference</em> </td><td>Set false if the initial reference count is floating, set true if it's not.</td></tr>
</table>
</dl>
<br>
The <em>mark</em> can be a newly created GtkTextMark or an existing GtkTextMark (see <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1G_1_1Object.html#z68_0">G::Object::Object</a>). </td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="z860_4" doxytag="GFC::Gtk::TextMark::get_deleted" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> bool GFC::Gtk::TextMark::get_deleted </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Returns true if the mark has been removed from its buffer with delete_mark().
<p>
Marks can't be used once deleted. </td>
</tr>
</table>
<a class="anchor" name="z861_0" doxytag="GFC::Gtk::TextMark::set_visible" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void GFC::Gtk::TextMark::set_visible </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">bool </td>
<td class="mdname1" valign="top" nowrap> <em>setting</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Sets the visibility of mark; the insertion point is normally visible, that is, you can see it as a vertical bar.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>setting</em> </td><td>The visibility of mark.</td></tr>
</table>
</dl>
<br>
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. </td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="textbuffer_8hh-source.html">textbuffer.hh</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Tue Aug 24 00:34:42 2004 for GFC-UI by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border=0 ></a> 1.3.8 </small></address>
</body>
</html>
|
