/usr/share/gtk-doc/html/gtksourceview-3.0/GtkSourceCompletionInfo.html is in libgtksourceview-3.0-doc 3.24.7-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GtkSourceCompletionInfo: GtkSourceView 3 Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="GtkSourceView 3 Reference Manual">
<link rel="up" href="ch04.html" title="Completion">
<link rel="prev" href="GtkSourceCompletionContext.html" title="GtkSourceCompletionContext">
<link rel="next" href="GtkSourceCompletionItem.html" title="GtkSourceCompletionItem">
<meta name="generator" content="GTK-Doc V1.27 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</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="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span>
<a href="#GtkSourceCompletionInfo.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#GtkSourceCompletionInfo.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces"> <span class="dim">|</span>
<a href="#GtkSourceCompletionInfo.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span><span id="nav_signals"> <span class="dim">|</span>
<a href="#GtkSourceCompletionInfo.signals" class="shortcut">Signals</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="ch04.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="GtkSourceCompletionContext.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="GtkSourceCompletionItem.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="GtkSourceCompletionInfo"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GtkSourceCompletionInfo.top_of_page"></a>GtkSourceCompletionInfo</span></h2>
<p>GtkSourceCompletionInfo — Calltips object</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="GtkSourceCompletionInfo.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<a class="link" href="GtkSourceCompletionInfo.html" title="GtkSourceCompletionInfo"><span class="returnvalue">GtkSourceCompletionInfo</span></a> *
</td>
<td class="function_name">
<a class="link" href="GtkSourceCompletionInfo.html#gtk-source-completion-info-new" title="gtk_source_completion_info_new ()">gtk_source_completion_info_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="GtkSourceCompletionInfo.html#gtk-source-completion-info-move-to-iter" title="gtk_source_completion_info_move_to_iter ()">gtk_source_completion_info_move_to_iter</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="GtkSourceCompletionInfo.html#gtk-source-completion-info-set-widget" title="gtk_source_completion_info_set_widget ()">gtk_source_completion_info_set_widget</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="../gtk3/GtkWidget.html#GtkWidget-struct"><span class="returnvalue">GtkWidget</span></a> *
</td>
<td class="function_name">
<a class="link" href="GtkSourceCompletionInfo.html#gtk-source-completion-info-get-widget" title="gtk_source_completion_info_get_widget ()">gtk_source_completion_info_get_widget</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GtkSourceCompletionInfo.signals"></a><h2>Signals</h2>
<div class="informaltable"><table class="informaltable" border="0">
<colgroup>
<col width="150px" class="signals_return">
<col width="300px" class="signals_name">
<col width="200px" class="signals_flags">
</colgroup>
<tbody><tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="GtkSourceCompletionInfo.html#GtkSourceCompletionInfo-before-show" title="The “before-show” signal">before-show</a></td>
<td class="signal_flags"><a href="../gobject/gobject-Signals.html#G-SIGNAL-ACTION:CAPS">Action</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GtkSourceCompletionInfo.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody><tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="GtkSourceCompletionInfo.html#GtkSourceCompletionInfo-struct" title="GtkSourceCompletionInfo">GtkSourceCompletionInfo</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GtkSourceCompletionInfo.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> <a href="../gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a>
<span class="lineart">╰──</span> <a href="../gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
<span class="lineart">╰──</span> <a href="../gtk3/GtkWidget.html#GtkWidget-struct">GtkWidget</a>
<span class="lineart">╰──</span> <a href="../gtk3/GtkContainer.html#GtkContainer-struct">GtkContainer</a>
<span class="lineart">╰──</span> <a href="../gtk3/GtkBin.html#GtkBin-struct">GtkBin</a>
<span class="lineart">╰──</span> <a href="../gtk3/GtkWindow.html#GtkWindow-struct">GtkWindow</a>
<span class="lineart">╰──</span> GtkSourceCompletionInfo
</pre>
</div>
<div class="refsect1">
<a name="GtkSourceCompletionInfo.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
GtkSourceCompletionInfo implements
AtkImplementorIface and <a href="../gtk3/GtkBuildable.html#GtkBuildable-struct">GtkBuildable</a>.</p>
</div>
<div class="refsect1">
<a name="GtkSourceCompletionInfo.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include <gtksourceview/gtksource.h>
</pre>
</div>
<div class="refsect1">
<a name="GtkSourceCompletionInfo.description"></a><h2>Description</h2>
<p>This object can be used to show a calltip or help for the
current completion proposal.</p>
<p>The info window has always the same size as the natural size of its child
widget, added with <a href="../gtk3/GtkContainer.html#gtk-container-add"><code class="function">gtk_container_add()</code></a>. If you want a fixed size instead, a
possibility is to use a scrolled window, as the following example
demonstrates.</p>
<div class="example">
<a name="id-1.3.5.4.9.4"></a><p class="title"><b>Example 1. Fixed size with a scrolled window.</b></p>
<div class="example-contents">
<table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
<tbody>
<tr>
<td class="listing_lines" align="right"><pre>1
2
3
4
5
6
7</pre></td>
<td class="listing_code"><pre class="programlisting">GtkSourceCompletionInfo <span class="gtkdoc opt">*</span>info<span class="gtkdoc opt">;</span>
GtkWidget <span class="gtkdoc opt">*</span>your_widget<span class="gtkdoc opt">;</span>
GtkWidget <span class="gtkdoc opt">*</span>scrolled_window <span class="gtkdoc opt">=</span> <span class="function"><a href="../gtk3/GtkScrolledWindow.html#gtk-scrolled-window-new">gtk_scrolled_window_new</a></span> <span class="gtkdoc opt">(</span>NULL<span class="gtkdoc opt">,</span> NULL<span class="gtkdoc opt">);</span>
<span class="function"><a href="../gtk3/GtkWidget.html#gtk-widget-set-size-request">gtk_widget_set_size_request</a></span> <span class="gtkdoc opt">(</span>scrolled_window<span class="gtkdoc opt">,</span> <span class="number">300</span><span class="gtkdoc opt">,</span> <span class="number">200</span><span class="gtkdoc opt">);</span>
<span class="function"><a href="../gtk3/GtkContainer.html#gtk-container-add">gtk_container_add</a></span> <span class="gtkdoc opt">(</span><span class="function">GTK_CONTAINER</span> <span class="gtkdoc opt">(</span>scrolled_window<span class="gtkdoc opt">),</span> your_widget<span class="gtkdoc opt">);</span>
<span class="function"><a href="../gtk3/GtkContainer.html#gtk-container-add">gtk_container_add</a></span> <span class="gtkdoc opt">(</span><span class="function">GTK_CONTAINER</span> <span class="gtkdoc opt">(</span>info<span class="gtkdoc opt">),</span> scrolled_window<span class="gtkdoc opt">);</span></pre></td>
</tr>
</tbody>
</table>
</div>
</div>
<br class="example-break"><p>If the calltip is displayed on top of a certain widget, say a <a href="../gtk3/GtkTextView.html#GtkTextView-struct"><span class="type">GtkTextView</span></a>,
you should attach the calltip window to the <a href="../gtk3/GtkTextView.html#GtkTextView-struct"><span class="type">GtkTextView</span></a> with
<a href="../gtk3/GtkWindow.html#gtk-window-set-attached-to"><code class="function">gtk_window_set_attached_to()</code></a>. By doing this, the calltip will be hidden when
the <a href="../gtk3/GtkWidget.html#GtkWidget-focus-out-event"><span class="type">“focus-out-event”</span></a> signal is emitted by the <a href="../gtk3/GtkTextView.html#GtkTextView-struct"><span class="type">GtkTextView</span></a>. You
may also be interested by the <a href="../gtk3/GtkTextBuffer.html#GtkTextBuffer--cursor-position"><span class="type">“cursor-position”</span></a> property (when
its value is modified). If you use the <a class="link" href="GtkSourceCompletionInfo.html" title="GtkSourceCompletionInfo"><span class="type">GtkSourceCompletionInfo</span></a> through the
<a class="link" href="GtkSourceCompletion.html" title="GtkSourceCompletion"><span class="type">GtkSourceCompletion</span></a> machinery, you don't need to worry about this.</p>
</div>
<div class="refsect1">
<a name="GtkSourceCompletionInfo.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="gtk-source-completion-info-new"></a><h3>gtk_source_completion_info_new ()</h3>
<pre class="programlisting"><a class="link" href="GtkSourceCompletionInfo.html" title="GtkSourceCompletionInfo"><span class="returnvalue">GtkSourceCompletionInfo</span></a> *
gtk_source_completion_info_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<div class="refsect3">
<a name="gtk-source-completion-info-new.returns"></a><h4>Returns</h4>
<p> a new GtkSourceCompletionInfo.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gtk-source-completion-info-move-to-iter"></a><h3>gtk_source_completion_info_move_to_iter ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gtk_source_completion_info_move_to_iter
(<em class="parameter"><code><a class="link" href="GtkSourceCompletionInfo.html" title="GtkSourceCompletionInfo"><span class="type">GtkSourceCompletionInfo</span></a> *info</code></em>,
<em class="parameter"><code><a href="../gtk3/GtkTextView.html#GtkTextView-struct"><span class="type">GtkTextView</span></a> *view</code></em>,
<em class="parameter"><code><a href="../gtk3/GtkTextIter.html#GtkTextIter-struct"><span class="type">GtkTextIter</span></a> *iter</code></em>);</pre>
<p>Moves the <a class="link" href="GtkSourceCompletionInfo.html" title="GtkSourceCompletionInfo"><span class="type">GtkSourceCompletionInfo</span></a> to <em class="parameter"><code>iter</code></em>
. If <em class="parameter"><code>iter</code></em>
is <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> <em class="parameter"><code>info</code></em>
is
moved to the cursor position. Moving will respect the <a href="../gdk3/gdk3-Windows.html#GdkGravity"><span class="type">GdkGravity</span></a> setting
of the info window and will ensure the line at <em class="parameter"><code>iter</code></em>
is not occluded by
the window.</p>
<div class="refsect3">
<a name="gtk-source-completion-info-move-to-iter.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>info</p></td>
<td class="parameter_description"><p>a <a class="link" href="GtkSourceCompletionInfo.html" title="GtkSourceCompletionInfo"><span class="type">GtkSourceCompletionInfo</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>view</p></td>
<td class="parameter_description"><p>a <a href="../gtk3/GtkTextView.html#GtkTextView-struct"><span class="type">GtkTextView</span></a> on which the info window should be positioned.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>iter</p></td>
<td class="parameter_description"><p>a <a href="../gtk3/GtkTextIter.html#GtkTextIter-struct"><span class="type">GtkTextIter</span></a>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gtk-source-completion-info-set-widget"></a><h3>gtk_source_completion_info_set_widget ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gtk_source_completion_info_set_widget (<em class="parameter"><code><a class="link" href="GtkSourceCompletionInfo.html" title="GtkSourceCompletionInfo"><span class="type">GtkSourceCompletionInfo</span></a> *info</code></em>,
<em class="parameter"><code><a href="../gtk3/GtkWidget.html#GtkWidget-struct"><span class="type">GtkWidget</span></a> *widget</code></em>);</pre>
<div class="warning">
<p><code class="literal">gtk_source_completion_info_set_widget</code> has been deprecated since version 3.8 and should not be used in newly-written code.</p>
<p>Use <a href="../gtk3/GtkContainer.html#gtk-container-add"><code class="function">gtk_container_add()</code></a> instead. If there is already a child
widget, remove it with <a href="../gtk3/GtkContainer.html#gtk-container-remove"><code class="function">gtk_container_remove()</code></a>.</p>
</div>
<p>Sets the content widget of the info window. See that the previous widget will
lose a reference and it can be destroyed, so if you do not want this to
happen you must use <a href="../gobject/gobject-The-Base-Object-Type.html#g-object-ref"><code class="function">g_object_ref()</code></a> before calling this method.</p>
<div class="refsect3">
<a name="gtk-source-completion-info-set-widget.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>info</p></td>
<td class="parameter_description"><p>a <a class="link" href="GtkSourceCompletionInfo.html" title="GtkSourceCompletionInfo"><span class="type">GtkSourceCompletionInfo</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>widget</p></td>
<td class="parameter_description"><p>a <a href="../gtk3/GtkWidget.html#GtkWidget-struct"><span class="type">GtkWidget</span></a>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gtk-source-completion-info-get-widget"></a><h3>gtk_source_completion_info_get_widget ()</h3>
<pre class="programlisting"><a href="../gtk3/GtkWidget.html#GtkWidget-struct"><span class="returnvalue">GtkWidget</span></a> *
gtk_source_completion_info_get_widget (<em class="parameter"><code><a class="link" href="GtkSourceCompletionInfo.html" title="GtkSourceCompletionInfo"><span class="type">GtkSourceCompletionInfo</span></a> *info</code></em>);</pre>
<div class="warning">
<p><code class="literal">gtk_source_completion_info_get_widget</code> has been deprecated since version 3.8 and should not be used in newly-written code.</p>
<p>Use <a href="../gtk3/GtkBin.html#gtk-bin-get-child"><code class="function">gtk_bin_get_child()</code></a> instead.</p>
</div>
<p>Get the current content widget.</p>
<div class="refsect3">
<a name="gtk-source-completion-info-get-widget.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>info</p></td>
<td class="parameter_description"><p>a <a class="link" href="GtkSourceCompletionInfo.html" title="GtkSourceCompletionInfo"><span class="type">GtkSourceCompletionInfo</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gtk-source-completion-info-get-widget.returns"></a><h4>Returns</h4>
<p>The current content widget. </p>
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
</div>
</div>
</div>
<div class="refsect1">
<a name="GtkSourceCompletionInfo.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="GtkSourceCompletionInfo-struct"></a><h3>GtkSourceCompletionInfo</h3>
<pre class="programlisting">typedef struct _GtkSourceCompletionInfo GtkSourceCompletionInfo;</pre>
</div>
</div>
<div class="refsect1">
<a name="GtkSourceCompletionInfo.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2">
<a name="GtkSourceCompletionInfo-before-show"></a><h3>The <code class="literal">“before-show”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="GtkSourceCompletionInfo.html" title="GtkSourceCompletionInfo"><span class="type">GtkSourceCompletionInfo</span></a> *info,
<a href="../glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)</pre>
<p>This signal is emitted before any "show" management. You can connect
to this signal if you want to change some properties or position
before the real "show".</p>
<div class="warning">
<p><code class="literal">GtkSourceCompletionInfo::before-show</code> has been deprecated since version 3.10 and should not be used in newly-written code.</p>
<p>This signal should not be used.</p>
</div>
<div class="refsect3">
<a name="GtkSourceCompletionInfo-before-show.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>info</p></td>
<td class="parameter_description"><p>The <a class="link" href="GtkSourceCompletionInfo.html" title="GtkSourceCompletionInfo"><span class="type">GtkSourceCompletionInfo</span></a> who emits the signal</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p>Flags: <a href="../gobject/gobject-Signals.html#G-SIGNAL-ACTION:CAPS">Action</a></p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.27</div>
</body>
</html>
|