[gnue] r9098 - in trunk/gnue-forms/src: . GFObjects input input/displayHandlers uidrivers/_base uidrivers/_commonGuiToolkit

[reinhard]

Author: reinhard
Date: 2006-12-04 06:42:06 -0600 (Mon, 04 Dec 2006)
New Revision: 9098

Modified:
   trunk/gnue-forms/src/GFClient.py
   trunk/gnue-forms/src/GFObjects/GFGrid.py
   trunk/gnue-forms/src/GFObjects/GFObj.py
   trunk/gnue-forms/src/GFObjects/GFScrollBar.py
   trunk/gnue-forms/src/GFObjects/GFTabStop.py
   trunk/gnue-forms/src/GFParser.py
   trunk/gnue-forms/src/input/GFKeyMapper.py
   trunk/gnue-forms/src/input/displayHandlers/Image.py
   trunk/gnue-forms/src/input/displayHandlers/__init__.py
   trunk/gnue-forms/src/uidrivers/_base/UserActions.py
   trunk/gnue-forms/src/uidrivers/_commonGuiToolkit/MenuBar.py
   trunk/gnue-forms/src/uidrivers/_commonGuiToolkit/ToolBar.py
Log:
Several epydoc fixes.


Modified: trunk/gnue-forms/src/GFClient.py
===================================================================
--- trunk/gnue-forms/src/GFClient.py    2006-12-01 18:37:23 UTC (rev 9097)
+++ trunk/gnue-forms/src/GFClient.py    2006-12-04 12:42:06 UTC (rev 9098)
@@ -30,6 +30,7 @@
 import os, sys
 
 from gnue.common.apps import GConfig
+from gnue.common.apps.i18n import utranslate as u_      # for epydoc
 from gnue.common.apps.GClientApp import GClientApp, StartupError
 from gnue.common.utils.FileUtils import dyn_import
 from gnue.common.utils import CaselessDict
@@ -58,8 +59,9 @@
   COMMAND = "gnue-forms"
   NAME    = "GNUe Forms"
   USAGE   = "%s file" % GClientApp.USAGE
-  SUMMARY = \
-    _("GNUe Forms is the primary user interface to the GNU Enterprise system.")
+  SUMMARY = u_(
+          "GNUe Forms is the primary user interface to the GNU Enterprise "
+          "system.")
   USE_DATABASE_OPTIONS = True
 
 

Modified: trunk/gnue-forms/src/GFObjects/GFGrid.py
===================================================================
--- trunk/gnue-forms/src/GFObjects/GFGrid.py    2006-12-01 18:37:23 UTC (rev 
9097)
+++ trunk/gnue-forms/src/GFObjects/GFGrid.py    2006-12-04 12:42:06 UTC (rev 
9098)
@@ -102,7 +102,6 @@
         Update the UI scrollbar to reflect a new position or record-count.
 
         @param current: current first visible record number in the block
-        @param size: current number of visible rows
         @param count: number of records in the block
         """
 

Modified: trunk/gnue-forms/src/GFObjects/GFObj.py
===================================================================
--- trunk/gnue-forms/src/GFObjects/GFObj.py     2006-12-01 18:37:23 UTC (rev 
9097)
+++ trunk/gnue-forms/src/GFObjects/GFObj.py     2006-12-04 12:42:06 UTC (rev 
9098)
@@ -99,7 +99,7 @@
         Return wether the object is currently navigable or not.
 
         @param mode: current state of the object. Can be 'edit', 'query' or
-          'new'
+            'new'
         @returns: True or False
         """
 
@@ -180,7 +180,7 @@
         """
         Returns the objects' field from the blocks' field mapping
 
-        @retruns: GFField instance or None if the object does not support 
fields
+        @returns: GFField instance or None if the object does not support 
fields
         @raises FieldNotFoundError: if the field is not available through the
           block
         """
@@ -202,11 +202,11 @@
         """
         Return wether the object is currently navigable or not.
 
+        Descendants can overwrite this method to return either True or False. 
If
+        this method is not overwritten it returns False.
+
         @param mode: current state of the object. Can be 'edit', 'query' or
           'new'
-
-        Descendants can overwrite this method to return either True or False. 
If
-        this method is not overwritten it returns False.
         """
 
         return False

