diff options
| author | Patrick Monnerat <[email protected]> | 2019-02-17 17:36:11 +0100 |
|---|---|---|
| committer | raveit65 <[email protected]> | 2019-03-31 12:30:00 +0200 |
| commit | 1d5a8b7aa497c6d3d3257887f95832eda397347c (patch) | |
| tree | 65471eef27198f9eeb9cf5c3c7f79fb05c13a729 /docs | |
| parent | 75906bebc8b7ce8adef7040d5bebde8ff7f59090 (diff) | |
| download | python-caja-1d5a8b7aa497c6d3d3257887f95832eda397347c.tar.bz2 python-caja-1d5a8b7aa497c6d3d3257887f95832eda397347c.tar.xz | |
Make Caja.OperationHandle usable.
The Caja.OperationHandle.handle property is added: this gives access to the
effective handle taking the form of a non-zero signed integer that can be
stored in a void pointer. Trying to set this property with an invalid value
raises an exception.
Upon update_file_info_full call, the new Caja.OperationHandle is preset with
a "unique" non-null value generated from an atomic counter. When the python
method returns, the handle value is transmitted to Caja whatever it is:
this fixes the problem of Caja expecting a non-null handle when
CAJA_OPERATION_IN_PROGRESS is returned.
Ref: https://github.com/mate-desktop/python-caja/issues/36
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/Makefile.am | 4 | ||||
| -rw-r--r-- | docs/reference/caja-python-class-reference.xml | 1 | ||||
| -rw-r--r-- | docs/reference/caja-python-info-provider.xml | 6 | ||||
| -rw-r--r-- | docs/reference/caja-python-operation-handle.xml | 68 |
4 files changed, 75 insertions, 4 deletions
diff --git a/docs/Makefile.am b/docs/Makefile.am index 70021bc..b05ab92 100644 --- a/docs/Makefile.am +++ b/docs/Makefile.am @@ -24,7 +24,8 @@ XML_FILES = \ reference/caja-python-file-info.xml \ reference/caja-python-info-provider.xml \ reference/caja-python-enum-reference.xml \ - reference/caja-python-operation-result.xml + reference/caja-python-operation-result.xml \ + reference/caja-python-operation-handle.xml HTMLdir = $(datadir)/gtk-doc/html/caja-python HTML_FILES = \ @@ -45,6 +46,7 @@ HTML_FILES = \ html/class-caja-python-location-widget-provider.html \ html/class-caja-python-file-info.html \ html/class-caja-python-info-provider.html \ + html/class-caja-python-operation-handle.html \ html/caja-python-enum-reference.html \ html/enum-caja-python-operation-result.html \ html/caja-python.devhelp diff --git a/docs/reference/caja-python-class-reference.xml b/docs/reference/caja-python-class-reference.xml index 5386ee9..ca47353 100644 --- a/docs/reference/caja-python-class-reference.xml +++ b/docs/reference/caja-python-class-reference.xml @@ -10,5 +10,6 @@ <xi:include href="caja-python-menu.xml"/> <xi:include href="caja-python-menu-item.xml"/> <xi:include href="caja-python-property-page.xml"/> + <xi:include href="caja-python-operation-handle.xml"/> </chapter> diff --git a/docs/reference/caja-python-info-provider.xml b/docs/reference/caja-python-info-provider.xml index 424fdb0..b8ca549 100644 --- a/docs/reference/caja-python-info-provider.xml +++ b/docs/reference/caja-python-info-provider.xml @@ -127,7 +127,7 @@ class ColumnExtension(GObject.GObject, Caja.InfoProvider): </varlistentry> <varlistentry> <term><parameter role="keyword">handle</parameter> :</term> - <listitem><simpara>a <classname>gobject.gpointer</classname> generated solely to track this call</simpara></listitem> + <listitem><simpara>a <link linkend="class-caja-python-operation-handle"><classname>Caja.OperationHandle</classname></link> generated solely to track this call</simpara></listitem> </varlistentry> <varlistentry> <term><parameter role="keyword">closure</parameter> :</term> @@ -184,7 +184,7 @@ class ColumnExtension(GObject.GObject, Caja.InfoProvider): </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> + <listitem><simpara>a <link linkend="class-caja-python-operation-handle"><classname>Caja.OperationHandle</classname></link> generated for a specific update_file_info_full call</simpara></listitem> </varlistentry> </variablelist> @@ -221,7 +221,7 @@ class ColumnExtension(GObject.GObject, Caja.InfoProvider): </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> + <listitem><simpara>a <link linkend="class-caja-python-operation-handle"><classname>Caja.OperationHandle</classname></link> generated for a specific update_file_info_full call</simpara></listitem> </varlistentry> <varlistentry> <term><parameter role="keyword">closure</parameter> :</term> diff --git a/docs/reference/caja-python-operation-handle.xml b/docs/reference/caja-python-operation-handle.xml new file mode 100644 index 0000000..379b51c --- /dev/null +++ b/docs/reference/caja-python-operation-handle.xml @@ -0,0 +1,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> |