[Commit-gnuradio] r11157 - gnuradio/branches/developers/jblum/wxgui/gr-wxgui/src/python/forms

[jblum]

Author: jblum
Date: 2009-05-27 22:47:26 -0600 (Wed, 27 May 2009)
New Revision: 11157

Modified:
   
gnuradio/branches/developers/jblum/wxgui/gr-wxgui/src/python/forms/__init__.py
   gnuradio/branches/developers/jblum/wxgui/gr-wxgui/src/python/forms/forms.py
Log:
docstrings

Modified: 
gnuradio/branches/developers/jblum/wxgui/gr-wxgui/src/python/forms/__init__.py
===================================================================
--- 
gnuradio/branches/developers/jblum/wxgui/gr-wxgui/src/python/forms/__init__.py  
    2009-05-28 00:21:43 UTC (rev 11156)
+++ 
gnuradio/branches/developers/jblum/wxgui/gr-wxgui/src/python/forms/__init__.py  
    2009-05-28 04:47:26 UTC (rev 11157)
@@ -46,6 +46,16 @@
 import wx
 
 class static_box_sizer(wx.StaticBoxSizer):
+       """
+       A box sizer with label and border.
+       @param parent the parent widget
+       @param sizer add this widget to sizer if provided (optional)
+       @param proportion the proportion when added to the sizer (default=0)
+       @param flag the flag argument when added to the sizer 
(default=wx.EXPAND)
+       @param label title label for this widget (optional)
+       @param bold true to boldify the label
+       @param orient the sizer orientation wx.VERTICAL or wx.HORIZONTAL 
(default=wx.VERTICAL)
+       """
        def __init__(self, parent, label='', bold=False, sizer=None, 
orient=wx.VERTICAL, proportion=0, flag=wx.EXPAND):
                box = wx.StaticBox(parent=parent, label=label)
                if bold: make_bold(box)
@@ -55,6 +65,13 @@
 class incr_decr_buttons(wx.BoxSizer):
        """
        A horizontal box sizer with a increment and a decrement button.
+       @param parent the parent widget
+       @param sizer add this widget to sizer if provided (optional)
+       @param proportion the proportion when added to the sizer (default=0)
+       @param flag the flag argument when added to the sizer 
(default=wx.EXPAND)
+       @param label title label for this widget (optional)
+       @param on_incr the callback for pressing the + button
+       @param on_decr the callback for pressing the - button
        """
        def __init__(self, parent, on_incr, on_decr, label='', sizer=None, 
proportion=0, flag=wx.EXPAND):
                """

Modified: 
gnuradio/branches/developers/jblum/wxgui/gr-wxgui/src/python/forms/forms.py
===================================================================
--- gnuradio/branches/developers/jblum/wxgui/gr-wxgui/src/python/forms/forms.py 
2009-05-28 00:21:43 UTC (rev 11156)
+++ gnuradio/branches/developers/jblum/wxgui/gr-wxgui/src/python/forms/forms.py 
2009-05-28 04:47:26 UTC (rev 11157)
@@ -37,11 +37,6 @@
 Known problems:
   * An empty label in the radio box still consumes space.
   * The static text cannot resize the parent at runtime.
-
-TODO:
-  * Add @flag to docstrings
-  * docstrings for classes in init
-  * add gauge that impls slider base
 """
 
 EXT_KEY = 'external'
@@ -192,6 +187,7 @@
        @param parent the parent widget
        @param sizer add this widget to sizer if provided (optional)
        @param proportion the proportion when added to the sizer (default=0)
+       @param flag the flag argument when added to the sizer 
(default=wx.EXPAND)
        @param ps the pubsub object (optional)
        @param key the pubsub key (optional)
        @param value the default value (optional)
@@ -217,6 +213,7 @@
        @param parent the parent widget
        @param sizer add this widget to sizer if provided (optional)
        @param proportion the proportion when added to the sizer (default=0)
+       @param flag the flag argument when added to the sizer 
(default=wx.EXPAND)
        @param ps the pubsub object (optional)
        @param key the pubsub key (optional)
        @param value the default value (optional)
@@ -244,6 +241,7 @@
        @param parent the parent widget
        @param sizer add this widget to sizer if provided (optional)
        @param proportion the proportion when added to the sizer (default=0)
+       @param flag the flag argument when added to the sizer 
(default=wx.EXPAND)
        @param ps the pubsub object (optional)
        @param key the pubsub key (optional)
        @param value the default value (optional)
@@ -269,6 +267,7 @@
        @param parent the parent widget
        @param sizer add this widget to sizer if provided (optional)
        @param proportion the proportion when added to the sizer (default=0)
+       @param flag the flag argument when added to the sizer 
(default=wx.EXPAND)
        @param ps the pubsub object (optional)
        @param key the pubsub key (optional)
        @param value the default value (optional)
@@ -297,6 +296,7 @@
        @param parent the parent widget
        @param sizer add this widget to sizer if provided (optional)
        @param proportion the proportion when added to the sizer (default=0)
+       @param flag the flag argument when added to the sizer 
(default=wx.EXPAND)
        @param ps the pubsub object (optional)
        @param key the pubsub key (optional)
        @param value the default value (optional)
@@ -335,6 +335,7 @@
        @param parent the parent widget
        @param sizer add this widget to sizer if provided (optional)
        @param proportion the proportion when added to the sizer (default=0)
+       @param flag the flag argument when added to the sizer 
(default=wx.EXPAND)
        @param ps the pubsub object (optional)
        @param key the pubsub key (optional)
        @param value the default value (optional)
@@ -360,6 +361,7 @@
        @param parent the parent widget
        @param sizer add this widget to sizer if provided (optional)
        @param proportion the proportion when added to the sizer (default=0)
+       @param flag the flag argument when added to the sizer 
(default=wx.EXPAND)
        @param ps the pubsub object (optional)
        @param key the pubsub key (optional)
        @param value the default value (optional)
@@ -389,6 +391,7 @@
        @param parent the parent widget
        @param sizer add this widget to sizer if provided (optional)
        @param proportion the proportion when added to the sizer (default=0)
+       @param flag the flag argument when added to the sizer 
(default=wx.EXPAND)
        @param ps the pubsub object (optional)
        @param key the pubsub key (optional)
        @param value the default value (optional)
@@ -414,6 +417,7 @@
        @param parent the parent widget
        @param sizer add this widget to sizer if provided (optional)
        @param proportion the proportion when added to the sizer (default=0)
+       @param flag the flag argument when added to the sizer 
(default=wx.EXPAND)
        @param ps the pubsub object (optional)
        @param key the pubsub key (optional)
        @param value the default value (optional)
@@ -433,6 +437,7 @@
        @param parent the parent widget
        @param sizer add this widget to sizer if provided (optional)
        @param proportion the proportion when added to the sizer (default=0)
+       @param flag the flag argument when added to the sizer 
(default=wx.EXPAND)
        @param ps the pubsub object (optional)
        @param key the pubsub key (optional)
        @param value the default value (optional)
@@ -452,6 +457,7 @@
        @param parent the parent widget
        @param sizer add this widget to sizer if provided (optional)
        @param proportion the proportion when added to the sizer (default=0)
+       @param flag the flag argument when added to the sizer 
(default=wx.EXPAND)
        @param ps the pubsub object (optional)
        @param key the pubsub key (optional)
        @param value the default value (optional)