1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146
|
complete = 1
reviewdate = "30 August 1998"
name = """
listbox with optional scrollbars
"""
description = """
A scrolled listbox consists of a standard listbox widget with optional
scrollbars which can be used to scroll the listbox. The
scrollbars can be 'dynamic', which means that a scrollbar will
only be displayed if it is necessary. That is, if the listbox
does not contain enough entries, the vertical scrollbar will be
automatically hidden and if the entries are not wide enough, the
horizontal scrollbar will be automatically hidden.
"""
text = {}
text['options'] = {}
text['options']['hscrollmode'] = """
The horizontal scroll mode. If *'none'*, the horizontal scrollbar
will never be displayed. If *'static'*, the scrollbar will always
be displayed. If *'dynamic'*, the scrollbar will be displayed
only if necessary.
"""
text['options']['vscrollmode'] = """
The vertical scroll mode. If *'none'*, the vertical scrollbar
will never be displayed. If *'static'*, the scrollbar will always
be displayed. If *'dynamic'*, the scrollbar will be displayed
only if necessary.
"""
text['options']['scrollmargin'] = """
The distance between the scrollbars and the listbox widget.
"""
text['options']['dblclickcommand'] = """
This specifies a function to call when mouse button 1 is double
clicked over an entry in the *listbox* component.
"""
text['options']['selectioncommand'] = """
This specifies a function to call when mouse button 1 is single
clicked over an entry in the *listbox* component or if the *<Space>*
or *<Return>* key is hit while the *listbox* has focus.
"""
text['options']['items'] = """
A tuple containing the initial items to be displayed by the
*listbox* component.
"""
text['options']['usehullsize'] = """
If true, the size of the megawidget is determined solely by the
width and height options of the *hull* component.
Otherwise, the size of the megawidget is determined by the width
and height of the *listbox* component, along with the size and/or
existence of the other components, such as the label, the
scrollbars and the scrollmargin option. All these affect the
overall size of the megawidget.
"""
text['components'] = {}
text['components']['listbox'] = """
The listbox widget which is scrolled by the scrollbars.
"""
text['components']['horizscrollbar'] = """
The horizontal scrollbar.
"""
text['components']['vertscrollbar'] = """
The vertical scrollbar.
"""
text['methods'] = {}
text['methods']['bbox'] = """
This method is explicitly forwarded to the *listbox* component's
/bbox()/ method. Without this explicit forwarding, the /bbox()/
method (aliased to /grid_bbox()/) of the *hull* would be invoked,
which is probably not what the programmer intended.
"""
text['methods']['size'] = """
This method is explicitly forwarded to the *listbox* component's
/size()/ method. Without this explicit forwarding, the /size()/
method (aliased to /grid_size()/) of the *hull* would be invoked,
which is probably not what the programmer intended.
"""
text['methods']['clear'] = """
Delete all items from the scrolled listbox. Equivalent to
/setlist(())/.
"""
text['methods']['get'] = """
This is the same as the /get()/ method of the *listbox* component,
except that if 'first' is *None* all list
elements are returned.
"""
text['methods']['getvalue'] = """
Return a list of the currently selected items of the listbox.
"""
text['methods']['setvalue'] = """
Set the current selection for the scrolled list to 'textOrList'.
If 'textOrList' is a string, select only the list item specified.
Otherwise, select only the list items specified by 'textOrList',
which must be a sequence of strings.
"""
text['methods']['getcurselection'] = """
Same as /getvalue()/ method.
"""
text['methods']['setlist'] = """
Replace all the items of the *listbox* component with those
specified by the 'items' sequence.
"""
|