File: nemo-python-operation-result.xml

package info (click to toggle)
nemo-python 5.6.0%2Bds-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 384 kB
  • sloc: xml: 1,732; ansic: 795; python: 157; makefile: 9
file content (59 lines) | stat: -rw-r--r-- 2,321 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
<?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="enum-nemo-python-operation-result">
  <refmeta>
    <refentrytitle>Nemo.OperationResult</refentrytitle>
  </refmeta>
  <refnamediv>
    <refname>Nemo.OperationResult</refname>
    <refpurpose>Nemo.OperationResult Reference</refpurpose>
  </refnamediv>



<!-- ********************************** -->
<!-- BEGIN OF DESCRIPTION -->
<!-- ********************************** -->

  <refsect1 id="description-operation-result">
    <title>Description</title>

      <para>
        The <link linkend="enum-nemo-python-operation-result"><classname>Nemo.OperationResult</classname></link> constants are
        used by the <link linkend="class-nemo-python-info-provider"><classname>Nemo.InfoProvider</classname></link> provider to
        notify Nemo what the extension intends to do when Nemo calls the extension's <link linkend="method-nemo-python-info-provider--update-file-info-full">update_file_info_full</link>
        method.  The possible values are as follows:
      </para>


      <variablelist>
	    <varlistentry>
	      <term><literal>Nemo.OperationResult.COMPLETE</literal></term>
	      <listitem>
	        <simpara>The operation is complete and Nemo can move on to the next <link linkend="method-nemo-python-info-provider--update-file-info-full">update_file_info_full</link> call.</simpara>
	      </listitem>
	    </varlistentry>
	    <varlistentry>
	      <term><literal>Nemo.OperationResult.IN_PROGRESS</literal></term>
	      <listitem>
	        <simpara>The operation is in progress and running asynchronously and Nemo should wait until the <link linkend="method-nemo-python-info-provider--update-complete-invoke">Nemo.info_provider_update_complete_invoke</link> method
	        is called before moving on to the next <link linkend="method-nemo-python-info-provider--update-file-info-full">update_file_info_full</link> call.</simpara>
	      </listitem>
	    </varlistentry>
	    <varlistentry>
	      <term><literal>Nemo.OperationResult.FAILED</literal></term>
	      <listitem>
	        <simpara>The operation has failed.</simpara>
	      </listitem>
	    </varlistentry>
	    </variablelist>
  </refsect1>





</refentry>