from tdecore import *

from tdecore import *

from tdeui import *

from tdeui import *

from KcontrolModuleWidgetUI import *

from KcontrolModuleWidgetUI import *

description = "A Kcontrol module"

description = "A Kcontrol module"

from qt import *

from qt import *

from tdecore import *

from tdecore import *

from tdeui import *

from tdeui import *

from KDEUtilityDialogUI import *

from KDEUtilityDialogUI import *

description = "A KDE Utility"

description = "A KDE Utility"

<?xml version="1.0" ?>

<?xml version="1.0" ?>

<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [

<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [

  <!ENTITY kappname "&appname;"><!-- Do *not* replace kappname-->

  <!ENTITY kappname "&appname;"><!-- Do *not* replace kappname-->

  <!ENTITY package "kde-module"><!-- tdebase, tdeadmin, etc -->

  <!ENTITY package "kde-module"><!-- tdebase, tdeadmin, etc -->

  <!ENTITY % addindex "IGNORE">

  <!ENTITY % addindex "IGNORE">

  <!ENTITY % English "INCLUDE"><!-- change language only here -->

  <!ENTITY % English "INCLUDE"><!-- change language only here -->

  <!-- Do not define any other entities; instead, use the entities

  <!-- Do not define any other entities; instead, use the entities

       from kde-genent.entities and $LANG/user.entities. -->

       from kde-genent.entities and $LANG/user.entities. -->

]>

]>

</abstract>

</abstract>

<!-- This is a set of Keywords for indexing by search engines.

<!-- This is a set of Keywords for indexing by search engines.

 of your application, and a few relevant keywords. -->

 of your application, and a few relevant keywords. -->

<keywordset>

<keywordset>

<keyword>python</keyword>

<keyword>python</keyword>

</keywordset>

</keywordset>

</bookinfo>

</bookinfo>

<title>Installation &amp; Distutils support</title>

<title>Installation &amp; Distutils support</title>

<para>

<para>

<ulink url="http://www.gnu.org/software/autoconf/">autoconf</ulink>,

<ulink url="http://www.gnu.org/software/autoconf/">autoconf</ulink>,

<ulink url="http://www.gnu.org/software/automake/">automake</ulink>

<ulink url="http://www.gnu.org/software/automake/">automake</ulink>

and <ulink url="http://www.gnu.org/software/libtool/">libtool</ulink>

and <ulink url="http://www.gnu.org/software/libtool/">libtool</ulink>

and difficult to use, even for experianced developers.

and difficult to use, even for experianced developers.

</para>

</para>

Fortunately Python has a its own system for building and installing

Fortunately Python has a its own system for building and installing

modules and software. <ulink url="http://docs.python.org/lib/module-distutils.html">Distutils</ulink>

modules and software. <ulink url="http://docs.python.org/lib/module-distutils.html">Distutils</ulink>

is a standard Python package and comes with every Python installation.

is a standard Python package and comes with every Python installation.

programs.

programs.

</para>

</para>

<para>

<para>

extra files such as a manual written in <ulink url="http://i18n.kde.org/doc/markup/">Docbook

extra files such as a manual written in <ulink url="http://i18n.kde.org/doc/markup/">Docbook

format</ulink>, <ulink url="http://i18n.kde.org/translation-howto/">translation files</ulink>,

format</ulink>, <ulink url="http://i18n.kde.org/translation-howto/">translation files</ulink>,

icons, images and other auxiliary data files. &appname; provides support for

icons, images and other auxiliary data files. &appname; provides support for

</para>

</para>

<sect1 id="distutils-using">

<sect1 id="distutils-using">

<para>

<para>

It is advised that you first read the standard

It is advised that you first read the standard

<ulink url="http://docs.python.org/lib/module-distutils.html">Distutils documentation</ulink>

<ulink url="http://docs.python.org/lib/module-distutils.html">Distutils documentation</ulink>

below.

below.

</para>

</para>

<para>

<para>

Distutils is based around writing a <filename>setup.py</filename> file which

Distutils is based around writing a <filename>setup.py</filename> file which

then uses the distutils package

then uses the distutils package

</filename> file is include the <symbol>tdedistutils</symbol> package.

</filename> file is include the <symbol>tdedistutils</symbol> package.

<programlisting>

<programlisting>

#!/usr/bin/env python

#!/usr/bin/env python

import tdedistutils

import tdedistutils

</programlisting>

</programlisting>

</programlisting>

</programlisting>

<symbol>min_kde_version</symbol> and <symbol>min_qt_version</symbol> specify

<symbol>min_kde_version</symbol> and <symbol>min_qt_version</symbol> specify

the software. These requirements are checked during install.

