← Back to branch summary

~ubuntu-branches/ubuntu/utopic/anjuta/utopic-proposed

« back to all changes in this revision

Viewing changes to manuals/reference/libanjuta/html/libanjuta-IAnjutaEditorTip.html

  • Committer: Package Import Robot
  • Author(s): Andreas Henriksson, Jackson Doak
  • Date: 2014-07-12 15:17:39 UTC
  • mfrom: (1.4.14)
  • Revision ID: package-import@ubuntu.com-20140712151739-p9xy0ntlgbpm2nxq
Tags: 2:3.12.0-1
* Team upload.

[ Jackson Doak ]
* New upstream release
* Drop 03_valac_0.22.patch, fixed upstream\
* debian/control:
  - Bump b-dep version on libgtk-3-dev (>= 3.6.0), libglib2.0-dev (>= 2.34.0)
  - Bump stardards-version to 3.9.5. No changes.

Show diffs side-by-side

added added

removed removed

Lines of Context:
manuals/reference/libanjuta/html/libanjuta-IAnjutaEditorTip.html
 
1
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
 
2
<html>
 
3
<head>
 
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
 
5
<title>IAnjutaEditorTip</title>
 
6
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
 
7
<link rel="home" href="index.html" title="Anjuta Developers Reference Manual">
 
8
<link rel="up" href="plugin-interfaces.html" title="Plugin interfaces">
 
9
<link rel="prev" href="libanjuta-IAnjutaEditorSelection.html" title="IAnjutaEditorSelection">
 
10
<link rel="next" href="libanjuta-IAnjutaEditorView.html" title="IAnjutaEditorView">
 
11
<meta name="generator" content="GTK-Doc V1.19 (XML mode)">
 
12
<link rel="stylesheet" href="style.css" type="text/css">
 
13
</head>
 
14
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
 
15
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
 
16
<tr valign="middle">
 
17
<td><a accesskey="p" href="libanjuta-IAnjutaEditorSelection.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
 
18
<td><a accesskey="u" href="plugin-interfaces.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
 
19
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
 
20
<th width="100%" align="center">Anjuta Developers Reference Manual</th>
 
21
<td><a accesskey="n" href="libanjuta-IAnjutaEditorView.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
 
22
</tr>
 
23
<tr><td colspan="5" class="shortcuts">
 
24
<a href="#libanjuta-IAnjutaEditorTip.synopsis" class="shortcut">Top</a>
 
25
                   | 
 
26
                  <a href="#libanjuta-IAnjutaEditorTip.description" class="shortcut">Description</a>
 
27
</td></tr>
 
28
</table>
 
29
<div class="refentry">
 
30
<a name="libanjuta-IAnjutaEditorTip"></a><div class="titlepage"></div>
 
31
<div class="refnamediv"><table width="100%"><tr>
 
32
<td valign="top">
 
33
<h2><span class="refentrytitle"><a name="libanjuta-IAnjutaEditorTip.top_of_page"></a>IAnjutaEditorTip</span></h2>
 
34
<p>IAnjutaEditorTip — Editor call tips assistance framework</p>
 
35
</td>
 
36
<td valign="top" align="right"></td>
 
37
</tr></table></div>
 
38
<div class="refsect1">
 
39
<a name="libanjuta-IAnjutaEditorTip.stability-level"></a><h2>Stability Level</h2>
 
40
Unstable, unless otherwise indicated
 
41
</div>
 
42
<div class="refsynopsisdiv">
 
43
<a name="libanjuta-IAnjutaEditorTip.synopsis"></a><h2>Synopsis</h2>
 
44
<pre class="synopsis">
 
45
#include &lt;libanjuta/interfaces/ianjuta-editor-tip.h&gt;
 
46
 
 
47
#define             <a class="link" href="libanjuta-IAnjutaEditorTip.html#IANJUTA-EDITOR-TIP-ERROR:CAPS" title="IANJUTA_EDITOR_TIP_ERROR">IANJUTA_EDITOR_TIP_ERROR</a>
 
