~ubuntu-branches/ubuntu/precise/gedit/precise

« back to all changes in this revision

Viewing changes to docs/reference/html/gedit-gedit-view.html

  • Committer: Bazaar Package Importer
  • Author(s): Sebastien Bacher
  • Date: 2010-04-14 16:41:13 UTC
  • mfrom: (1.1.78 upstream)
  • Revision ID: james.westby@ubuntu.com-20100414164113-0xgl3u73pcs0ngbc
Tags: 2.30.0git20100413-0ubuntu1
* Updating to git snaptshot since 2.30.1 will be after lucid
* debian/patches/90_autoconf.patch:
  - new version update

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
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>GeditView</title>
 
6
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
 
7
<link rel="home" href="index.html" title="gedit Reference Manual">
 
8
<link rel="up" href="ch01.html" title="gedit">
 
9
<link rel="prev" href="gedit-gedit-tab.html" title="GeditTab">
 
10
<link rel="next" href="gedit-gedit-window.html" title="GeditWindow">
 
11
<meta name="generator" content="GTK-Doc V1.14 (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="gedit-gedit-tab.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
 
18
<td><a accesskey="u" href="ch01.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">gedit Reference Manual</th>
 
21
<td><a accesskey="n" href="gedit-gedit-window.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="#gedit-gedit-view.synopsis" class="shortcut">Top</a>
 
25
                   | 
 
26
                  <a href="#gedit-gedit-view.description" class="shortcut">Description</a>
 
27
                   | 
 
28
                  <a href="#gedit-gedit-view.object-hierarchy" class="shortcut">Object Hierarchy</a>
 
29
                   | 
 
30
                  <a href="#gedit-gedit-view.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
 
31
                   | 
 
32
                  <a href="#gedit-gedit-view.signals" class="shortcut">Signals</a>
 
33
</td></tr>
 
34
</table>
 
35
<div class="refentry" title="GeditView">
 
36
<a name="gedit-gedit-view"></a><div class="titlepage"></div>
 
37
<div class="refnamediv"><table width="100%"><tr>
 
38
<td valign="top">
 
39
<h2><span class="refentrytitle"><a name="gedit-gedit-view.top_of_page"></a>GeditView</span></h2>
 
40
<p>GeditView</p>
 
41
</td>
 
42
<td valign="top" align="right"></td>
 
43
</tr></table></div>
 
44
<div class="refsynopsisdiv" title="Synopsis">
 
45
<a name="gedit-gedit-view.synopsis"></a><h2>Synopsis</h2>
 
46
<a name="GeditView"></a><pre class="synopsis">                    <a class="link" href="gedit-gedit-view.html#GeditViewPrivate" title="GeditViewPrivate">GeditViewPrivate</a>;
 
47
                    <a class="link" href="gedit-gedit-view.html#GeditView-struct" title="GeditView">GeditView</a>;
 
48
<a href="http://library.gnome.org/devel/gtk/unstable/GtkWidget.html"><span class="returnvalue">GtkWidget</span></a> *         <a class="link" href="gedit-gedit-view.html#gedit-view-new" title="gedit_view_new ()">gedit_view_new</a>                      (<em class="parameter"><code><a class="link" href="gedit-gedit-document.html#GeditDocument"><span class="type">GeditDocument</span></a> *doc</code></em>);
 
49
<span class="returnvalue">void</span>                <a class="link" href="gedit-gedit-view.html#gedit-view-cut-clipboard" title="gedit_view_cut_clipboard ()">gedit_view_cut_clipboard</a>            (<em class="parameter"><code><a class="link" href="gedit-gedit-view.html#GeditView"><span class="type">GeditView</span></a> *view</code></em>);
 
50
<span class="returnvalue">void</span>                <a class="link" href="gedit-gedit-view.html#gedit-view-copy-clipboard" title="gedit_view_copy_clipboard ()">gedit_view_copy_clipboard</a>           (<em class="parameter"><code><a class="link" href="gedit-gedit-view.html#GeditView"><span class="type">GeditView</span></a> *view</code></em>);
 
