dabo Commit
Revision 1593
Date: 2005-11-28 17:06:21 -0800 (Mon, 28 Nov 2005)
Author: paul
Changed:
U trunk/dabo/ui/uiwx/dBaseMenuBar.py
U trunk/dabo/ui/uiwx/dBitmap.py
U trunk/dabo/ui/uiwx/dBitmapButton.py
U trunk/dabo/ui/uiwx/dBorderSizer.py
U trunk/dabo/ui/uiwx/dBox.py
U trunk/dabo/ui/uiwx/dButton.py
U trunk/dabo/ui/uiwx/dCheckBox.py
U trunk/dabo/ui/uiwx/dColorDialog.py
U trunk/dabo/ui/uiwx/dComboBox.py
U trunk/dabo/ui/uiwx/dDialog.py
U trunk/dabo/ui/uiwx/dDropdownList.py
U trunk/dabo/ui/uiwx/dEditBox.py
U trunk/dabo/ui/uiwx/dFileDialog.py
U trunk/dabo/ui/uiwx/dFontDialog.py
U trunk/dabo/ui/uiwx/dForm.py
U trunk/dabo/ui/uiwx/dFormMain.py
U trunk/dabo/ui/uiwx/dFormMixin.py
U trunk/dabo/ui/uiwx/dGauge.py
U trunk/dabo/ui/uiwx/dGrid.py
U trunk/dabo/ui/uiwx/dGridSizer.py
U trunk/dabo/ui/uiwx/dLabel.py
U trunk/dabo/ui/uiwx/dLine.py
U trunk/dabo/ui/uiwx/dListBox.py
U trunk/dabo/ui/uiwx/dListControl.py
U trunk/dabo/ui/uiwx/dMenu.py
U trunk/dabo/ui/uiwx/dMenuBar.py
U trunk/dabo/ui/uiwx/dMenuItem.py
U trunk/dabo/ui/uiwx/dPage.py
U trunk/dabo/ui/uiwx/dPageFrame.py
U trunk/dabo/ui/uiwx/dPageFrameMixin.py
U trunk/dabo/ui/uiwx/dPageFrameNoTabs.py
U trunk/dabo/ui/uiwx/dPanel.py
U trunk/dabo/ui/uiwx/dPemMixin.py
U trunk/dabo/ui/uiwx/dRadioGroup.py
U trunk/dabo/ui/uiwx/dSlider.py
U trunk/dabo/ui/uiwx/dSpinner.py
U trunk/dabo/ui/uiwx/dStatusBar.py
U trunk/dabo/ui/uiwx/dTextBox.py
U trunk/dabo/ui/uiwx/dTimer.py
U trunk/dabo/ui/uiwx/dToggleButton.py
U trunk/dabo/ui/uiwx/dToolBar.py
U trunk/dabo/ui/uiwx/dTreeView.py
Log:
I went through all the uiwx classes and filled in docstrings for most of them.
I think we still want to spend a lot more time explaining each class, when to
use it, as well as providing a short example or two. But at least they aren't
empty anymore.
Also, I want to get screenshots of each control saved with a naming convention,
which will allow the screenshots to be displayed in the api documentation.
Diff:
Modified: trunk/dabo/ui/uiwx/dBaseMenuBar.py
===================================================================
--- trunk/dabo/ui/uiwx/dBaseMenuBar.py 2005-11-28 20:01:05 UTC (rev 1592)
+++ trunk/dabo/ui/uiwx/dBaseMenuBar.py 2005-11-29 01:06:21 UTC (rev 1593)
@@ -109,6 +109,17 @@
class dBaseMenuBar(dMenuBar):
+ """Creates a basic menu bar with File, Edit, and Help menus.
+
+ The Edit menu has standard Copy, Cut, and Paste menu items, and the
Help menu
+ has an About menu item. On Mac, the About menu item and Help menu are
moved
+ to the appropriate place in the application menu.
+
+ Typical usage would be to instantiate dBaseMenuBar, set it to your
form's
+ menubar (using form.MenuBar = dabo.ui.dBaseMenuBar) and then use the
+ append() methods of dMenuBar and dMenu to add the specific dMenu(s) and
+ dMenuItem(s) that your application needs.
+ """
def _afterInit(self):
super(dBaseMenuBar, self)._afterInit()
self.appendMenu(FileMenu(self))
Modified: trunk/dabo/ui/uiwx/dBitmap.py
===================================================================
--- trunk/dabo/ui/uiwx/dBitmap.py 2005-11-28 20:01:05 UTC (rev 1592)
+++ trunk/dabo/ui/uiwx/dBitmap.py 2005-11-29 01:06:21 UTC (rev 1593)
@@ -9,7 +9,7 @@
import dIcons
class dBitmap(wx.StaticBitmap, cm.dControlMixin):
- """ Create a simple bitmap to display images.
+ """Creates a simple bitmap control to display images on your forms.
"""
def __init__(self, parent, properties=None, *args, **kwargs):
self._baseClass = dBitmap
Modified: trunk/dabo/ui/uiwx/dBitmapButton.py
===================================================================
--- trunk/dabo/ui/uiwx/dBitmapButton.py 2005-11-28 20:01:05 UTC (rev 1592)
+++ trunk/dabo/ui/uiwx/dBitmapButton.py 2005-11-29 01:06:21 UTC (rev 1593)
@@ -9,7 +9,15 @@
from dIcons import getIconBitmap
class dBitmapButton(wx.BitmapButton, cm.dControlMixin):
- """ Allows the user to cause an action to occur by pushing a button."""
+ """Creates a button with a picture.
+
+ The button can have up to three pictures associated with it:
+ Picture: the normal picture shown on the button.
+ DownPicture: the picture displayed when the button is depressed.
+ FocusPicture: the picture displayed when the button has the
focus.
+
+ Otherwise, dBitmapButton behaves the same as a normal dButton.
+ """
def __init__(self, parent, properties=None, *args, **kwargs):
self._baseClass = dBitmapButton
preClass = wx.PreBitmapButton
Modified: trunk/dabo/ui/uiwx/dBorderSizer.py
===================================================================
--- trunk/dabo/ui/uiwx/dBorderSizer.py 2005-11-28 20:01:05 UTC (rev 1592)
+++ trunk/dabo/ui/uiwx/dBorderSizer.py 2005-11-29 01:06:21 UTC (rev 1593)
@@ -4,6 +4,7 @@
import dSizerMixin
class dBorderSizer(wx.StaticBoxSizer, dSizerMixin.dSizerMixin):
+ """TODO: Explain what a BorderSizer does and when you'd use it."""
def __init__(self, box, orientation="h"):
# Make sure that they got the params in the right order
if isinstance(box, basestring):
Modified: trunk/dabo/ui/uiwx/dBox.py
===================================================================
--- trunk/dabo/ui/uiwx/dBox.py 2005-11-28 20:01:05 UTC (rev 1592)
+++ trunk/dabo/ui/uiwx/dBox.py 2005-11-29 01:06:21 UTC (rev 1593)
@@ -6,8 +6,10 @@
import dControlMixin as cm
class dBox(wx.StaticBox, cm.dControlMixin):
- """ Create a static (not data-aware) box.
+ """Creates a box for visually grouping objects on your form.
"""
+ ## pkm: I'm not sure of the utility of this class, since you can draw
+ ## borders around panels and direct draw on any object. Opinions?
def __init__(self, parent, properties=None, *args, **kwargs):
self._baseClass = dBox
preClass = wx.PreStaticBox
Modified: trunk/dabo/ui/uiwx/dButton.py
===================================================================
--- trunk/dabo/ui/uiwx/dButton.py 2005-11-28 20:01:05 UTC (rev 1592)
+++ trunk/dabo/ui/uiwx/dButton.py 2005-11-29 01:06:21 UTC (rev 1593)
@@ -10,7 +10,17 @@
import dabo.dEvents as dEvents
class dButton(wx.Button, cm.dControlMixin):
- """ Allows the user to cause an action to occur by pushing a button.
+ """Creates a button that can be pressed by the user to trigger an
action.
+
+ Example:
+
+ class MyButton(dabo.ui.dButton):
+ def initProperties(self):
+ self.Caption = "Press Me"
+
+ def onHit(self, evt):
+ self.Caption = "Press Me one more time"
+
"""
def __init__(self, parent, properties=None, *args, **kwargs):
self._baseClass = dButton
Modified: trunk/dabo/ui/uiwx/dCheckBox.py
===================================================================
--- trunk/dabo/ui/uiwx/dCheckBox.py 2005-11-28 20:01:05 UTC (rev 1592)
+++ trunk/dabo/ui/uiwx/dCheckBox.py 2005-11-29 01:06:21 UTC (rev 1593)
@@ -9,7 +9,7 @@
class dCheckBox(wx.CheckBox, dcm.dDataControlMixin):
- """ Allows visual editing of boolean values.
+ """Creates a checkbox, allowing editing boolean values.
"""
def __init__(self, parent, properties=None, *args, **kwargs):
self._baseClass = dCheckBox
Modified: trunk/dabo/ui/uiwx/dColorDialog.py
===================================================================
--- trunk/dabo/ui/uiwx/dColorDialog.py 2005-11-28 20:01:05 UTC (rev 1592)
+++ trunk/dabo/ui/uiwx/dColorDialog.py 2005-11-29 01:06:21 UTC (rev 1593)
@@ -4,6 +4,7 @@
class dColorDialog(wx.ColourDialog):
+ """Creates a dialog that allows the user to pick a color."""
def __init__(self, parent=None, color=None):
self._baseClass = dColorDialog
dat = wx.ColourData()
@@ -39,3 +40,8 @@
def getColor(self):
return self._selColor
+
+
+if __name__ == "__main__":
+ import test
+ test.Test().runTest(dColorDialog)
Modified: trunk/dabo/ui/uiwx/dComboBox.py
===================================================================
--- trunk/dabo/ui/uiwx/dComboBox.py 2005-11-28 20:01:05 UTC (rev 1592)
+++ trunk/dabo/ui/uiwx/dComboBox.py 2005-11-29 01:06:21 UTC (rev 1593)
@@ -7,7 +7,7 @@
class dComboBox(wx.ComboBox, dcm.dControlItemMixin):
- """Combination DropdownList and TextBox.
+ """Creates a combobox, which combines a dropdown list with a textbox.
The user can choose an item in the dropdown, or enter freeform text.
"""
Modified: trunk/dabo/ui/uiwx/dDialog.py
===================================================================
--- trunk/dabo/ui/uiwx/dDialog.py 2005-11-28 20:01:05 UTC (rev 1592)
+++ trunk/dabo/ui/uiwx/dDialog.py 2005-11-29 01:06:21 UTC (rev 1593)
@@ -9,6 +9,12 @@
class dDialog(wx.Dialog, fm.dFormMixin):
+ """Creates a dialog, which is a lightweight form.
+
+ Dialogs are like forms, but typically are modal and are requesting a
very
+ specific piece of information from the user, and/or offering specific
+ information to the user.
+ """
def __init__(self, parent=None, properties=None, *args, **kwargs):
self._baseClass = dDialog
self._modal = True
Modified: trunk/dabo/ui/uiwx/dDropdownList.py
===================================================================
--- trunk/dabo/ui/uiwx/dDropdownList.py 2005-11-28 20:01:05 UTC (rev 1592)
+++ trunk/dabo/ui/uiwx/dDropdownList.py 2005-11-29 01:06:21 UTC (rev 1593)
@@ -7,7 +7,13 @@
class dDropdownList(wx.Choice, dcm.dControlItemMixin):
- """ Allows presenting a choice of items for the user to choose from."""
+ """Creates a dropdown list, which allows the user to select one item.
+
+ This is a very simple control, suitable for choosing from one of a
handful
+ of items. Only one column can be displayed. A more powerful, flexible
+ control for all kinds of lists is dListControl, but dDropdownList does
+ suffice for simple needs.
+ """
def __init__(self, parent, properties=None, *args, **kwargs):
self._baseClass = dDropdownList
self._choices = []
Modified: trunk/dabo/ui/uiwx/dEditBox.py
===================================================================
--- trunk/dabo/ui/uiwx/dEditBox.py 2005-11-28 20:01:05 UTC (rev 1592)
+++ trunk/dabo/ui/uiwx/dEditBox.py 2005-11-29 01:06:21 UTC (rev 1593)
@@ -10,7 +10,10 @@
# The EditBox is just a TextBox with some additional styles.
class dEditBox(wx.TextCtrl, dcm.dDataControlMixin):
- """ Allows editing of string or unicode data of unlimited length.
+ """Creates an editbox, which allows editing of string data of unlimited
size.
+
+ The editbox will create scrollbars as necessary, and can edit string or
+ unicode data.
"""
def __init__(self, parent, properties=None, *args, **kwargs):
self._baseClass = dEditBox
Modified: trunk/dabo/ui/uiwx/dFileDialog.py
===================================================================
--- trunk/dabo/ui/uiwx/dFileDialog.py 2005-11-28 20:01:05 UTC (rev 1592)
+++ trunk/dabo/ui/uiwx/dFileDialog.py 2005-11-29 01:06:21 UTC (rev 1593)
@@ -73,6 +73,7 @@
class dFileDialog(wx.FileDialog, OsDialogMixin):
+ """Creates a file dialog, which asks the user to choose a file."""
_exposeFiles = True
def __init__(self, parent=None, message="Choose a file",
defaultPath="",
@@ -89,6 +90,7 @@
class dFolderDialog(wx.DirDialog, OsDialogMixin):
+ """Creates a folder dialog, which asks the user to choose a folder."""
_exposeFiles = False
def __init__(self, parent=None, message="Choose a folder",
@@ -100,6 +102,7 @@
class dSaveDialog(dFileDialog):
+ """Creates a save dialog, which asks the user to specify a file to save
to."""
def __init__(self, parent=None, message="Save to:", defaultPath="",
defaultFile="", wildcard="*.*", style=wx.SAVE):
self._baseClass = dSaveDialog
@@ -108,3 +111,8 @@
wildcard=wildcard, style=style)
# self._dir = self._fname = self._msg = self._path =
self._wildcard = ""
+if __name__ == "__main__":
+ import test
+ test.Test().runTest(dFileDialog)
+ test.Test().runTest(dFolderDialog)
+ test.Test().runTest(dSaveDialog)
Modified: trunk/dabo/ui/uiwx/dFontDialog.py
===================================================================
--- trunk/dabo/ui/uiwx/dFontDialog.py 2005-11-28 20:01:05 UTC (rev 1592)
+++ trunk/dabo/ui/uiwx/dFontDialog.py 2005-11-29 01:06:21 UTC (rev 1593)
@@ -3,6 +3,7 @@
class dFontDialog(wx.FontDialog):
+ """Creates a font dialog, which asks the user to choose a font."""
def __init__(self, parent=None, fontData=None):
self._baseClass = dFontDialog
@@ -23,3 +24,8 @@
def release(self):
self.Destroy()
+
+
+if __name__ == "__main__":
+ import test
+ test.Test().runTest(dFontDialog)
Modified: trunk/dabo/ui/uiwx/dForm.py
===================================================================
--- trunk/dabo/ui/uiwx/dForm.py 2005-11-28 20:01:05 UTC (rev 1592)
+++ trunk/dabo/ui/uiwx/dForm.py 2005-11-29 01:06:21 UTC (rev 1593)
@@ -11,7 +11,7 @@
class dFormBase(fm.dFormMixin):
- """ Create a dForm object, which is a bizobj-aware form.
+ """Creates a bizobj-aware form.
dForm knows how to handle one or more dBizobjs, providing proxy methods
like next(), last(), save(), and requery().
Modified: trunk/dabo/ui/uiwx/dFormMain.py
===================================================================
--- trunk/dabo/ui/uiwx/dFormMain.py 2005-11-28 20:01:05 UTC (rev 1592)
+++ trunk/dabo/ui/uiwx/dFormMain.py 2005-11-29 01:06:21 UTC (rev 1593)
@@ -1,4 +1,3 @@
-""" dFormMain.py """
import wx
import dFormMixin as fm
import dPanel, dIcons, dSizer
Modified: trunk/dabo/ui/uiwx/dFormMixin.py
===================================================================
--- trunk/dabo/ui/uiwx/dFormMixin.py 2005-11-28 20:01:05 UTC (rev 1592)
+++ trunk/dabo/ui/uiwx/dFormMixin.py 2005-11-29 01:06:21 UTC (rev 1593)
@@ -1,4 +1,3 @@
-""" dFormMixin.py """
import os
import wx, dabo
import dPemMixin as pm
Modified: trunk/dabo/ui/uiwx/dGauge.py
===================================================================
--- trunk/dabo/ui/uiwx/dGauge.py 2005-11-28 20:01:05 UTC (rev 1592)
+++ trunk/dabo/ui/uiwx/dGauge.py 2005-11-29 01:06:21 UTC (rev 1593)
@@ -6,7 +6,7 @@
import dControlMixin as cm
class dGauge(wx.Gauge, cm.dControlMixin):
- """ Allows the creation of progress bars.
+ """Creates a gauge, which can be used as a progress bar.
"""
def __init__(self, parent, properties=None, *args, **kwargs):
self._baseClass = dGauge
Modified: trunk/dabo/ui/uiwx/dGrid.py
===================================================================
--- trunk/dabo/ui/uiwx/dGrid.py 2005-11-28 20:01:05 UTC (rev 1592)
+++ trunk/dabo/ui/uiwx/dGrid.py 2005-11-29 01:06:21 UTC (rev 1593)
@@ -1,8 +1,3 @@
-""" Grid.py
-
-This is the base Dabo dGrid, usually used for showing a set of records
-in a dataset, and optionally allowing the fields to be edited.
-"""
import datetime
import locale
import wx
@@ -1324,6 +1319,14 @@
class dGrid(wx.grid.Grid, cm.dControlMixin):
+ """Creates a grid, with rows and columns to represent records and
fields.
+
+ Grids are powerful controls for allowing reading and writing of data. A
+ grid can have any number of dColumns, which themselves have lots of
properties
+ to manipulate. The grid is virtual, meaning that large amounts of data
can
+ be accessed efficiently: only the data that needs to be shown on the
current
+ screen is copied and displayed.
+ """
def __init__(self, parent, properties=None, *args, **kwargs):
self._baseClass = dGrid
preClass = wx.grid.Grid
Modified: trunk/dabo/ui/uiwx/dGridSizer.py
===================================================================
--- trunk/dabo/ui/uiwx/dGridSizer.py 2005-11-28 20:01:05 UTC (rev 1592)
+++ trunk/dabo/ui/uiwx/dGridSizer.py 2005-11-29 01:06:21 UTC (rev 1593)
@@ -8,6 +8,7 @@
GridSizerItem = wx.GBSizerItem
def __init__(self, vgap=3, hgap=3, maxRows=0, maxCols=0, **kwargs):
+ """TODO: what is a grid sizer?"""
self._baseClass = dGridSizer
# Save these values, as there is no easy way to determine them
# later
Modified: trunk/dabo/ui/uiwx/dLabel.py
===================================================================
--- trunk/dabo/ui/uiwx/dLabel.py 2005-11-28 20:01:05 UTC (rev 1592)
+++ trunk/dabo/ui/uiwx/dLabel.py 2005-11-29 01:06:21 UTC (rev 1593)
@@ -7,7 +7,7 @@
import dControlMixin as cm
class dLabel(wx.StaticText, cm.dControlMixin):
- """ Create a static (not data-aware) label.
+ """Creates a static label, to make a caption for another control, for
example.
"""
def __init__(self, parent, properties=None, *args, **kwargs):
self._baseClass = dLabel
Modified: trunk/dabo/ui/uiwx/dLine.py
===================================================================
--- trunk/dabo/ui/uiwx/dLine.py 2005-11-28 20:01:05 UTC (rev 1592)
+++ trunk/dabo/ui/uiwx/dLine.py 2005-11-29 01:06:21 UTC (rev 1593)
@@ -6,7 +6,7 @@
import dControlMixin as cm
class dLine(wx.StaticLine, cm.dControlMixin):
- """ Create a horizontal or vertical line.
+ """Creates a horizontal or vertical line.
If Orientation is "Vertical", Height refers to the length of the line.
If Orientation is "Horizontal", Width refers to the length of the line.
@@ -18,17 +18,6 @@
self._baseClass = dLine
preClass = wx.PreStaticLine
- # Set the minimum initial Height and Width to 1.
-## pkm: no, don't do this: it overrides whatever was set in a subclass
initProperties()
-# if kwargs.has_key("Width"):
-# kwargs["Width"] = max(1, kwargs["Width"])
-# else:
-# kwargs["Width"] = 1
-# if kwargs.has_key("Height"):
-# kwargs["Height"] = max(1, kwargs["Height"])
-# else:
-# kwargs["Height"] = 1
-
cm.dControlMixin.__init__(self, preClass, parent, properties,
*args, **kwargs)
Modified: trunk/dabo/ui/uiwx/dListBox.py
===================================================================
--- trunk/dabo/ui/uiwx/dListBox.py 2005-11-28 20:01:05 UTC (rev 1592)
+++ trunk/dabo/ui/uiwx/dListBox.py 2005-11-29 01:06:21 UTC (rev 1593)
@@ -8,7 +8,7 @@
from dabo.dLocalize import _
class dListBox(wx.ListBox, dcm.dControlItemMixin):
- """ Allows presenting a choice of items for the user to choose from.
+ """Creates a listbox, allowing the user to choose one or more items.
"""
def __init__(self, parent, properties=None, *args, **kwargs):
self._baseClass = dListBox
Modified: trunk/dabo/ui/uiwx/dListControl.py
===================================================================
--- trunk/dabo/ui/uiwx/dListControl.py 2005-11-28 20:01:05 UTC (rev 1592)
+++ trunk/dabo/ui/uiwx/dListControl.py 2005-11-29 01:06:21 UTC (rev 1593)
@@ -10,10 +10,12 @@
class dListControl(wx.ListCtrl, dcm.dControlItemMixin,
ListMixin.ListCtrlAutoWidthMixin):
- """ The List Control is ideal for visually dealing with data sets
- where each 'row' is a unit, where it doesn't make sense to deal
- with individual elements inside of the row. If you need to be
- able work with individual elements, you should use a grid.
+ """Creates a list control, which is a flexible, virtual list box.
+
+ The List Control is ideal for visually dealing with data sets where
each
+ 'row' is a unit, where it doesn't make sense to deal with individual
+ elements inside of the row. If you need to be able work with
individual
+ elements, you should use a dGrid.
"""
# The ListMixin allows the rightmost column to expand as the
Modified: trunk/dabo/ui/uiwx/dMenu.py
===================================================================
--- trunk/dabo/ui/uiwx/dMenu.py 2005-11-28 20:01:05 UTC (rev 1592)
+++ trunk/dabo/ui/uiwx/dMenu.py 2005-11-29 01:06:21 UTC (rev 1593)
@@ -1,4 +1,3 @@
-""" dMenu.py """
import wx
import dPemMixin as pm
import dMenuItem
Modified: trunk/dabo/ui/uiwx/dMenuBar.py
===================================================================
--- trunk/dabo/ui/uiwx/dMenuBar.py 2005-11-28 20:01:05 UTC (rev 1592)
+++ trunk/dabo/ui/uiwx/dMenuBar.py 2005-11-29 01:06:21 UTC (rev 1593)
@@ -1,4 +1,3 @@
-""" dMenuBar.py """
import wx
import dabo
import dPemMixin as pm
@@ -8,6 +7,10 @@
class dMenuBar(wx.MenuBar, pm.dPemMixin):
"""Creates a menu bar, which can contain dMenus.
+
+ You probably don't want to use this directly. Instead, see dBaseMenuBar
+ which will give you a dMenuBar with the standard File, Edit, and Help
+ menus already set up for you.
"""
def __init__(self, properties=None, *args, **kwargs):
self._baseClass = dMenuBar
Modified: trunk/dabo/ui/uiwx/dMenuItem.py
===================================================================
--- trunk/dabo/ui/uiwx/dMenuItem.py 2005-11-28 20:01:05 UTC (rev 1592)
+++ trunk/dabo/ui/uiwx/dMenuItem.py 2005-11-29 01:06:21 UTC (rev 1593)
@@ -1,4 +1,3 @@
-""" dMenuItem.py """
import types
import wx
import dPemMixin as pm
@@ -8,7 +7,7 @@
import dabo.dEvents as dEvents
class dMenuItem(wx.MenuItem, pm.dPemMixin):
- """Creates an item in a menu.
+ """Creates a menu item, which is usually represented as a string.
"""
def __init__(self, parent=None, properties=None, *args, **kwargs):
self._baseClass = dMenuItem
Modified: trunk/dabo/ui/uiwx/dPage.py
===================================================================
--- trunk/dabo/ui/uiwx/dPage.py 2005-11-28 20:01:05 UTC (rev 1592)
+++ trunk/dabo/ui/uiwx/dPage.py 2005-11-29 01:06:21 UTC (rev 1593)
@@ -4,7 +4,7 @@
class dPage(dPanel.dScrollPanel):
- """ Create a page to appear as a tab in a pageframe."""
+ """Creates a page to appear as a tab in a pageframe."""
def __init__(self, *args, **kwargs):
super(dPage, self).__init__(*args, **kwargs)
self._baseClass = dPage
Modified: trunk/dabo/ui/uiwx/dPageFrame.py
===================================================================
--- trunk/dabo/ui/uiwx/dPageFrame.py 2005-11-28 20:01:05 UTC (rev 1592)
+++ trunk/dabo/ui/uiwx/dPageFrame.py 2005-11-29 01:06:21 UTC (rev 1593)
@@ -14,6 +14,11 @@
class dPageFrame(wx.Notebook, dPageFrameMixin):
+ """Creates a pageframe, which can contain an unlimited number of pages.
+
+ Typically, your pages will descend from dPage, but they can in fact be
any
+ Dabo visual control, such as a dPanel, dEditBox, etc.
+ """
_evtPageChanged = readonly(wx.EVT_NOTEBOOK_PAGE_CHANGED)
_tabposBottom = readonly(wx.NB_BOTTOM)
_tabposRight = readonly(wx.NB_RIGHT)
Modified: trunk/dabo/ui/uiwx/dPageFrameMixin.py
===================================================================
--- trunk/dabo/ui/uiwx/dPageFrameMixin.py 2005-11-28 20:01:05 UTC (rev
1592)
+++ trunk/dabo/ui/uiwx/dPageFrameMixin.py 2005-11-29 01:06:21 UTC (rev
1593)
@@ -1,4 +1,6 @@
-import wx, dabo, dabo.ui
+import wx
+import dabo
+import dabo.ui
if __name__ == "__main__":
dabo.ui.loadUI("wx")
import dControlMixin as cm
@@ -7,7 +9,7 @@
from dabo.dLocalize import _
class dPageFrameMixin(cm.dControlMixin):
- """ Create a container for an unlimited number of pages."""
+ """Creates a container for an unlimited number of pages."""
def _initEvents(self):
super(dPageFrameMixin, self)._initEvents()
self.Bind(self._evtPageChanged, self.__onPageChanged)
Modified: trunk/dabo/ui/uiwx/dPageFrameNoTabs.py
===================================================================
--- trunk/dabo/ui/uiwx/dPageFrameNoTabs.py 2005-11-28 20:01:05 UTC (rev
1592)
+++ trunk/dabo/ui/uiwx/dPageFrameNoTabs.py 2005-11-29 01:06:21 UTC (rev
1593)
@@ -8,6 +8,11 @@
class dPageFrameNoTabs(dabo.ui.dPanel):
+ """Creates a pageframe with no tabs.
+
+ Your code will have to programatically set the current page, because the
+ user will have no way to do this.
+ """
def _afterInit(self):
self.Sizer = dabo.ui.dSizer()
self._pageClass = dPage.dPage
Modified: trunk/dabo/ui/uiwx/dPanel.py
===================================================================
--- trunk/dabo/ui/uiwx/dPanel.py 2005-11-28 20:01:05 UTC (rev 1592)
+++ trunk/dabo/ui/uiwx/dPanel.py 2005-11-29 01:06:21 UTC (rev 1593)
@@ -6,7 +6,7 @@
import dControlMixin as cm
class dPanel(wx.Panel, cm.dControlMixin):
- """ This is a basic container for controls.
+ """Creates a panel, a basic container for controls.
Panels can contain subpanels to unlimited depth, making them quite
flexible for many uses. Consider laying out your forms on panels
Modified: trunk/dabo/ui/uiwx/dPemMixin.py
===================================================================
--- trunk/dabo/ui/uiwx/dPemMixin.py 2005-11-28 20:01:05 UTC (rev 1592)
+++ trunk/dabo/ui/uiwx/dPemMixin.py 2005-11-29 01:06:21 UTC (rev 1593)
@@ -1,4 +1,3 @@
-""" dPemMixin.py: Provide common PEM functionality """
import wx
import sys
import types
Modified: trunk/dabo/ui/uiwx/dRadioGroup.py
===================================================================
--- trunk/dabo/ui/uiwx/dRadioGroup.py 2005-11-28 20:01:05 UTC (rev 1592)
+++ trunk/dabo/ui/uiwx/dRadioGroup.py 2005-11-29 01:06:21 UTC (rev 1593)
@@ -8,7 +8,12 @@
from dabo.dLocalize import _
class dRadioGroup(wx.RadioBox, dcm.dDataControlMixin):
- """ Allows choosing one option from a list of options.
+ """Creates a group of radio buttons, allowing mutually-exclusive
choices.
+
+ Like a dDropdownList, use this to present the user with multiple
choices and
+ for them to choose from one of the choices. Where the dDropdownList is
+ suitable for lists of one to a couple hundred choices, a dRadioGroup is
+ really only suitable for lists of one to a dozen at most.
"""
def __init__(self, parent, properties=None, *args, **kwargs):
self._baseClass = dRadioGroup
Modified: trunk/dabo/ui/uiwx/dSlider.py
===================================================================
--- trunk/dabo/ui/uiwx/dSlider.py 2005-11-28 20:01:05 UTC (rev 1592)
+++ trunk/dabo/ui/uiwx/dSlider.py 2005-11-29 01:06:21 UTC (rev 1593)
@@ -8,9 +8,9 @@
from dabo.dLocalize import _
class dSlider(wx.Slider, dcm.dDataControlMixin):
- """ Allows editing integer values with a slider control.
+ """Creates a slider control, allowing editing integer values.
- Slider does not allow entering a value with the keyboard.
+ Unlike dSpinner, dSlider does not allow entering a value with the
keyboard.
"""
def __init__(self, parent, properties=None, *args, **kwargs):
self._baseClass = dSlider
Modified: trunk/dabo/ui/uiwx/dSpinner.py
===================================================================
--- trunk/dabo/ui/uiwx/dSpinner.py 2005-11-28 20:01:05 UTC (rev 1592)
+++ trunk/dabo/ui/uiwx/dSpinner.py 2005-11-29 01:06:21 UTC (rev 1593)
@@ -8,7 +8,11 @@
from dabo.dLocalize import _
class dSpinner(wx.SpinCtrl, dcm.dDataControlMixin):
- """ Allows editing integer values.
+ """Creates a spinner, which is a textbox with clickable up/down arrows.
+
+ Use this to edit integer values. You can set the maximum and minimum
+ allowable values, as well as the increment when the user clicks the
+ arrows.
"""
def __init__(self, parent, properties=None, *args, **kwargs):
self._baseClass = dSpinner
Modified: trunk/dabo/ui/uiwx/dStatusBar.py
===================================================================
--- trunk/dabo/ui/uiwx/dStatusBar.py 2005-11-28 20:01:05 UTC (rev 1592)
+++ trunk/dabo/ui/uiwx/dStatusBar.py 2005-11-29 01:06:21 UTC (rev 1593)
@@ -9,6 +9,11 @@
class dStatusBar(wx.StatusBar, dcm.dControlMixin):
+ """Creates a status bar, which displays information to the user.
+
+ The status bar is displayed at the bottom of the form. Add the status
bar
+ to your form using form.StatusBar=dStatusBar().
+ """
def __init__(self, parent, properties=None, *args, **kwargs):
self._baseClass = dStatusBar
preClass = wx.PreStatusBar
Modified: trunk/dabo/ui/uiwx/dTextBox.py
===================================================================
--- trunk/dabo/ui/uiwx/dTextBox.py 2005-11-28 20:01:05 UTC (rev 1592)
+++ trunk/dabo/ui/uiwx/dTextBox.py 2005-11-29 01:06:21 UTC (rev 1593)
@@ -18,7 +18,7 @@
class dTextBox(wx.TextCtrl, dcm.dDataControlMixin):
- """ Allows editing one line of string or unicode data.
+ """Creates a text box for editing one line of string data.
"""
def __init__(self, parent, properties=None, *args, **kwargs):
self._baseClass = dTextBox
Modified: trunk/dabo/ui/uiwx/dTimer.py
===================================================================
--- trunk/dabo/ui/uiwx/dTimer.py 2005-11-28 20:01:05 UTC (rev 1592)
+++ trunk/dabo/ui/uiwx/dTimer.py 2005-11-29 01:06:21 UTC (rev 1593)
@@ -8,7 +8,7 @@
import dIcons
class dTimer(dabo.ui.dBitmap):
- """ Create a timer.
+ """Creates a timer, for causing something to happen at regular
intervals.
"""
# Note: this class is implemented as a static bitmap which serves as
# a proxy to the underlying timer object. This was to allow the timer
Modified: trunk/dabo/ui/uiwx/dToggleButton.py
===================================================================
--- trunk/dabo/ui/uiwx/dToggleButton.py 2005-11-28 20:01:05 UTC (rev 1592)
+++ trunk/dabo/ui/uiwx/dToggleButton.py 2005-11-29 01:06:21 UTC (rev 1593)
@@ -8,7 +8,11 @@
import dabo.dEvents as dEvents
class dToggleButton(wx.ToggleButton, dcm.dDataControlMixin):
- """ Allows the user to set an on/off condition by pressing a button.
+ """Creates a button that toggles on and off, for editing boolean values.
+
+ This is functionally equivilent to a dCheckbox, but visually much
different.
+ Also, it implies that pushing it will cause some sort of immediate
action to
+ take place, like you get with a normal button.
"""
def __init__(self, parent, properties=None, *args, **kwargs):
self._baseClass = dToggleButton
Modified: trunk/dabo/ui/uiwx/dToolBar.py
===================================================================
--- trunk/dabo/ui/uiwx/dToolBar.py 2005-11-28 20:01:05 UTC (rev 1592)
+++ trunk/dabo/ui/uiwx/dToolBar.py 2005-11-29 01:06:21 UTC (rev 1593)
@@ -1,4 +1,3 @@
-""" dToolBar.py """
import wx
import dabo, dabo.ui
import os.path
Modified: trunk/dabo/ui/uiwx/dTreeView.py
===================================================================
--- trunk/dabo/ui/uiwx/dTreeView.py 2005-11-28 20:01:05 UTC (rev 1592)
+++ trunk/dabo/ui/uiwx/dTreeView.py 2005-11-29 01:06:21 UTC (rev 1593)
@@ -141,6 +141,7 @@
class dTreeView(wx.TreeCtrl, dcm.dControlMixin):
+ """Creates a treeview, which allows display of hierarchical data."""
def __init__(self, parent, properties=None, *args, **kwargs):
self._baseClass = dTreeView
_______________________________________________
Post Messages to: [email protected]
Subscription Maintenance: http://leafe.com/mailman/listinfo/dabo-dev
