File: thunarx-python-property-page.xml

package info (click to toggle)
thunarx-python 0.5.2-3
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 360 kB
  • sloc: xml: 1,500; ansic: 678; python: 136; makefile: 106; sh: 11
file content (217 lines) | stat: -rw-r--r-- 8,139 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
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
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
<?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-thunarx-python-property-page">
  <refnamediv>
    <refname>Thunarx.PropertyPage</refname>
    <refpurpose>Thunarx.PropertyPage Reference</refpurpose>
  </refnamediv>

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

  <refsect1>
    <title>Synopsis</title>

    <classsynopsis language="python">
        <ooclass><classname>Thunarx.PropertyPage</classname></ooclass>
        <ooclass><classname><link linkend="class-GObject">GObject.GObject</link></classname></ooclass>

        <constructorsynopsis language="python">
            <methodname><link linkend="constructor-Thunarx-property-page">Thunarx.PropertyPage</link></methodname>
            <methodparam><parameter role="keyword">label</parameter></methodparam>
        </constructorsynopsis>

        <constructorsynopsis language="python">
            <methodname><link linkend="constructor-Thunarx-property-page">Thunarx.PropertyPage</link></methodname>
            <methodparam><parameter role="keyword">label_widget</parameter></methodparam>
        </constructorsynopsis>
        
      <methodsynopsis language="python">
        <methodname><link linkend="method-thunarx-python-property-page--get-label">get_label</link></methodname>
      </methodsynopsis>

      <methodsynopsis language="python">
        <methodname><link linkend="method-thunarx-python-property-page--set-label">set_label</link></methodname>
            <methodparam><parameter role="keyword">label</parameter></methodparam>
      </methodsynopsis>

      <methodsynopsis language="python">
        <methodname><link linkend="method-thunarx-python-property-page--get-label-widget">get_label_widget</link></methodname>
      </methodsynopsis>

      <methodsynopsis language="python">
        <methodname><link linkend="method-thunarx-python-property-page--set-label-widget">set_label_widget</link></methodname>
            <methodparam><parameter role="keyword">label_widget</parameter></methodparam>
      </methodsynopsis>
    </classsynopsis>
  </refsect1>

<!-- ********************************* -->
<!-- BEGIN OF ANCESTRY -->
<!-- ********************************* -->

<refsect1>
    <title>Ancestry</title>

<synopsis>+-- <link linkend="class-GObject">GObject.GObject</link>
    +-- <link linkend="class-thunarx-python-property-page">Thunarx.PropertyPage</link>
</synopsis>
</refsect1>


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

  <refsect1 id="description-property-page">
    <title>Description</title>

      <para>
        A <link linkend="class-thunarx-python-property-page"><classname>Thunarx.PropertyPage</classname></link> object is returned by <link linkend="class-thunarx-python-property-page-provider"><classname>Thunarx.PropertyPageProvider</classname></link> extensions.
      </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>"label"</entry>
              <entry>The label displayed in the notebook tab.</entry>
              <entry>Read-Write</entry>
            </row>
      
            <row valign="top">
              <entry>"label-widget"</entry>
              <entry>The label widget displayed in the notebook tab.  Default value: None</entry>
              <entry>Read-Write</entry>
            </row>
            
          </tbody>
        </tgroup>
      </informaltable>
    </blockquote>
</refsect1>


<!-- ************************************ -->
<!-- BEGIN OF CONSTRUCTOR -->
<!-- ************************************ -->

<refsect1 id="constructor-Thunarx-property-page">
  <title>Constructor</title>

  <programlisting><constructorsynopsis language="python">
        <methodname>Thunarx.PropertyPage</methodname>
        <methodparam><parameter role="keyword">label</parameter></methodparam>
  </constructorsynopsis></programlisting>

  <variablelist>
    <varlistentry>
	    <term><parameter role="keyword">label</parameter>&nbsp;:</term>
	    <listitem><simpara>the user-visible label for the property page</simpara></listitem>
    </varlistentry>
  </variablelist>

  <para>
    Creates a new <link linkend="class-thunarx-python-property-page"><classname>Thunarx.PropertyPage</classname></link> object.
  </para>
</refsect1>

<refsect1 id="constructor-Thunarx-property-page-label-widget">
  <title>Constructor</title>

  <programlisting><constructorsynopsis language="python">
        <methodname>Thunarx.PropertyPage</methodname>
        <methodparam><parameter role="keyword">label_widget</parameter></methodparam>
  </constructorsynopsis></programlisting>
    
  <variablelist>
    <varlistentry>
	    <term><parameter role="keyword">label_widget</parameter>&nbsp;:</term>
	    <listitem><simpara>the user-visible label widget for the property page</simpara></listitem>
    </varlistentry>
  </variablelist>

  <para>
    Creates a new <link linkend="class-thunarx-python-property-page-label-widget"><classname>Thunarx.PropertyPage</classname></link> object.
  </para>
</refsect1>

<!-- ******************************** -->
<!-- BEGIN OF METHODS -->
<!-- ******************************** -->

<refsect1>
    <title>Public Methods</title>

    <refsect2 id="method-thunarx-python-property-page--get-label">
        <title>Thunarx.FileInfo.get_label</title>
        <programlisting><methodsynopsis language="python">
            <methodname>get_label</methodname>
        </methodsynopsis></programlisting>
        <variablelist>
            <varlistentry>
                <term><emphasis>Returns</emphasis>&nbsp;:</term>
                <listitem><simpara>the text in the label or NULL</simpara></listitem>
            </varlistentry>
        </variablelist>
    </refsect2>

    <refsect2 id="method-thunarx-python-property-page--set-label">
        <title>Thunarx.FileInfo.set_label</title>
        <programlisting><methodsynopsis language="python">
            <methodname>set_label</methodname>
        </methodsynopsis></programlisting>
        <variablelist>
            <varlistentry>
                <term><emphasis>Returns</emphasis>&nbsp;:</term>
                <listitem><simpara>Sets the text of the label.</simpara></listitem>
            </varlistentry>
        </variablelist>
    </refsect2>

    <refsect2 id="method-thunarx-python-property-page--get-label-widget">
        <title>Thunarx.FileInfo.get_label_widget</title>
        <programlisting><methodsynopsis language="python">
            <methodname>get_label_widget</methodname>
        </methodsynopsis></programlisting>
        <variablelist>
            <varlistentry>
                <term><emphasis>Returns</emphasis>&nbsp;:</term>
                <listitem><simpara>Returns the label widget for the property_page.</simpara></listitem>
            </varlistentry>
        </variablelist>
    </refsect2>
    
    <refsect2 id="method-thunarx-python-property-page--set-label-widget">
        <title>Thunarx.FileInfo.set_label_widget</title>
        <programlisting><methodsynopsis language="python">
            <methodname>set_label_widget</methodname>
        </methodsynopsis></programlisting>
        <variablelist>
            <varlistentry>
                <term><emphasis>Returns</emphasis>&nbsp;:</term>
                <listitem><simpara>Sets the label widget for the property_page. This is the widget that will appear in the notebook header for the property_page.</simpara></listitem>
            </varlistentry>
        </variablelist>
    </refsect2>

</refsect1>
</refentry>