51
<span class="returnvalue">void</span>                <a class="link" href="gedit-gedit-view.html#gedit-view-paste-clipboard" title="gedit_view_paste_clipboard ()">gedit_view_paste_clipboard</a>          (<em class="parameter"><code><a class="link" href="gedit-gedit-view.html#GeditView"><span class="type">GeditView</span></a> *view</code></em>);
 
52
<span class="returnvalue">void</span>                <a class="link" href="gedit-gedit-view.html#gedit-view-delete-selection" title="gedit_view_delete_selection ()">gedit_view_delete_selection</a>         (<em class="parameter"><code><a class="link" href="gedit-gedit-view.html#GeditView"><span class="type">GeditView</span></a> *view</code></em>);
 
53
<span class="returnvalue">void</span>                <a class="link" href="gedit-gedit-view.html#gedit-view-select-all" title="gedit_view_select_all ()">gedit_view_select_all</a>               (<em class="parameter"><code><a class="link" href="gedit-gedit-view.html#GeditView"><span class="type">GeditView</span></a> *view</code></em>);
 
54
<span class="returnvalue">void</span>                <a class="link" href="gedit-gedit-view.html#gedit-view-scroll-to-cursor" title="gedit_view_scroll_to_cursor ()">gedit_view_scroll_to_cursor</a>         (<em class="parameter"><code><a class="link" href="gedit-gedit-view.html#GeditView"><span class="type">GeditView</span></a> *view</code></em>);
 
55
<span class="returnvalue">void</span>                <a class="link" href="gedit-gedit-view.html#gedit-view-set-font" title="gedit_view_set_font ()">gedit_view_set_font</a>                 (<em class="parameter"><code><a class="link" href="gedit-gedit-view.html#GeditView"><span class="type">GeditView</span></a> *view</code></em>,
 
56
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> def</code></em>,
 
57
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *font_name</code></em>);
 
58
</pre>
 
59
</div>
 
60
<div class="refsect1" title="Object Hierarchy">
 
61
<a name="gedit-gedit-view.object-hierarchy"></a><h2>Object Hierarchy</h2>
 
62
<pre class="synopsis">
 
63
  <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
 
64
   +----<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
 
65
         +----<a href="http://library.gnome.org/devel/gtk/unstable/GtkObject.html">GtkObject</a>
 
66
               +----<a href="http://library.gnome.org/devel/gtk/unstable/GtkWidget.html">GtkWidget</a>
 
67
                     +----<a href="http://library.gnome.org/devel/gtk/unstable/GtkContainer.html">GtkContainer</a>
 
68
                           +----<a href="http://library.gnome.org/devel/gtk/unstable/GtkTextView.html">GtkTextView</a>
 
69
                                 +----<a href="/usr/share/gtk-doc/html/gtksourceview-2.0/GtkSourceView.html">GtkSourceView</a>
 
70
                                       +----GeditView
 
71
</pre>
 
72
</div>
 
73
<div class="refsect1" title="Implemented Interfaces">
 
74
<a name="gedit-gedit-view.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
 
75
<p>
 
76
GeditView implements
 
77
 AtkImplementorIface and  <a href="http://library.gnome.org/devel/gtk/unstable/gtk-gtkbuildable.html#GtkBuildable">GtkBuildable</a>.</p>
 
78
</div>
 
79
<div class="refsect1" title="Signals">
 
80
<a name="gedit-gedit-view.signals"></a><h2>Signals</h2>
 
81
<pre class="synopsis">
 
82
  "<a class="link" href="gedit-gedit-view.html#GeditView-drop-uris" title='The "drop-uris" signal'>drop-uris</a>"                                      : Run Last / Action
 
83
  "<a class="link" href="gedit-gedit-view.html#GeditView-reset-searched-text" title='The "reset-searched-text" signal'>reset-searched-text</a>"                            : Run Last / Action
 
