[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[gnue] r6997 - trunk/gnue-forms/src
|
From: |
kilo |
|
Subject: |
[gnue] r6997 - trunk/gnue-forms/src |
|
Date: |
Fri, 11 Feb 2005 04:56:58 -0600 (CST) |
Author: kilo
Date: 2005-02-11 04:56:57 -0600 (Fri, 11 Feb 2005)
New Revision: 6997
Modified:
trunk/gnue-forms/src/GFParser.py
Log:
Added documentation
Modified: trunk/gnue-forms/src/GFParser.py
===================================================================
--- trunk/gnue-forms/src/GFParser.py 2005-02-11 10:54:05 UTC (rev 6996)
+++ trunk/gnue-forms/src/GFParser.py 2005-02-11 10:56:57 UTC (rev 6997)
@@ -18,10 +18,8 @@
#
# Copyright 2000-2005 Free Software Foundation
#
-# FILE:
-# GFParser.py
-#
-# DESCRIPTION:
+# $Id$
+
"""
Class that contains a sax based xml processor for GNUe forms
@@ -111,9 +109,11 @@
'normal': {'Label': _('Normal')},
'dialog': {'Label': _('Dialog')} },
'Default': 'normal',
- 'Description': '' }, },
+ 'Description': 'Display as normal or dialog-style window.' },
},
'ParentTags': None,
- 'Description': 'TODO' },
+ 'Description': 'Top-level element that encloses all the logic '
+ 'and visuals that the user interface will show '
+ 'to the user.' },
'logic': {
'BaseClass': GFObjects.GFLogic,
@@ -121,7 +121,8 @@
'Importable': True,
'SingleInstance': True,
'ParentTags': ('form',),
- 'Description': 'TODO' },
+ 'Description': 'Separation layer that contains "Business logic": '
+ 'blocks, fields, block-level and field-level
triggers.'},
'layout': {
'BaseClass': GFObjects.GFLayout,
@@ -129,7 +130,8 @@
'Importable': True,
'SingleInstance': True,
'ParentTags': ('form',),
- 'Description': 'TODO' ,
+ 'Description': 'Separation layer that contains all the '
+ 'visual elements on the form.' ,
'Attributes': {
'tabbed': {
'Typecast': GTypecast.name,
@@ -141,9 +143,12 @@
'bottom': {'Label': _('Botton tabs')},
'top': {'Label': _('Top tabs')} },
'Default': "none",
- 'Description': 'Informs the UI subsystem to display a form\'s pages
as '
- 'notebook tabs. Allowed values are {left}, '
- '{right}, {bottom}, {top}. If the UI driver in use
does not support the chosen tab position (or tabs at all,) then the UI driver
may choose another tab position.' } } } ,
+ 'Description': 'Informs the UI subsystem to display a form\'s pages
'
+ 'as notebook tabs. Allowed values are {left}, '
+ '{right}, {bottom}, {top}. If the UI driver in use '
+ 'does not support the chosen tab position '
+ '(or tabs at all,) then the UI driver may choose '
+ 'another tab position.' } } } ,
'page': {
'BaseClass': GFObjects.GFPage,
@@ -173,9 +178,11 @@
'Description': 'The type of page.' },
'caption': {
'Typecast': GTypecast.text,
- 'Description': 'For {tabbed} or {popup} pages, this contains
the caption to use for the page.' } },
+ 'Description': 'For {tabbed} or {popup} pages, this contains '
+ 'the caption to use for the page.' } },
'ParentTags': ('layout',),
- 'Description': 'TODO' },
+ 'Description': 'Encapsulates visual elements to be displayed '
+ 'on a page.' },
'block': {
'BaseClass': GFObjects.GFBlock,
@@ -285,7 +292,8 @@
'{<datasource>} tag) that provides this block '
'with it\'s data.' } },
'ParentTags': ('logic',),
- 'Description': 'TODO' },
+ 'Description': 'A block contains instructions on how Forms '
+ 'should interact with a datasource.' },
'label': {
'BaseClass': GFObjects.GFLabel,
@@ -308,33 +316,22 @@
'Description': 'The justification of the label. Can be one of '
'the following: {left}, {right}, or {center}. '
'Requires that the {width} attribute be set.'},
-## 'width': {
-## 'Typecast': GTypecast.whole,
-## 'Description': 'The width of the label in text columns. '
-## 'Defaults to the width of the text. Only
really '
-## 'useful when used with the {alignment}
attribute.' },
'rows': {
'Typecast': GTypecast.whole,
- 'Description': 'Overrides the rows setting defined at the block
level. ' },
+ 'Description': 'Overrides the rows setting defined at the '
+ 'block level. ' },
'rowSpacer': {
'Typecast': GTypecast.whole,
'Label': _('Row Spacing'),
- 'Description': 'Overriders the rowSpace setting defined at the
block level.' } },
-## 'x': {
-## 'Required': True,
-## 'Typecast': GTypecast.whole,
-## 'Description': 'The text column starting position of the
widget. Based upon leftmost column of screen being 0. ' },
-## 'y': {
-## 'Required': True,
-## 'Typecast': GTypecast.whole,
-## 'Description': 'The text row starting position of the widget.
Based upon the top row of the screen being 0.' } },
+ 'Description': 'Overriders the rowSpace setting defined at the '
+ 'block level.' } },
'Positionable': True,
'ParentTags': ('page',),
- 'Description': 'TODO' },
+ 'Description': 'Displays static text' },
'field': {
'BaseClass': GFObjects.GFField,
- 'Importable':1,
+ 'Importable': True,
'Attributes': {
'name': {
'Required': True,
@@ -390,7 +387,8 @@
'upper': {'Label': _('Upper case')},
'lower': {'Label': _('Lower case')} },
'Default': 'mixed',
- 'Description': 'TODO' },
+ 'Description': 'Convert the value to uppercase/lowercase '
+ 'or leave it as it is.' },
'typecast': {
'Typecast': GTypecast.name,
'Label': _('Data Type'),
@@ -404,35 +402,27 @@
'value': {
'Typecast': GTypecast.text,
'Deprecated': 'Use default="..." instead',
- 'Description': 'TODO' },
-## 'foreign_key': {
-## 'Typecast': GTypecast.name,
-## 'Deprecated': 'Use fk_source="..." and fk_key="..." instead.',
-## 'Description': 'Set in the format datasource.field This
forces any '
-## 'input into this entry to match the values
stored '
-## 'in the datasource.field' },
-## 'foreign_key_description': {
-## 'Typecast': GTypecast.text,
-## 'Deprecated': 'Use fk_description="..." instead.',
-## 'Description': 'The description used if a style of dropdown
is '
-## 'selected. This fields value is displayed in
the '
-## 'dropdown but the foreign_key value is
actually '
-## 'stored in the field. This allows you to
display '
-## 'something like the full name of a US state
but '
-## 'only store it\'s 2 character abrievation.' },
+ 'Description': 'Deprecated' },
'fk_source': {
'References': 'datasource.name',
'Label': _('F/K Datasource'),
'Typecast': GTypecast.name,
- 'Description': 'TODO' },
+ 'Description': 'Source table that the foreign key links to.' },
'fk_key': {
'Label': _('F/K Bound Field'),
'Typecast': GTypecast.name,
- 'Description': 'TODO' },
+ 'Description': 'The table column (field) in the foreign key '
+ 'source table that the foreign key links to.' },
'fk_description': {
'Typecast': GTypecast.name,
'Label': _('F/K Description Field'),
- 'Description': 'TODO' },
+ 'Description': 'The description used if a style of dropdown is '
+ 'selected. This field\'s value is displayed in '
+ 'the dropdown but the foreign_key value is '
+ 'actually stored in the field. This allows you '
+ 'to display something like the full name of a '
+ 'US state but only store it\'s 2 character '
+ 'abbreviation.' },
'fk_refresh': {
'Typecast': GTypecast.name,
'Label': _('F/K Refresh Method'),
@@ -441,12 +431,13 @@
'change': {'Label': _('On field modification')},
'commit': {'Label': _('On commit')} },
'Default': 'startup',
- 'Description': 'TODO' },
+ 'Description': 'Decides when the foreign key should be '
+ 'refreshed.' },
'default': {
'Typecast': GTypecast.text,
'Label': _('Default (New Records)'),
- 'Description': 'The default value for this field whena new
record '
- 'is created. '
+ 'Description': 'The default value for this field when a new '
+ 'record is created. '
'If the field is visible the user can override '
'the value.' },
'defaultToLast': {
@@ -507,7 +498,8 @@
'Typecast': GTypecast.boolean,
'Default': True } },
'ParentTags': ('block',),
- 'Description': 'TODO' },
+ 'Description': 'A field represents a column in the database table '
+ 'designated by the block.' },
# If you implement a new entry "style", add to the entryStyles
# structure after this list
@@ -535,25 +527,28 @@
'focusorder': {
'Typecast': GTypecast.whole,
'Label': _('Focus Order'),
- 'Description': 'TODO'},
+ 'Description': 'Defines what order the focus moves through '
+ 'entries.'},
'rows': {
'Typecast': GTypecast.whole,
- 'Description': 'TODO'},
+ 'Description': 'Overrides the rows setting defined at the '
+ 'block level.'},
'rowSpacer': {
'Typecast': GTypecast.whole,
'Label': _('Row Spacing'),
- 'Description': 'TODO' },
+ 'Description': 'Overrides the rowSpacer setting at the '
+ 'block level.' },
'navigable': {
'Typecast': GTypecast.boolean,
'Description': 'If false, the user will be unable to navigate '
'to this entry. Triggers can still '
- 'alter the value.',
+ 'alter the value though.',
'Default': True },
'hidden': {
'Typecast': GTypecast.boolean,
'Default': False,
'Description': 'If "Y", the entry widget will not be '
- 'displayed on the form. This is usefull for '
+ 'displayed on the form. This is useful for '
'fields the user doesn\'t need to know about '
'that you wish to update via triggers.' },
'style': {
@@ -566,9 +561,10 @@
'checkbox': {'Label': _('Checkbox')},
'label': {'Label': _('Label (non-editable)')} },
'Default': 'default',
- 'Description': 'The style of entry widget requested. Currently '
- 'either {text}, {label}, {checkbox}, {listbox},
or {dropdown}. To '
- 'use {listbox} or {dropdown} you are required to
use both the '
+ 'Description': 'The style of entry widget requested. '
+ 'Currently either {text}, {label}, {checkbox}, '
+ '{listbox}, or {dropdown}. To use {listbox} or '
+ '{dropdown} you are required to use both the '
'{fk_source}, {fk_key}, and {fk_description} '
'attributes. The {label} style implies the '
'{readonly} attribute.' },
@@ -579,25 +575,18 @@
'inputmask': {
'Typecast': GTypecast.text,
'Label': _('Input Mask'),
- 'Description': 'TODO' },
+ 'Description': 'Defines how the user will edit a field\'s '
+ 'value.' },
'displaymask': {
'Label': _('Display Mask'),
'Typecast': GTypecast.text,
- 'Description': 'TODO' } },
-## 'x': {
-## 'Required': True,
-## 'Typecast': GTypecast.whole,
-## 'Description': 'The text column starting position of the '
-## 'widget. Based upon leftmost column of screen '
-## 'being 0.' },
-## 'y': {
-## 'Required': True,
-## 'Typecast': GTypecast.whole,
-## 'Description': 'The text row starting position of the widget.
'
-## 'Based upon the top row of the screen being
0.' } },
+ 'Description': 'Defines how the field data will be formatted '
+ 'for display.' } },
'Positionable': True,
'ParentTags': ('page',),
- 'Description': 'An {entry} is the visual counterpart to a {field}.' },
+ 'Description': 'An {entry} is the visual counterpart to a {field}, '
+ 'it defines how the data in a field will be displayed '
+ 'and how it can be edited.'},
'scrollbar': {
'BaseClass': GFObjects.GFScrollBar,
@@ -605,31 +594,16 @@
'name': {
'Unique': True,
'Typecast': GTypecast.name,
- 'Description': 'TODO' },
+ 'Description': 'The unique name of the scrollbar.' },
'block': {
'Required': True,
'Typecast': GTypecast.name,
'References': 'block.name',
'Description': 'The {block} to which this scrollbar scrolls.' }
},
-## 'width': {
-## 'Required': True,
-## 'Typecast': GTypecast.whole,
-## 'Description': 'The width of the box in text columns.' },
-## 'height': {
-## 'Required': True,
-## 'Typecast': GTypecast.whole,
-## 'Description': 'The height of the box in text rows.' },
-## 'x': {
-## 'Required': True,
-## 'Typecast': GTypecast.whole,
-## 'Description': 'The text column starting position of the
widget. Based upon leftmost column of screen being 0. ' },
-## 'y': {
-## 'Required': True,
-## 'Typecast': GTypecast.whole,
-## 'Description': 'The text row starting position of the widget.
Based upon the top row of the screen being 0.' } },
'Positionable': True,
'ParentTags': ('page',),
- 'Description': 'TODO' },
+ 'Description': 'A scrollbar is a visual element that lets the user '
+ 'move vertically layout elements linked to it.' },
'box': {
'BaseClass': GFObjects.GFBox,
@@ -637,39 +611,27 @@
'name': {
'Unique': True,
'Typecast': GTypecast.name,
- 'Description': 'TODO' },
+ 'Description': 'The unique name of the box.' },
'label': {
'Typecast': GTypecast.text,
- 'Description': 'An optional text label that will be displayed
on the border.' },
-## 'width': {
-## 'Required': True,
-## 'Typecast': GTypecast.whole,
-## 'Description': 'The width of the box in text columns.' },
-## 'height': {
-## 'Required': True,
-## 'Typecast': GTypecast.whole,
-## 'Description': 'The height of the box in text rows.' },
+ 'Description': 'An optional text label that will be displayed '
+ 'on the border.' },
'focusorder': {
'Typecast': GTypecast.whole,
- 'Description': 'TODO' } },
-## 'x': {
-## 'Required': True,
-## 'Typecast': GTypecast.whole,
-## 'Description': 'The text column starting position of the
widget. Based upon leftmost column of screen being 0. ' },
-## 'y': {
-## 'Required': True,
-## 'Typecast': GTypecast.whole,
-## 'Description': 'The text row starting position of the widget.
Based upon the top row of the screen being 0.' } },
+ 'Description': 'Defines what order the focus moves through '
+ 'entries.' } },
'Positionable': True,
'ParentTags': ('page',),
- 'Description': 'TODO' },
+ 'Description': 'A box is a visual element that draws a box around '
+ 'other visual elements, thus providing logical '
+ 'separation for them.' },
'image': {
'BaseClass': GFObjects.GFImage,
'Attributes': {
'name': {
'Unique': True,
'Typecast': GTypecast.name,
- 'Description': 'TODO' },
+ 'Description': 'The unique name of the image.' },
'field': {
'Typecast': GTypecast.name,
'References': 'field.name',
@@ -686,7 +648,9 @@
'URL': {'Label': _('Field contains the URL of the image')},
'PIL': {'Label': _('Field contains a PIL encoding of the
image')} },
'Default': "URL",
- 'Description': 'The type of image reference. Can be {URL} for a
url reference, or {PIL} for an embedded image.' },
+ 'Description': 'The type of image reference. Can be {URL} '
+ 'for a url reference, or {PIL} for an '
+ 'embedded image.' },
'fit': {
'Typecast': GTypecast.name,
'ValueSet': {
@@ -696,7 +660,10 @@
'both': {'Label': _('Scale width and height (may distort
image)')},
'auto': {'Label': _('Use a best-fit algorithm')} },
'Default': "none",
- 'Description': 'TODO' },
+ 'Description': 'Defines how the image will fill the space '
+ 'provided for it (crop parts outside borders, '
+ 'or stretch width/height/both to fit into '
+ 'given boundaries).' },
'editable': {
'Description': 'Only allow this object to be edited if it '
'is currently empty.',
@@ -711,10 +678,11 @@
'Default': 'Y' },
'focusorder': {
'Typecast': GTypecast.whole,
- 'Description': 'TODO' } },
+ 'Description': 'Defines what order the focus moves through '
+ 'entries.' } },
'Positionable': True,
'ParentTags': ('page',),
- 'Description': 'TODO' },
+ 'Description': 'Displays an image.' },
'component': {
'BaseClass': GFObjects.GFComponent,
@@ -722,7 +690,7 @@
'name': {
'Unique': True,
'Typecast': GTypecast.name,
- 'Description': 'TODO' },
+ 'Description': 'The unique name of the component.' },
'field': {
'Typecast': GTypecast.name,
'References': 'field.name',
@@ -747,19 +715,21 @@
'Description': 'TODO' },
'focusorder': {
'Typecast': GTypecast.whole,
- 'Description': 'TODO' } },
+ 'Description': 'Defines what order the focus moves through '
+ 'entries.' } },
'Positionable': True,
'ParentTags': ('page',),
'Description': 'TODO' },
'button': {
'BaseClass': GFObjects.GFButton,
- 'Importable':1,
+ 'Importable': True,
'Attributes': {
'name': {
'Unique': True,
'Typecast': GTypecast.name,
- 'Description': 'A unique ID for the widget. Useful for
importable buttons. ' },
+ 'Description': 'A unique ID for the widget. Useful for '
+ 'importable buttons. ' },
'navigable': {
'Description': 'Can this button be navigated?',
'Label': _('Navigable'),
@@ -768,32 +738,22 @@
'block': {
'Typecast': GTypecast.name,
'References': 'block.name',
- 'Description': 'The (optional) name of the block that this ties
to. If a button is associated with a block, then the button honors the block\'s
rows= value.' },
+ 'Description': 'The (optional) name of the block that this '
+ 'ties to. If a button is associated with '
+ 'a block, then the button honors '
+ 'the block\'s rows= value.' },
'focusorder': {
'Typecast': GTypecast.whole,
- 'Description': 'TODO'},
+ 'Description': 'Defines what order the focus moves through '
+ 'entries.'},
'label': {
'Typecast': GTypecast.name,
'Description': 'The text that should appear on the button' } },
-## 'width': {
-## 'Required': True,
-## 'Typecast': GTypecast.whole,
-## 'Description': 'The width of the entry in text columns.' },
-## 'height': {
-## 'Required': True,
-## 'Typecast': GTypecast.whole,
-## 'Description': 'The height of the entry in text rows. ' },
-## 'x': {
-## 'Required': True,
-## 'Typecast': GTypecast.whole,
-## 'Description': 'The text column starting position of the
widget. Based upon leftmost column of screen being 0.' },
-## 'y': {
-## 'Required': True,
-## 'Typecast': GTypecast.whole,
-## 'Description': 'The text row starting position of the widget.
Based upon the top row of the screen being 0.' } },
'Positionable': True,
'ParentTags': ('page',),
- 'Description': 'TODO' },
+ 'Description': 'A visual element with text placed on it, that '
+ 'the user can push or click, and that event can run '
+ 'a bound trigger.' },
'tree': {
'BaseClass': GFObjects.GFTree,
@@ -801,14 +761,16 @@
'name': {
'Unique': True,
'Typecast': GTypecast.name,
- 'Description': 'Tree Widget.' },
+ 'Description': 'Unique name of the tree.' },
'rows': {
'Typecast': GTypecast.whole,
- 'Description': 'Overrides the rows setting defined at the block
level. ' },
+ 'Description': 'Overrides the rows setting defined at '
+ 'the block level.' },
'rowSpacer': {
'Typecast': GTypecast.whole,
'Label': _('Row Spacing'),
- 'Description': 'Overriders the rowSpace setting defined at the
block level.' },
+ 'Description': 'Overriders the rowSpace setting defined at '
+ 'the block level.' },
'block': {
'Typecast': GTypecast.name,
'Required': True,
@@ -853,11 +815,13 @@
'fld_id': {
'Label': _('ID of a field'), # TODO: we need some kind of
restriction
'Typecast': GTypecast.name, # TODO: on which entries we
pick...
- 'Required': True },
+ 'Required': True,
+ 'Description': 'TODO' },
'fld_desc': {
'Label': _('Description field'),
'Typecast': GTypecast.name,
- 'Required': True },
+ 'Required': True,
+ 'Description': 'TODO' },
'tblhint': {
'Typecast': GTypecast.name,
'Required': True,
@@ -1029,22 +993,25 @@
'Required': True,
'Unique': True,
'Typecast': GTypecast.name,
- 'Description': 'TODO' },
+ 'Description': 'Unique name of the parameter.' },
'required': {
'Typecast': GTypecast.boolean,
'Default': False,
- 'Description': 'TODO' },
+ 'Description': 'Is it obligatory to provide this parameter '
+ 'to run the form?' },
## 'limited': {
## 'Typecast': GTypecast.boolean,
## 'Default': False,
## 'Description': 'TODO' },
'default': {
'Typecast': GTypecast.text,
- 'Description': 'TODO' },
+ 'Description': 'Default value of the parameter, if the user '
+ 'does not provide a value for it.' },
'description': {
## 'Required': True,
'Typecast': GTypecast.text,
- 'Description': 'TODO' },
+ 'Description': 'Provide some textual information '
+ 'to describe the parameter better.' },
## 'source': {
## 'Typecast': GTypecast.name,
## 'Description': 'TODO' },
@@ -1053,7 +1020,9 @@
'Default': "char",
'Description': 'TODO' } },
'ParentTags': ('form',),
- 'Description': 'TODO' },
+ 'Description': 'A form can get parameters from the outer world '
+ 'or a calling form, and can pass values back too '
+ 'in these parameters.' },
}
Property changes on: trunk/gnue-forms/src/GFParser.py
___________________________________________________________________
Name: svn:keywords
+ Id
Name: svn:leywords
+ Id
| [Prev in Thread] |
Current Thread |
[Next in Thread] |
- [gnue] r6997 - trunk/gnue-forms/src,
kilo <=