first import
[iramuteq] / agw / __init__.py
1 """
2 This is the Advanced Generic Widgets package (AGW). It provides many 
3 custom-drawn wxPython controls: some of them can be used as a replacement 
4 of the platform native controls, others are simply an addition to the 
5 already rich wxPython widgets set.
6
7
8 Description:
9
10 AGW contains many different modules, listed below. Items labelled with 
11 an asterisk were already present in `wx.lib` before:
12
13 - AdvancedSplash: reproduces the behaviour of `wx.SplashScreen`, with more
14   advanced features like custom shapes and text animations;
15 - AquaButton: this is another custom-drawn button class which
16   *approximatively* mimics the behaviour of Aqua buttons on the Mac;
17 - AUI: a pure-Python implementation of `wx.aui`, with many bug fixes and
18   new features like HUD docking and L{AuiNotebook} tab arts;
19 - BalloonTip: allows you to display tooltips in a balloon style window
20   (actually a frame), similarly to the Windows XP balloon help;
21 - ButtonPanel (*): a panel with gradient background shading with the
22   possibility to add buttons and controls still respecting the gradient
23   background;
24 - CubeColourDialog: an alternative implementation of `wx.ColourDialog`, it
25   offers different functionalities like colour wheel and RGB cube;
26 - CustomTreeCtrl (*): mimics the behaviour of `wx.TreeCtrl`, with almost the
27   same base functionalities plus a bunch of enhancements and goodies;
28 - FlatMenu: as the name implies, it is a generic menu implementation,
29   offering the same `wx.MenuBar`/`wx.Menu`/`wx.ToolBar` capabilities and much more;
30 - FlatNotebook (*): a full implementation of the `wx.Notebook`, and designed
31   to be a drop-in replacement for `wx.Notebook` with enhanced capabilities;
32 - FloatSpin: this class implements a floating point spinctrl, cabable (in
33   theory) of handling infinite-precision floating point numbers;
34 - FoldPanelBar (*): a control that contains multiple panels that can be
35   expanded or collapsed a la Windows Explorer/Outlook command bars;
36 - FourWaySplitter: this is a layout manager which manages four children like
37   four panes in a window, similar to many CAD software interfaces;
38 - GenericMessageDialog: it is a possible replacement for the standard
39   `wx.MessageDialog`, with a fancier look and extended functionalities;
40 - GradientButton: another custom-drawn button class which mimics Windows CE
41   mobile gradient buttons, using a tri-vertex blended gradient background;
42 - HyperLinkCtrl (*): this widget acts line an hyper link in a typical browser;
43 - HyperTreeList: a class that mimics the behaviour of `wx.gizmos.TreeListCtrl`,
44   with almost the same base functionalities plus some more enhancements;
45 - KnobCtrl: a widget which lets the user select a numerical value by
46   rotating it, like a slider with a wheel shape;
47 - LabelBook and FlatImageBook: these are a quasi-full implementations of
48   `wx.ListBook`, with additional features;
49 - MultiDirDialog: it represents a possible replacement for `wx.DirDialog`,
50   with the additional ability of selecting multiple folders at once and a
51   fancier look;
52 - PeakMeter: this widget mimics the behaviour of LED equalizers that are
53   usually found in stereos and MP3 players;
54 - PersistentControls: widgets which automatically save their state
55   when they are destroyed and restore it when they are recreated, even during
56   another program invocation;
57 - PieCtrl and ProgressPie: these are simple classes that reproduce the
58   behavior of a pie chart, in a static or progress-gauge-like way;
59 - PyBusyInfo: constructs a busy info window and displays a message in it:
60   it is similar to `wx.BusyInfo`;
61 - PyCollapsiblePane: a pure Python implementation of the original wxWidgets
62   C++ code of `wx.CollapsiblePane`, with customizable buttons;
63 - PyGauge: a generic `wx.Gauge` implementation, it supports the determinate
64   mode functions as `wx.Gauge`;
65 - PyProgress: it is similar to `wx.ProgressDialog` in indeterminated mode, but
66   with a different gauge appearance and a different spinning behavior;
67 - RibbonBar: the RibbonBar library is a set of classes for writing a ribbon
68   user interface, similar to the user interface present in recent versions
69   of Microsoft Office;
70 - RulerCtrl: it implements a ruler window that can be placed on top, bottom,
71   left or right to any wxPython widget. It is somewhat similar to the rulers
72   you can find in text editors software;
73 - ShapedButton: this class tries to fill the lack of "custom shaped" controls
74   in wxPython. It can be used to build round buttons or elliptic buttons;
75 - SpeedMeter: this widget tries to reproduce the behavior of some car
76   controls (but not only), by creating an "angular" control;
77 - SuperToolTip: a class that mimics the behaviour of `wx.TipWindow` and
78   generic tooltips, with many features and highly customizable;
79 - ThumbnailCtrl: a widget that can be used to display a series of images
80   in a "thumbnail" format; it mimics, for example, the Windows Explorer
81   behavior when you select the "view thumbnails" option;
82 - ToasterBox: a cross-platform widget to make the creation of MSN-style
83   "toaster" popups easier;
84 - UltimateListCtrl: mimics the behaviour of `wx.ListCtrl`, with almost the same
85   base functionalities plus some more enhancements;
86 - ZoomBar: a class that *appoximatively* mimics the behaviour of the Mac Dock,
87   inside a `wx.Panel`.
88
89
90 Bugs and Limitations: many, patches and fixes welcome :-D
91
92 See the demos for an example of what AGW can do, and on how to use it.
93
94 Copyright: Andrea Gavana
95
96 License: Same as the version of wxPython you are using it with.
97
98 SVN for latest code:
99 http://svn.wxwidgets.org/viewvc/wx/wxPython/3rdParty/AGW/
100
101 Mailing List:
102 wxpython-users@lists.wxwidgets.org
103
104 My personal web page:
105 http://xoomer.alice.it/infinity77
106
107 Please let me know if you are using AGW!
108
109 You can contact me at:
110
111 andrea.gavana@gmail.com
112 gavana@kpo.kz
113
114 AGW version: 0.9.1
115
116 Last updated: 10 Mar 2011, 15.00 GMT
117
118 """
119
120 __version__ = "0.9.1"
121 __author__ = "Andrea Gavana <andrea.gavana@gmail.com>"