84
  "<a class="link" href="gedit-gedit-view.html#GeditView-start-interactive-goto-line" title='The "start-interactive-goto-line" signal'>start-interactive-goto-line</a>"                    : Run Last / Action
 
85
  "<a class="link" href="gedit-gedit-view.html#GeditView-start-interactive-search" title='The "start-interactive-search" signal'>start-interactive-search</a>"                       : Run Last / Action
 
86
</pre>
 
87
</div>
 
88
<div class="refsect1" title="Description">
 
89
<a name="gedit-gedit-view.description"></a><h2>Description</h2>
 
90
</div>
 
91
<div class="refsect1" title="Details">
 
92
<a name="gedit-gedit-view.details"></a><h2>Details</h2>
 
93
<div class="refsect2" title="GeditViewPrivate">
 
94
<a name="GeditViewPrivate"></a><h3>GeditViewPrivate</h3>
 
95
<pre class="programlisting">typedef struct _GeditViewPrivate GeditViewPrivate;</pre>
 
96
</div>
 
97
<hr>
 
98
<div class="refsect2" title="GeditView">
 
99
<a name="GeditView-struct"></a><h3>GeditView</h3>
 
100
<pre class="programlisting">typedef struct _GeditView GeditView;</pre>
 
101
</div>
 
102
<hr>
 
103
<div class="refsect2" title="gedit_view_new ()">
 
104
<a name="gedit-view-new"></a><h3>gedit_view_new ()</h3>
 
105
<pre class="programlisting"><a href="http://library.gnome.org/devel/gtk/unstable/GtkWidget.html"><span class="returnvalue">GtkWidget</span></a> *         gedit_view_new                      (<em class="parameter"><code><a class="link" href="gedit-gedit-document.html#GeditDocument"><span class="type">GeditDocument</span></a> *doc</code></em>);</pre>
 
106
<p>
 
107
Creates a new <a class="link" href="gedit-gedit-view.html#GeditView"><span class="type">GeditView</span></a> object displaying the <em class="parameter"><code>doc</code></em> document. 
 
108
<em class="parameter"><code>doc</code></em> cannot be NULL.
 
109
</p>
 
110
<div class="variablelist"><table border="0">
 
111
<col align="left" valign="top">
 
112
<tbody>
 
113
<tr>
 
114
<td><p><span class="term"><em class="parameter"><code>doc</code></em> :</span></p></td>
 
115
<td>a <a class="link" href="gedit-gedit-document.html#GeditDocument"><span class="type">GeditDocument</span></a>
 
116
</td>
 
117
</tr>
 
118
<tr>
 
119
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
120
<td> a new <a class="link" href="gedit-gedit-view.html#GeditView"><span class="type">GeditView</span></a>
 
121
</td>
 
122
</tr>
 
123
</tbody>
 
124
</table></div>
 
125
</div>
 
126
<hr>
 
127
<div class="refsect2" title="gedit_view_cut_clipboard ()">
 
128
<a name="gedit-view-cut-clipboard"></a><h3>gedit_view_cut_clipboard ()</h3>
 
129
<pre class="programlisting"><span class="returnvalue">void</span>                gedit_view_cut_clipboard            (<em class="parameter"><code><a class="link" href="gedit-gedit-view.html#GeditView"><span class="type">GeditView</span></a> *view</code></em>);</pre>
 
130
</div>
 
131
<hr>
 
132
<div class="refsect2" title="gedit_view_copy_clipboard ()">
 
133
<a name="gedit-view-copy-clipboard"></a><h3>gedit_view_copy_clipboard ()</h3>
 
134
<pre class="programlisting"><span class="returnvalue">void</span>                gedit_view_copy_clipboard           (<em class="parameter"><code><a class="link" href="gedit-gedit-view.html#GeditView"><span class="type">GeditView</span></a> *view</code></em>);</pre>
 
135
</div>
 
136
<hr>
 
137
<div class="refsect2" title="gedit_view_paste_clipboard ()">
 
