summaryrefslogtreecommitdiffstats
path: root/python/pykde/examples/pykde-sampler/HOWTO.samples
diff options
context:
space:
mode:
Diffstat (limited to 'python/pykde/examples/pykde-sampler/HOWTO.samples')
-rw-r--r--python/pykde/examples/pykde-sampler/HOWTO.samples60
1 files changed, 0 insertions, 60 deletions
diff --git a/python/pykde/examples/pykde-sampler/HOWTO.samples b/python/pykde/examples/pykde-sampler/HOWTO.samples
deleted file mode 100644
index 74180541..00000000
--- a/python/pykde/examples/pykde-sampler/HOWTO.samples
+++ /dev/null
@@ -1,60 +0,0 @@
-How to Write Samples for the PyKDE Sampler
-==========================================
-
-
-Create or locate a directory within the sampler application root directory.
-
-Add a module.
-
-In side the module, add the following:
-
-- iconName - string (optional)
- default: 'filenew'
- example: 'colorize'
-
- When supplied, this should be the short name of a KDE icon, such as
- 'stop', 'editclear', etc. If available, This icon will be used as
- the list item's icon in the sampler. Not all icons are available in
- all themes, so try to use the icons that are available in the
- default KDE installation.
-
-
-- labelText - string (optional)
- default: module name
- example: 'KMessageBox'
-
- When supplied, this value is used as the list item text for the
- sample. If it's not supplied, the application will use the name of
- the module instead.
-
-
-- docParts - two-tuple (optional)
- default: None
- example: ('kdeui', 'KAboutDialog')
-
- If specified, this sequence should contain two items, first item
- name of pykde module, second item name of class within the module.
- These two values are used to form the URL to the documentation for
- the sample.
-
-
-- one of buildWidget, buildDialog, buildApp, MainFrame - callable (required)
- default: None
- example: MainFrame(QFrame): ...
-
- The sample module must contain a callable with one of these names.
- The callable must accept a single positional parameter, the parent
- widget.
-
- In most cases, it is sufficient to define a subclass of QFrame named
- 'MainFrame'. To construct a more complex sample, define a function
- with one of the other names.
-
- The callable should return (or instatiate) a widget for display in
- the main sampler widget. The created frame is responsible for
- displaying it's help text and for any providing any widgets
- necessary to
-
-
-
-