File: classGFC_1_1Gtk_1_1TextChildAnchor.html

package info (click to toggle)
gfcui 2.3.1-2
  • links: PTS
  • area: main
  • in suites: sarge
  • size: 43,420 kB
  • ctags: 18,023
  • sloc: cpp: 53,967; sh: 31,555; makefile: 1,322; perl: 108
file content (236 lines) | stat: -rw-r--r-- 12,023 bytes parent folder | download | duplicates (3)
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
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
<!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>&nbsp; |&nbsp; <a
 href="../html/namespaces.html">Namespace List</a>&nbsp; |&nbsp; <a
 href="classes.html">Alphabetical List</a>&nbsp; |&nbsp; <a
 href="../html/annotated.html">Class List</a>&nbsp; |&nbsp; <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::TextChildAnchor Class Reference</h1>A GtkTextChildAnchor C++ wrapper class.  
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="textbuffer_8hh-source.html">gfc/gtk/textbuffer.hh</a>&gt;</code>
<p>
<p>Inheritance diagram for GFC::Gtk::TextChildAnchor:
<p><center><img src="classGFC_1_1Gtk_1_1TextChildAnchor.png" usemap="#GFC::Gtk::TextChildAnchor_map" border="0" alt=""></center>
<map name="GFC::Gtk::TextChildAnchor_map">
<area doxygen="gfccore.tag:" href="classGFC_1_1G_1_1Object.html" alt="GFC::G::Object" shape="rect" coords="0,112,162,136">
<area doxygen="gfccore.tag:" href="classGFC_1_1G_1_1TypeInstance.html" alt="GFC::G::TypeInstance" shape="rect" coords="0,56,162,80">
<area doxygen="gfccore.tag:" href="classGFC_1_1Trackable.html" alt="GFC::Trackable" shape="rect" coords="0,0,162,24">
</map>
<a href="classGFC_1_1Gtk_1_1TextChildAnchor-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="el" href="classGFC_1_1Gtk_1_1TextChildAnchor.html#z863_0">TextChildAnchor</a> ()
<dl class="el"><dd class="mdescRight">Construct a new anchor.  <a href="#z863_0"></a><br></dl><li><a class="anchor" name="z863_1" doxytag="GFC::Gtk::TextChildAnchor::~TextChildAnchor" ></a>
virtual <a class="el" href="classGFC_1_1Gtk_1_1TextChildAnchor.html#z863_1">~TextChildAnchor</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="z864_0" doxytag="GFC::Gtk::TextChildAnchor::gtk_text_child_anchor" ></a>
GtkTextChildAnchor * <a class="el" href="classGFC_1_1Gtk_1_1TextChildAnchor.html#z864_0">gtk_text_child_anchor</a> () const
<dl class="el"><dd class="mdescRight">Get a pointer to the GtkTextChildAnchor structure. <br></dl><li><a class="anchor" name="z864_1" doxytag="GFC::Gtk::TextChildAnchor::operator GtkTextChildAnchor *" ></a>
<a class="el" href="classGFC_1_1Gtk_1_1TextChildAnchor.html#z864_1">operator GtkTextChildAnchor *</a> () const
<dl class="el"><dd class="mdescRight">Conversion operator; safely converts a <a class="el" href="classGFC_1_1Gtk_1_1TextChildAnchor.html">TextChildAnchor</a> to a GtkTextChildAnchor pointer. <br></dl><li>bool <a class="el" href="classGFC_1_1Gtk_1_1TextChildAnchor.html#z864_2">get_widgets</a> (std::vector&lt; <a class="el" href="classGFC_1_1Gtk_1_1Widget.html">Widget</a> * &gt; &amp;widgets) const
<dl class="el"><dd class="mdescRight">Gets a list of all widgets anchored at this child anchor.  <a href="#z864_2"></a><br></dl><li>bool <a class="el" href="classGFC_1_1Gtk_1_1TextChildAnchor.html#z864_3">get_deleted</a> () const
<dl class="el"><dd class="mdescRight">Determines whether a child anchor has been deleted from the buffer.  <a href="#z864_3"></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_1TextChildAnchor.html#z862_0">TextChildAnchor</a> (GtkTextChildAnchor *anchor, bool <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1Trackable.html#z143_1">owns_reference</a>=true)
<dl class="el"><dd class="mdescRight">Construct a new <a class="el" href="classGFC_1_1Gtk_1_1TextChildAnchor.html">TextChildAnchor</a> from an existing GtkTextChildAnchor.  <a href="#z862_0"></a><br></dl></ul>
<hr><a name="_details"></a><h2>Detailed Description</h2>
A GtkTextChildAnchor C++ wrapper class. 
<p>
A <a class="el" href="classGFC_1_1Gtk_1_1TextChildAnchor.html">TextChildAnchor</a> is a spot in a <a class="el" href="classGFC_1_1Gtk_1_1TextBuffer.html">TextBuffer</a> where child widgets can be <em>anchored</em>, inserted inline, as if they were characters. The anchor can have multiple widgets anchored, to allow for multiple views. 
<p>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="z862_0" doxytag="GFC::Gtk::TextChildAnchor::TextChildAnchor" ></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::TextChildAnchor::TextChildAnchor           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">GtkTextChildAnchor *&nbsp;</td>
          <td class="mdname" nowrap> <em>anchor</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td></td>
          <td class="md" nowrap>bool&nbsp;</td>
          <td class="mdname" nowrap> <em>owns_reference</em> = <code>true</code></td>
        </tr>
        <tr>
          <td></td>
          <td class="md">)&nbsp;</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>
      &nbsp;
    </td>
    <td>