138
<a name="gedit-view-paste-clipboard"></a><h3>gedit_view_paste_clipboard ()</h3>
 
139
<pre class="programlisting"><span class="returnvalue">void</span>                gedit_view_paste_clipboard          (<em class="parameter"><code><a class="link" href="gedit-gedit-view.html#GeditView"><span class="type">GeditView</span></a> *view</code></em>);</pre>
 
140
</div>
 
141
<hr>
 
142
<div class="refsect2" title="gedit_view_delete_selection ()">
 
143
<a name="gedit-view-delete-selection"></a><h3>gedit_view_delete_selection ()</h3>
 
144
<pre class="programlisting"><span class="returnvalue">void</span>                gedit_view_delete_selection         (<em class="parameter"><code><a class="link" href="gedit-gedit-view.html#GeditView"><span class="type">GeditView</span></a> *view</code></em>);</pre>
 
145
<p>
 
146
Deletes the text currently selected in the <a href="http://library.gnome.org/devel/gtk/unstable/GtkTextBuffer.html"><span class="type">GtkTextBuffer</span></a> associated
 
147
to the view and scroll to the cursor position.
 
148
</p>
 
149
<div class="variablelist"><table border="0">
 
150
<col align="left" valign="top">
 
151
<tbody><tr>
 
152
<td><p><span class="term"><em class="parameter"><code>view</code></em> :</span></p></td>
 
153
<td>a <a class="link" href="gedit-gedit-view.html#GeditView"><span class="type">GeditView</span></a>
 
154
</td>
 
155
</tr></tbody>
 
156
</table></div>
 
157
</div>
 
158
<hr>
 
159
<div class="refsect2" title="gedit_view_select_all ()">
 
160
<a name="gedit-view-select-all"></a><h3>gedit_view_select_all ()</h3>
 
161
<pre class="programlisting"><span class="returnvalue">void</span>                gedit_view_select_all               (<em class="parameter"><code><a class="link" href="gedit-gedit-view.html#GeditView"><span class="type">GeditView</span></a> *view</code></em>);</pre>
 
162
<p>
 
163
Selects all the text displayed in the <em class="parameter"><code>view</code></em>.
 
164
</p>
 
165
<div class="variablelist"><table border="0">
 
166
<col align="left" valign="top">
 
167
<tbody><tr>
 
168
<td><p><span class="term"><em class="parameter"><code>view</code></em> :</span></p></td>
 
169
<td>a <a class="link" href="gedit-gedit-view.html#GeditView"><span class="type">GeditView</span></a>
 
170
</td>
 
171
</tr></tbody>
 
172
</table></div>
 
173
</div>
 
174
<hr>
 
175
<div class="refsect2" title="gedit_view_scroll_to_cursor ()">
 
176
<a name="gedit-view-scroll-to-cursor"></a><h3>gedit_view_scroll_to_cursor ()</h3>
 
177
<pre class="programlisting"><span class="returnvalue">void</span>                gedit_view_scroll_to_cursor         (<em class="parameter"><code><a class="link" href="gedit-gedit-view.html#GeditView"><span class="type">GeditView</span></a> *view</code></em>);</pre>
 
178
<p>
 
179
Scrolls the <em class="parameter"><code>view</code></em> to the cursor position.
 
180
</p>
 
181
<div class="variablelist"><table border="0">
 
182
<col align="left" valign="top">
 
183
<tbody><tr>
 
184
<td><p><span class="term"><em class="parameter"><code>view</code></em> :</span></p></td>
 
185
<td>a <a class="link" href="gedit-gedit-view.html#GeditView"><span class="type">GeditView</span></a>
 
186
</td>
 
187
</tr></tbody>
 
188
</table></div>
 
189
</div>
 
190
<hr>
 
191
<div class="refsect2" title="gedit_view_set_font ()">
 
192
<a name="gedit-view-set-font"></a><h3>gedit_view_set_font ()</h3>
 
