File: nemo-python-column.xml

package info (click to toggle)
nemo-python 5.6.0%2Bds-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 384 kB
  • sloc: xml: 1,732; ansic: 795; python: 157; makefile: 9
file content (161 lines) | stat: -rw-r--r-- 5,600 bytes parent folder | download | duplicates (3)
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
<?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-nemo-python-column">
  <refmeta>
    <refentrytitle>Nemo.Column</refentrytitle>
  </refmeta>
  <refnamediv>
    <refname>Nemo.Column</refname>
    <refpurpose>Nemo.Column Reference</refpurpose>
  </refnamediv>

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

  <refsect1>
    <title>Synopsis</title>

    <classsynopsis language="python">
        <ooclass><classname>Nemo.Column</classname></ooclass>
        <ooclass><classname><link linkend="class-gobject">gobject.GObject</link></classname></ooclass>

        <constructorsynopsis language="python">
            <methodname><link linkend="constructor-nemo-column">Nemo.Column</link></methodname>
            <methodparam><parameter role="keyword">name</parameter></methodparam>
            <methodparam><parameter role="keyword">attribute</parameter></methodparam>
            <methodparam><parameter role="keyword">label</parameter></methodparam>
            <methodparam><parameter role="keyword">description</parameter></methodparam>
        </constructorsynopsis>
    </classsynopsis>
  </refsect1>

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

<refsect1>
    <title>Ancestry</title>

<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
    +-- <link linkend="class-nemo-python-column">Nemo.Column</link>
</synopsis>
</refsect1>


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

  <refsect1 id="description-column">
    <title>Description</title>

      <para>
        A list of <link linkend="class-nemo-python-column"><classname>Nemo.Column</classname></link> objects is returned by <link linkend="class-nemo-python-column-provider"><classname>Nemo.ColumnProvider</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>"attribute"</entry>
              <entry>The attribute name to display.  Default value: None</entry>
              <entry>Read-Write</entry>
            </row>
      
            <row valign="top">
              <entry>"attribute-q"</entry>
              <entry>The attribute name to display, in quark form.  Default value: 0</entry>
              <entry>Read</entry>
            </row>
      
            <row valign="top">
              <entry>"description"</entry>
              <entry>The user-visible description of the column.  Default value: None</entry>
              <entry>Read-Write</entry>
            </row>

            <row valign="top">
              <entry>"label"</entry>
              <entry>The label to display in the column.  Default value: None</entry>
              <entry>Read-Write</entry>
            </row>
      
            <row valign="top">
              <entry>"name"</entry>
              <entry>The name of the column.  Default value: None</entry>
              <entry>Read-Write-ConstructOnly</entry>
            </row>
      
            <row valign="top">
              <entry>"xalign"</entry>
              <entry>The x-alignment of the column.  Allowed values: [0,1].  Default value: 0</entry>
              <entry>Read-Write</entry>
            </row>

          </tbody>
        </tgroup>
      </informaltable>
    </blockquote>
</refsect1>


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

<refsect1 id="constructor-nemo-column">
  <title>Constructor</title>

  <programlisting><constructorsynopsis language="python">
        <methodname>Nemo.Column</methodname>
        <methodparam><parameter role="keyword">name</parameter></methodparam>
        <methodparam><parameter role="keyword">attribute</parameter></methodparam>
        <methodparam><parameter role="keyword">label</parameter></methodparam>
        <methodparam><parameter role="keyword">description</parameter></methodparam>
  </constructorsynopsis></programlisting>
    
  <variablelist>
    <varlistentry>
	    <term><parameter role="keyword">name</parameter>&nbsp;:</term>
	    <listitem><simpara>identifier of the column</simpara></listitem>
    </varlistentry>
    <varlistentry>
	    <term><parameter role="keyword">attribute</parameter>&nbsp;:</term>
	    <listitem><simpara>the file attribute to be displayed in the column</simpara></listitem>
    </varlistentry>
    <varlistentry>
	    <term><parameter role="keyword">label</parameter>&nbsp;:</term>
	    <listitem><simpara>the user-visible label for the column</simpara></listitem>
    </varlistentry>
    <varlistentry>
	    <term><parameter role="keyword">description</parameter>&nbsp;:</term>
	    <listitem><simpara>a user-visible description of the column</simpara></listitem>
    </varlistentry>
  </variablelist>

  <para>
    Creates a new <link linkend="class-nemo-python-column"><classname>Nemo.Column</classname></link> object.
  </para>
</refsect1>



</refentry>