Modified: trunk/gnue-forms/src/GFObjects/GFScrollBar.py
===================================================================
--- trunk/gnue-forms/src/GFObjects/GFScrollBar.py       2006-12-01 18:37:23 UTC 
(rev 9097)
+++ trunk/gnue-forms/src/GFObjects/GFScrollBar.py       2006-12-04 12:42:06 UTC 
(rev 9098)
@@ -69,7 +69,6 @@
         Update the UI scrollbar to reflect a new position or record-count.
 
         @param current: current first visible record number in the block
-        @param size: current number of visible rows
         @param count: number of records in the block
         """
 

Modified: trunk/gnue-forms/src/GFObjects/GFTabStop.py
===================================================================
--- trunk/gnue-forms/src/GFObjects/GFTabStop.py 2006-12-01 18:37:23 UTC (rev 
9097)
+++ trunk/gnue-forms/src/GFObjects/GFTabStop.py 2006-12-04 12:42:06 UTC (rev 
9098)
@@ -129,8 +129,8 @@
         In case the current focus widget vetoes the focus loss, this method
         beats the focus back to the old widget.
 
-        In fact, this method only calls L{GFForm.GFForm._event_focus_changed}
-        with a target of this object.
+        In fact, this method only calls GFForm._event_focus_changed() with a
+        target of this object.
         """
 
         # Most UIs issue a set_focus event also when the focus moves from

Modified: trunk/gnue-forms/src/GFParser.py
===================================================================
--- trunk/gnue-forms/src/GFParser.py    2006-12-01 18:37:23 UTC (rev 9097)
+++ trunk/gnue-forms/src/GFParser.py    2006-12-04 12:42:06 UTC (rev 9098)
@@ -23,10 +23,9 @@
 """
 Class that contains a sax based xml processor for GNUe forms
 
-NOTES:
- * Designer uses the 'Positionable' attribute. It is specific to
-   forms+designer and is not part of the GParser spec. If set to
-   true, then this object is a visible, movable, sizable attribute.
+NOTE: Designer uses the 'Positionable' attribute. It is specific to
+forms+designer and is not part of the GParser spec. If set to
+true, then this object is a visible, movable, sizable attribute.
 """
 
 from gnue.common.datasources import GDataSource

Modified: trunk/gnue-forms/src/input/GFKeyMapper.py
===================================================================
--- trunk/gnue-forms/src/input/GFKeyMapper.py   2006-12-01 18:37:23 UTC (rev 
9097)
+++ trunk/gnue-forms/src/input/GFKeyMapper.py   2006-12-04 12:42:06 UTC (rev 
9098)
@@ -224,15 +224,15 @@
     """
     If an event is assigned to the specified keystroke then return 
     that command.
-    
-   The keystroke is the UI-specific keystroke, not our virtual keys.  If
-   a command isn't defined but a modifier key is held down then a command
-   USERCOMMAND-[CTRL-][ALT-]key will be returned.
-   
-   This needs to stay as simple as possible as it gets called for 
-   each keystroke
-   
-   @return: The command name or None if the keystroke isn't tied to an event.
+
+    The keystroke is the UI-specific keystroke, not our virtual keys.  If
+    a command isn't defined but a modifier key is held down then a command
+    USERCOMMAND-[CTRL-][ALT-]key will be returned.
+
+    This needs to stay as simple as possible as it gets called for 
+    each keystroke
+
+    @returns: The command name or None if the keystroke isn't tied to an event.
     """
     try:
       return (self._translatedUserKeyMap[(basekey, shift, ctrl, meta)], None)

Modified: trunk/gnue-forms/src/input/displayHandlers/Image.py
===================================================================
--- trunk/gnue-forms/src/input/displayHandlers/Image.py 2006-12-01 18:37:23 UTC 
(rev 9097)
+++ trunk/gnue-forms/src/input/displayHandlers/Image.py 2006-12-04 12:42:06 UTC 
(rev 9098)
@@ -49,8 +49,6 @@
     @param eventHandler: The 
     @param subEventHandler: The event handler this display helper will 
                             user to register it's listeners.