48
struct              <a class="link" href="libanjuta-IAnjutaEditorTip.html#IAnjutaEditorTipIface" title="struct IAnjutaEditorTipIface">IAnjutaEditorTipIface</a>;
 
49
<a href="http://library.gnome.org/devel/glib/unstable/glib-Quarks.html#GQuark"><span class="returnvalue">GQuark</span></a>              <a class="link" href="libanjuta-IAnjutaEditorTip.html#ianjuta-editor-tip-error-quark" title="ianjuta_editor_tip_error_quark ()">ianjuta_editor_tip_error_quark</a>      (<em class="parameter"><code><span class="type">void</span></code></em>);
 
50
<span class="returnvalue">void</span>                <a class="link" href="libanjuta-IAnjutaEditorTip.html#ianjuta-editor-tip-cancel" title="ianjuta_editor_tip_cancel ()">ianjuta_editor_tip_cancel</a>           (<em class="parameter"><code><span class="type">IAnjutaEditorTip</span> *obj</code></em>,
 
51
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **err</code></em>);
 
52
<span class="returnvalue">void</span>                <a class="link" href="libanjuta-IAnjutaEditorTip.html#ianjuta-editor-tip-show" title="ianjuta_editor_tip_show ()">ianjuta_editor_tip_show</a>             (<em class="parameter"><code><span class="type">IAnjutaEditorTip</span> *obj</code></em>,
 
53
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="type">GList</span></a> *tips</code></em>,
 
54
                                                         <em class="parameter"><code><span class="type">IAnjutaIterable</span> *position</code></em>,
 
55
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **err</code></em>);
 
56
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="libanjuta-IAnjutaEditorTip.html#ianjuta-editor-tip-visible" title="ianjuta_editor_tip_visible ()">ianjuta_editor_tip_visible</a>          (<em class="parameter"><code><span class="type">IAnjutaEditorTip</span> *obj</code></em>,
 
57
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **err</code></em>);
 
58
</pre>
 
59
</div>
 
60
<div class="refsect1">
 
61
<a name="libanjuta-IAnjutaEditorTip.description"></a><h2>Description</h2>
 
62
</div>
 
63
<div class="refsect1">
 
64
<a name="libanjuta-IAnjutaEditorTip.details"></a><h2>Details</h2>
 
65
<div class="refsect2">
 
66
<a name="IANJUTA-EDITOR-TIP-ERROR:CAPS"></a><h3>IANJUTA_EDITOR_TIP_ERROR</h3>
 
67
<pre class="programlisting">#define IANJUTA_EDITOR_TIP_ERROR ianjuta_editor_tip_error_quark()
 
68
</pre>
 
69
<p>
 
70
</p>
 
71
</div>
 
72
<hr>
 
73
<div class="refsect2">
 
74
<a name="IAnjutaEditorTipIface"></a><h3>struct IAnjutaEditorTipIface</h3>
 
75
<pre class="programlisting">struct IAnjutaEditorTipIface {
 
76
        IAnjutaEditorIface g_iface;
 
77
        
 
78
 
 
79
        void (*cancel) (IAnjutaEditorTip *obj, GError **err);
 
80
        void (*show) (IAnjutaEditorTip *obj, GList* tips,  IAnjutaIterable *position, GError **err);
 
81
        gboolean (*visible) (IAnjutaEditorTip *obj, GError **err);
 
82
};
 
83
</pre>
 
84
<p>
 
85
</p>
 
86
</div>
 
87
<hr>
 
88
<div class="refsect2">
 
89
<a name="ianjuta-editor-tip-error-quark"></a><h3>ianjuta_editor_tip_error_quark ()</h3>
 
90
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Quarks.html#GQuark"><span class="returnvalue">GQuark</span></a>              ianjuta_editor_tip_error_quark      (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
 
91
<p>
 
92
</p>
 
93
</div>
 
94
<hr>
 
95
<div class="refsect2">
 
96
<a name="ianjuta-editor-tip-cancel"></a><h3>ianjuta_editor_tip_cancel ()</h3>
 
97
<pre class="programlisting"><span class="returnvalue">void</span>                ianjuta_editor_tip_cancel           (<em class="parameter"><code><span class="type">IAnjutaEditorTip</span> *obj</code></em>,
 
98
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **err</code></em>);</pre>
 
