mirror of
https://bitbucket.org/smil3y/kde-playground.git
synced 2025-02-24 10:52:52 +00:00
220 lines
9.8 KiB
HTML
220 lines
9.8 KiB
HTML
<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 - General Information</TH></TR>
|
|
<TR><TD WIDTH="10%" ALIGN="left" VALIGN="bottom"><A HREF="toc.html" ACCESSKEY="P">Prev</A></TD>
|
|
<TD WIDTH="80%" ALIGN="center" VALIGN="bottom"></TD>
|
|
<TD WIDTH="10%" ALIGN="right" VALIGN="bottom"><A HREF="install.html" ACCESSKEY="N">Next</A></TD>
|
|
</TR>
|
|
</TABLE><HR ALIGN="LEFT" WIDTH="100%"></DIV>
|
|
<h2>General Information</h2>
|
|
<p>
|
|
PyKDE4 is a set of Python bindings for KDE4's kdelibs. It includes the modules kdecore, solid,
|
|
kdeui, kio, kparts, kutils, and khtml.
|
|
</p>
|
|
<p>
|
|
PyKDE4 should be installed in a path known to Python (usually /usr/lib/python/site-packages). PyKDE4/
|
|
is the top level directory for all PyKDE4 modules, so an import statement and code references must look like:
|
|
</p>
|
|
<pre>
|
|
from PyKDE4.kdeui import KApplication
|
|
...
|
|
app = KApplication ()
|
|
</pre>
|
|
<p>or:</p>
|
|
<pre>
|
|
import PyKDE4.kdeui
|
|
...
|
|
app = PyKDE4.kdeui.KApplication ()
|
|
</pre>
|
|
<p>
|
|
Other forms are also possible. The form:
|
|
</p>
|
|
<pre>
|
|
from PyKDE4.kdeui import *
|
|
</pre>
|
|
<p>
|
|
is not recommended, as there may be clashes between object names in the various PyKDE4 modules.
|
|
</p>
|
|
<a name="versions"><h3>Versions and Numbering</h3></a>
|
|
<p>
|
|
Releases of the tarball versions of PyKDE4 are numbered as follows:
|
|
</p>
|
|
<dl>
|
|
<dt>PyKDE4</dt><dd>All PyKDE4 versions begin with 'PyKDE4'</dd>
|
|
<dt>X.Y.Z</dt><dd>A version number corresponding to the highest KDE version supported (see below)</dd>
|
|
<dt>blank or #</dt><dd>nothing for the first release for a KDE version, otherwise a sequential number for subsequent
|
|
update releases for the same KDE version (bugfixes or new features)</dd>
|
|
</dl>
|
|
<p>
|
|
For example, the first three releases have been PyKDE4-4.0.0 (the initial release), PyKDE4-4.0.0-1 (a bug fix release of 4.4.0)
|
|
and PyKDE4-4.0.2 (initial release against KDE 4.0.2 - has some bug fixes in this case). The ChangeLog in the top level directory
|
|
outlines changes made between versions.
|
|
</p>
|
|
<p>
|
|
<b>NOTE</b>: The PyKDE4 tarballs should build against <b>any</b> KDE4 release - the files include version information to
|
|
generate correct code for the detected installed KDE version. The KDE svn source (kdebindings) may or may not include
|
|
version information, and will likely only build against the KDE version it was released with. So in the future, the PyKDE4-4.5.6
|
|
tarball sources should still build correctly against KDE 4.0.0.
|
|
</p>
|
|
<p>
|
|
Presently, PyKDE4 is only tested against the most recent KDE, sip, Qt and PyQt versions at the time of release.
|
|
However, failure to build against an earlier version should be considered a bug and reported. Also, changes
|
|
to KDE do occur that may prevent PyKDE4 versions from building against future KDE versions (for example,
|
|
PyKDE4-4.0.2 should build against KDE 4.1.0, but may not, depending on changes in KDE).
|
|
</p>
|
|
<p>
|
|
<b>NOTE</b>: Compatibility with older sip or PyQt versions is not guaranteed. In fact, incompatible sip revisions
|
|
sometimes are necessary to support new PyKDE4 features.
|
|
</p>
|
|
<a name="components"><h3>PyKDE4 Components</h3></a>
|
|
<p><b>kdecore</b></p>
|
|
<p>
|
|
kdecore contains classes for handling non-graphical needs of PyKDE4 applications, basic program information
|
|
(KAboutData, KCmdLineArgs), URL handling (KUrl, KMimetype), date and time (KDateTime), file operations
|
|
(KAutoSaveFile, KSaveFile), localization and translation (KLocale, KLocalizedString, i18n, ki18n), one
|
|
config file mechanism (KConfig) and access to KService related mechanisms.
|
|
</p>
|
|
<p><b>solid</b></p>
|
|
<p>
|
|
solid contains classes for discovering the hardware and hardware capabilities on a system
|
|
</p>
|
|
<p><b>kdeui</b></p>
|
|
<p>
|
|
kdeui is the largest module in PyKDE4 and includes the classes necessary to create a KDE4/PyKDE4
|
|
application (KApplication, KUniqueApplication) and its main window (KMainWindow, KXmlGuiWindow),
|
|
classes for actions (KAction, the KStandardAction namespace) most of the KDE4 widgets, pre-written
|
|
or reusable dialogs and the base class for KDE4 dialogs (KDialog, KMessageBox, KColorDialog) and
|
|
an alternative config file mechanism (KConfigSkeleton).
|
|
</p>
|
|
<p><b>kio</b></p>
|
|
<p>
|
|
The kio module includes classes to interact with and intiate KIO slaves (KIO:Job and descendants, KIO.NetAccess).
|
|
It also contains the KFile* classes, including those which pop up file or directory selection dialogs, and
|
|
a bookmark handling class (KBookmark and releated).
|
|
</p>
|
|
<p><b>kparts</b></p>
|
|
<p>
|
|
kparts includes classes to allow you to embed KParts in your application (creating a reusable KPart requires
|
|
C++). It also includes classes that add capabilities to KHTMLPart (BrowserExtension, BrowserHostExtension).
|
|
</p>
|
|
<p><b>kutils</b></p>
|
|
<p>
|
|
kutils is a small module that includes some utility classes.
|
|
</p>
|
|
<p><b>khtml</b></p>
|
|
<p>
|
|
khtml includes classes (KHTMLPart, KHTMLView) that allow you to build a web browser into your application. This
|
|
module also includes and extensive set of classes for DOM handling.
|
|
</p>
|
|
|
|
<a name="license"><h3>License</h3></a>
|
|
<p><a href="COPYING.html">GNU General Public License (GPL)</a></p>
|
|
<p><a href="COPYING.LESSER.html">GNU Lesser General Public License (LGPL)</a></p>
|
|
<p><a href="CREATIVECOMMONS.html">Creative Commons License</a></p>
|
|
<p>
|
|
PyKDE4 librairies are licensed under the GNU Library (or "Lesser") General Public License (LGPL) version 2.
|
|
That means non-open source software can use and link to the PyKDE4 libraries, as long as
|
|
no substantial modifications are made to those libraries. A copy of the LGPL license should
|
|
have been included with PyKDE4 in the file COPYING.LESSER. If not, you can find a copy online
|
|
at the <a href="http://www.gnu.org">GNU web site</a> or follow the links above.
|
|
</p>
|
|
<p>
|
|
The PyKDE4 documentation viewer code (<b>pykdedocs</b>) and example code produced by the PyKDE4
|
|
authors are licensed under the GNU General Public License (GPL) version 2. Tutorials and other
|
|
text information produced by the PyKDE4 authors is licensed under the Creative Commons Public License
|
|
(CCPL - the "share-alike" license - see link above for complete license terms). Materials contributed to PyKDE4
|
|
are licensed as specified by the material's respective authors - see the individual files for license
|
|
terms.
|
|
</p>
|
|
<p>
|
|
All code and text included in the PyKDE4 and pykdedocs packages may be freely distributed in its original
|
|
form, subject to the GPL and CCPL license requirements. If you need to modify any of the code or text and want to
|
|
distribute the modified code, your modified code must be licensed under the GPL version 2 or later and any
|
|
modifications to non-executable parts of the package must be licensed under the "share-alike" CCPL version. If
|
|
this is a problem, contact the author(s)/copyright holder(s) of the material to be modified.
|
|
</p>
|
|
<p>
|
|
All code and text in PyKDE4 and pykdedocs is copyrighted and owned by the code's or text's respective
|
|
authors - see specific files for more information.
|
|
</p>
|
|
PyKDE4 is built on software developed by
|
|
</P>
|
|
<ul>
|
|
<li>KDE project programmers (the KDE Desktop Environment and kdelibs) </li>
|
|
<li>Python programmers (the Python language and extensions) </li>
|
|
<li>Riverbank Computiing (sip, PyQt4 and the original PyKDE version)</li>
|
|
</ul>
|
|
<p>
|
|
These packages are required, and each has its own licensing requirements.
|
|
</p>
|
|
<a name="disclaimer"><h3>Disclaimer</h3></a>
|
|
<p>
|
|
pykdedocs is capable of interacting with external web sites via the internet. Use of
|
|
the internet may expose you or your computer to well known risks.
|
|
</p>
|
|
<p>
|
|
pykdedocs and PyKDE4 are licensed for your use only under the GNU General Public License (GPL) version 2.
|
|
The GPL includes the following disclaimers which apply to both internet access using
|
|
pykdedocs, and the use of pykdedocs and PyKDE4 in general. A copy of the GPL can be found in the file
|
|
documentation/COPYING at the location where pykdedocs documentation files were installed.
|
|
</p>
|
|
<h3 align="center">NO WARRANTY</h3>
|
|
<p>
|
|
11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
|
|
FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
|
|
OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
|
|
PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
|
|
OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
|
|
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
|
|
TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
|
|
PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
|
|
REPAIR OR CORRECTION.
|
|
</p>
|
|
<p>
|
|
12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
|
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
|
|
REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
|
|
INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
|
|
OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
|
|
TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
|
|
YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
|
|
PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
|
|
POSSIBILITY OF SUCH DAMAGES.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<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="toc.html" ACCESSKEY="P">Prev</p></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="install.html" ACCESSKEY="N">Next</A></TD>
|
|
</TR>
|
|
<TR>
|
|
<TD WIDTH="33%" ALIGN="left" VALIGN="top">Table of Contents</TD>
|
|
<TD WIDTH="34%" ALIGN="center" VALIGN="top"> </TD>
|
|
<TD WIDTH="33%" ALIGN="right" VALIGN="top">Installation</TD>
|
|
</TR>
|
|
</TABLE>
|
|
</DIV>
|
|
</BODY>
|
|
</HTML>
|