193
<pre class="programlisting"><span class="returnvalue">void</span>                gedit_view_set_font                 (<em class="parameter"><code><a class="link" href="gedit-gedit-view.html#GeditView"><span class="type">GeditView</span></a> *view</code></em>,
 
194
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> def</code></em>,
 
195
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *font_name</code></em>);</pre>
 
196
<p>
 
197
If <em class="parameter"><code>def</code></em> is <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><span class="type">TRUE</span></a>, resets the font of the <em class="parameter"><code>view</code></em> to the default font
 
198
otherwise sets it to <em class="parameter"><code>font_name</code></em>.
 
199
</p>
 
200
<div class="variablelist"><table border="0">
 
201
<col align="left" valign="top">
 
202
<tbody>
 
203
<tr>
 
204
<td><p><span class="term"><em class="parameter"><code>view</code></em> :</span></p></td>
 
205
<td>a <a class="link" href="gedit-gedit-view.html#GeditView"><span class="type">GeditView</span></a>
 
206
</td>
 
207
</tr>
 
208
<tr>
 
209
<td><p><span class="term"><em class="parameter"><code>def</code></em> :</span></p></td>
 
210
<td>whether to reset the default font
 
211
</td>
 
212
</tr>
 
213
<tr>
 
214
<td><p><span class="term"><em class="parameter"><code>font_name</code></em> :</span></p></td>
 
215
<td>the name of the font to use
 
216
</td>
 
217
</tr>
 
218
</tbody>
 
219
</table></div>
 
220
</div>
 
221
</div>
 
222
<div class="refsect1" title="Signal Details">
 
223
<a name="gedit-gedit-view.signal-details"></a><h2>Signal Details</h2>
 
224
<div class="refsect2" title='The "drop-uris" signal'>
 
225
<a name="GeditView-drop-uris"></a><h3>The <code class="literal">"drop-uris"</code> signal</h3>
 
226
<pre class="programlisting"><span class="returnvalue">void</span>                user_function                      (<a class="link" href="gedit-gedit-view.html#GeditView"><span class="type">GeditView</span></a> *geditview,
 
227
                                                        <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Boxed-Types.html#GStrv"><span class="type">GStrv</span></a>     *arg1,
 
228
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>   user_data)      : Run Last / Action</pre>
 
229
</div>
 
230
<hr>
 
231
<div class="refsect2" title='The "reset-searched-text" signal'>
 
232
<a name="GeditView-reset-searched-text"></a><h3>The <code class="literal">"reset-searched-text"</code> signal</h3>
 
233
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            user_function                      (<a class="link" href="gedit-gedit-view.html#GeditView"><span class="type">GeditView</span></a> *geditview,
 
234
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>   user_data)      : Run Last / Action</pre>
 
235
</div>
 
236
<hr>
 
237
<div class="refsect2" title='The "start-interactive-goto-line" signal'>
 
238
<a name="GeditView-start-interactive-goto-line"></a><h3>The <code class="literal">"start-interactive-goto-line"</code> signal</h3>
 
239
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            user_function                      (<a class="link" href="gedit-gedit-view.html#GeditView"><span class="type">GeditView</span></a> *geditview,
 
240
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>   user_data)      : Run Last / Action</pre>
 
241
</div>
 
242
<hr>
 
243
<div class="refsect2" title='The "start-interactive-search" signal'>
 
244
<a name="GeditView-start-interactive-search"></a><h3>The <code class="literal">"start-interactive-search"</code> signal</h3>
 
245
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            user_function                      (<a class="link" href="gedit-gedit-view.html#GeditView"><span class="type">GeditView</span></a> *geditview,
 
246
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>   user_data)      : Run Last / Action</pre>
 
247
</div>
 
248
</div>
 
249
</div>
 
250
<div class="footer">
 
251
<hr>
 
252
          Generated by GTK-Doc V1.14</div>
 
253
</body>
 
254
</html>
 
 
b'\\ No newline at end of file'