the software. These requirements are checked during install.

</para>

</para>

<sect1 id="distutils-files">

<sect1 id="distutils-files">

<title>Application data files</title>

<title>Application data files</title>

<para>

<para>

data files it may need to run.

data files it may need to run.

</para>

</para>

<para>

<para>

Even with all of the python files in the Application data directory, it is

Even with all of the python files in the Application data directory, it is

<filename>bin</filename> directory. &appname; provides an easy way for creating

<filename>bin</filename> directory. &appname; provides an easy way for creating

symbolic links from the "bin" directory to scripts in the application

symbolic links from the "bin" directory to scripts in the application

directory.

directory.

<sect1 id="distutils-uninstall">

<sect1 id="distutils-uninstall">

<title>Uninstall command</title>

<title>Uninstall command</title>

<para>

<para>

and it can be easily invoked with:

and it can be easily invoked with:

<screen>

<screen>

python setup.py uninstall

python setup.py uninstall

More information about using Docbook to write manuals and documentation using

More information about using Docbook to write manuals and documentation using

Docbook is <ulink url="http://i18n.kde.org/doc/markup/">here</ulink>.

Docbook is <ulink url="http://i18n.kde.org/doc/markup/">here</ulink>.

Manuals are written in the Docbook format, but need to be converted

Manuals are written in the Docbook format, but need to be converted

</para>

</para>

<para>

<para>

application. This can be manually done using the <command>pyuic</command>

application. This can be manually done using the <command>pyuic</command>

command from the shell. But it is a lot more convenient to let &appname;

command from the shell. But it is a lot more convenient to let &appname;

to this automatically for you. All you need to do is import the

to this automatically for you. All you need to do is import the

your user interface files as though they were normal Python files.

your user interface files as though they were normal Python files.

<programlisting>

<programlisting>

#!/usr/bin/env python

#!/usr/bin/env python

from tdeui import *

from tdeui import *

from MyWindow import * # Loads MyWindow.ui

from MyWindow import * # Loads MyWindow.ui

# Subclass the Qt-designer form.

# Subclass the Qt-designer form.

class MyWindowCode(MyWindow):

class MyWindowCode(MyWindow):

    # Implement extra functionality and methods.

    # Implement extra functionality and methods.

</programlisting>

</programlisting>

<literal role="extension">.ui</literal> on demand to

<literal role="extension">.ui</literal> on demand to

<literal role="extension">.py</literal> files.

<literal role="extension">.py</literal> files.

</para>

</para>

<para>

<para>

i18n (an abbreviation of internationalization) is the process of translating

i18n (an abbreviation of internationalization) is the process of translating

the user interface and documentation of a piece of software into another

the user interface and documentation of a piece of software into another

languages.

languages.

</para>

</para>

that should contain the <literal role="extension">.pot</literal> and

that should contain the <literal role="extension">.pot</literal> and

<literal role="extension">.po</literal> files. The argument for

<literal role="extension">.po</literal> files. The argument for

<symbol>i18n</symbol> is a tuple. The first item is the relative path

<symbol>i18n</symbol> is a tuple. The first item is the relative path

second item is a list of directories that should be scanned for Python source

second item is a list of directories that should be scanned for Python source

files containing translatable strings.

files containing translatable strings.

<programlisting>

<programlisting>

<chapter id="kcontrol-modules">

<chapter id="kcontrol-modules">

<title>TDE Control Center Modules</title>

<title>TDE Control Center Modules</title>

<para>

<para>

C++ glue code is needed when writing in module in Python. Fortunately

C++ glue code is needed when writing in module in Python. Fortunately

&appname; can generate this glue for you automatically.

&appname; can generate this glue for you automatically.

</para>

</para>

<para>

<para>

<ulink url="http://developer.kde.org/documentation/other/kcm_howto.html">TDEConfig

<ulink url="http://developer.kde.org/documentation/other/kcm_howto.html">TDEConfig

Module HOWTO</ulink>. It is written for C++, but the concepts are the same for

Module HOWTO</ulink>. It is written for C++, but the concepts are the same for

Python.

Python.

</para>

</para>

<para>

<para>

In your <filename>setup.py</filename> file you can specify the list of kcontrol

In your <filename>setup.py</filename> file you can specify the list of kcontrol

<programlisting>

<programlisting>

    kcontrol_modules = [ ('src/kcontrol_module.desktop','kcontrol_module.py')] )

    kcontrol_modules = [ ('src/kcontrol_module.desktop','kcontrol_module.py')] )

</programlisting>

</programlisting>

This is just a list of tuples. The first item is name of the

This is just a list of tuples. The first item is name of the

