Make AddMouseRegion's index unsigned
[dockapps.git] / libdockapp / examples / README
blobeef6b209195304f8934c9b6ab6abf7b42be23ad9
1 About the examples
2 ------------------
3 In this directory you find the example applications for libDockApp. This is a
4 work in progress. It is not easy to come up with good examples of how to use
5 features without bloating it with "stuff you don't need to know". That's why it
6 is far from finished, and that's also why I INVITE YOU TO SUBMIT simple dockapps
7 that provide good examples of certain features.
9 The examples:
10 ------------
11    basic:
12         This is an example that uses a few simple shapes; a rectangle containing
13         a bouncing ball.
14         It shows how to use the abstracted DAShapedPixmap structs and how to use
15         X Window types for overlaying one shape on top of another (something
16         much easier and more flexible than trying to blend the pixmaps
17         together).
18         It also shows some simple event handling (a timeout event and a window
19         close event).
21     rectangles:
22         This example shows how to use "action rectangles". Those are areas that
23         you define callbacks for events on.
24         The example got rather mixed up with X drawing calls, and creating
25         shapes by hand from X regions. I'm thinking about either stripping it of
26         most functionality to make it a proper example of what it tries to show,
27         or to rename it to "tangles".
28         It even uses some deprecated features...
30     shapes:
31         NOT IMPLEMENTED YET.
32         And maybe a tad superfluous, as "basic" already show how to use shapes.
34 Needed examples:
35 ---------------
36 I need examples that show one or more of the following (less is better):
37 - Something very basic; just showing how to get started.
38 - Command line parameter parsing.
39 - Action rectangles; my example isn't very good.
40 - How to handle different icon sizes flexibly (I think that could result in some
41   new library functions to be added).
42 - Loading pixmaps in runtime.