diff options
| author | Gian Mario Tagliaretti <gianmt@src.gnome.org> | 2007-04-23 14:24:10 +0000 |
|---|---|---|
| committer | Gian Mario Tagliaretti <gianmt@src.gnome.org> | 2007-04-23 14:24:10 +0000 |
| commit | 1e29b21df31efc1a7f0b9e8e1ab5a9b3de4137c8 (patch) | |
| tree | 9ee16e082d3ea3bc7d39aa1c76f958b83dd56a1e /docs/reference | |
| parent | 6e47e1134ef64b9f11169bef22ac8561030dbca2 (diff) | |
| download | pygobject-1e29b21df31efc1a7f0b9e8e1ab5a9b3de4137c8.tar.gz pygobject-1e29b21df31efc1a7f0b9e8e1ab5a9b3de4137c8.tar.xz pygobject-1e29b21df31efc1a7f0b9e8e1ab5a9b3de4137c8.zip | |
new pygobject_set_properties and pygobject_get_properties methods
svn path=/trunk/; revision=646
Diffstat (limited to 'docs/reference')
| -rw-r--r-- | docs/reference/pygobject.xml | 83 |
1 files changed, 83 insertions, 0 deletions
diff --git a/docs/reference/pygobject.xml b/docs/reference/pygobject.xml index fd75829..ff02664 100644 --- a/docs/reference/pygobject.xml +++ b/docs/reference/pygobject.xml @@ -25,12 +25,25 @@ linkend="method-gobject--get-property">get_property</link></methodname> </methodsynopsis> <methodsynopsis language="python"> <methodname><link +linkend="method-gobject--get-properties">get_properties</link></methodname> + <methodparam><parameter>first_property_name</parameter></methodparam> + <methodparam><parameter>...</parameter></methodparam> + </methodsynopsis> + <methodsynopsis language="python"> + <methodname><link linkend="method-gobject--set-property">set_property</link></methodname> <methodparam><parameter>property_name</parameter></methodparam> <methodparam><parameter>value</parameter></methodparam> </methodsynopsis> <methodsynopsis language="python"> <methodname><link +linkend="method-gobject--set-properties">set_properties</link></methodname> + <methodparam><parameter>property_name</parameter> + <initializer>value</initializer></methodparam> + <methodparam><parameter>...</parameter></methodparam> + </methodsynopsis> + <methodsynopsis language="python"> + <methodname><link linkend="method-gobject--freeze-notify">freeze_notify</link></methodname> <methodparam></methodparam> </methodsynopsis> <methodsynopsis language="python"> @@ -242,6 +255,40 @@ if the property name is not registered with the object class.</para> </refsect2> + <refsect2 id="method-gobject--get-properties"> + <title>gobject.GObject.get_properties</title> + + <programlisting><methodsynopsis language="python"> + <methodname>get_properties</methodname> + <methodparam><parameter>first_property_name</parameter></methodparam> + <methodparam><parameter>...</parameter></methodparam> + </methodsynopsis></programlisting> + <variablelist> + <varlistentry> + <term><parameter>first_property_name</parameter> :</term> + <listitem><simpara>a string containing the first property name for the +GObject</simpara></listitem> + </varlistentry> + <varlistentry> + <term><parameter>...</parameter> :</term> + <listitem><simpara>additional property names +</simpara></listitem> + </varlistentry> + <varlistentry> + <term><emphasis>Returns</emphasis> :</term> + <listitem><simpara>a tuple containing the property values +requested</simpara></listitem> + </varlistentry> + </variablelist> + + <para>The <methodname>get_properties</methodname>() method returns a tuple containing +the values of the properties requested, or +None if there is no value associated with the property.</para> + <para>The <exceptionname>TypeError</exceptionname> exception is raised +if the property name is not registered with the object class.</para> + + </refsect2> + <refsect2 id="method-gobject--set-property"> <title>gobject.GObject.set_property</title> @@ -271,6 +318,42 @@ if the property name is not registered with the object class or if the value specified could not be converted to the property type.</para> </refsect2> + + <refsect2 id="method-gobject--set-properties"> + <title>gobject.GObject.set_properties</title> + + <programlisting><methodsynopsis language="python"> + <methodname>set_properties</methodname> + <methodparam><parameter>property_name</parameter> + <initializer>value</initializer></methodparam> + <methodparam><parameter>...</parameter></methodparam> + </methodsynopsis></programlisting> + <variablelist> + <varlistentry> + <term><parameter>property_name</parameter> :</term> + <listitem><simpara>the property name</simpara></listitem> + </varlistentry> + <varlistentry> + <term><parameter>value</parameter> :</term> + <listitem><simpara>a Python object containing the property value +to be set</simpara></listitem> + </varlistentry> + <varlistentry> + <term><parameter>...</parameter> :</term> + <listitem><simpara>additional property name and value +kwargs</simpara></listitem> + </varlistentry> + </variablelist> + + <para>The <methodname>set_properties</methodname>() method sets the +property specified by <parameter>property_name</parameter> to the specified +<parameter>value</parameter>, followed by pairs of property name +and value as keyword arguments.</para> + <para>The <exceptionname>TypeError</exceptionname> exception is raised +if the property name is not registered with the object class or if the value +specified could not be converted to the property type.</para> + + </refsect2> <refsect2 id="method-gobject--freeze-notify"> <title>gobject.GObject.freeze_notify</title> |