99
<p>
 
100
Cancels the last shown tooltip
 
101
</p>
 
102
<div class="variablelist"><table border="0" class="variablelist">
 
103
<colgroup>
 
104
<col align="left" valign="top">
 
105
<col>
 
106
</colgroup>
 
107
<tbody>
 
108
<tr>
 
109
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
 
110
<td>Self</td>
 
111
</tr>
 
112
<tr>
 
113
<td><p><span class="term"><em class="parameter"><code>err</code></em> :</span></p></td>
 
114
<td>Error propagation and reporting</td>
 
115
</tr>
 
116
</tbody>
 
117
</table></div>
 
118
</div>
 
119
<hr>
 
120
<div class="refsect2">
 
121
<a name="ianjuta-editor-tip-show"></a><h3>ianjuta_editor_tip_show ()</h3>
 
122
<pre class="programlisting"><span class="returnvalue">void</span>                ianjuta_editor_tip_show             (<em class="parameter"><code><span class="type">IAnjutaEditorTip</span> *obj</code></em>,
 
123
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="type">GList</span></a> *tips</code></em>,
 
124
                                                         <em class="parameter"><code><span class="type">IAnjutaIterable</span> *position</code></em>,
 
125
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **err</code></em>);</pre>
 
126
<p>
 
127
Show tips showing more information on current context. No user feedback
 
128
is required when tips are shown. <em class="parameter"><code>position</code></em> indicates
 
129
the position before which is the known context and after which are
 
130
the suggestions. Usually the editor would use this to
 
131
align the choices displayed such that the carat is just at this
 
132
position when the choices are displayed.
 
133
</p>
 
134
<div class="variablelist"><table border="0" class="variablelist">
 
135
<colgroup>
 
136
<col align="left" valign="top">
 
137
<col>
 
138
</colgroup>
 
139
<tbody>
 
140
<tr>
 
141
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
 
142
<td>Self</td>
 
143
</tr>
 
144
<tr>
 
145
<td><p><span class="term"><em class="parameter"><code>tips</code></em> :</span></p></td>
 
146
<td>list of alternative tips. <span class="annotation">[<a href="http://foldoc.org/element-type"><span class="acronym">element-type</span></a> utf8]</span>
 
147
</td>
 
148
</tr>
 
149
<tr>
 
150
<td><p><span class="term"><em class="parameter"><code>position</code></em> :</span></p></td>
 
151
<td>Tip position.</td>
 
152
</tr>
 
153
<tr>
 
154
<td><p><span class="term"><em class="parameter"><code>err</code></em> :</span></p></td>
 
155
<td>Error propagation and reporting</td>
 
156
</tr>
 
157
</tbody>
 
158
</table></div>
 
159
</div>
 
160
<hr>
 
161
<div class="refsect2">
 
162
<a name="ianjuta-editor-tip-visible"></a><h3>ianjuta_editor_tip_visible ()</h3>
 
163
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            ianjuta_editor_tip_visible          (<em class="parameter"><code><span class="type">IAnjutaEditorTip</span> *obj</code></em>,
 
164
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **err</code></em>);</pre>
 
165
<div class="variablelist"><table border="0" class="variablelist">
 
166
<colgroup>
 
167
<col align="left" valign="top">
 
168
<col>
 
169
</colgroup>
 
170
<tbody>
 
171
<tr>
 
172
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
 
173
<td>Self</td>
 
174
</tr>
 
175
<tr>
 
176
<td><p><span class="term"><em class="parameter"><code>err</code></em> :</span></p></td>
 
177
<td>Error propagation and reporting</td>
 
178
</tr>
 
179
<tr>
 
180
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
181
<td>whether a tooltip is crrently shown</td>
 
182
</tr>
 
183
</tbody>
 
184
</table></div>
 
185
</div>
 
186
</div>
 
187
</div>
 
188
<div class="footer">
 
189
<hr>
 
190
          Generated by GTK-Doc V1.19</div>
 
191
</body>
 
192
</html>
 
 
b'\\ No newline at end of file'