← Back to branch summary

~ubuntu-branches/ubuntu/saucy/nautilus-python/saucy-proposed

« back to all changes in this revision

Viewing changes to docs/reference/nautilus-python-property-page.xml

  • Committer: Bazaar Package Importer
  • Author(s): Michael Terry
  • Date: 2011-07-06 13:17:39 UTC
  • mfrom: (1.1.6 upstream)
  • Revision ID: james.westby@ubuntu.com-20110706131739-ardhj06fem65n3l3
Tags: 1.0-0ubuntu1
* New upstream release that works with nautilus 3.0
* debian/control.in:
  - Update dependencies

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/nautilus-python-property-page.xml
 
1
<?xml version="1.0" standalone="no"?>
 
2
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
 
3
    "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
 
4
 
 
5
<refentry id="class-nautilus-python-property-page">
 
6
  <refnamediv>
 
7
    <refname>Nautilus.PropertyPage</refname>
 
8
    <refpurpose>Nautilus.PropertyPage Reference</refpurpose>
 
9
  </refnamediv>
 
10
 
 
11
<!-- ******************************* -->
 
12
<!-- BEGIN OF NAUTILUS-PYTHON SYNOPSIS -->
 
13
<!-- ******************************* -->
 
14
 
 
15
  <refsect1>
 
16
    <title>Synopsis</title>
 
17
 
 
18
    <classsynopsis language="python">
 
19
        <ooclass><classname>Nautilus.PropertyPage</classname></ooclass>
 
20
        <ooclass><classname><link linkend="class-gobject">gobject.GObject</link></classname></ooclass>
 
21
 
 
22
        <constructorsynopsis language="python">
 
23
            <methodname><link linkend="constructor-nautilus-property-page">Nautilus.PropertyPage</link></methodname>
 
24
            <methodparam><parameter role="keyword">name</parameter></methodparam>
 
25
            <methodparam><parameter role="keyword">label</parameter></methodparam>
 
26
            <methodparam><parameter role="keyword">page</parameter></methodparam>
 
27
        </constructorsynopsis>
 
28
    </classsynopsis>
 
29
  </refsect1>
 
30
 
 
31
<!-- ********************************* -->
 
32
<!-- BEGIN OF ANCESTRY -->
 
33
<!-- ********************************* -->
 
34
 
 
35
<refsect1>
 
36
    <title>Ancestry</title>
 
37
 
 
38
<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
 
39
    +-- <link linkend="class-nautilus-python-property-page">Nautilus.PropertyPage</link>
 
40
</synopsis>
 
41
</refsect1>
 
42
 
 
43
 
 
44
<!-- ********************************** -->
 
45
<!-- BEGIN OF DESCRIPTION -->
 
46
<!-- ********************************** -->
 
47
 
 
48
  <refsect1 id="description-property-page">
 
49
    <title>Description</title>
 
50
 
 
51
      <para>
 
52
        A <link linkend="class-nautilus-python-property-page"><classname>Nautilus.PropertyPage</classname></link> object is returned by <link linkend="class-nautilus-python-property-page-provider"><classname>Nautilus.PropertyPageProvider</classname></link> extensions.
 
53
      </para>
 
54
 
 
55
  </refsect1>
 
56
 
 
57
 
 
58
<!-- *********************************** -->
 
59
<!-- BEGIN OF PROPERTIES -->
 
60
<!-- *********************************** -->
 
61
 
 
62
<refsect1>
 
63
    <title>Properties</title>
 
64
 
 
65
    <blockquote role="properties">
 
66
      <informaltable pgwide="1" frame="none">
 
67
      <tgroup cols="3">
 
68
        <colspec column="1" colwidth="1in"/>
 
69
        <colspec column="2" colwidth="1in"/>
 
70
        <colspec column="3" colwidth="4in"/>
 
71
          <tbody>
 
72
      
 
73
            <row valign="top">
 
74
              <entry>"label"</entry>
 
75
              <entry>The label widget displayed in the notebook tab.</entry>
 
76
              <entry>Read-Write</entry>
 
77
            </row>
 
78
      
 
79
            <row valign="top">
 
80
              <entry>"name"</entry>
 
81
              <entry>The name of the page.  Default value: None</entry>
 
82
              <entry>Read-Write-ConstructOnly</entry>
 
83
            </row>
 
84
      
 
85
            <row valign="top">
 
86
              <entry>"page"</entry>
 
87
              <entry>The property page widget</entry>
 
88
              <entry>Read-Write</entry>
 
89
            </row>
 
90
 
 
91
          </tbody>
 
92
        </tgroup>
 
93
      </informaltable>
 
94
    </blockquote>
 
95
</refsect1>
 
96
 
 
97
 
 
98
<!-- ************************************ -->
 
99
<!-- BEGIN OF CONSTRUCTOR -->
 
100
<!-- ************************************ -->
 
101
 
 
102
<refsect1 id="constructor-nautilus-property-page">
 
103
  <title>Constructor</title>
 
104
 
 
105
  <programlisting><constructorsynopsis language="python">
 
106
        <methodname>Nautilus.PropertyPage</methodname>
 
107
        <methodparam><parameter role="keyword">name</parameter></methodparam>
 
108
        <methodparam><parameter role="keyword">label</parameter></methodparam>
 
109
        <methodparam><parameter role="keyword">page</parameter></methodparam>
 
110
  </constructorsynopsis></programlisting>
 
111
    
 
112
  <variablelist>
 
113
    <varlistentry>
 
114
            <term><parameter role="keyword">name</parameter>&nbsp;:</term>
 
115
            <listitem><simpara>identifier of the property page</simpara></listitem>
 
116
    </varlistentry>
 
117
    <varlistentry>
 
118
            <term><parameter role="keyword">label</parameter>&nbsp;:</term>
 
119
            <listitem><simpara>the user-visible label for the property page</simpara></listitem>
 
120
    </varlistentry>
 
121
    <varlistentry>
 
122
            <term><parameter role="keyword">page</parameter>&nbsp;:</term>
 
123
            <listitem><simpara>the property page widget</simpara></listitem>
 
124
    </varlistentry>
 
125
  </variablelist>
 
126
 
 
127
  <para>
 
128
    Creates a new <link linkend="class-nautilus-python-property-page"><classname>Nautilus.PropertyPage</classname></link> object.
 
129
  </para>
 
130
</refsect1>
 
131
 
 
132
 
 
133
 
 
134
</refentry>
 
135