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
|
<?xml version="1.0" standalone="no"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<refentry id="class-nemo-python-info-provider">
<refmeta>
<refentrytitle>Nemo.InfoProvider</refentrytitle>
</refmeta>
<refnamediv>
<refname>Nemo.InfoProvider</refname>
<refpurpose>Nemo.InfoProvider Reference</refpurpose>
</refnamediv>
<!-- ******************************* -->
<!-- BEGIN OF SYNOPSIS -->
<!-- ******************************* -->
<refsect1>
<title>Synopsis</title>
<classsynopsis language="python">
<ooclass><classname>Nemo.InfoProvider</classname></ooclass>
<methodsynopsis language="python">
<methodname><link linkend="method-nemo-python-info-provider--update-file-info">update_file_info</link></methodname>
<methodparam><parameter role="keyword">file</parameter></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-nemo-python-info-provider--update-file-info-full">update_file_info_full</link></methodname>
<methodparam><parameter role="keyword">provider</parameter></methodparam>
<methodparam><parameter role="keyword">handle</parameter></methodparam>
<methodparam><parameter role="keyword">closure</parameter></methodparam>
<methodparam><parameter role="keyword">file</parameter></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-nemo-python-info-provider--cancel-update">cancel_update</link></methodname>
<methodparam><parameter role="keyword">provider</parameter></methodparam>
<methodparam><parameter role="keyword">handle</parameter></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-nemo-python-info-provider--update-complete-invoke">Nemo.info_provider_update_complete_invoke</link></methodname>
<methodparam><parameter role="keyword">provider</parameter></methodparam>
<methodparam><parameter role="keyword">handle</parameter></methodparam>
<methodparam><parameter role="keyword">closure</parameter></methodparam>
<methodparam><parameter role="keyword">result</parameter><initializer>Nemo.OperationResult.COMPLETE</initializer></methodparam>
</methodsynopsis>
</classsynopsis>
</refsect1>
<!-- ********************************** -->
<!-- BEGIN OF DESCRIPTION -->
<!-- ********************************** -->
<refsect1 id="description-info-provider">
<title>Description</title>
<para>
If subclassed, Nemo will call update_file_info(_full) to notify extensions of which
files are being viewed by the user. This gives extensions an opportunity to invoke actions on the files,
or to add emblems or attributes.
</para>
<example>
<title>Nemo.InfoProvider Example</title>
<programlisting>
from gi.repository import Nemo, GObject
class ColumnExtension(GObject.GObject, Nemo.InfoProvider):
def __init__(self):
pass
def update_file_info_full(self, provider, handle, closure, file):
gobject.timeout_add_seconds(3, self.update_cb, provider, handle, closure)
return Nemo.OperationResult.IN_PROGRESS
def update_cb(self, provider, handle, closure):
Nemo.info_provider_update_complete_invoke(closure, provider, handle, Nemo.OperationResult.FAILED)
</programlisting>
</example>
</refsect1>
<!-- ****************************** -->
<!-- BEGIN OF METHODS -->
<!-- ****************************** -->
<refsect1>
<title>Passive Methods</title>
<refsect2 id="method-nemo-python-info-provider--update-file-info">
<title>Nemo.InfoProvider.update_file_info</title>
<programlisting><methodsynopsis language="python">
<methodname>update_file_info</methodname>
<methodparam><parameter role="keyword">file</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">file</parameter> :</term>
<listitem><simpara>a <link linkend="class-nemo-python-file-info"><classname>Nemo.FileInfo</classname></link> object</simpara></listitem>
</varlistentry>
</variablelist>
<para>
This method is called by Nemo for each file or folder that exists under the
current directory listing. There is no return value.
</para>
</refsect2>
<refsect2 id="method-nemo-python-info-provider--update-file-info-full">
<title>Nemo.InfoProvider.update_file_info_full</title>
<programlisting><methodsynopsis language="python">
<methodname>update_file_info_full</methodname>
<methodparam><parameter role="keyword">provider</parameter></methodparam>
<methodparam><parameter role="keyword">handle</parameter></methodparam>
<methodparam><parameter role="keyword">closure</parameter></methodparam>
<methodparam><parameter role="keyword">file</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">provider</parameter> :</term>
<listitem><simpara>the current <link linkend="class-nemo-python-info-provider"><classname>Nemo.InfoProvider</classname></link> instance</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter role="keyword">handle</parameter> :</term>
<listitem><simpara>a <classname>gobject.gpointer</classname> generated solely to track this call</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter role="keyword">closure</parameter> :</term>
<listitem><simpara>a C Closure that must be passed to <link linkend="method-nemo-python-info-provider--update-complete-invoke">Nemo.info_provider_update_complete_invoke</link> if that method is called</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter role="keyword">file</parameter> :</term>
<listitem><simpara>a <link linkend="class-nemo-python-file-info"><classname>Nemo.FileInfo</classname></link> object</simpara></listitem>
</varlistentry>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara>None or a <link linkend="enum-nemo-python-operation-result"><classname>Nemo.OperationResult</classname></link> enum</simpara></listitem>
</varlistentry>
</variablelist>
<para>
This method is called by Nemo for each file or folder that exists under the
current directory listing. Originally, <link linkend="class-nemo-python-info-provider"><classname>Nemo.InfoProvider</classname></link>
only provided the update_file_info
method, which blocked Nemo when the method required a lot of computation time. This method was
created to allow an extension to tell Nemo that it will be spending time on an operation and that
Nemo should not block itself during that time.
</para>
<para>
In order to notify Nemo of your extension's intentions, you must return a
<link linkend="enum-nemo-python-operation-result"><classname>Nemo.OperationResult</classname></link> enum.
Then, when the operation has completed, call the Nemo.info_provider_update_complete_invoke method, passing the provider,
handle and closure variables as parameters.
</para>
<para>
This method was created for backwards compatibility reasons. If your
extension used the <link linkend="method-nemo-python-info-provider--update-file-info"><function>update_file_info</function></link> method and you want non-blocking
usage, you should switch to this method.
</para>
<note>
This method was introduced in nemo-python 0.7.0.
</note>
</refsect2>
<refsect2 id="method-nemo-python-info-provider--cancel-update">
<title>Nemo.InfoProvider.cancel_update</title>
<programlisting><methodsynopsis language="python">
<methodname>cancel_update</methodname>
<methodparam><parameter role="keyword">provider</parameter></methodparam>
<methodparam><parameter role="keyword">handle</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">provider</parameter> :</term>
<listitem><simpara>the current <link linkend="class-nemo-python-info-provider"><classname>Nemo.InfoProvider</classname></link> instance</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter role="keyword">handle</parameter> :</term>
<listitem><simpara>a <classname>gobject.gpointer</classname> generated by a specific update_file_info_full call</simpara></listitem>
</varlistentry>
</variablelist>
<para>
This method is called by Nemo when an update_file_info_full call is in progress
but is no longer required. This may happen because the user is moving directories or a file
has been deleted, etc. You may use the handle parameter here to match the
handle parameter passed in <link linkend="method-nemo-python-info-provider--update-file-info-full"><function>update_file_info_full</function></link>.
</para>
<note>
This method was introduced in nemo-python 0.7.0.
</note>
</refsect2>
</refsect1>
<refsect1>
<title>Active Methods</title>
<refsect2 id="method-nemo-python-info-provider--update-complete-invoke">
<title>Nemo.info_provider_update_complete_invoke</title>
<programlisting><methodsynopsis language="python">
<methodname>info_provider_update_complete_invoke</methodname>
<methodparam><parameter role="keyword">provider</parameter></methodparam>
<methodparam><parameter role="keyword">handle</parameter></methodparam>
<methodparam><parameter role="keyword">closure</parameter></methodparam>
<methodparam><parameter role="keyword">result</parameter><initializer>Nemo.OperationResult.COMPLETE</initializer></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">provider</parameter> :</term>
<listitem><simpara>the current <link linkend="class-nemo-python-info-provider"><classname>Nemo.InfoProvider</classname></link> instance</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter role="keyword">handle</parameter> :</term>
<listitem><simpara>a <classname>gobject.gpointer</classname> generated by a specific update_file_info_full call</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter role="keyword">closure</parameter> :</term>
<listitem><simpara>a C Closure that must be passed to <link linkend="method-nemo-python-info-provider--update-complete-invoke">Nemo.info_provider_update_complete_invoke</link> if that method is called</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter role="keyword">result</parameter> :</term>
<listitem><simpara>an optional parameter. If left out, <link linkend="enum-nemo-python-operation-result--OPERATION_COMPLETE"><classname>Nemo.OperationResult.COMPLETE</classname></link> is assumed.
Otherwise, you may pass any any of the <link linkend="enum-nemo-python-operation-result"><classname>Nemo.OperationResult</classname></link> enums.</simpara></listitem>
</varlistentry>
</variablelist>
<para>
An extension must call this method for each update_file_info_full method that
returns the <link linkend="enum-nemo-python-operation-result--OPERATION_IN_PROGRESS"><classname>Nemo.OperationResult.IN_PROGRESS</classname></link> enum.
The method must be called with the provider, handle, and closure parameters which were passed to the earlier <link linkend="method-nemo-python-info-provider--update-file-info-full"><function>update_file_info_full</function></link> method.
</para>
<note>
This method was introduced in nemo-python 0.7.0.
</note>
</refsect2>
</refsect1>
</refentry>
|