<literal role="extension">.desktop</literal> file that you've made for your

<literal role="extension">.desktop</literal> file that you've made for your

module. The second item is the name of the Python program to run when the

module. The second item is the name of the Python program to run when the

the application's data files directory.

the application's data files directory.

</para>

</para>

<para>

<para>

The <ulink url="http://developer.kde.org/documentation/standards/kde/kcontrol_style/index.html">

The <ulink url="http://developer.kde.org/documentation/standards/kde/kcontrol_style/index.html">

KControl Module Guidelines</ulink> provides useful information about how to

KControl Module Guidelines</ulink> provides useful information about how to

</para>

</para>

<tip>

<tip>

</para>

</para>

<para>

<para>

In your <filename>setup.py</filename> file you can specify the list of tdeioslaves

In your <filename>setup.py</filename> file you can specify the list of tdeioslaves

<programlisting>

<programlisting>

    tdeioslaves = [ ('src/tdeioslave.protocol','tdeioslave.py')] )

    tdeioslaves = [ ('src/tdeioslave.protocol','tdeioslave.py')] )

</programlisting>

</programlisting>

This is just a list of tuples. The first item is name of the

This is just a list of tuples. The first item is name of the

<literal role="extension">.protocol</literal> file that you've made for your

<literal role="extension">.protocol</literal> file that you've made for your

tdeio-slave. The second item is the name of the Python program to run when the

tdeio-slave. The second item is the name of the Python program to run when the

the application's data files directory.

the application's data files directory.

</para>

</para>

</chapter>

</chapter>

<para>

<para>

The <filename>app_templates</filename> directory contains a number of

The <filename>app_templates</filename> directory contains a number of

application templates. An <quote>application template</quote> is just a collection of files

application templates. An <quote>application template</quote> is just a collection of files

when developing a new application. An application template typically contains

when developing a new application. An application template typically contains

default documentation files, icons, source file and <filename>setup.py

default documentation files, icons, source file and <filename>setup.py

</filename> file which can later be modified.

</filename> file which can later be modified.

</para>

</para>

<sect1 id="app-template-simple">

<sect1 id="app-template-simple">

<para>

<para>

The <filename>kdeutility</filename> application template is a simple utility

The <filename>kdeutility</filename> application template is a simple utility

or toolbar.

or toolbar.

</para>

</para>

</sect1>

</sect1>

<sect1 id="app-template-application">

<sect1 id="app-template-application">

<para>

<para>

The <filename>kdeapp</filename> application template is an application with

The <filename>kdeapp</filename> application template is an application with

menubar, toolbar and separated document and view classes. The menubar and toolbars

menubar, toolbar and separated document and view classes. The menubar and toolbars

<title>TDEIO-slave Application Template</title>

<title>TDEIO-slave Application Template</title>

<para>

<para>

The <filename>tdeioslave</filename> application template is a simple

The <filename>tdeioslave</filename> application template is a simple

accessed using tdeioslave:/ in konqueror. It is initially empty. Files and

accessed using tdeioslave:/ in konqueror. It is initially empty. Files and

directories can be made and deposited. <filename>tdeioslave.py</filename>

directories can be made and deposited. <filename>tdeioslave.py</filename>

contains more information and comments.

contains more information and comments.

<refpurpose>remove a list of children from a parent widget's managed

<refpurpose>remove a list of children from a parent widget's managed

list.

list.

<indexterm id="ix-1007-unmanagechildren-1"><primary>widgets</primary><secondary>removing</secondary></indexterm>

<indexterm id="ix-1007-unmanagechildren-1"><primary>widgets</primary><secondary>removing</secondary></indexterm>

</refpurpose>

</refpurpose>

</refnamediv>

</refnamediv>

<!-- Include credits for the programmers, documentation writers, and

<!-- Include credits for the programmers, documentation writers, and

contributors here. The license for your software should then be included below

contributors here. The license for your software should then be included below

distribution. -->

distribution. -->

<title>Credits and License</title>

<title>Credits and License</title>

sgml-indent-data:nil

sgml-indent-data:nil

End:

End:

-->

-->

        min_qt_version = "3.0.0",

        min_qt_version = "3.0.0",

        license = "LGPL",

        license = "LGPL",

        package_dir = {'': 'src'},

        package_dir = {'': 'src'},

        application_data = ["app_templates","AUTHORS","ChangeLog","COPYING","INSTALL","NEWS"],

        application_data = ["app_templates","AUTHORS","ChangeLog","COPYING","INSTALL","NEWS"],

        docbooks = [ ('doc/en','en') ],

        docbooks = [ ('doc/en','en') ],

        cmdclass = {

        cmdclass = {