File: caja-python-operation-handle.xml

package info (click to toggle)
python-caja 1.26.0-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, forky, sid, trixie
  • size: 832 kB
  • sloc: xml: 1,745; ansic: 791; python: 297; makefile: 182; sh: 19
file content (68 lines) | stat: -rw-r--r-- 2,280 bytes parent folder | download | duplicates (2)
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
<?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-caja-python-operation-handle">
  <refnamediv>
    <refname>Caja.OperationHandle</refname>
    <refpurpose><link linkend="class-caja-python-file-info"><classname>Caja.FileInfo</classname></link> update in progress handle</refpurpose>
  </refnamediv>

<!-- ******************************* -->
<!-- BEGIN OF CAJA-PYTHON SYNOPSIS -->
<!-- ******************************* -->

  <refsect1>
    <title>Synopsis</title>

    <classsynopsis language="python">
        <ooclass><classname>Caja.OperationHandle</classname></ooclass>
    </classsynopsis>
  </refsect1>


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

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

      <para>
        A handle for a <link linkend="class-caja-python-file-info"><classname>Caja.FileInfo</classname></link> update operation in progress. The handle value is a non-zero signed integer that can be stored in a <classname>gobject.gpointer</classname>. It cannot be explicitly constructed and is always generated by Caja itself.
      </para>
      <para>
        As every instance is created and initialized by Caja, handle values may be used as keys within the extension. It is however possible to update these values with more convenient ones.
      </para>

  </refsect1>


<!-- *********************************** -->
<!-- BEGIN OF PROPERTIES -->
<!-- *********************************** -->

<refsect1>
    <title>Properties</title>

    <blockquote role="properties">
      <informaltable pgwide="1" frame="none">
      <tgroup cols="3">
        <colspec column="1" colwidth="1in"/>
        <colspec column="2" colwidth="1in"/>
        <colspec column="3" colwidth="4in"/>
          <tbody>
      
            <row valign="top">
              <entry>"handle"</entry>
              <entry>The unique handle value. Default value: preset by Caja.</entry>
              <entry>Read-Write</entry>
            </row>

          </tbody>
        </tgroup>
      </informaltable>
    </blockquote>
</refsect1>

</refentry>