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
|
<?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-nautilus-python-properties-model">
<refmeta>
<refentrytitle>Nautilus.PropertiesModel</refentrytitle>
</refmeta>
<refnamediv>
<refname>Nautilus.PropertiesModel</refname>
<refpurpose>Nautilus.PropertiesModel Reference</refpurpose>
</refnamediv>
<!-- ******************************* -->
<!-- BEGIN OF NAUTILUS-PYTHON SYNOPSIS -->
<!-- ******************************* -->
<refsect1>
<title>Synopsis</title>
<classsynopsis language="python">
<ooclass><classname>Nautilus.PropertiesModel</classname></ooclass>
<ooclass><classname><link linkend="class-gobject">gobject.GObject</link></classname></ooclass>
<constructorsynopsis language="python">
<methodname><link linkend="constructor-nautilus-properties-model">Nautilus.PropertiesModel</link></methodname>
<methodparam><parameter role="keyword">title</parameter></methodparam>
<methodparam><parameter role="keyword">model</parameter></methodparam>
</constructorsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-nautilus-python-menu--set_title">set_title</link></methodname>
<methodparam><parameter role="keyword">title</parameter></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-nautilus-python-menu--get_title">get_title</link></methodname>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-nautilus-python-menu--get_model">get_model</link></methodname>
</methodsynopsis>
</classsynopsis>
</refsect1>
<!-- ********************************* -->
<!-- BEGIN OF ANCESTRY -->
<!-- ********************************* -->
<refsect1>
<title>Ancestry</title>
<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
+-- <link linkend="class-nautilus-python-properties-model">Nautilus.PropertiesModel</link>
</synopsis>
</refsect1>
<!-- ********************************** -->
<!-- BEGIN OF DESCRIPTION -->
<!-- ********************************** -->
<refsect1 id="description-properties-model">
<title>Description</title>
<para>
A <link linkend="class-nautilus-python-properties-model"><classname>Nautilus.PropertiesModel</classname></link> object an model that describes a set of file properties. Extensions can provide <link linkend="class-nautilus-python-properties-model"><classname>Nautilus.PropertiesModel</classname></link> objects by registering it in <link linkend="class-nautilus-python-properties-model-provider"><classname>Nautilus.PropertiesModelProvider</classname></link>.
</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>"title"</entry>
<entry>The user-visible name for the set of properties in this model.</entry>
<entry>Read-Write</entry>
</row>
<row valign="top">
<entry>"model"</entry>
<entry>The <classname>GListModel</classname> containing <link linkend="class-nautilus-python-properties-item"><classname>Nautilus.PropertyItem</classname></link> objects. Default value: <literal>[]</literal></entry>
<entry>Read-Write-ConstructOnly</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</blockquote>
</refsect1>
<!-- ************************************ -->
<!-- BEGIN OF CONSTRUCTOR -->
<!-- ************************************ -->
<refsect1 id="constructor-nautilus-properties-model">
<title>Constructor</title>
<programlisting><constructorsynopsis language="python">
<methodname>Nautilus.PropertiesModel</methodname>
<methodparam><parameter role="keyword">title</parameter></methodparam>
<methodparam><parameter role="keyword">model</parameter></methodparam>
</constructorsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">title</parameter> :</term>
<listitem><simpara>the user-visible name for the set of properties in this model</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter role="keyword">model</parameter> :</term>
<listitem><simpara>The <classname>GListModel</classname> containing <link linkend="class-nautilus-python-properties-item"><classname>Nautilus.PropertyItem</classname></link> objects.</simpara></listitem>
</varlistentry>
</variablelist>
<para>
Creates a new <link linkend="class-nautilus-python-properties-model"><classname>Nautilus.PropertiesModel</classname></link> object.
</para>
</refsect1>
<!-- ******************************** -->
<!-- BEGIN OF METHODS -->
<!-- ******************************** -->
<refsect1>
<title>Public Methods</title>
<refsect2 id="method-nautilus-python-menu--set_title">
<title>Nautilus.Menu.set_title</title>
<programlisting><methodsynopsis language="python">
<methodname>set_title</methodname>
<methodparam><parameter role="keyword">title</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">title</parameter> :</term>
<listitem><simpara>a new name of this <link linkend="class-nautilus-python-properties-model"><classname>Nautilus.PropertiesModel</classname></link></simpara></listitem>
</varlistentry>
</variablelist>
<para>
Sets a new name of this <link linkend="class-nautilus-python-properties-model"><classname>Nautilus.PropertiesModel</classname></link>.
</para>
</refsect2>
<refsect2 id="method-nautilus-python-menu--get_title">
<title>Nautilus.Menu.get_title</title>
<programlisting><methodsynopsis language="python">
<methodname>get_title</methodname>
</methodsynopsis></programlisting>
<para>
Returns the title of this <link linkend="class-nautilus-python-properties-model"><classname>Nautilus.PropertiesModel</classname></link>.
</para>
</refsect2>
<refsect2 id="method-nautilus-python-menu--get_model">
<title>Nautilus.Menu.get_model</title>
<programlisting><methodsynopsis language="python">
<methodname>get_model</methodname>
</methodsynopsis></programlisting>
<para>
Returns a <classname>GListModel</classname> containing <link linkend="class-nautilus-python-properties-item"><classname>Nautilus.PropertyItem</classname></link> objects.
</para>
</refsect2>
</refsect1>
</refentry>
|