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
|
<HTML>
<HEAD>
<TITLE></TITLE>
</HEAD>
<BODY style="font-size : 10pt;">
<DIV CLASS="NAVHEADER">
<TABLE SUMMARY="Header navigation table" WIDTH="100%" BORDER="0" CELLPADDING="0" CELLSPACING="0" style="font-size : 10pt;">
<TR><TH COLSPAN="3" ALIGN="center">PyKDE4 - Class Reference</TH></TR>
<TR><TD WIDTH="10%" ALIGN="left" VALIGN="bottom"><A HREF="contributing.html" ACCESSKEY="P">Prev</A></TD>
<TD WIDTH="80%" ALIGN="center" VALIGN="bottom"></TD>
<TD WIDTH="10%" ALIGN="right" VALIGN="bottom"><A HREF="pykdedocs.html" ACCESSKEY="N">Next</A></TD>
</TR>
</TABLE><HR ALIGN="LEFT" WIDTH="100%"></DIV>
<h2>Class Reference</h2>
<p>
The PyKDE4 class reference has a consistent format (it's machine generated). A number of examples
here show what information the class reference contains and how to interpret it.
</p>
<p><b>Note:</b>
The text in the class reference is retrieved and formatted from markup placed in the C++ header
files by KDE programmers. The example code shown is in C++, and in some cases the descriptions
may be C++ oriented. These limitations may be removed in future versions of the documentation.
</p>
<p>
Also, some methods may appear to be duplicates - these result from changes like adding 'explicit'
to constructors or changes in 'const' for return values or argument types.
</p>
<u><h3 align="center">Page header</h3></u>
<table cellspacing="20" style="font-size : 10pt;">
<tr>
<td>
<p>
The examples shown here are cut from pages in the PyKDE4 class reference. The first is a typical header
for a class page - shown compressed horizontally.
</p>
<p>
The features are fairly obvious. The class name is at the top left. Below it, the contents of the box
indicate the module the class is found in, the namespace it belongs (global is effectively "none"),
and the base class (if any) the class is derived from.
</p>
<p>
The links in the upper right hand corner link to the table of contents, a module page which lists
all of the modules (with links to their classes), a link to the kdeui module page, and link to
a list of all PyKDE4 classes.
</p>
<p>
Below the links is a description of the class - these may be short, extremely lengthy or may include
usage examples of the class or its methods.
</p>
</td>
<td>
<img src="images/cr_header.png" width="470" height="299" align="left" border="0" style="border-bottom-color : #929292; border-left-color : #929292; border-right-color : #929292; border-top-color : #929292;">
</td>
</tr>
</table>
<u><h3 align="center">methods Section</h3></u>
<table cellspacing="20" style="font-size : 10pt;">
<tr>
<td>
<p>
The methods section of class's page lists in alphabetical order all of the methods defined in the
KDE4 class declaration. If the class has base classes, there are probably considerably more methods
inherited from the base class which are not shown here.
</p>
<p>
The left-hand side of the page lists the methods and their Python signature. The argument list shows
the names and numbers of the arguments, but not their types. The type information is listed in a
table below the method name. Each row shows the argument name, its type, and the default value, if any.
Methods which are not implemented in PyKDE4 are labeled and will have their method name "grayed out".
</p>
<p>
Above the table the type of value returned by the method (if any) is described.
</p>
<p>
On the right-hand side is description (again, some short, some lengthy) that describes what actions
the method performs. Some methods (or even entire classes) are marked as
<b style="color : #ff0000;"><i>Internal</i></b>, <b style="color : #ff0000;"><i>Deprecated</i></b>,
or <b style="color : #ff0000;"><i>Obsolete</i></b>. These determinations are made by KDE4 programmers.
Methods and classes like those are included in PyKDE4 for completeness or because in some cases, other
methods or classes depend on the marked method or class.
</p>
<p>
You should avoid using internal, deprecated or obsolete methods in your code, as their function may change
or they may disappear in new releases.
</p>
<p>
<b>Versions</b> If there are no version limitations specified, the method is available in all PyKDE4 versions.
Versions are specified as "KDE X.Y.Z and later", which means the method is available in version X.Y.Z, as 'before
KDE X.Y.Z", which means the method is NOT available in version X.Y.Z, but is available in any previous version,
or "KDE A.B.C to before KDE X.Y.Z", which means it is available in version A.B.C, any version before X.Y.Z, but
NOT in X.Y.Z itself. Or in other words, versions are always given as A.B.C <= version < X.Y.Z
</p>
</td>
<td>
<img src="images/cr_methods.png" width="471" height="288" align="left" border="0" style="border-bottom-color : #929292; border-left-color : #929292; border-right-color : #929292; border-top-color : #929292;">
</td>
</tr>
</table>
<u><h3 align="center">enums Section</h3></u>
<table cellspacing="20" style="font-size : 10pt;"></u>
<tr>
<td>
<p>
If a class defines enums, the enum and its enumerators are shown at the top of the page.
</p>
<p>
Sometimes it's clear from the names of the enum and enumerators what they represent. For
some enums, more detailed explanations have been provided, and these are attached at the
bottom of the page (accessible by clicking the "enum details" link)
</p>
</td>
<td>
<img src="images/cr_enum.png" width="602" height="143" align="left" border="0" style="border-bottom-color : #929292; border-left-color : #929292; border-right-color : #929292; border-top-color : #929292;">
</td>
</tr>
<tr>
<td valign="top">
<p>
If more descriptive detail is available, its shown at the bottom of the page in the "enum details" section.
</p>
<p>
In the case shown, the programmer has provided a brief description of the function of each enumerator.
</p>
</td>
<td>
<img src="images/cr_enumdtl.png" width="603" height="247" align="left" border="0" style="border-bottom-color : #929292; border-left-color : #929292; border-right-color : #929292; border-top-color : #929292;">
</td>
</tr>
</table>
<u><h3 align="center">Static methods, signals</h3></u>
<table cellspacing="20" style="font-size : 10pt;">
<tr>
<td>
<p>
This clipping shows two different types of methods - signals and static methods.
</p>
<p>
A static method (at the top) is one that can be called without creating and instance
of the class it belongs to - simply call className.methodName () to use the method.
</p>
<p>
A signal is emitted when some particular action has occurred (a button clicked, a page has
completed printing or rendering, etc). Signals are connected to slots.
</p>
<p>
Besides labeling this method as a signal, the documentation shows the signal's "signature"
and a SIGNAL statement, which can be pasted into a 'connect' call that links the signal
to a slot that responds to the occurance the signal represents.
</p>
</td>
<td>
<IMG src="images/cr_sig.png" width="395" height="475" align="left" border="0" style="border-bottom-color : #929292; border-left-color : #929292; border-right-color : #929292; border-top-color : #929292;">
</td>
</tr>
</table>
<u><h3 align="center">Abstract Classes, pure virtual methods</h3></u>
<table cellspacing="20" style="font-size : 10pt;">
<tr>
<td>
<p>
The final examples show how abstract classes and pure virutal methods are identified.
</p>
<p>
Abstract classes are classes that can be used as a base class for new classes, but can't
be instantiated themselves. The label under the class name defines this class as abstract.
</p>
<p>
A class is abstract when it has pure virtual methods. If a class is to be derived from an
abstract class, the pure virtual methods (which are empty) must be replaced by usable methods
in the new (derived) class.
</p>
<p>
The methods in the new class must have exactly the same number and types of arguments as
found in the pure virtual method's declaration.
</p>
</td>
<td valign="top">
<IMG src="images/cr_abstract.png" width="445" height="630" align="left" border="0" style="border-bottom-color : #929292; border-left-color : #929292; border-right-color : #929292; border-top-color : #929292;">
</td>
</tr>
</table>
<DIV CLASS="NAVFOOTER">
<HR ALIGN="LEFT" WIDTH="100%">
<TABLE SUMMARY="Footer navigation table" WIDTH="100%" BORDER="0" CELLPADDING="0" CELLSPACING="0" style="font-size : 10pt;">
<TR>
<TD WIDTH="33%" ALIGN="left" VALIGN="top"><A HREF="contributing.html" ACCESSKEY="P">Prev</A></TD>
<TD WIDTH="34%" ALIGN="center" VALIGN="top"><A HREF="toc.html" ACCESSKEY="H">Table of Contents</A></TD>
<TD WIDTH="33%" ALIGN="right" VALIGN="top"><A HREF="pykdedocs.html" ACCESSKEY="N">Next</A></TD>
</TR>
<TR>
<TD WIDTH="33%" ALIGN="left" VALIGN="top">Contributing to PyKDE4 PyKDE4</TD>
<TD WIDTH="34%" ALIGN="center" VALIGN="top"> </TD>
<TD WIDTH="33%" ALIGN="right" VALIGN="top">pykdedocs</TD>
</TR>
</TABLE>
</DIV>
</BODY>
</HTML>
|
