44The modules documented here provide GUI or graphics capabilities that
55are used in multiple sections of the GSAS-II GUI or graphics.
66
7+ .. TODO: The tables below need work. The references such as :class:`EnumSelector`
8+ .. and :func:`G2RadioButtons` don't work. What is needed is
9+ .. :class:`~GSASII.GSASIIctrlGUI.EnumSelector` and
10+ .. :func:`~GSASII.GSASIIctrlGUI.G2RadioButtons`. That will require
11+ .. realigning the tables big-time.
12+
13+
714---------------------------------------------
815*GSASIIctrlGUI: Custom GUI controls *
916---------------------------------------------
@@ -15,47 +22,48 @@ data window or dialogs:
1522
1623.. tabularcolumns :: |l|p{4in}|
1724
18- ================================ =================================================================
19- Class or function name Description
20- ================================ =================================================================
21- :class: `EnumSelector ` A combo box with a built-in call back routine that
22- automatically sets a dict or list entry.
23- :class: `G2ChoiceButton ` A customized wx.Choice that automatically initializes to
24- the initial value and saves the choice directly into a dict
25- or list value. Optionally calls function when a
26- choice is selected
27- :class: `G2CheckBox ` A customized wx.CheckBox that automatically initializes to
28- the initial value and saves the choice directly into a dict
29- or list value. Optionally calls function when a
30- choice is selected
31- :func: `G2CheckBoxFrontLbl ` A version of :class: `G2CheckBox ` that places the label
32- for the check box in front. Otherwise works the same.
33- :func: `G2RadioButtons ` Creates a series of grouped radio buttons.
34- :class: `G2SliderWidget ` A customized combination of a wx.Slider and a validated
35- wx.TextCtrl (see :class: `ValidatedTxtCtrl `).
36- :class: `G2Slider ` A wrapped version of wx.Slider that implements scaling
37- :class: `G2SpinWidget ` A customized combination of a wx.SpinButton and a validated
38- wx.TextCtrl (see :class: `ValidatedTxtCtrl `).
39- :class: `G2MultiChoiceWindow ` Similar to :class: `G2MultiChoiceDialog ` but provides
40- a sizer that can be placed in a frame or panel.
41- :class: `HelpButton ` Creates a button labeled with a "?" that when pressed
42- displays help text in a modal message window
43- or web browser.
44- :class: `OrderBox ` Creates a wx.Panel with scrollbars where items can be
45- ordered into columns.
46- :class: `SortableLstCtrl ` Creates a wx.Panel for a table of data that
47- can be sorted by clicking on a column label.
48- :class: `ValidatedTxtCtrl ` A text control with a built-in call back routine to set dict
49- or list elements. Optionally validates input as float, int or
50- for strings non-blank. Value is set when focus changes
51- :func: `HorizontalLine ` Places a line in a Frame or Dialog to separate sections.
52- :class: `ScrolledStaticText ` A wx.StaticText widget that fits a large string into a
53- small space by scrolling it
54- :func: `ReadOnlyTextCtrl ` A wx.TextCtrl widget to be used wx.StaticText
55- (no edits allowed) text appears in a box.
56- :func: `setColorButton ` A button for color selection as a replacement
57- for wx.ColourSelect
58- ================================ =================================================================
25+ =================================== =================================================================
26+ Class or function name Description
27+ =================================== =================================================================
28+ :class: `EnumSelector ` A combo box with a built-in call back routine that
29+ automatically sets a dict or list entry.
30+ :class: `G2ChoiceButton ` A customized wx.Choice that automatically initializes to
31+ the initial value and saves the choice directly into a dict
32+ or list value. Optionally calls function when a
33+ choice is selected
34+ :class: `G2CheckBox ` A customized wx.CheckBox that automatically initializes to
35+ the initial value and saves the choice directly into a dict
36+ or list value. Optionally calls function when a
37+ choice is selected
38+ :func: `G2CheckBoxFrontLbl ` A version of :class: `~GSASII.GSASIIctrlGUI.G2CheckBox ` that
39+ places the label
40+ for the check box in front. Otherwise works the same.
41+ :func: `G2RadioButtons ` Creates a series of grouped radio buttons.
42+ :class: `G2SliderWidget ` A customized combination of a wx.Slider and a validated
43+ wx.TextCtrl (see :class: `ValidatedTxtCtrl `).
44+ :class: `G2Slider ` A wrapped version of wx.Slider that implements scaling
45+ :class: `G2SpinWidget ` A customized combination of a wx.SpinButton and a validated
46+ wx.TextCtrl (see :class: `ValidatedTxtCtrl `).
47+ :class: `G2MultiChoiceWindow ` Similar to :class: `G2MultiChoiceDialog ` but provides
48+ a sizer that can be placed in a frame or panel.
49+ :class: `HelpButton ` Creates a button labeled with a "?" that when pressed
50+ displays help text in a modal message window
51+ or web browser.
52+ :class: `OrderBox ` Creates a wx.Panel with scrollbars where items can be
53+ ordered into columns.
54+ :class: `SortableLstCtrl ` Creates a wx.Panel for a table of data that
55+ can be sorted by clicking on a column label.
56+ :class: `ValidatedTxtCtrl ` A text control with a built-in call back routine to set dict
57+ or list elements. Optionally validates input as float, int or
58+ for strings non-blank. Value is set when focus changes
59+ :func: `HorizontalLine ` Places a line in a Frame or Dialog to separate sections.
60+ :class: `ScrolledStaticText ` A wx.StaticText widget that fits a large string into a
61+ small space by scrolling it
62+ :func: `ReadOnlyTextCtrl ` A wx.TextCtrl widget to be used wx.StaticText
63+ (no edits allowed) text appears in a box.
64+ :func: `setColorButton ` A button for color selection as a replacement
65+ for wx.ColourSelect
66+ =================================== =================================================================
5967
6068GSAS-II-provided Dialog (full window) routines:
6169
@@ -171,7 +179,7 @@ Function name Description
171179GSASIIctrlGUI Classes & Routines
172180---------------------------------------------
173181
174- .. automodule :: GSASIIctrlGUI
182+ .. automodule :: GSASII. GSASIIctrlGUI
175183 :members:
176184
177185---------------------------------------------
@@ -186,7 +194,7 @@ Includes support for image reading.
186194GSASIImiscGUI Classes & Routines
187195---------------------------------------------
188196
189- .. automodule :: GSASIImiscGUI
197+ .. automodule :: GSASII. GSASIImiscGUI
190198 :members:
191199
192200---------------------------------------------
0 commit comments