<p>
Construct a new <a class="el" href="classGFC_1_1Gtk_1_1TextChildAnchor.html">TextChildAnchor</a> from an existing GtkTextChildAnchor. 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td></td><td valign=top><em>anchor</em>&nbsp;</td><td>A pointer to a GtkTextChildAnchor. </td></tr>
    <tr><td></td><td valign=top><em>owns_reference</em>&nbsp;</td><td>Set false if the initial reference count is floating, set true if it's not.</td></tr>
  </table>
</dl>
<br>
The <em>anchor</em> can be a newly created GtkTextChildAnchor or an existing GtkTextChildAnchor (see <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1G_1_1Object.html#z68_0">G::Object::Object</a>).     </td>
  </tr>
</table>
<a class="anchor" name="z863_0" doxytag="GFC::Gtk::TextChildAnchor::TextChildAnchor" ></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::TextChildAnchor::TextChildAnchor           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Construct a new anchor. 
<p>
Constructs a new <a class="el" href="classGFC_1_1Gtk_1_1TextChildAnchor.html">TextChildAnchor</a>. Usually you would then insert it into a <a class="el" href="classGFC_1_1Gtk_1_1TextBuffer.html">TextBuffer</a> with <a class="el" href="classGFC_1_1Gtk_1_1TextBuffer.html#z869_25">Gtk::TextBuffer::insert_child_anchor()</a>. To perform the creation and insertion in one step, use the convenience method <a class="el" href="classGFC_1_1Gtk_1_1TextBuffer.html#z869_26">Gtk::TextBuffer::create_child_anchor()</a>.     </td>
  </tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="z864_3" doxytag="GFC::Gtk::TextChildAnchor::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::TextChildAnchor::get_deleted           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap> const</td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Determines whether a child anchor has been deleted from the buffer. 
<p>
<dl compact><dt><b>Returns:</b></dt><dd><em>true</em> if the child anchor has been deleted from its buffer.</dd></dl>
<br>
Keep in mind that the child anchor will be unreferenced when removed from the buffer, so you need to hold your own reference (with <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1G_1_1Object.html#z72_0">ref()</a>) if you plan to use this method - otherwise all deleted child anchors will also be finalized.     </td>
  </tr>
</table>
<a class="anchor" name="z864_2" doxytag="GFC::Gtk::TextChildAnchor::get_widgets" ></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::TextChildAnchor::get_widgets           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">std::vector&lt; <a class="el" href="classGFC_1_1Gtk_1_1Widget.html">Widget</a> * &gt; &amp;&nbsp;</td>
          <td class="mdname1" valign="top" nowrap> <em>widgets</em>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap> const</td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Gets a list of all widgets anchored at this child anchor. 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td></td><td valign=top><em>widgets</em>&nbsp;</td><td>A reference to a vector of Widget* to hold the list of widgets. </td></tr>
  </table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd><em>true</em> if the vector contains any widgets. </dd></dl>
    </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>