-    @param displayMask: Not applicable to images
-    @param inputMask: Not applicable to images
     """
     BaseCursor.__init__(self, entry, eventHandler, subEventHandler)
 

Modified: trunk/gnue-forms/src/input/displayHandlers/__init__.py
===================================================================
--- trunk/gnue-forms/src/input/displayHandlers/__init__.py      2006-12-01 
18:37:23 UTC (rev 9097)
+++ trunk/gnue-forms/src/input/displayHandlers/__init__.py      2006-12-04 
12:42:06 UTC (rev 9098)
@@ -42,9 +42,9 @@
 def factory(entry, eventHandler, subEventHandler, displayMask, inputMask):
   """
   Function to act as a display handler factory.
-  
-  @return An instance of a display handler that is appropriate for the
-          entry type passed in.
+
+  @returns: An instance of a display handler that is appropriate for the entry
+        type passed in.
   """
   classConstructors = {'checkbox':Checkbox,
                        'date':    DateTime,

Modified: trunk/gnue-forms/src/uidrivers/_base/UserActions.py
===================================================================
--- trunk/gnue-forms/src/uidrivers/_base/UserActions.py 2006-12-01 18:37:23 UTC 
(rev 9097)
+++ trunk/gnue-forms/src/uidrivers/_base/UserActions.py 2006-12-04 12:42:06 UTC 
(rev 9098)
@@ -28,14 +28,12 @@
 #
 
 from gnue.common.apps import GConfig
+from gnue.common.apps.i18n import utranslate as u_      # for epydoc
 from gnue.forms.input import GFKeyMapper
 
 import os
 import copy
 
-_iconpath = GConfig.getInstalledBase('form_images', 'common_images')
-_iconset = gConfigForms('IconSet')
-
 ######################################################################
 #
 #
@@ -58,7 +56,10 @@
     try:
       return self.__iconloc[size + format]
     except:
-      iconset = _iconset == 'auto' and forms_ui.default_iconset or _iconset
+      iconset = gConfigForms('IconSet')
+      if iconset == 'auto':
+        iconset = forms_ui.default_iconset
+      _iconpath = GConfig.getInstalledBase('form_images', 'common_images')
       loc = os.path.join(_iconpath, 'forms', iconset,
           '%s-%s.%s' % (self.event.lower(),size, format))
       if not os.path.isfile(loc):
@@ -229,12 +230,6 @@
        help=u_('Switch to query mode. Select Execute Query once your criteria 
has been entered.'),
        canToggle='CANCELQUERY' ),
 
-#   UserAction(
-#      event="ENTEREDIT",
-#      description=u_('Switch to edit mode.  This will allow you to edit the 
current entries.'),
-#      help=u_('Switch to edit mode.'),
-#      canToggle='CANCELEDIT' ),
-
     UserAction(
        event="COPYQUERY",
        description=u_('Switch to query mode (if not already) and retrieve the 
last query parameters. Select Execute Query once your criteria has been 
entered.'),

Modified: trunk/gnue-forms/src/uidrivers/_commonGuiToolkit/MenuBar.py
===================================================================
--- trunk/gnue-forms/src/uidrivers/_commonGuiToolkit/MenuBar.py 2006-12-01 
18:37:23 UTC (rev 9097)
+++ trunk/gnue-forms/src/uidrivers/_commonGuiToolkit/MenuBar.py 2006-12-04 
12:42:06 UTC (rev 9098)
@@ -21,6 +21,7 @@
 #
 # $Id: $
 
+from gnue.common.apps.i18n import utranslate as u_      # for epydoc
 from gnue.forms.uidrivers._base import UserActions
 
 

Modified: trunk/gnue-forms/src/uidrivers/_commonGuiToolkit/ToolBar.py
===================================================================
--- trunk/gnue-forms/src/uidrivers/_commonGuiToolkit/ToolBar.py 2006-12-01 
18:37:23 UTC (rev 9097)
+++ trunk/gnue-forms/src/uidrivers/_commonGuiToolkit/ToolBar.py 2006-12-04 
12:42:06 UTC (rev 9098)
@@ -21,6 +21,7 @@
 #
 # $Id: $
 
+from gnue.common.apps.i18n import utranslate as u_      # for epydoc
 from gnue.forms.uidrivers._base import UserActions
 
 # =============================================================================