Changeset 1709 for sphinxdocs/build/html/GSASIIGUIr.html
- Timestamp:
- Mar 14, 2015 5:35:03 PM (8 years ago)
- File:
-
- 1 edited
-
sphinxdocs/build/html/GSASIIGUIr.html (modified) (35 diffs)
Legend:
- Unmodified
- Added
- Removed
-
sphinxdocs/build/html/GSASIIGUIr.html
r1513 r1709 54 54 <div class="body"> 55 55 56 <div class="section" id="module-GSASIIgrid"> 57 <span id="gsas-ii-gui-routines"></span><h1><em>GSAS-II GUI Routines</em><a class="headerlink" href="#module-GSASIIgrid" title="Permalink to this headline">¶</a></h1> 58 <div class="section" id="gsasiigrid-basic-gui-routines"> 59 <h2><em>GSASIIgrid: Basic GUI routines</em><a class="headerlink" href="#gsasiigrid-basic-gui-routines" title="Permalink to this headline">¶</a></h2> 60 <dl class="class"> 61 <dt id="GSASIIgrid.ASCIIValidator"> 62 <em class="property">class </em><tt class="descclassname">GSASIIgrid.</tt><tt class="descname">ASCIIValidator</tt><big>(</big><em>result=None</em>, <em>key=None</em><big>)</big><a class="reference internal" href="_modules/GSASIIgrid.html#ASCIIValidator"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIgrid.ASCIIValidator" title="Permalink to this definition">¶</a></dt> 56 <div class="section" id="module-GSASIIctrls"> 57 <span id="gsas-ii-gui-routines"></span><h1><em>GSAS-II GUI Routines</em><a class="headerlink" href="#module-GSASIIctrls" title="Permalink to this headline">¶</a></h1> 58 <div class="section" id="gsasiictrls-custom-gui-controls"> 59 <h2><em>GSASIIctrls: Custom GUI controls</em><a class="headerlink" href="#gsasiictrls-custom-gui-controls" title="Permalink to this headline">¶</a></h2> 60 <p>A library of GUI controls for reuse throughout GSAS-II</p> 61 <p>(at present many are still in GSASIIgrid, but with time will be moved here)</p> 62 <dl class="class"> 63 <dt id="GSASIIctrls.ASCIIValidator"> 64 <em class="property">class </em><tt class="descclassname">GSASIIctrls.</tt><tt class="descname">ASCIIValidator</tt><big>(</big><em>result=None</em>, <em>key=None</em><big>)</big><a class="reference internal" href="_modules/GSASIIctrls.html#ASCIIValidator"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIctrls.ASCIIValidator" title="Permalink to this definition">¶</a></dt> 63 65 <dd><p>A validator to be used with a TextCtrl to prevent 64 66 entering characters other than ASCII characters.</p> … … 81 83 </table> 82 84 <dl class="method"> 83 <dt id="GSASII grid.ASCIIValidator.Clone">84 <tt class="descname">Clone</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/GSASII grid.html#ASCIIValidator.Clone"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIgrid.ASCIIValidator.Clone" title="Permalink to this definition">¶</a></dt>85 <dt id="GSASIIctrls.ASCIIValidator.Clone"> 86 <tt class="descname">Clone</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/GSASIIctrls.html#ASCIIValidator.Clone"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIctrls.ASCIIValidator.Clone" title="Permalink to this definition">¶</a></dt> 85 87 <dd><p>Create a copy of the validator, a strange, but required component</p> 86 88 </dd></dl> 87 89 88 90 <dl class="method"> 89 <dt id="GSASII grid.ASCIIValidator.OnChar">90 <tt class="descname">OnChar</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="_modules/GSASII grid.html#ASCIIValidator.OnChar"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIgrid.ASCIIValidator.OnChar" title="Permalink to this definition">¶</a></dt>91 <dt id="GSASIIctrls.ASCIIValidator.OnChar"> 92 <tt class="descname">OnChar</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="_modules/GSASIIctrls.html#ASCIIValidator.OnChar"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIctrls.ASCIIValidator.OnChar" title="Permalink to this definition">¶</a></dt> 91 93 <dd><p>Called each type a key is pressed 92 94 ignores keys that are not allowed for int and float types</p> … … 94 96 95 97 <dl class="method"> 96 <dt id="GSASII grid.ASCIIValidator.TestValid">97 <tt class="descname">TestValid</tt><big>(</big><em>tc</em><big>)</big><a class="reference internal" href="_modules/GSASII grid.html#ASCIIValidator.TestValid"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIgrid.ASCIIValidator.TestValid" title="Permalink to this definition">¶</a></dt>98 <dt id="GSASIIctrls.ASCIIValidator.TestValid"> 99 <tt class="descname">TestValid</tt><big>(</big><em>tc</em><big>)</big><a class="reference internal" href="_modules/GSASIIctrls.html#ASCIIValidator.TestValid"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIctrls.ASCIIValidator.TestValid" title="Permalink to this definition">¶</a></dt> 98 100 <dd><p>Check if the value is valid by casting the input string 99 101 into ASCII.</p> … … 111 113 112 114 <dl class="method"> 113 <dt id="GSASII grid.ASCIIValidator.TransferFromWindow">114 <tt class="descname">TransferFromWindow</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/GSASII grid.html#ASCIIValidator.TransferFromWindow"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIgrid.ASCIIValidator.TransferFromWindow" title="Permalink to this definition">¶</a></dt>115 <dt id="GSASIIctrls.ASCIIValidator.TransferFromWindow"> 116 <tt class="descname">TransferFromWindow</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/GSASIIctrls.html#ASCIIValidator.TransferFromWindow"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIctrls.ASCIIValidator.TransferFromWindow" title="Permalink to this definition">¶</a></dt> 115 117 <dd><p>Needed by validator, strange, but required component</p> 116 118 </dd></dl> 117 119 118 120 <dl class="method"> 119 <dt id="GSASII grid.ASCIIValidator.TransferToWindow">120 <tt class="descname">TransferToWindow</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/GSASII grid.html#ASCIIValidator.TransferToWindow"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIgrid.ASCIIValidator.TransferToWindow" title="Permalink to this definition">¶</a></dt>121 <dt id="GSASIIctrls.ASCIIValidator.TransferToWindow"> 122 <tt class="descname">TransferToWindow</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/GSASIIctrls.html#ASCIIValidator.TransferToWindow"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIctrls.ASCIIValidator.TransferToWindow" title="Permalink to this definition">¶</a></dt> 121 123 <dd><p>Needed by validator, strange, but required component</p> 122 124 </dd></dl> … … 125 127 126 128 <dl class="class"> 127 <dt id="GSASII grid.AddHelp">128 <em class="property">class </em><tt class="descclassname">GSASII grid.</tt><tt class="descname">AddHelp</tt><big>(</big><em>frame</em>, <em>helpType</em>, <em>helpLbl=None</em>, <em>title=''</em><big>)</big><a class="reference internal" href="_modules/GSASIIgrid.html#AddHelp"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIgrid.AddHelp" title="Permalink to this definition">¶</a></dt>129 <dt id="GSASIIctrls.AddHelp"> 130 <em class="property">class </em><tt class="descclassname">GSASIIctrls.</tt><tt class="descname">AddHelp</tt><big>(</big><em>frame</em>, <em>helpType</em>, <em>helpLbl=None</em>, <em>title=''</em><big>)</big><a class="reference internal" href="_modules/GSASIIctrls.html#AddHelp"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIctrls.AddHelp" title="Permalink to this definition">¶</a></dt> 129 131 <dd><p>For the Mac: creates an entry to the help menu of type 130 132 ‘Help on <helpType>’: where helpType is a reference to an HTML page to … … 133 135 ‘&Help’ so that wx handles it correctly.</p> 134 136 <dl class="method"> 135 <dt id="GSASII grid.AddHelp.OnHelpById">136 <tt class="descname">OnHelpById</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="_modules/GSASII grid.html#AddHelp.OnHelpById"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIgrid.AddHelp.OnHelpById" title="Permalink to this definition">¶</a></dt>137 <dt id="GSASIIctrls.AddHelp.OnHelpById"> 138 <tt class="descname">OnHelpById</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="_modules/GSASIIctrls.html#AddHelp.OnHelpById"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIctrls.AddHelp.OnHelpById" title="Permalink to this definition">¶</a></dt> 137 139 <dd><p>Called when Help on... is pressed in a menu. Brings up 138 140 a web page for documentation.</p> … … 142 144 143 145 <dl class="function"> 144 <dt id="GSASII grid.CallScrolledMultiEditor">145 <tt class="descclassname">GSASII grid.</tt><tt class="descname">CallScrolledMultiEditor</tt><big>(</big><em>parent</em>, <em>dictlst</em>, <em>elemlst</em>, <em>prelbl=</em>, <span class="optional">[</span><span class="optional">]</span><em>postlbl=</em>, <span class="optional">[</span><span class="optional">]</span><em>title='Edit items'</em>, <em>header=''</em>, <em>size=(300</em>, <em>250)</em>, <em>CopyButton=False</em>, <em>**kw</em><big>)</big><a class="reference internal" href="_modules/GSASIIgrid.html#CallScrolledMultiEditor"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIgrid.CallScrolledMultiEditor" title="Permalink to this definition">¶</a></dt>146 <dt id="GSASIIctrls.CallScrolledMultiEditor"> 147 <tt class="descclassname">GSASIIctrls.</tt><tt class="descname">CallScrolledMultiEditor</tt><big>(</big><em>parent</em>, <em>dictlst</em>, <em>elemlst</em>, <em>prelbl=</em>, <span class="optional">[</span><span class="optional">]</span><em>postlbl=</em>, <span class="optional">[</span><span class="optional">]</span><em>title='Edit items'</em>, <em>header=''</em>, <em>size=(300</em>, <em>250)</em>, <em>CopyButton=False</em>, <em>**kw</em><big>)</big><a class="reference internal" href="_modules/GSASIIctrls.html#CallScrolledMultiEditor"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIctrls.CallScrolledMultiEditor" title="Permalink to this definition">¶</a></dt> 146 148 <dd><p>Shell routine to call a ScrolledMultiEditor dialog. See 147 <a class="reference internal" href="#GSASII grid.ScrolledMultiEditor" title="GSASIIgrid.ScrolledMultiEditor"><tt class="xref py py-class docutils literal"><span class="pre">ScrolledMultiEditor</span></tt></a> for parameter definitions.</p>149 <a class="reference internal" href="#GSASIIctrls.ScrolledMultiEditor" title="GSASIIctrls.ScrolledMultiEditor"><tt class="xref py py-class docutils literal"><span class="pre">ScrolledMultiEditor</span></tt></a> for parameter definitions.</p> 148 150 <table class="docutils field-list" frame="void" rules="none"> 149 151 <col class="field-name" /> … … 158 160 159 161 <dl class="class"> 160 <dt id="GSASIIgrid.DataFrame"> 161 <em class="property">class </em><tt class="descclassname">GSASIIgrid.</tt><tt class="descname">DataFrame</tt><big>(</big><em>parent</em>, <em>frame</em>, <em>data=None</em>, <em>name=None</em>, <em>size=None</em>, <em>pos=None</em><big>)</big><a class="reference internal" href="_modules/GSASIIgrid.html#DataFrame"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIgrid.DataFrame" title="Permalink to this definition">¶</a></dt> 162 <dd><p>Create the data item window and all the entries in menus used in 163 that window. For Linux and windows, the menu entries are created for the 164 current data item window, but in the Mac the menu is accessed from all 165 windows. This means that a different menu is posted depending on which 166 data item is posted. On the Mac, all the menus contain the data tree menu 167 items, but additional menus are added specific to the data item.</p> 168 <p>Note that while the menus are created here, 169 the binding for the menus is done later in various GSASII*GUI modules, 170 where the functions to be called are defined.</p> 171 <dl class="method"> 172 <dt id="GSASIIgrid.DataFrame.Bind"> 173 <tt class="descname">Bind</tt><big>(</big><em>eventtype</em>, <em>handler</em>, <em>*args</em>, <em>**kwargs</em><big>)</big><a class="reference internal" href="_modules/GSASIIgrid.html#DataFrame.Bind"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIgrid.DataFrame.Bind" title="Permalink to this definition">¶</a></dt> 174 <dd><p>Override the Bind() function: on the Mac the binding is to 175 the main window, so that menus operate with any window on top. 176 For other platforms, either wrap calls that will be logged 177 or call the default wx.Frame Bind() to bind to the menu item directly.</p> 178 <p>Note that bindings can be made to objects by Id or by direct reference to the 179 object. As a convention, when bindings are to objects, they are not logged 180 but when bindings are by Id, they are logged.</p> 181 </dd></dl> 182 183 <dl class="method"> 184 <dt id="GSASIIgrid.DataFrame.PostfillDataMenu"> 185 <tt class="descname">PostfillDataMenu</tt><big>(</big><em>empty=False</em><big>)</big><a class="reference internal" href="_modules/GSASIIgrid.html#DataFrame.PostfillDataMenu"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIgrid.DataFrame.PostfillDataMenu" title="Permalink to this definition">¶</a></dt> 186 <dd><p>Create the “standard” part of data frame menus. Note that on Linux and 187 Windows, this is the standard help Menu. On Mac, this menu duplicates the 188 tree menu, but adds an extra help command for the data item and a separator.</p> 189 </dd></dl> 190 191 <dl class="method"> 192 <dt id="GSASIIgrid.DataFrame.PrefillDataMenu"> 193 <tt class="descname">PrefillDataMenu</tt><big>(</big><em>menu</em>, <em>helpType</em>, <em>helpLbl=None</em>, <em>empty=False</em><big>)</big><a class="reference internal" href="_modules/GSASIIgrid.html#DataFrame.PrefillDataMenu"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIgrid.DataFrame.PrefillDataMenu" title="Permalink to this definition">¶</a></dt> 194 <dd><p>Create the “standard” part of data frame menus. Note that on Linux and 195 Windows nothing happens here. On Mac, this menu duplicates the 196 tree menu, but adds an extra help command for the data item and a separator.</p> 197 </dd></dl> 198 199 </dd></dl> 200 201 <dl class="class"> 202 <dt id="GSASIIgrid.DisAglDialog"> 203 <em class="property">class </em><tt class="descclassname">GSASIIgrid.</tt><tt class="descname">DisAglDialog</tt><big>(</big><em>parent</em>, <em>data</em>, <em>default</em><big>)</big><a class="reference internal" href="_modules/GSASIIgrid.html#DisAglDialog"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIgrid.DisAglDialog" title="Permalink to this definition">¶</a></dt> 204 <dd><p>Distance/Angle Controls input dialog. After 205 <tt class="xref py py-meth docutils literal"><span class="pre">ShowModal()</span></tt> returns, the results are found in 206 dict <tt class="xref py py-attr docutils literal"><span class="pre">self.data</span></tt>, which is accessed using <a class="reference internal" href="#GSASIIgrid.DisAglDialog.GetData" title="GSASIIgrid.DisAglDialog.GetData"><tt class="xref py py-meth docutils literal"><span class="pre">GetData()</span></tt></a>.</p> 207 <table class="docutils field-list" frame="void" rules="none"> 208 <col class="field-name" /> 209 <col class="field-body" /> 210 <tbody valign="top"> 211 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 212 <li><strong>parent</strong> (<em>wx.Frame</em>) – reference to parent frame (or None)</li> 213 <li><strong>data</strong> (<em>dict</em>) – a dict containing the current 214 search ranges or an empty dict, which causes default values 215 to be used. 216 Will be used to set element <cite>DisAglCtls</cite> in 217 <a class="reference internal" href="GSASIIobj.html#phase-table"><em>Phase Tree Item</em></a></li> 218 <li><strong>default</strong> (<em>dict</em>) – A dict containing the default 219 search ranges for each element.</li> 220 </ul> 221 </td> 222 </tr> 223 </tbody> 224 </table> 225 <dl class="method"> 226 <dt id="GSASIIgrid.DisAglDialog.Draw"> 227 <tt class="descname">Draw</tt><big>(</big><em>data</em><big>)</big><a class="reference internal" href="_modules/GSASIIgrid.html#DisAglDialog.Draw"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIgrid.DisAglDialog.Draw" title="Permalink to this definition">¶</a></dt> 228 <dd><p>Creates the contents of the dialog. Normally called 229 by <tt class="xref py py-meth docutils literal"><span class="pre">__init__()</span></tt>.</p> 230 </dd></dl> 231 232 <dl class="method"> 233 <dt id="GSASIIgrid.DisAglDialog.GetData"> 234 <tt class="descname">GetData</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/GSASIIgrid.html#DisAglDialog.GetData"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIgrid.DisAglDialog.GetData" title="Permalink to this definition">¶</a></dt> 235 <dd><p>Returns the values from the dialog</p> 236 </dd></dl> 237 238 <dl class="method"> 239 <dt id="GSASIIgrid.DisAglDialog.OnOk"> 240 <tt class="descname">OnOk</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="_modules/GSASIIgrid.html#DisAglDialog.OnOk"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIgrid.DisAglDialog.OnOk" title="Permalink to this definition">¶</a></dt> 241 <dd><p>Called when the OK button is pressed</p> 242 </dd></dl> 243 244 <dl class="method"> 245 <dt id="GSASIIgrid.DisAglDialog.OnReset"> 246 <tt class="descname">OnReset</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="_modules/GSASIIgrid.html#DisAglDialog.OnReset"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIgrid.DisAglDialog.OnReset" title="Permalink to this definition">¶</a></dt> 247 <dd><p>Called when the Reset button is pressed</p> 248 </dd></dl> 249 250 </dd></dl> 251 252 <dl class="class"> 253 <dt id="GSASIIgrid.EnumSelector"> 254 <em class="property">class </em><tt class="descclassname">GSASIIgrid.</tt><tt class="descname">EnumSelector</tt><big>(</big><em>parent</em>, <em>dct</em>, <em>item</em>, <em>choices</em>, <em>values=None</em>, <em>**kw</em><big>)</big><a class="reference internal" href="_modules/GSASIIgrid.html#EnumSelector"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIgrid.EnumSelector" title="Permalink to this definition">¶</a></dt> 255 <dd><p>A customized <tt class="xref py py-class docutils literal"><span class="pre">wxpython.ComboBox</span></tt> that selects items from a list 256 of choices, but sets a dict (list) entry to the corresponding 257 entry from the input list of values.</p> 258 <table class="docutils field-list" frame="void" rules="none"> 259 <col class="field-name" /> 260 <col class="field-body" /> 261 <tbody valign="top"> 262 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 263 <li><strong>parent</strong> (<em>wx.Panel</em>) – the parent to the <tt class="xref py py-class docutils literal"><span class="pre">ComboBox</span></tt> (usually a 264 frame or panel)</li> 265 <li><strong>dct</strong> (<em>dict</em>) – a dict (or list) to contain the value set 266 for the <tt class="xref py py-class docutils literal"><span class="pre">ComboBox</span></tt>.</li> 267 <li><strong>item</strong> – the dict key (or list index) where <tt class="docutils literal"><span class="pre">dct[item]</span></tt> will 268 be set to the value selected in the <tt class="xref py py-class docutils literal"><span class="pre">ComboBox</span></tt>. Also, dct[item] 269 contains the starting value shown in the widget. If the value 270 does not match an entry in <tt class="xref py py-data docutils literal"><span class="pre">values</span></tt>, the first value 271 in <tt class="xref py py-data docutils literal"><span class="pre">choices</span></tt> is used as the default, but <tt class="docutils literal"><span class="pre">dct[item]</span></tt> is 272 not changed.</li> 273 <li><strong>choices</strong> (<em>list</em>) – <p>a list of choices to be displayed to the 274 user such as</p> 275 <div class="highlight-python"><div class="highlight"><pre><span class="p">[</span><span class="s">"default"</span><span class="p">,</span><span class="s">"option 1"</span><span class="p">,</span><span class="s">"option 2"</span><span class="p">,]</span> 276 </pre></div> 277 </div> 278 <p>Note that these options will correspond to the entries in 279 <tt class="xref py py-data docutils literal"><span class="pre">values</span></tt> (if specified) item by item.</p> 280 </li> 281 <li><strong>values</strong> (<em>list</em>) – <p>a list of values that correspond to 282 the options in <tt class="xref py py-data docutils literal"><span class="pre">choices</span></tt>, such as</p> 283 <div class="highlight-python"><div class="highlight"><pre><span class="p">[</span><span class="mi">0</span><span class="p">,</span><span class="mi">1</span><span class="p">,</span><span class="mi">2</span><span class="p">]</span> 284 </pre></div> 285 </div> 286 <p>The default for <tt class="xref py py-data docutils literal"><span class="pre">values</span></tt> is to use the same list as 287 specified for <tt class="xref py py-data docutils literal"><span class="pre">choices</span></tt>.</p> 288 </li> 289 <li><strong>(other)</strong> – additional keyword arguments accepted by 290 <tt class="xref py py-class docutils literal"><span class="pre">ComboBox</span></tt> can be specified.</li> 291 </ul> 292 </td> 293 </tr> 294 </tbody> 295 </table> 296 </dd></dl> 297 298 <dl class="class"> 299 <dt id="GSASIIgrid.G2CheckBox"> 300 <em class="property">class </em><tt class="descclassname">GSASIIgrid.</tt><tt class="descname">G2CheckBox</tt><big>(</big><em>parent</em>, <em>label</em>, <em>loc</em>, <em>key</em><big>)</big><a class="reference internal" href="_modules/GSASIIgrid.html#G2CheckBox"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIgrid.G2CheckBox" title="Permalink to this definition">¶</a></dt> 162 <dt id="GSASIIctrls.G2CheckBox"> 163 <em class="property">class </em><tt class="descclassname">GSASIIctrls.</tt><tt class="descname">G2CheckBox</tt><big>(</big><em>parent</em>, <em>label</em>, <em>loc</em>, <em>key</em><big>)</big><a class="reference internal" href="_modules/GSASIIctrls.html#G2CheckBox"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIctrls.G2CheckBox" title="Permalink to this definition">¶</a></dt> 301 164 <dd><p>A customized version of a CheckBox that automatically initializes 302 165 the control to a supplied list or dict entry and updates that … … 325 188 326 189 <dl class="class"> 327 <dt id="GSASIIgrid.G2ChoiceButton"> 328 <em class="property">class </em><tt class="descclassname">GSASIIgrid.</tt><tt class="descname">G2ChoiceButton</tt><big>(</big><em>parent</em>, <em>choiceList</em>, <em>indLoc=None</em>, <em>indKey=None</em>, <em>strLoc=None</em>, <em>strKey=None</em>, <em>onChoice=None</em>, <em>**kwargs</em><big>)</big><a class="reference internal" href="_modules/GSASIIgrid.html#G2ChoiceButton"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIgrid.G2ChoiceButton" title="Permalink to this definition">¶</a></dt> 329 <dd><p>A customized version of a wx.Choice that automatically initializes 330 the control to match a supplied value and saves the choice directly 331 into an array or list. Optionally a function can be called each time a 332 choice is selected. The widget can be used with an array item that is set to 333 to the choice by number (<tt class="docutils literal"><span class="pre">indLoc[indKey]</span></tt>) or by string value 334 (<tt class="docutils literal"><span class="pre">strLoc[strKey]</span></tt>) or both. The initial value is taken from <tt class="docutils literal"><span class="pre">indLoc[indKey]</span></tt> 335 if not None or <tt class="docutils literal"><span class="pre">strLoc[strKey]</span></tt> if not None.</p> 336 <table class="docutils field-list" frame="void" rules="none"> 337 <col class="field-name" /> 338 <col class="field-body" /> 339 <tbody valign="top"> 340 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 341 <li><strong>parent</strong> (<em>wx.Panel</em>) – name of panel or frame that will be 342 the parent to the widget. Can be None.</li> 343 <li><strong>choiceList</strong> (<em>list</em>) – a list or tuple of choices to offer the user.</li> 344 <li><strong>indLoc</strong> (<em>dict/list</em>) – a dict or list with the initial value to be 345 placed in the Choice button. If this is None, this is ignored.</li> 346 <li><strong>indKey</strong> (<em>int/str</em>) – the dict key or the list index for the value to be 347 edited by the Choice button. If indLoc is not None then this 348 must be specified and the <tt class="docutils literal"><span class="pre">indLoc[indKey]</span></tt> will be set. If the value 349 for <tt class="docutils literal"><span class="pre">indLoc[indKey]</span></tt> is not None, it should be an integer in 350 range(len(choiceList)). The Choice button will be initialized to the 351 choice corresponding to the value in this element if not None.</li> 352 <li><strong>strLoc</strong> (<em>dict/list</em>) – a dict or list with the string value corresponding to 353 indLoc/indKey. Default (None) means that this is not used.</li> 354 <li><strong>strKey</strong> (<em>int/str</em>) – the dict key or the list index for the string value 355 The <tt class="docutils literal"><span class="pre">strLoc[strKey]</span></tt> element must exist or strLoc must be None (default).</li> 356 <li><strong>onChoice</strong> (<em>function</em>) – name of a function to call when the choice is made.</li> 357 </ul> 358 </td> 359 </tr> 360 </tbody> 361 </table> 362 </dd></dl> 363 364 <dl class="class"> 365 <dt id="GSASIIgrid.G2HtmlWindow"> 366 <em class="property">class </em><tt class="descclassname">GSASIIgrid.</tt><tt class="descname">G2HtmlWindow</tt><big>(</big><em>parent</em>, <em>*args</em>, <em>**kwargs</em><big>)</big><a class="reference internal" href="_modules/GSASIIgrid.html#G2HtmlWindow"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIgrid.G2HtmlWindow" title="Permalink to this definition">¶</a></dt> 190 <dt id="GSASIIctrls.G2HtmlWindow"> 191 <em class="property">class </em><tt class="descclassname">GSASIIctrls.</tt><tt class="descname">G2HtmlWindow</tt><big>(</big><em>parent</em>, <em>*args</em>, <em>**kwargs</em><big>)</big><a class="reference internal" href="_modules/GSASIIctrls.html#G2HtmlWindow"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIctrls.G2HtmlWindow" title="Permalink to this definition">¶</a></dt> 367 192 <dd><p>Displays help information in a primitive HTML browser type window</p> 368 193 </dd></dl> 369 194 370 <dl class="class"> 371 <dt id="GSASIIgrid.G2LoggedButton"> 372 <em class="property">class </em><tt class="descclassname">GSASIIgrid.</tt><tt class="descname">G2LoggedButton</tt><big>(</big><em>parent</em>, <em>id</em>, <em>label</em>, <em>locationcode</em>, <em>handler</em>, <em>*args</em>, <em>**kwargs</em><big>)</big><a class="reference internal" href="_modules/GSASIIgrid.html#G2LoggedButton"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIgrid.G2LoggedButton" title="Permalink to this definition">¶</a></dt> 373 <dd><p>A version of wx.Button that creates logging events. Bindings are saved 374 in the object, and are looked up rather than directly set with a bind. 375 An index to these buttons is saved as log.ButtonBindingLookup</p> 376 <dl class="method"> 377 <dt id="GSASIIgrid.G2LoggedButton.onPress"> 378 <tt class="descname">onPress</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="_modules/GSASIIgrid.html#G2LoggedButton.onPress"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIgrid.G2LoggedButton.onPress" title="Permalink to this definition">¶</a></dt> 379 <dd><p>create log event and call handler</p> 380 </dd></dl> 381 382 </dd></dl> 383 384 <dl class="class"> 385 <dt id="GSASIIgrid.G2MultiChoiceDialog"> 386 <em class="property">class </em><tt class="descclassname">GSASIIgrid.</tt><tt class="descname">G2MultiChoiceDialog</tt><big>(</big><em>parent</em>, <em>title</em>, <em>header</em>, <em>ChoiceList</em>, <em>toggle=True</em>, <em>monoFont=False</em>, <em>filterBox=True</em>, <em>**kw</em><big>)</big><a class="reference internal" href="_modules/GSASIIgrid.html#G2MultiChoiceDialog"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIgrid.G2MultiChoiceDialog" title="Permalink to this definition">¶</a></dt> 387 <dd><p>A dialog similar to MultiChoiceDialog except that buttons are 388 added to set all choices and to toggle all choices.</p> 389 <table class="docutils field-list" frame="void" rules="none"> 390 <col class="field-name" /> 391 <col class="field-body" /> 392 <tbody valign="top"> 393 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> 394 <li><strong>ParentFrame</strong> (<em>wx.Frame</em>) – reference to parent frame</li> 395 <li><strong>title</strong> (<em>str</em>) – heading above list of choices</li> 396 <li><strong>header</strong> (<em>str</em>) – Title to place on window frame</li> 397 <li><strong>ChoiceList</strong> (<em>list</em>) – a list of choices where one will be selected</li> 398 <li><strong>toggle</strong> (<em>bool</em>) – If True (default) the toggle and select all buttons 399 are displayed</li> 400 <li><strong>monoFont</strong> (<em>bool</em>) – If False (default), use a variable-spaced font; 401 if True use a equally-spaced font.</li> 402 <li><strong>filterBox</strong> (<em>bool</em>) – If True (default) an input widget is placed on 403 the window and only entries matching the entered text are shown.</li> 404 <li><strong>kw</strong> – optional keyword parameters for the wx.Dialog may 405 be included such as size [which defaults to <cite>(320,310)</cite>] and 406 style (which defaults to <cite>wx.DEFAULT_DIALOG_STYLE|wx.RESIZE_BORDER|wx.CENTRE| wx.OK | wx.CANCEL</cite>); 407 note that <cite>wx.OK</cite> and <cite>wx.CANCEL</cite> controls 408 the presence of the eponymous buttons in the dialog.</li> 409 </ul> 410 </td> 411 </tr> 412 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">the name of the created dialog</p> 413 </td> 414 </tr> 415 </tbody> 416 </table> 417 <dl class="method"> 418 <dt id="GSASIIgrid.G2MultiChoiceDialog.GetSelections"> 419 <tt class="descname">GetSelections</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/GSASIIgrid.html#G2MultiChoiceDialog.GetSelections"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIgrid.G2MultiChoiceDialog.GetSelections" title="Permalink to this definition">¶</a></dt> 420 <dd><p>Returns a list of the indices for the selected choices</p> 421 </dd></dl> 422 423 <dl class="method"> 424 <dt id="GSASIIgrid.G2MultiChoiceDialog.SetSelections"> 425 <tt class="descname">SetSelections</tt><big>(</big><em>selList</em><big>)</big><a class="reference internal" href="_modules/GSASIIgrid.html#G2MultiChoiceDialog.SetSelections"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIgrid.G2MultiChoiceDialog.SetSelections" title="Permalink to this definition">¶</a></dt> 426 <dd><p>Sets the selection indices in selList as selected. Resets any previous 427 selections for compatibility with wx.MultiChoiceDialog. Note that 428 the state for only the filtered items is shown.</p> 429 <table class="docutils field-list" frame="void" rules="none"> 430 <col class="field-name" /> 431 <col class="field-body" /> 432 <tbody valign="top"> 433 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>selList</strong> (<em>list</em>) – indices of items to be selected. These indices 434 are referenced to the order in self.ChoiceList</td> 435 </tr> 436 </tbody> 437 </table> 438 </dd></dl> 439 440 </dd></dl> 441 442 <dl class="class"> 443 <dt id="GSASIIgrid.G2SingleChoiceDialog"> 444 <em class="property">class </em><tt class="descclassname">GSASIIgrid.</tt><tt class="descname">G2SingleChoiceDialog</tt><big>(</big><em>parent</em>, <em>title</em>, <em>header</em>, <em>ChoiceList</em>, <em>monoFont=False</em>, <em>filterBox=True</em>, <em>**kw</em><big>)</big><a class="reference internal" href="_modules/GSASIIgrid.html#G2SingleChoiceDialog"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIgrid.G2SingleChoiceDialog" title="Permalink to this definition">¶</a></dt> 445 <dd><p>A dialog similar to wx.SingleChoiceDialog except that a filter can be 446 added.</p> 447 <table class="docutils field-list" frame="void" rules="none"> 448 <col class="field-name" /> 449 <col class="field-body" /> 450 <tbody valign="top"> 451 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> 452 <li><strong>ParentFrame</strong> (<em>wx.Frame</em>) – reference to parent frame</li> 453 <li><strong>title</strong> (<em>str</em>) – heading above list of choices</li> 454 <li><strong>header</strong> (<em>str</em>) – Title to place on window frame</li> 455 <li><strong>ChoiceList</strong> (<em>list</em>) – a list of choices where one will be selected</li> 456 <li><strong>monoFont</strong> (<em>bool</em>) – If False (default), use a variable-spaced font; 457 if True use a equally-spaced font.</li> 458 <li><strong>filterBox</strong> (<em>bool</em>) – If True (default) an input widget is placed on 459 the window and only entries matching the entered text are shown.</li> 460 <li><strong>kw</strong> – optional keyword parameters for the wx.Dialog may 461 be included such as size [which defaults to <cite>(320,310)</cite>] and 462 style (which defaults to <tt class="docutils literal"><span class="pre">wx.DEFAULT_DIALOG_STYLE</span> <span class="pre">|</span> <span class="pre">wx.RESIZE_BORDER</span> <span class="pre">|</span> <span class="pre">wx.CENTRE</span> <span class="pre">|</span> <span class="pre">wx.OK</span> <span class="pre">|</span> <span class="pre">wx.CANCEL</span></tt>); 463 note that <tt class="docutils literal"><span class="pre">wx.OK</span></tt> and <tt class="docutils literal"><span class="pre">wx.CANCEL</span></tt> controls 464 the presence of the eponymous buttons in the dialog.</li> 465 </ul> 466 </td> 467 </tr> 468 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">the name of the created dialog</p> 469 </td> 470 </tr> 471 </tbody> 472 </table> 473 <dl class="method"> 474 <dt id="GSASIIgrid.G2SingleChoiceDialog.GetSelection"> 475 <tt class="descname">GetSelection</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/GSASIIgrid.html#G2SingleChoiceDialog.GetSelection"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIgrid.G2SingleChoiceDialog.GetSelection" title="Permalink to this definition">¶</a></dt> 476 <dd><p>Returns the index of the selected choice</p> 477 </dd></dl> 478 479 </dd></dl> 480 481 <dl class="class"> 482 <dt id="GSASIIgrid.G2TreeCtrl"> 483 <em class="property">class </em><tt class="descclassname">GSASIIgrid.</tt><tt class="descname">G2TreeCtrl</tt><big>(</big><em>parent=None</em>, <em>*args</em>, <em>**kwargs</em><big>)</big><a class="reference internal" href="_modules/GSASIIgrid.html#G2TreeCtrl"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIgrid.G2TreeCtrl" title="Permalink to this definition">¶</a></dt> 195 <dl class="function"> 196 <dt id="GSASIIctrls.G2MessageBox"> 197 <tt class="descclassname">GSASIIctrls.</tt><tt class="descname">G2MessageBox</tt><big>(</big><em>parent</em>, <em>msg</em>, <em>title='Error'</em><big>)</big><a class="reference internal" href="_modules/GSASIIctrls.html#G2MessageBox"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIctrls.G2MessageBox" title="Permalink to this definition">¶</a></dt> 198 <dd><p>Simple code to display a error or warning message</p> 199 </dd></dl> 200 201 <dl class="class"> 202 <dt id="GSASIIctrls.G2TreeCtrl"> 203 <em class="property">class </em><tt class="descclassname">GSASIIctrls.</tt><tt class="descname">G2TreeCtrl</tt><big>(</big><em>parent=None</em>, <em>*args</em>, <em>**kwargs</em><big>)</big><a class="reference internal" href="_modules/GSASIIctrls.html#G2TreeCtrl"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIctrls.G2TreeCtrl" title="Permalink to this definition">¶</a></dt> 484 204 <dd><p>Create a wrapper around the standard TreeCtrl so we can “wrap” 485 205 various events.</p> 486 <p>This logs when a tree item is selected (in <a class="reference internal" href="#GSASII grid.G2TreeCtrl.onSelectionChanged" title="GSASIIgrid.G2TreeCtrl.onSelectionChanged"><tt class="xref py py-meth docutils literal"><span class="pre">onSelectionChanged()</span></tt></a>)</p>206 <p>This logs when a tree item is selected (in <a class="reference internal" href="#GSASIIctrls.G2TreeCtrl.onSelectionChanged" title="GSASIIctrls.G2TreeCtrl.onSelectionChanged"><tt class="xref py py-meth docutils literal"><span class="pre">onSelectionChanged()</span></tt></a>)</p> 487 207 <p>This also wraps lists and dicts pulled out of the tree to track where 488 208 they were retrieved from.</p> 489 209 <dl class="method"> 490 <dt id="GSASII grid.G2TreeCtrl.Bind">491 <tt class="descname">Bind</tt><big>(</big><em>eventtype</em>, <em>handler</em>, <em>*args</em>, <em>**kwargs</em><big>)</big><a class="reference internal" href="_modules/GSASII grid.html#G2TreeCtrl.Bind"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIgrid.G2TreeCtrl.Bind" title="Permalink to this definition">¶</a></dt>210 <dt id="GSASIIctrls.G2TreeCtrl.Bind"> 211 <tt class="descname">Bind</tt><big>(</big><em>eventtype</em>, <em>handler</em>, <em>*args</em>, <em>**kwargs</em><big>)</big><a class="reference internal" href="_modules/GSASIIctrls.html#G2TreeCtrl.Bind"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIctrls.G2TreeCtrl.Bind" title="Permalink to this definition">¶</a></dt> 492 212 <dd><p>Override the Bind() function so that page change events can be trapped</p> 493 213 </dd></dl> 494 214 495 215 <dl class="method"> 496 <dt id="GSASII grid.G2TreeCtrl.ConvertRelativeHistNum">497 <tt class="descname">ConvertRelativeHistNum</tt><big>(</big><em>histtype</em>, <em>histnum</em><big>)</big><a class="reference internal" href="_modules/GSASII grid.html#G2TreeCtrl.ConvertRelativeHistNum"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIgrid.G2TreeCtrl.ConvertRelativeHistNum" title="Permalink to this definition">¶</a></dt>216 <dt id="GSASIIctrls.G2TreeCtrl.ConvertRelativeHistNum"> 217 <tt class="descname">ConvertRelativeHistNum</tt><big>(</big><em>histtype</em>, <em>histnum</em><big>)</big><a class="reference internal" href="_modules/GSASIIctrls.html#G2TreeCtrl.ConvertRelativeHistNum"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIctrls.G2TreeCtrl.ConvertRelativeHistNum" title="Permalink to this definition">¶</a></dt> 498 218 <dd><p>Converts a histogram type and relative histogram number to a 499 219 histogram name in the current project</p> … … 501 221 502 222 <dl class="method"> 503 <dt id="GSASII grid.G2TreeCtrl.ConvertRelativePhaseNum">504 <tt class="descname">ConvertRelativePhaseNum</tt><big>(</big><em>phasenum</em><big>)</big><a class="reference internal" href="_modules/GSASII grid.html#G2TreeCtrl.ConvertRelativePhaseNum"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIgrid.G2TreeCtrl.ConvertRelativePhaseNum" title="Permalink to this definition">¶</a></dt>223 <dt id="GSASIIctrls.G2TreeCtrl.ConvertRelativePhaseNum"> 224 <tt class="descname">ConvertRelativePhaseNum</tt><big>(</big><em>phasenum</em><big>)</big><a class="reference internal" href="_modules/GSASIIctrls.html#G2TreeCtrl.ConvertRelativePhaseNum"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIctrls.G2TreeCtrl.ConvertRelativePhaseNum" title="Permalink to this definition">¶</a></dt> 505 225 <dd><p>Converts relative phase number to a phase name in 506 226 the current project</p> … … 508 228 509 229 <dl class="method"> 510 <dt id="GSASIIgrid.G2TreeCtrl.GetItemPyData"> 511 <tt class="descname">GetItemPyData</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="reference internal" href="_modules/GSASIIgrid.html#G2TreeCtrl.GetItemPyData"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIgrid.G2TreeCtrl.GetItemPyData" title="Permalink to this definition">¶</a></dt> 512 <dd><p>Override the standard method to wrap the contents 513 so that the source can be tracked</p> 514 </dd></dl> 515 516 <dl class="method"> 517 <dt id="GSASIIgrid.G2TreeCtrl.GetRelativeHistNum"> 518 <tt class="descname">GetRelativeHistNum</tt><big>(</big><em>histname</em><big>)</big><a class="reference internal" href="_modules/GSASIIgrid.html#G2TreeCtrl.GetRelativeHistNum"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIgrid.G2TreeCtrl.GetRelativeHistNum" title="Permalink to this definition">¶</a></dt> 230 <dt id="GSASIIctrls.G2TreeCtrl.GetRelativeHistNum"> 231 <tt class="descname">GetRelativeHistNum</tt><big>(</big><em>histname</em><big>)</big><a class="reference internal" href="_modules/GSASIIctrls.html#G2TreeCtrl.GetRelativeHistNum"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIctrls.G2TreeCtrl.GetRelativeHistNum" title="Permalink to this definition">¶</a></dt> 519 232 <dd><p>Returns list with a histogram type and a relative number for that 520 233 histogram, or the original string if not a histogram</p> … … 522 235 523 236 <dl class="method"> 524 <dt id="GSASII grid.G2TreeCtrl.GetRelativePhaseNum">525 <tt class="descname">GetRelativePhaseNum</tt><big>(</big><em>phasename</em><big>)</big><a class="reference internal" href="_modules/GSASII grid.html#G2TreeCtrl.GetRelativePhaseNum"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIgrid.G2TreeCtrl.GetRelativePhaseNum" title="Permalink to this definition">¶</a></dt>237 <dt id="GSASIIctrls.G2TreeCtrl.GetRelativePhaseNum"> 238 <tt class="descname">GetRelativePhaseNum</tt><big>(</big><em>phasename</em><big>)</big><a class="reference internal" href="_modules/GSASIIctrls.html#G2TreeCtrl.GetRelativePhaseNum"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIctrls.G2TreeCtrl.GetRelativePhaseNum" title="Permalink to this definition">¶</a></dt> 526 239 <dd><p>Returns a phase number if the string matches a phase name 527 240 or else returns the original string</p> … … 529 242 530 243 <dl class="method"> 531 <dt id="GSASII grid.G2TreeCtrl.onSelectionChanged">532 <tt class="descname">onSelectionChanged</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="_modules/GSASII grid.html#G2TreeCtrl.onSelectionChanged"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIgrid.G2TreeCtrl.onSelectionChanged" title="Permalink to this definition">¶</a></dt>244 <dt id="GSASIIctrls.G2TreeCtrl.onSelectionChanged"> 245 <tt class="descname">onSelectionChanged</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="_modules/GSASIIctrls.html#G2TreeCtrl.onSelectionChanged"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIctrls.G2TreeCtrl.onSelectionChanged" title="Permalink to this definition">¶</a></dt> 533 246 <dd><p>Log each press on a tree item here.</p> 534 247 </dd></dl> … … 536 249 </dd></dl> 537 250 538 <dl class="class"> 539 <dt id="GSASIIgrid.GSGrid"> 540 <em class="property">class </em><tt class="descclassname">GSASIIgrid.</tt><tt class="descname">GSGrid</tt><big>(</big><em>parent</em>, <em>name=''</em><big>)</big><a class="reference internal" href="_modules/GSASIIgrid.html#GSGrid"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIgrid.GSGrid" title="Permalink to this definition">¶</a></dt> 541 <dd><p>Basic wx.Grid implementation</p> 542 <dl class="method"> 543 <dt id="GSASIIgrid.GSGrid.InstallGridToolTip"> 544 <tt class="descname">InstallGridToolTip</tt><big>(</big><em>rowcolhintcallback</em>, <em>colLblCallback=None</em>, <em>rowLblCallback=None</em><big>)</big><a class="reference internal" href="_modules/GSASIIgrid.html#GSGrid.InstallGridToolTip"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIgrid.GSGrid.InstallGridToolTip" title="Permalink to this definition">¶</a></dt> 545 <dd><p>code to display a tooltip for each item on a grid 546 from <a class="reference external" href="http://wiki.wxpython.org/wxGrid%20ToolTips">http://wiki.wxpython.org/wxGrid%20ToolTips</a> (buggy!), expanded to 547 column and row labels using hints from 548 <a class="reference external" href="https://groups.google.com/forum/#!topic/wxPython-users/bm8OARRVDCs">https://groups.google.com/forum/#!topic/wxPython-users/bm8OARRVDCs</a></p> 251 <dl class="function"> 252 <dt id="GSASIIctrls.GetItemOrder"> 253 <tt class="descclassname">GSASIIctrls.</tt><tt class="descname">GetItemOrder</tt><big>(</big><em>parent</em>, <em>keylist</em>, <em>vallookup</em>, <em>posdict</em><big>)</big><a class="reference internal" href="_modules/GSASIIctrls.html#GetItemOrder"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIctrls.GetItemOrder" title="Permalink to this definition">¶</a></dt> 254 <dd><p>Creates a panel where items can be ordered into columns</p> 549 255 <table class="docutils field-list" frame="void" rules="none"> 550 256 <col class="field-name" /> … … 552 258 <tbody valign="top"> 553 259 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 554 <li><strong>rowcolhintcallback</strong> (<em>function</em>) – a routine that returns a text 555 string depending on the selected row and column, to be used in 556 explaining grid entries.</li> 557 <li><strong>colLblCallback</strong> (<em>function</em>) – a routine that returns a text 558 string depending on the selected column, to be used in 559 explaining grid columns (if None, the default), column labels 560 do not get a tooltip.</li> 561 <li><strong>rowLblCallback</strong> (<em>function</em>) – a routine that returns a text 562 string depending on the selected row, to be used in 563 explaining grid rows (if None, the default), row labels 564 do not get a tooltip.</li> 565 </ul> 566 </td> 567 </tr> 568 </tbody> 569 </table> 570 </dd></dl> 571 572 </dd></dl> 573 574 <dl class="class"> 575 <dt id="GSASIIgrid.GSNoteBook"> 576 <em class="property">class </em><tt class="descclassname">GSASIIgrid.</tt><tt class="descname">GSNoteBook</tt><big>(</big><em>parent</em>, <em>name=''</em>, <em>size=None</em><big>)</big><a class="reference internal" href="_modules/GSASIIgrid.html#GSNoteBook"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIgrid.GSNoteBook" title="Permalink to this definition">¶</a></dt> 577 <dd><p>Notebook used in various locations; implemented with wx.aui extension</p> 578 <dl class="method"> 579 <dt id="GSASIIgrid.GSNoteBook.Bind"> 580 <tt class="descname">Bind</tt><big>(</big><em>eventtype</em>, <em>handler</em>, <em>*args</em>, <em>**kwargs</em><big>)</big><a class="reference internal" href="_modules/GSASIIgrid.html#GSNoteBook.Bind"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIgrid.GSNoteBook.Bind" title="Permalink to this definition">¶</a></dt> 581 <dd><p>Override the Bind() function so that page change events can be trapped</p> 582 </dd></dl> 583 584 </dd></dl> 585 586 <dl class="function"> 587 <dt id="GSASIIgrid.GetPatternTreeDataNames"> 588 <tt class="descclassname">GSASIIgrid.</tt><tt class="descname">GetPatternTreeDataNames</tt><big>(</big><em>G2frame</em>, <em>dataTypes</em><big>)</big><a class="reference internal" href="_modules/GSASIIgrid.html#GetPatternTreeDataNames"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIgrid.GetPatternTreeDataNames" title="Permalink to this definition">¶</a></dt> 589 <dd><p>Needs a doc string</p> 590 </dd></dl> 591 592 <dl class="function"> 593 <dt id="GSASIIgrid.GetPatternTreeItemId"> 594 <tt class="descclassname">GSASIIgrid.</tt><tt class="descname">GetPatternTreeItemId</tt><big>(</big><em>G2frame</em>, <em>parentId</em>, <em>itemText</em><big>)</big><a class="reference internal" href="_modules/GSASIIgrid.html#GetPatternTreeItemId"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIgrid.GetPatternTreeItemId" title="Permalink to this definition">¶</a></dt> 595 <dd><p>Needs a doc string</p> 596 </dd></dl> 597 598 <dl class="class"> 599 <dt id="GSASIIgrid.GridFractionEditor"> 600 <em class="property">class </em><tt class="descclassname">GSASIIgrid.</tt><tt class="descname">GridFractionEditor</tt><big>(</big><em>grid</em><big>)</big><a class="reference internal" href="_modules/GSASIIgrid.html#GridFractionEditor"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIgrid.GridFractionEditor" title="Permalink to this definition">¶</a></dt> 601 <dd><p>A grid cell editor class that allows entry of values as fractions as well 602 as sine and cosine values [as s() and c()]</p> 603 </dd></dl> 604 605 <dl class="class"> 606 <dt id="GSASIIgrid.HelpButton"> 607 <em class="property">class </em><tt class="descclassname">GSASIIgrid.</tt><tt class="descname">HelpButton</tt><big>(</big><em>parent</em>, <em>msg</em><big>)</big><a class="reference internal" href="_modules/GSASIIgrid.html#HelpButton"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIgrid.HelpButton" title="Permalink to this definition">¶</a></dt> 260 <li><strong>keylist</strong> (<em>list</em>) – is a list of keys for column assignments</li> 261 <li><strong>vallookup</strong> (<em>dict</em>) – is a dict keyed by names in keylist where each item is a dict. 262 Each inner dict contains variable names as keys and their associated values</li> 263 <li><strong>posdict</strong> (<em>dict</em>) – is a dict keyed by names in keylist where each item is a dict. 264 Each inner dict contains column numbers as keys and their associated 265 variable name as a value. This is used for both input and output.</li> 266 </ul> 267 </td> 268 </tr> 269 </tbody> 270 </table> 271 </dd></dl> 272 273 <dl class="class"> 274 <dt id="GSASIIctrls.HelpButton"> 275 <em class="property">class </em><tt class="descclassname">GSASIIctrls.</tt><tt class="descname">HelpButton</tt><big>(</big><em>parent</em>, <em>msg</em><big>)</big><a class="reference internal" href="_modules/GSASIIctrls.html#HelpButton"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIctrls.HelpButton" title="Permalink to this definition">¶</a></dt> 608 276 <dd><p>Create a help button that displays help information. 609 277 The text is displayed in a modal message window.</p> … … 625 293 </dd></dl> 626 294 627 <dl class="function"> 628 <dt id="GSASIIgrid.HorizontalLine"> 629 <tt class="descclassname">GSASIIgrid.</tt><tt class="descname">HorizontalLine</tt><big>(</big><em>sizer</em>, <em>parent</em><big>)</big><a class="reference internal" href="_modules/GSASIIgrid.html#HorizontalLine"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIgrid.HorizontalLine" title="Permalink to this definition">¶</a></dt> 630 <dd><p>Draws a horizontal line as wide as the window. 631 This shows up on the Mac as a very thin line, no matter what I do</p> 632 </dd></dl> 633 634 <dl class="function"> 635 <dt id="GSASIIgrid.HowDidIgetHere"> 636 <tt class="descclassname">GSASIIgrid.</tt><tt class="descname">HowDidIgetHere</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/GSASIIgrid.html#HowDidIgetHere"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIgrid.HowDidIgetHere" title="Permalink to this definition">¶</a></dt> 637 <dd><p>Show a traceback with calls that brought us to the current location. 638 Used for debugging.</p> 639 </dd></dl> 640 641 <dl class="function"> 642 <dt id="GSASIIgrid.ItemSelector"> 643 <tt class="descclassname">GSASIIgrid.</tt><tt class="descname">ItemSelector</tt><big>(</big><em>ChoiceList</em>, <em>ParentFrame=None</em>, <em>title='Select an item'</em>, <em>size=None</em>, <em>header='Item Selector'</em>, <em>useCancel=True</em>, <em>multiple=False</em><big>)</big><a class="reference internal" href="_modules/GSASIIgrid.html#ItemSelector"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIgrid.ItemSelector" title="Permalink to this definition">¶</a></dt> 644 <dd><p>Provide a wx dialog to select a single item or multiple items from list of choices</p> 645 <table class="docutils field-list" frame="void" rules="none"> 646 <col class="field-name" /> 647 <col class="field-body" /> 648 <tbody valign="top"> 649 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> 650 <li><strong>ChoiceList</strong> (<em>list</em>) – a list of choices where one will be selected</li> 651 <li><strong>ParentFrame</strong> (<em>wx.Frame</em>) – Name of parent frame (default None)</li> 652 <li><strong>title</strong> (<em>str</em>) – heading above list of choices (default ‘Select an item’)</li> 653 <li><strong>size</strong> (<em>wx.Size</em>) – Size for dialog to be created (default None – size as needed)</li> 654 <li><strong>header</strong> (<em>str</em>) – Title to place on window frame (default ‘Item Selector’)</li> 655 <li><strong>useCancel</strong> (<em>bool</em>) – If True (default) both the OK and Cancel buttons are offered</li> 656 <li><strong>multiple</strong> (<em>bool</em>) – If True then multiple items can be selected (default False)</li> 657 </ul> 658 </td> 659 </tr> 660 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">the selection index or None or a selection list if multiple is true</p> 661 </td> 662 </tr> 663 </tbody> 664 </table> 665 </dd></dl> 666 667 <dl class="function"> 668 <dt id="GSASIIgrid.MovePatternTreeToGrid"> 669 <tt class="descclassname">GSASIIgrid.</tt><tt class="descname">MovePatternTreeToGrid</tt><big>(</big><em>G2frame</em>, <em>item</em><big>)</big><a class="reference internal" href="_modules/GSASIIgrid.html#MovePatternTreeToGrid"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIgrid.MovePatternTreeToGrid" title="Permalink to this definition">¶</a></dt> 670 <dd><p>Called from GSASII.OnPatternTreeSelChanged when a item is selected on the tree</p> 671 </dd></dl> 672 673 <dl class="class"> 674 <dt id="GSASIIgrid.MultiStringDialog"> 675 <em class="property">class </em><tt class="descclassname">GSASIIgrid.</tt><tt class="descname">MultiStringDialog</tt><big>(</big><em>parent</em>, <em>title</em>, <em>prompts</em>, <em>values=</em><span class="optional">[</span><span class="optional">]</span><big>)</big><a class="reference internal" href="_modules/GSASIIgrid.html#MultiStringDialog"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIgrid.MultiStringDialog" title="Permalink to this definition">¶</a></dt> 676 <dd><p>Dialog to obtain a multi string values from user</p> 677 <table class="docutils field-list" frame="void" rules="none"> 678 <col class="field-name" /> 679 <col class="field-body" /> 680 <tbody valign="top"> 681 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 682 <li><strong>parent</strong> (<em>wx.Frame</em>) – name of parent frame</li> 683 <li><strong>title</strong> (<em>str</em>) – title string for dialog</li> 684 <li><strong>prompts</strong> (<em>str</em>) – strings to tell use what they are inputting</li> 685 <li><strong>values</strong> (<em>str</em>) – default input values, if any</li> 686 </ul> 687 </td> 688 </tr> 689 </tbody> 690 </table> 691 <dl class="method"> 692 <dt id="GSASIIgrid.MultiStringDialog.GetValues"> 693 <tt class="descname">GetValues</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/GSASIIgrid.html#MultiStringDialog.GetValues"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIgrid.MultiStringDialog.GetValues" title="Permalink to this definition">¶</a></dt> 694 <dd><p>Use this method to get the value entered by the user 695 :returns: string entered by user</p> 696 </dd></dl> 697 698 <dl class="method"> 699 <dt id="GSASIIgrid.MultiStringDialog.Show"> 700 <tt class="descname">Show</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/GSASIIgrid.html#MultiStringDialog.Show"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIgrid.MultiStringDialog.Show" title="Permalink to this definition">¶</a></dt> 701 <dd><p>Use this method after creating the dialog to post it 702 :returns: True if the user pressed OK; False if the User pressed Cancel</p> 703 </dd></dl> 704 705 </dd></dl> 706 707 <dl class="class"> 708 <dt id="GSASIIgrid.MyHelp"> 709 <em class="property">class </em><tt class="descclassname">GSASIIgrid.</tt><tt class="descname">MyHelp</tt><big>(</big><em>frame</em>, <em>helpType=None</em>, <em>helpLbl=None</em>, <em>morehelpitems=</em>, <span class="optional">[</span><span class="optional">]</span><em>title=''</em><big>)</big><a class="reference internal" href="_modules/GSASIIgrid.html#MyHelp"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIgrid.MyHelp" title="Permalink to this definition">¶</a></dt> 295 <dl class="class"> 296 <dt id="GSASIIctrls.MyHelp"> 297 <em class="property">class </em><tt class="descclassname">GSASIIctrls.</tt><tt class="descname">MyHelp</tt><big>(</big><em>frame</em>, <em>helpType=None</em>, <em>helpLbl=None</em>, <em>morehelpitems=</em>, <span class="optional">[</span><span class="optional">]</span><em>title=''</em><big>)</big><a class="reference internal" href="_modules/GSASIIctrls.html#MyHelp"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIctrls.MyHelp" title="Permalink to this definition">¶</a></dt> 710 298 <dd><p>A class that creates the contents of a help menu. 711 299 The menu will start with two entries:</p> … … 722 310 </div> 723 311 <dl class="method"> 724 <dt id="GSASII grid.MyHelp.OnCheckUpdates">725 <tt class="descname">OnCheckUpdates</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="_modules/GSASII grid.html#MyHelp.OnCheckUpdates"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIgrid.MyHelp.OnCheckUpdates" title="Permalink to this definition">¶</a></dt>312 <dt id="GSASIIctrls.MyHelp.OnCheckUpdates"> 313 <tt class="descname">OnCheckUpdates</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="_modules/GSASIIctrls.html#MyHelp.OnCheckUpdates"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIctrls.MyHelp.OnCheckUpdates" title="Permalink to this definition">¶</a></dt> 726 314 <dd><p>Check if the GSAS-II repository has an update for the current source files 727 315 and perform that update if requested.</p> … … 729 317 730 318 <dl class="method"> 731 <dt id="GSASII grid.MyHelp.OnHelpAbout">732 <tt class="descname">OnHelpAbout</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="_modules/GSASII grid.html#MyHelp.OnHelpAbout"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIgrid.MyHelp.OnHelpAbout" title="Permalink to this definition">¶</a></dt>319 <dt id="GSASIIctrls.MyHelp.OnHelpAbout"> 320 <tt class="descname">OnHelpAbout</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="_modules/GSASIIctrls.html#MyHelp.OnHelpAbout"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIctrls.MyHelp.OnHelpAbout" title="Permalink to this definition">¶</a></dt> 733 321 <dd><p>Display an ‘About GSAS-II’ box</p> 734 322 </dd></dl> 735 323 736 324 <dl class="method"> 737 <dt id="GSASII grid.MyHelp.OnHelpById">738 <tt class="descname">OnHelpById</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="_modules/GSASII grid.html#MyHelp.OnHelpById"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIgrid.MyHelp.OnHelpById" title="Permalink to this definition">¶</a></dt>325 <dt id="GSASIIctrls.MyHelp.OnHelpById"> 326 <tt class="descname">OnHelpById</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="_modules/GSASIIctrls.html#MyHelp.OnHelpById"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIctrls.MyHelp.OnHelpById" title="Permalink to this definition">¶</a></dt> 739 327 <dd><p>Called when Help on... is pressed in a menu. Brings up 740 328 a web page for documentation.</p> … … 742 330 743 331 <dl class="method"> 744 <dt id="GSASII grid.MyHelp.OnSelectVersion">745 <tt class="descname">OnSelectVersion</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="_modules/GSASII grid.html#MyHelp.OnSelectVersion"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIgrid.MyHelp.OnSelectVersion" title="Permalink to this definition">¶</a></dt>332 <dt id="GSASIIctrls.MyHelp.OnSelectVersion"> 333 <tt class="descname">OnSelectVersion</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="_modules/GSASIIctrls.html#MyHelp.OnSelectVersion"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIctrls.MyHelp.OnSelectVersion" title="Permalink to this definition">¶</a></dt> 746 334 <dd><p>Allow the user to select a specific version of GSAS-II</p> 747 335 </dd></dl> … … 750 338 751 339 <dl class="class"> 752 <dt id="GSASII grid.MyHtmlPanel">753 <em class="property">class </em><tt class="descclassname">GSASII grid.</tt><tt class="descname">MyHtmlPanel</tt><big>(</big><em>frame</em>, <em>id</em><big>)</big><a class="reference internal" href="_modules/GSASIIgrid.html#MyHtmlPanel"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIgrid.MyHtmlPanel" title="Permalink to this definition">¶</a></dt>340 <dt id="GSASIIctrls.MyHtmlPanel"> 341 <em class="property">class </em><tt class="descclassname">GSASIIctrls.</tt><tt class="descname">MyHtmlPanel</tt><big>(</big><em>frame</em>, <em>id</em><big>)</big><a class="reference internal" href="_modules/GSASIIctrls.html#MyHtmlPanel"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIctrls.MyHtmlPanel" title="Permalink to this definition">¶</a></dt> 754 342 <dd><p>Defines a panel to display HTML help information, as an alternative to 755 343 displaying help information in a web browser.</p> … … 757 345 758 346 <dl class="class"> 759 <dt id="GSASII grid.NumberValidator">760 <em class="property">class </em><tt class="descclassname">GSASII grid.</tt><tt class="descname">NumberValidator</tt><big>(</big><em>typ</em>, <em>positiveonly=False</em>, <em>min=None</em>, <em>max=None</em>, <em>result=None</em>, <em>key=None</em>, <em>OKcontrol=None</em>, <em>CIFinput=False</em><big>)</big><a class="reference internal" href="_modules/GSASIIgrid.html#NumberValidator"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIgrid.NumberValidator" title="Permalink to this definition">¶</a></dt>347 <dt id="GSASIIctrls.NumberValidator"> 348 <em class="property">class </em><tt class="descclassname">GSASIIctrls.</tt><tt class="descname">NumberValidator</tt><big>(</big><em>typ</em>, <em>positiveonly=False</em>, <em>min=None</em>, <em>max=None</em>, <em>result=None</em>, <em>key=None</em>, <em>OKcontrol=None</em>, <em>CIFinput=False</em><big>)</big><a class="reference internal" href="_modules/GSASIIctrls.html#NumberValidator"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIctrls.NumberValidator" title="Permalink to this definition">¶</a></dt> 761 349 <dd><p>A validator to be used with a TextCtrl to prevent 762 350 entering characters other than digits, signs, and for float … … 793 381 </table> 794 382 <dl class="method"> 795 <dt id="GSASII grid.NumberValidator.CheckInput">796 <tt class="descname">CheckInput</tt><big>(</big><em>previousInvalid</em><big>)</big><a class="reference internal" href="_modules/GSASII grid.html#NumberValidator.CheckInput"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIgrid.NumberValidator.CheckInput" title="Permalink to this definition">¶</a></dt>383 <dt id="GSASIIctrls.NumberValidator.CheckInput"> 384 <tt class="descname">CheckInput</tt><big>(</big><em>previousInvalid</em><big>)</big><a class="reference internal" href="_modules/GSASIIctrls.html#NumberValidator.CheckInput"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIctrls.NumberValidator.CheckInput" title="Permalink to this definition">¶</a></dt> 797 385 <dd><p>called to test every change to the TextCtrl for validity and 798 386 to change the appearance of the TextCtrl</p> … … 813 401 814 402 <dl class="method"> 815 <dt id="GSASII grid.NumberValidator.Clone">816 <tt class="descname">Clone</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/GSASII grid.html#NumberValidator.Clone"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIgrid.NumberValidator.Clone" title="Permalink to this definition">¶</a></dt>403 <dt id="GSASIIctrls.NumberValidator.Clone"> 404 <tt class="descname">Clone</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/GSASIIctrls.html#NumberValidator.Clone"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIctrls.NumberValidator.Clone" title="Permalink to this definition">¶</a></dt> 817 405 <dd><p>Create a copy of the validator, a strange, but required component</p> 818 406 </dd></dl> 819 407 820 408 <dl class="method"> 821 <dt id="GSASII grid.NumberValidator.OnChar">822 <tt class="descname">OnChar</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="_modules/GSASII grid.html#NumberValidator.OnChar"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIgrid.NumberValidator.OnChar" title="Permalink to this definition">¶</a></dt>409 <dt id="GSASIIctrls.NumberValidator.OnChar"> 410 <tt class="descname">OnChar</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="_modules/GSASIIctrls.html#NumberValidator.OnChar"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIctrls.NumberValidator.OnChar" title="Permalink to this definition">¶</a></dt> 823 411 <dd><p>Called each type a key is pressed 824 412 ignores keys that are not allowed for int and float types</p> … … 826 414 827 415 <dl class="method"> 828 <dt id="GSASII grid.NumberValidator.ShowValidity">829 <tt class="descname">ShowValidity</tt><big>(</big><em>tc</em><big>)</big><a class="reference internal" href="_modules/GSASII grid.html#NumberValidator.ShowValidity"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIgrid.NumberValidator.ShowValidity" title="Permalink to this definition">¶</a></dt>416 <dt id="GSASIIctrls.NumberValidator.ShowValidity"> 417 <tt class="descname">ShowValidity</tt><big>(</big><em>tc</em><big>)</big><a class="reference internal" href="_modules/GSASIIctrls.html#NumberValidator.ShowValidity"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIctrls.NumberValidator.ShowValidity" title="Permalink to this definition">¶</a></dt> 830 418 <dd><p>Set the control colors to show invalid input</p> 831 419 <table class="docutils field-list" frame="void" rules="none"> … … 841 429 842 430 <dl class="method"> 843 <dt id="GSASII grid.NumberValidator.TestValid">844 <tt class="descname">TestValid</tt><big>(</big><em>tc</em><big>)</big><a class="reference internal" href="_modules/GSASII grid.html#NumberValidator.TestValid"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIgrid.NumberValidator.TestValid" title="Permalink to this definition">¶</a></dt>431 <dt id="GSASIIctrls.NumberValidator.TestValid"> 432 <tt class="descname">TestValid</tt><big>(</big><em>tc</em><big>)</big><a class="reference internal" href="_modules/GSASIIctrls.html#NumberValidator.TestValid"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIctrls.NumberValidator.TestValid" title="Permalink to this definition">¶</a></dt> 845 433 <dd><p>Check if the value is valid by casting the input string 846 434 into the current type.</p> … … 860 448 861 449 <dl class="method"> 862 <dt id="GSASII grid.NumberValidator.TransferFromWindow">863 <tt class="descname">TransferFromWindow</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/GSASII grid.html#NumberValidator.TransferFromWindow"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIgrid.NumberValidator.TransferFromWindow" title="Permalink to this definition">¶</a></dt>450 <dt id="GSASIIctrls.NumberValidator.TransferFromWindow"> 451 <tt class="descname">TransferFromWindow</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/GSASIIctrls.html#NumberValidator.TransferFromWindow"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIctrls.NumberValidator.TransferFromWindow" title="Permalink to this definition">¶</a></dt> 864 452 <dd><p>Needed by validator, strange, but required component</p> 865 453 </dd></dl> 866 454 867 455 <dl class="method"> 868 <dt id="GSASII grid.NumberValidator.TransferToWindow">869 <tt class="descname">TransferToWindow</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/GSASII grid.html#NumberValidator.TransferToWindow"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIgrid.NumberValidator.TransferToWindow" title="Permalink to this definition">¶</a></dt>456 <dt id="GSASIIctrls.NumberValidator.TransferToWindow"> 457 <tt class="descname">TransferToWindow</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/GSASIIctrls.html#NumberValidator.TransferToWindow"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIctrls.NumberValidator.TransferToWindow" title="Permalink to this definition">¶</a></dt> 870 458 <dd><p>Needed by validator, strange, but required component</p> 871 459 </dd></dl> … … 874 462 875 463 <dl class="class"> 876 <dt id="GSASIIgrid.PickTwoDialog"> 877 <em class="property">class </em><tt class="descclassname">GSASIIgrid.</tt><tt class="descname">PickTwoDialog</tt><big>(</big><em>parent</em>, <em>title</em>, <em>prompt</em>, <em>names</em>, <em>choices</em><big>)</big><a class="reference internal" href="_modules/GSASIIgrid.html#PickTwoDialog"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIgrid.PickTwoDialog" title="Permalink to this definition">¶</a></dt> 464 <dt id="GSASIIctrls.OpenTutorial"> 465 <em class="property">class </em><tt class="descclassname">GSASIIctrls.</tt><tt class="descname">OpenTutorial</tt><big>(</big><em>parent=None</em><big>)</big><a class="reference internal" href="_modules/GSASIIctrls.html#OpenTutorial"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIctrls.OpenTutorial" title="Permalink to this definition">¶</a></dt> 466 <dd><p>Open a tutorial, optionally copying it to the local disk. Always copy 467 the data files locally.</p> 468 <p>For now tutorials will always be copied into the source code tree, but it 469 might be better to have an option to copy them somewhere else, for people 470 who don’t have write access to the GSAS-II source code location.</p> 471 <dl class="method"> 472 <dt id="GSASIIctrls.OpenTutorial.LoadExercise"> 473 <tt class="descname">LoadExercise</tt><big>(</big><em>tutorialname</em>, <em>fullpath='/Users/toby/software/G2/GSASII'</em>, <em>baseURL='https://subversion.xray.aps.anl.gov/pyGSAS'</em><big>)</big><a class="reference internal" href="_modules/GSASIIctrls.html#OpenTutorial.LoadExercise"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIctrls.OpenTutorial.LoadExercise" title="Permalink to this definition">¶</a></dt> 474 <dd><p>Load Exercise file(s) for a Tutorial to the selected location</p> 475 </dd></dl> 476 477 <dl class="method"> 478 <dt id="GSASIIctrls.OpenTutorial.LoadTutorial"> 479 <tt class="descname">LoadTutorial</tt><big>(</big><em>tutorialname</em>, <em>fullpath='/Users/toby/software/G2/GSASII'</em>, <em>baseURL='https://subversion.xray.aps.anl.gov/pyGSAS'</em><big>)</big><a class="reference internal" href="_modules/GSASIIctrls.html#OpenTutorial.LoadTutorial"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIctrls.OpenTutorial.LoadTutorial" title="Permalink to this definition">¶</a></dt> 480 <dd><p>Load a Tutorial to the selected location</p> 481 </dd></dl> 482 483 <dl class="method"> 484 <dt id="GSASIIctrls.OpenTutorial.OnModeSelect"> 485 <tt class="descname">OnModeSelect</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="_modules/GSASIIctrls.html#OpenTutorial.OnModeSelect"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIctrls.OpenTutorial.OnModeSelect" title="Permalink to this definition">¶</a></dt> 486 <dd><p>Respond when the mode is changed</p> 487 </dd></dl> 488 489 <dl class="method"> 490 <dt id="GSASIIctrls.OpenTutorial.OnTutorialSelected"> 491 <tt class="descname">OnTutorialSelected</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="_modules/GSASIIctrls.html#OpenTutorial.OnTutorialSelected"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIctrls.OpenTutorial.OnTutorialSelected" title="Permalink to this definition">¶</a></dt> 492 <dd><p>Respond when a tutorial is selected. Load tutorials and data locally, 493 as needed and then display the page</p> 494 </dd></dl> 495 496 <dl class="method"> 497 <dt id="GSASIIctrls.OpenTutorial.SelectDownloadLoc"> 498 <tt class="descname">SelectDownloadLoc</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="_modules/GSASIIctrls.html#OpenTutorial.SelectDownloadLoc"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIctrls.OpenTutorial.SelectDownloadLoc" title="Permalink to this definition">¶</a></dt> 499 <dd><p>Select a download location, 500 Cancel resets to the default</p> 501 </dd></dl> 502 503 <dl class="method"> 504 <dt id="GSASIIctrls.OpenTutorial.ValidateTutorialDir"> 505 <tt class="descname">ValidateTutorialDir</tt><big>(</big><em>fullpath='/Users/toby/software/G2/GSASII'</em>, <em>baseURL='https://subversion.xray.aps.anl.gov/pyGSAS'</em><big>)</big><a class="reference internal" href="_modules/GSASIIctrls.html#OpenTutorial.ValidateTutorialDir"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIctrls.OpenTutorial.ValidateTutorialDir" title="Permalink to this definition">¶</a></dt> 506 <dd><p>Load help to new directory or make sure existing directory looks correctly set up 507 throws an exception if there is a problem.</p> 508 </dd></dl> 509 510 </dd></dl> 511 512 <dl class="class"> 513 <dt id="GSASIIctrls.OrderBox"> 514 <em class="property">class </em><tt class="descclassname">GSASIIctrls.</tt><tt class="descname">OrderBox</tt><big>(</big><em>parent</em>, <em>keylist</em>, <em>vallookup</em>, <em>posdict</em>, <em>*arg</em>, <em>**kw</em><big>)</big><a class="reference internal" href="_modules/GSASIIctrls.html#OrderBox"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIctrls.OrderBox" title="Permalink to this definition">¶</a></dt> 515 <dd><p>Creates a panel with scrollbars where items can be ordered into columns</p> 516 <table class="docutils field-list" frame="void" rules="none"> 517 <col class="field-name" /> 518 <col class="field-body" /> 519 <tbody valign="top"> 520 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 521 <li><strong>keylist</strong> (<em>list</em>) – is a list of keys for column assignments</li> 522 <li><strong>vallookup</strong> (<em>dict</em>) – is a dict keyed by names in keylist where each item is a dict. 523 Each inner dict contains variable names as keys and their associated values</li> 524 <li><strong>posdict</strong> (<em>dict</em>) – is a dict keyed by names in keylist where each item is a dict. 525 Each inner dict contains column numbers as keys and their associated 526 variable name as a value. This is used for both input and output.</li> 527 </ul> 528 </td> 529 </tr> 530 </tbody> 531 </table> 532 <dl class="method"> 533 <dt id="GSASIIctrls.OrderBox.OnChoice"> 534 <tt class="descname">OnChoice</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="_modules/GSASIIctrls.html#OrderBox.OnChoice"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIctrls.OrderBox.OnChoice" title="Permalink to this definition">¶</a></dt> 535 <dd><p>Called when a column is assigned to a variable</p> 536 </dd></dl> 537 538 </dd></dl> 539 540 <dl class="class"> 541 <dt id="GSASIIctrls.PickTwoDialog"> 542 <em class="property">class </em><tt class="descclassname">GSASIIctrls.</tt><tt class="descname">PickTwoDialog</tt><big>(</big><em>parent</em>, <em>title</em>, <em>prompt</em>, <em>names</em>, <em>choices</em><big>)</big><a class="reference internal" href="_modules/GSASIIctrls.html#PickTwoDialog"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIctrls.PickTwoDialog" title="Permalink to this definition">¶</a></dt> 878 543 <dd><p>This does not seem to be in use</p> 879 544 </dd></dl> 880 545 881 546 <dl class="class"> 882 <dt id="GSASII grid.ScrolledMultiEditor">883 <em class="property">class </em><tt class="descclassname">GSASII grid.</tt><tt class="descname">ScrolledMultiEditor</tt><big>(</big><em>parent</em>, <em>dictlst</em>, <em>elemlst</em>, <em>prelbl=</em>, <span class="optional">[</span><span class="optional">]</span><em>postlbl=</em>, <span class="optional">[</span><span class="optional">]</span><em>title='Edit items'</em>, <em>header=''</em>, <em>size=(300</em>, <em>250)</em>, <em>CopyButton=False</em>, <em>minvals=</em>, <span class="optional">[</span><span class="optional">]</span><em>maxvals=</em>, <span class="optional">[</span><span class="optional">]</span><em>sizevals=</em>, <span class="optional">[</span><span class="optional">]</span><em>checkdictlst=</em>, <span class="optional">[</span><span class="optional">]</span><em>checkelemlst=</em>, <span class="optional">[</span><span class="optional">]</span><em>checklabel=''</em><big>)</big><a class="reference internal" href="_modules/GSASIIgrid.html#ScrolledMultiEditor"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIgrid.ScrolledMultiEditor" title="Permalink to this definition">¶</a></dt>547 <dt id="GSASIIctrls.ScrolledMultiEditor"> 548 <em class="property">class </em><tt class="descclassname">GSASIIctrls.</tt><tt class="descname">ScrolledMultiEditor</tt><big>(</big><em>parent</em>, <em>dictlst</em>, <em>elemlst</em>, <em>prelbl=</em>, <span class="optional">[</span><span class="optional">]</span><em>postlbl=</em>, <span class="optional">[</span><span class="optional">]</span><em>title='Edit items'</em>, <em>header=''</em>, <em>size=(300</em>, <em>250)</em>, <em>CopyButton=False</em>, <em>minvals=</em>, <span class="optional">[</span><span class="optional">]</span><em>maxvals=</em>, <span class="optional">[</span><span class="optional">]</span><em>sizevals=</em>, <span class="optional">[</span><span class="optional">]</span><em>checkdictlst=</em>, <span class="optional">[</span><span class="optional">]</span><em>checkelemlst=</em>, <span class="optional">[</span><span class="optional">]</span><em>checklabel=''</em><big>)</big><a class="reference internal" href="_modules/GSASIIctrls.html#ScrolledMultiEditor"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIctrls.ScrolledMultiEditor" title="Permalink to this definition">¶</a></dt> 884 549 <dd><p>Define a window for editing a potentially large number of dict- or 885 550 list-contained values with validation for each item. Edited values are … … 952 617 that are blank are marked as invalid.</p> 953 618 <dl class="method"> 954 <dt id="GSASII grid.ScrolledMultiEditor.ControlOKButton">955 <tt class="descname">ControlOKButton</tt><big>(</big><em>setvalue</em><big>)</big><a class="reference internal" href="_modules/GSASII grid.html#ScrolledMultiEditor.ControlOKButton"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIgrid.ScrolledMultiEditor.ControlOKButton" title="Permalink to this definition">¶</a></dt>619 <dt id="GSASIIctrls.ScrolledMultiEditor.ControlOKButton"> 620 <tt class="descname">ControlOKButton</tt><big>(</big><em>setvalue</em><big>)</big><a class="reference internal" href="_modules/GSASIIctrls.html#ScrolledMultiEditor.ControlOKButton"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIctrls.ScrolledMultiEditor.ControlOKButton" title="Permalink to this definition">¶</a></dt> 956 621 <dd><p>Enable or Disable the OK button for the dialog. Note that this is 957 622 passed into the ValidatedTxtCtrl for use by validators.</p> … … 970 635 971 636 <dl class="function"> 972 <dt id="GSASII grid.SelectEdit1Var">973 <tt class="descclassname">GSASII grid.</tt><tt class="descname">SelectEdit1Var</tt><big>(</big><em>G2frame</em>, <em>array</em>, <em>labelLst</em>, <em>elemKeysLst</em>, <em>dspLst</em>, <em>refFlgElem</em><big>)</big><a class="reference internal" href="_modules/GSASIIgrid.html#SelectEdit1Var"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIgrid.SelectEdit1Var" title="Permalink to this definition">¶</a></dt>637 <dt id="GSASIIctrls.SelectEdit1Var"> 638 <tt class="descclassname">GSASIIctrls.</tt><tt class="descname">SelectEdit1Var</tt><big>(</big><em>G2frame</em>, <em>array</em>, <em>labelLst</em>, <em>elemKeysLst</em>, <em>dspLst</em>, <em>refFlgElem</em><big>)</big><a class="reference internal" href="_modules/GSASIIctrls.html#SelectEdit1Var"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIctrls.SelectEdit1Var" title="Permalink to this definition">¶</a></dt> 974 639 <dd><p>Select a variable from a list, then edit it and select histograms 975 640 to copy it to.</p> … … 1010 675 1011 676 <dl class="function"> 1012 <dt id="GSASIIgrid.SetDataMenuBar"> 1013 <tt class="descclassname">GSASIIgrid.</tt><tt class="descname">SetDataMenuBar</tt><big>(</big><em>G2frame</em>, <em>menu=None</em><big>)</big><a class="reference internal" href="_modules/GSASIIgrid.html#SetDataMenuBar"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIgrid.SetDataMenuBar" title="Permalink to this definition">¶</a></dt> 1014 <dd><p>Set the menu for the data frame. On the Mac put this 1015 menu for the data tree window instead.</p> 1016 <p>Note that data frame items do not have menus, for these (menu=None) 1017 display a blank menu or on the Mac display the standard menu for 1018 the data tree window.</p> 1019 </dd></dl> 1020 1021 <dl class="function"> 1022 <dt id="GSASIIgrid.ShowHelp"> 1023 <tt class="descclassname">GSASIIgrid.</tt><tt class="descname">ShowHelp</tt><big>(</big><em>helpType</em>, <em>frame</em><big>)</big><a class="reference internal" href="_modules/GSASIIgrid.html#ShowHelp"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIgrid.ShowHelp" title="Permalink to this definition">¶</a></dt> 677 <dt id="GSASIIctrls.ShowHelp"> 678 <tt class="descclassname">GSASIIctrls.</tt><tt class="descname">ShowHelp</tt><big>(</big><em>helpType</em>, <em>frame</em><big>)</big><a class="reference internal" href="_modules/GSASIIctrls.html#ShowHelp"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIctrls.ShowHelp" title="Permalink to this definition">¶</a></dt> 1024 679 <dd><p>Called to bring up a web page for documentation.</p> 1025 680 </dd></dl> 1026 681 1027 <dl class="class"> 1028 <dt id="GSASIIgrid.ShowLSParms"> 1029 <em class="property">class </em><tt class="descclassname">GSASIIgrid.</tt><tt class="descname">ShowLSParms</tt><big>(</big><em>parent</em>, <em>title</em>, <em>parmDict</em>, <em>varyList</em>, <em>fullVaryList</em>, <em>size=(300</em>, <em>430)</em><big>)</big><a class="reference internal" href="_modules/GSASIIgrid.html#ShowLSParms"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIgrid.ShowLSParms" title="Permalink to this definition">¶</a></dt> 1030 <dd><p>Create frame to show least-squares parameters</p> 1031 </dd></dl> 1032 1033 <dl class="class"> 1034 <dt id="GSASIIgrid.SingleFloatDialog"> 1035 <em class="property">class </em><tt class="descclassname">GSASIIgrid.</tt><tt class="descname">SingleFloatDialog</tt><big>(</big><em>parent, title, prompt, value, limits=[0.0, 1.0], format='%.5g'</em><big>)</big><a class="reference internal" href="_modules/GSASIIgrid.html#SingleFloatDialog"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIgrid.SingleFloatDialog" title="Permalink to this definition">¶</a></dt> 1036 <dd><p>Dialog to obtain a single float value from user</p> 1037 </dd></dl> 1038 1039 <dl class="class"> 1040 <dt id="GSASIIgrid.SingleStringDialog"> 1041 <em class="property">class </em><tt class="descclassname">GSASIIgrid.</tt><tt class="descname">SingleStringDialog</tt><big>(</big><em>parent</em>, <em>title</em>, <em>prompt</em>, <em>value=''</em>, <em>size=(200</em>, <em>-1)</em><big>)</big><a class="reference internal" href="_modules/GSASIIgrid.html#SingleStringDialog"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIgrid.SingleStringDialog" title="Permalink to this definition">¶</a></dt> 1042 <dd><p>Dialog to obtain a single string value from user</p> 1043 <table class="docutils field-list" frame="void" rules="none"> 1044 <col class="field-name" /> 1045 <col class="field-body" /> 1046 <tbody valign="top"> 1047 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 1048 <li><strong>parent</strong> (<em>wx.Frame</em>) – name of parent frame</li> 1049 <li><strong>title</strong> (<em>str</em>) – title string for dialog</li> 1050 <li><strong>prompt</strong> (<em>str</em>) – string to tell use what they are inputting</li> 1051 <li><strong>value</strong> (<em>str</em>) – default input value, if any</li> 1052 </ul> 1053 </td> 1054 </tr> 1055 </tbody> 1056 </table> 1057 <dl class="method"> 1058 <dt id="GSASIIgrid.SingleStringDialog.GetValue"> 1059 <tt class="descname">GetValue</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/GSASIIgrid.html#SingleStringDialog.GetValue"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIgrid.SingleStringDialog.GetValue" title="Permalink to this definition">¶</a></dt> 1060 <dd><p>Use this method to get the value entered by the user 1061 :returns: string entered by user</p> 1062 </dd></dl> 1063 1064 <dl class="method"> 1065 <dt id="GSASIIgrid.SingleStringDialog.Show"> 1066 <tt class="descname">Show</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/GSASIIgrid.html#SingleStringDialog.Show"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIgrid.SingleStringDialog.Show" title="Permalink to this definition">¶</a></dt> 1067 <dd><p>Use this method after creating the dialog to post it 1068 :returns: True if the user pressed OK; False if the User pressed Cancel</p> 1069 </dd></dl> 1070 1071 </dd></dl> 1072 1073 <dl class="class"> 1074 <dt id="GSASIIgrid.SymOpDialog"> 1075 <em class="property">class </em><tt class="descclassname">GSASIIgrid.</tt><tt class="descname">SymOpDialog</tt><big>(</big><em>parent</em>, <em>SGData</em>, <em>New=True</em>, <em>ForceUnit=False</em><big>)</big><a class="reference internal" href="_modules/GSASIIgrid.html#SymOpDialog"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIgrid.SymOpDialog" title="Permalink to this definition">¶</a></dt> 1076 <dd><p>Class to select a symmetry operator</p> 1077 </dd></dl> 1078 1079 <dl class="class"> 1080 <dt id="GSASIIgrid.Table"> 1081 <em class="property">class </em><tt class="descclassname">GSASIIgrid.</tt><tt class="descname">Table</tt><big>(</big><em>data=</em>, <span class="optional">[</span><span class="optional">]</span><em>rowLabels=None</em>, <em>colLabels=None</em>, <em>types=None</em><big>)</big><a class="reference internal" href="_modules/GSASIIgrid.html#Table"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIgrid.Table" title="Permalink to this definition">¶</a></dt> 1082 <dd><p>Basic data table for use with GSgrid</p> 1083 </dd></dl> 1084 1085 <dl class="function"> 1086 <dt id="GSASIIgrid.UpdateControls"> 1087 <tt class="descclassname">GSASIIgrid.</tt><tt class="descname">UpdateControls</tt><big>(</big><em>G2frame</em>, <em>data</em><big>)</big><a class="reference internal" href="_modules/GSASIIgrid.html#UpdateControls"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIgrid.UpdateControls" title="Permalink to this definition">¶</a></dt> 1088 <dd><p>Edit overall GSAS-II controls in main Controls data tree entry</p> 1089 </dd></dl> 1090 1091 <dl class="function"> 1092 <dt id="GSASIIgrid.UpdateNotebook"> 1093 <tt class="descclassname">GSASIIgrid.</tt><tt class="descname">UpdateNotebook</tt><big>(</big><em>G2frame</em>, <em>data</em><big>)</big><a class="reference internal" href="_modules/GSASIIgrid.html#UpdateNotebook"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIgrid.UpdateNotebook" title="Permalink to this definition">¶</a></dt> 1094 <dd><p>Called when the data tree notebook entry is selected. Allows for 1095 editing of the text in that tree entry</p> 1096 </dd></dl> 1097 1098 <dl class="function"> 1099 <dt id="GSASIIgrid.UpdatePWHKPlot"> 1100 <tt class="descclassname">GSASIIgrid.</tt><tt class="descname">UpdatePWHKPlot</tt><big>(</big><em>G2frame</em>, <em>kind</em>, <em>item</em><big>)</big><a class="reference internal" href="_modules/GSASIIgrid.html#UpdatePWHKPlot"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIgrid.UpdatePWHKPlot" title="Permalink to this definition">¶</a></dt> 1101 <dd><p>Called when the histogram main tree entry is called. Displays the 1102 histogram weight factor, refinement statistics for the histogram 1103 and the range of data for a simulation.</p> 1104 <p>Also invokes a plot of the histogram.</p> 1105 </dd></dl> 1106 1107 <dl class="function"> 1108 <dt id="GSASIIgrid.UpdateSeqResults"> 1109 <tt class="descclassname">GSASIIgrid.</tt><tt class="descname">UpdateSeqResults</tt><big>(</big><em>G2frame</em>, <em>data</em>, <em>prevSize=None</em><big>)</big><a class="reference internal" href="_modules/GSASIIgrid.html#UpdateSeqResults"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIgrid.UpdateSeqResults" title="Permalink to this definition">¶</a></dt> 1110 <dd><p>Called when the Sequential Results data tree entry is selected 1111 to show results from a sequential refinement.</p> 1112 <table class="docutils field-list" frame="void" rules="none"> 1113 <col class="field-name" /> 1114 <col class="field-body" /> 1115 <tbody valign="top"> 1116 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 1117 <li><strong>G2frame</strong> (<em>wx.Frame</em>) – main GSAS-II data tree windows</li> 1118 <li><strong>data</strong> (<em>dict</em>) – <p>a dictionary containing the following items:</p> 1119 <ul> 1120 <li>‘histNames’ - list of histogram names in order as processed by Sequential Refinement</li> 1121 <li>‘varyList’ - list of variables - identical over all refinements in sequence 1122 note that this is the original list of variables, prior to processing 1123 constraints.</li> 1124 <li>‘variableLabels’ – a dict of labels to be applied to each parameter 1125 (this is created as an empty dict if not present in data).</li> 1126 <li>keyed by histName - dictionaries for all data sets processed, which contains:<ul> 1127 <li>‘variables’- result[0] from leastsq call</li> 1128 <li>‘varyList’ - list of variables passed to leastsq call (not same as above)</li> 1129 <li>‘sig’ - esds for variables</li> 1130 <li>‘covMatrix’ - covariance matrix from individual refinement</li> 1131 <li>‘title’ - histogram name; same as dict item name</li> 1132 <li>‘newAtomDict’ - new atom parameters after shifts applied</li> 1133 <li>‘newCellDict’ - refined cell parameters after shifts to A0-A5 from Dij terms applied’</li> 1134 </ul> 1135 </li> 1136 </ul> 1137 </li> 1138 </ul> 1139 </td> 1140 </tr> 1141 </tbody> 1142 </table> 1143 </dd></dl> 1144 1145 <dl class="class"> 1146 <dt id="GSASIIgrid.ValidatedTxtCtrl"> 1147 <em class="property">class </em><tt class="descclassname">GSASIIgrid.</tt><tt class="descname">ValidatedTxtCtrl</tt><big>(</big><em>parent</em>, <em>loc</em>, <em>key</em>, <em>nDig=None</em>, <em>notBlank=True</em>, <em>min=None</em>, <em>max=None</em>, <em>OKcontrol=None</em>, <em>OnLeave=None</em>, <em>typeHint=None</em>, <em>CIFinput=False</em>, <em>OnLeaveArgs={}</em>, <em>**kw</em><big>)</big><a class="reference internal" href="_modules/GSASIIgrid.html#ValidatedTxtCtrl"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIgrid.ValidatedTxtCtrl" title="Permalink to this definition">¶</a></dt> 682 <dl class="function"> 683 <dt id="GSASIIctrls.ShowWebPage"> 684 <tt class="descclassname">GSASIIctrls.</tt><tt class="descname">ShowWebPage</tt><big>(</big><em>URL</em>, <em>frame</em><big>)</big><a class="reference internal" href="_modules/GSASIIctrls.html#ShowWebPage"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIctrls.ShowWebPage" title="Permalink to this definition">¶</a></dt> 685 <dd><p>Called to show a tutorial web page.</p> 686 </dd></dl> 687 688 <dl class="function"> 689 <dt id="GSASIIctrls.StripIndents"> 690 <tt class="descclassname">GSASIIctrls.</tt><tt class="descname">StripIndents</tt><big>(</big><em>msg</em><big>)</big><a class="reference internal" href="_modules/GSASIIctrls.html#StripIndents"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIctrls.StripIndents" title="Permalink to this definition">¶</a></dt> 691 <dd><p>Strip indentation from multiline strings</p> 692 </dd></dl> 693 694 <dl class="class"> 695 <dt id="GSASIIctrls.ValidatedTxtCtrl"> 696 <em class="property">class </em><tt class="descclassname">GSASIIctrls.</tt><tt class="descname">ValidatedTxtCtrl</tt><big>(</big><em>parent</em>, <em>loc</em>, <em>key</em>, <em>nDig=None</em>, <em>notBlank=True</em>, <em>min=None</em>, <em>max=None</em>, <em>OKcontrol=None</em>, <em>OnLeave=None</em>, <em>typeHint=None</em>, <em>CIFinput=False</em>, <em>OnLeaveArgs={}</em>, <em>**kw</em><big>)</big><a class="reference internal" href="_modules/GSASIIctrls.html#ValidatedTxtCtrl"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIctrls.ValidatedTxtCtrl" title="Permalink to this definition">¶</a></dt> 1148 697 <dd><p>Create a TextCtrl widget that uses a validator to prevent the 1149 698 entry of inappropriate characters and changes color to highlight … … 1227 776 </table> 1228 777 <dl class="method"> 1229 <dt id="GSASII grid.ValidatedTxtCtrl.EvaluateExpression">1230 <tt class="descname">EvaluateExpression</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/GSASII grid.html#ValidatedTxtCtrl.EvaluateExpression"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIgrid.ValidatedTxtCtrl.EvaluateExpression" title="Permalink to this definition">¶</a></dt>778 <dt id="GSASIIctrls.ValidatedTxtCtrl.EvaluateExpression"> 779 <tt class="descname">EvaluateExpression</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/GSASIIctrls.html#ValidatedTxtCtrl.EvaluateExpression"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIctrls.ValidatedTxtCtrl.EvaluateExpression" title="Permalink to this definition">¶</a></dt> 1231 780 <dd><p>Show the computed value when an expression is entered to the TextCtrl 1232 781 Make sure that the number fits by truncating decimal places and switching … … 1236 785 1237 786 <dl class="method"> 1238 <dt id="GSASII grid.ValidatedTxtCtrl.OnKeyDown">1239 <tt class="descname">OnKeyDown</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="_modules/GSASII grid.html#ValidatedTxtCtrl.OnKeyDown"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIgrid.ValidatedTxtCtrl.OnKeyDown" title="Permalink to this definition">¶</a></dt>787 <dt id="GSASIIctrls.ValidatedTxtCtrl.OnKeyDown"> 788 <tt class="descname">OnKeyDown</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="_modules/GSASIIctrls.html#ValidatedTxtCtrl.OnKeyDown"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIctrls.ValidatedTxtCtrl.OnKeyDown" title="Permalink to this definition">¶</a></dt> 1240 789 <dd><p>Special callback for wx 2.9+ on Mac where backspace is not processed by validator</p> 1241 790 </dd></dl> 1242 791 1243 792 <dl class="method"> 1244 <dt id="GSASII grid.ValidatedTxtCtrl.ShowStringValidity">1245 <tt class="descname">ShowStringValidity</tt><big>(</big><em>previousInvalid=True</em><big>)</big><a class="reference internal" href="_modules/GSASII grid.html#ValidatedTxtCtrl.ShowStringValidity"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIgrid.ValidatedTxtCtrl.ShowStringValidity" title="Permalink to this definition">¶</a></dt>793 <dt id="GSASIIctrls.ValidatedTxtCtrl.ShowStringValidity"> 794 <tt class="descname">ShowStringValidity</tt><big>(</big><em>previousInvalid=True</em><big>)</big><a class="reference internal" href="_modules/GSASIIctrls.html#ValidatedTxtCtrl.ShowStringValidity"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIctrls.ValidatedTxtCtrl.ShowStringValidity" title="Permalink to this definition">¶</a></dt> 1246 795 <dd><p>Check if input is valid. Anytime the input is 1247 796 invalid, call self.OKcontrol (if defined) because it is fast. … … 1262 811 1263 812 <dl class="class"> 1264 <dt id="GSASII grid.downdate">1265 <em class="property">class </em><tt class="descclassname">GSASII grid.</tt><tt class="descname">downdate</tt><big>(</big><em>parent=None</em><big>)</big><a class="reference internal" href="_modules/GSASIIgrid.html#downdate"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIgrid.downdate" title="Permalink to this definition">¶</a></dt>813 <dt id="GSASIIctrls.downdate"> 814 <em class="property">class </em><tt class="descclassname">GSASIIctrls.</tt><tt class="descname">downdate</tt><big>(</big><em>parent=None</em><big>)</big><a class="reference internal" href="_modules/GSASIIctrls.html#downdate"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIctrls.downdate" title="Permalink to this definition">¶</a></dt> 1266 815 <dd><p>Dialog to allow a user to select a version of GSAS-II to install</p> 1267 816 <dl class="method"> 1268 <dt id="GSASII grid.downdate.getVersion">1269 <tt class="descname">getVersion</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/GSASII grid.html#downdate.getVersion"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIgrid.downdate.getVersion" title="Permalink to this definition">¶</a></dt>817 <dt id="GSASIIctrls.downdate.getVersion"> 818 <tt class="descname">getVersion</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/GSASIIctrls.html#downdate.getVersion"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIctrls.downdate.getVersion" title="Permalink to this definition">¶</a></dt> 1270 819 <dd><p>Get the version number in the dialog</p> 1271 820 </dd></dl> 1272 821 822 </dd></dl> 823 824 </div> 825 <span class="target" id="module-GSASIIgrid"></span><div class="section" id="gsasiigrid-basic-gui-routines"> 826 <h2><em>GSASIIgrid: Basic GUI routines</em><a class="headerlink" href="#gsasiigrid-basic-gui-routines" title="Permalink to this headline">¶</a></h2> 827 <p>Note that a number of routines here should be moved to GSASIIctrls eventually, such as 828 G2LoggedButton, EnumSelector, G2ChoiceButton, SingleFloatDialog, SingleStringDialog, 829 MultiStringDialog, G2MultiChoiceDialog, G2SingleChoiceDialog, G2ColumnIDDialog, ItemSelector, GridFractionEditor</p> 830 <p>Probably SGMessageBox, SymOpDialog, DisAglDialog, too.</p> 831 <dl class="class"> 832 <dt id="GSASIIgrid.DataFrame"> 833 <em class="property">class </em><tt class="descclassname">GSASIIgrid.</tt><tt class="descname">DataFrame</tt><big>(</big><em>parent</em>, <em>frame</em>, <em>data=None</em>, <em>name=None</em>, <em>size=None</em>, <em>pos=None</em><big>)</big><a class="reference internal" href="_modules/GSASIIgrid.html#DataFrame"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIgrid.DataFrame" title="Permalink to this definition">¶</a></dt> 834 <dd><p>Create the data item window and all the entries in menus used in 835 that window. For Linux and windows, the menu entries are created for the 836 current data item window, but in the Mac the menu is accessed from all 837 windows. This means that a different menu is posted depending on which 838 data item is posted. On the Mac, all the menus contain the data tree menu 839 items, but additional menus are added specific to the data item.</p> 840 <p>Note that while the menus are created here, 841 the binding for the menus is done later in various GSASII*GUI modules, 842 where the functions to be called are defined.</p> 843 <dl class="method"> 844 <dt id="GSASIIgrid.DataFrame.Bind"> 845 <tt class="descname">Bind</tt><big>(</big><em>eventtype</em>, <em>handler</em>, <em>*args</em>, <em>**kwargs</em><big>)</big><a class="reference internal" href="_modules/GSASIIgrid.html#DataFrame.Bind"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIgrid.DataFrame.Bind" title="Permalink to this definition">¶</a></dt> 846 <dd><p>Override the Bind() function: on the Mac the binding is to 847 the main window, so that menus operate with any window on top. 848 For other platforms, either wrap calls that will be logged 849 or call the default wx.Frame Bind() to bind to the menu item directly.</p> 850 <p>Note that bindings can be made to objects by Id or by direct reference to the 851 object. As a convention, when bindings are to objects, they are not logged 852 but when bindings are by Id, they are logged.</p> 853 </dd></dl> 854 855 <dl class="method"> 856 <dt id="GSASIIgrid.DataFrame.PostfillDataMenu"> 857 <tt class="descname">PostfillDataMenu</tt><big>(</big><em>empty=False</em><big>)</big><a class="reference internal" href="_modules/GSASIIgrid.html#DataFrame.PostfillDataMenu"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIgrid.DataFrame.PostfillDataMenu" title="Permalink to this definition">¶</a></dt> 858 <dd><p>Create the “standard” part of data frame menus. Note that on Linux and 859 Windows, this is the standard help Menu. On Mac, this menu duplicates the 860 tree menu, but adds an extra help command for the data item and a separator.</p> 861 </dd></dl> 862 863 <dl class="method"> 864 <dt id="GSASIIgrid.DataFrame.PrefillDataMenu"> 865 <tt class="descname">PrefillDataMenu</tt><big>(</big><em>menu</em>, <em>helpType</em>, <em>helpLbl=None</em>, <em>empty=False</em><big>)</big><a class="reference internal" href="_modules/GSASIIgrid.html#DataFrame.PrefillDataMenu"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIgrid.DataFrame.PrefillDataMenu" title="Permalink to this definition">¶</a></dt> 866 <dd><p>Create the “standard” part of data frame menus. Note that on Linux and 867 Windows nothing happens here. On Mac, this menu duplicates the 868 tree menu, but adds an extra help command for the data item and a separator.</p> 869 </dd></dl> 870 871 </dd></dl> 872 873 <dl class="class"> 874 <dt id="GSASIIgrid.DisAglDialog"> 875 <em class="property">class </em><tt class="descclassname">GSASIIgrid.</tt><tt class="descname">DisAglDialog</tt><big>(</big><em>parent</em>, <em>data</em>, <em>default</em><big>)</big><a class="reference internal" href="_modules/GSASIIgrid.html#DisAglDialog"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIgrid.DisAglDialog" title="Permalink to this definition">¶</a></dt> 876 <dd><p>Distance/Angle Controls input dialog. After 877 <tt class="xref py py-meth docutils literal"><span class="pre">ShowModal()</span></tt> returns, the results are found in 878 dict <tt class="xref py py-attr docutils literal"><span class="pre">self.data</span></tt>, which is accessed using <a class="reference internal" href="#GSASIIgrid.DisAglDialog.GetData" title="GSASIIgrid.DisAglDialog.GetData"><tt class="xref py py-meth docutils literal"><span class="pre">GetData()</span></tt></a>.</p> 879 <table class="docutils field-list" frame="void" rules="none"> 880 <col class="field-name" /> 881 <col class="field-body" /> 882 <tbody valign="top"> 883 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 884 <li><strong>parent</strong> (<em>wx.Frame</em>) – reference to parent frame (or None)</li> 885 <li><strong>data</strong> (<em>dict</em>) – a dict containing the current 886 search ranges or an empty dict, which causes default values 887 to be used. 888 Will be used to set element <cite>DisAglCtls</cite> in 889 <a class="reference internal" href="GSASIIobj.html#phase-table"><em>Phase Tree Item</em></a></li> 890 <li><strong>default</strong> (<em>dict</em>) – A dict containing the default 891 search ranges for each element.</li> 892 </ul> 893 </td> 894 </tr> 895 </tbody> 896 </table> 897 <dl class="method"> 898 <dt id="GSASIIgrid.DisAglDialog.Draw"> 899 <tt class="descname">Draw</tt><big>(</big><em>data</em><big>)</big><a class="reference internal" href="_modules/GSASIIgrid.html#DisAglDialog.Draw"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIgrid.DisAglDialog.Draw" title="Permalink to this definition">¶</a></dt> 900 <dd><p>Creates the contents of the dialog. Normally called 901 by <tt class="xref py py-meth docutils literal"><span class="pre">__init__()</span></tt>.</p> 902 </dd></dl> 903 904 <dl class="method"> 905 <dt id="GSASIIgrid.DisAglDialog.GetData"> 906 <tt class="descname">GetData</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/GSASIIgrid.html#DisAglDialog.GetData"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIgrid.DisAglDialog.GetData" title="Permalink to this definition">¶</a></dt> 907 <dd><p>Returns the values from the dialog</p> 908 </dd></dl> 909 910 <dl class="method"> 911 <dt id="GSASIIgrid.DisAglDialog.OnOk"> 912 <tt class="descname">OnOk</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="_modules/GSASIIgrid.html#DisAglDialog.OnOk"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIgrid.DisAglDialog.OnOk" title="Permalink to this definition">¶</a></dt> 913 <dd><p>Called when the OK button is pressed</p> 914 </dd></dl> 915 916 <dl class="method"> 917 <dt id="GSASIIgrid.DisAglDialog.OnReset"> 918 <tt class="descname">OnReset</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="_modules/GSASIIgrid.html#DisAglDialog.OnReset"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIgrid.DisAglDialog.OnReset" title="Permalink to this definition">¶</a></dt> 919 <dd><p>Called when the Reset button is pressed</p> 920 </dd></dl> 921 922 </dd></dl> 923 924 <dl class="class"> 925 <dt id="GSASIIgrid.EnumSelector"> 926 <em class="property">class </em><tt class="descclassname">GSASIIgrid.</tt><tt class="descname">EnumSelector</tt><big>(</big><em>parent</em>, <em>dct</em>, <em>item</em>, <em>choices</em>, <em>values=None</em>, <em>**kw</em><big>)</big><a class="reference internal" href="_modules/GSASIIgrid.html#EnumSelector"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIgrid.EnumSelector" title="Permalink to this definition">¶</a></dt> 927 <dd><p>A customized <tt class="xref py py-class docutils literal"><span class="pre">wxpython.ComboBox</span></tt> that selects items from a list 928 of choices, but sets a dict (list) entry to the corresponding 929 entry from the input list of values.</p> 930 <table class="docutils field-list" frame="void" rules="none"> 931 <col class="field-name" /> 932 <col class="field-body" /> 933 <tbody valign="top"> 934 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 935 <li><strong>parent</strong> (<em>wx.Panel</em>) – the parent to the <tt class="xref py py-class docutils literal"><span class="pre">ComboBox</span></tt> (usually a 936 frame or panel)</li> 937 <li><strong>dct</strong> (<em>dict</em>) – a dict (or list) to contain the value set 938 for the <tt class="xref py py-class docutils literal"><span class="pre">ComboBox</span></tt>.</li> 939 <li><strong>item</strong> – the dict key (or list index) where <tt class="docutils literal"><span class="pre">dct[item]</span></tt> will 940 be set to the value selected in the <tt class="xref py py-class docutils literal"><span class="pre">ComboBox</span></tt>. Also, dct[item] 941 contains the starting value shown in the widget. If the value 942 does not match an entry in <tt class="xref py py-data docutils literal"><span class="pre">values</span></tt>, the first value 943 in <tt class="xref py py-data docutils literal"><span class="pre">choices</span></tt> is used as the default, but <tt class="docutils literal"><span class="pre">dct[item]</span></tt> is 944 not changed.</li> 945 <li><strong>choices</strong> (<em>list</em>) – <p>a list of choices to be displayed to the 946 user such as</p> 947 <div class="highlight-python"><div class="highlight"><pre><span class="p">[</span><span class="s">"default"</span><span class="p">,</span><span class="s">"option 1"</span><span class="p">,</span><span class="s">"option 2"</span><span class="p">,]</span> 948 </pre></div> 949 </div> 950 <p>Note that these options will correspond to the entries in 951 <tt class="xref py py-data docutils literal"><span class="pre">values</span></tt> (if specified) item by item.</p> 952 </li> 953 <li><strong>values</strong> (<em>list</em>) – <p>a list of values that correspond to 954 the options in <tt class="xref py py-data docutils literal"><span class="pre">choices</span></tt>, such as</p> 955 <div class="highlight-python"><div class="highlight"><pre><span class="p">[</span><span class="mi">0</span><span class="p">,</span><span class="mi">1</span><span class="p">,</span><span class="mi">2</span><span class="p">]</span> 956 </pre></div> 957 </div> 958 <p>The default for <tt class="xref py py-data docutils literal"><span class="pre">values</span></tt> is to use the same list as 959 specified for <tt class="xref py py-data docutils literal"><span class="pre">choices</span></tt>.</p> 960 </li> 961 <li><strong>(other)</strong> – additional keyword arguments accepted by 962 <tt class="xref py py-class docutils literal"><span class="pre">ComboBox</span></tt> can be specified.</li> 963 </ul> 964 </td> 965 </tr> 966 </tbody> 967 </table> 968 </dd></dl> 969 970 <dl class="class"> 971 <dt id="GSASIIgrid.G2ChoiceButton"> 972 <em class="property">class </em><tt class="descclassname">GSASIIgrid.</tt><tt class="descname">G2ChoiceButton</tt><big>(</big><em>parent</em>, <em>choiceList</em>, <em>indLoc=None</em>, <em>indKey=None</em>, <em>strLoc=None</em>, <em>strKey=None</em>, <em>onChoice=None</em>, <em>**kwargs</em><big>)</big><a class="reference internal" href="_modules/GSASIIgrid.html#G2ChoiceButton"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIgrid.G2ChoiceButton" title="Permalink to this definition">¶</a></dt> 973 <dd><p>A customized version of a wx.Choice that automatically initializes 974 the control to match a supplied value and saves the choice directly 975 into an array or list. Optionally a function can be called each time a 976 choice is selected. The widget can be used with an array item that is set to 977 to the choice by number (<tt class="docutils literal"><span class="pre">indLoc[indKey]</span></tt>) or by string value 978 (<tt class="docutils literal"><span class="pre">strLoc[strKey]</span></tt>) or both. The initial value is taken from <tt class="docutils literal"><span class="pre">indLoc[indKey]</span></tt> 979 if not None or <tt class="docutils literal"><span class="pre">strLoc[strKey]</span></tt> if not None.</p> 980 <table class="docutils field-list" frame="void" rules="none"> 981 <col class="field-name" /> 982 <col class="field-body" /> 983 <tbody valign="top"> 984 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 985 <li><strong>parent</strong> (<em>wx.Panel</em>) – name of panel or frame that will be 986 the parent to the widget. Can be None.</li> 987 <li><strong>choiceList</strong> (<em>list</em>) – a list or tuple of choices to offer the user.</li> 988 <li><strong>indLoc</strong> (<em>dict/list</em>) – a dict or list with the initial value to be 989 placed in the Choice button. If this is None, this is ignored.</li> 990 <li><strong>indKey</strong> (<em>int/str</em>) – the dict key or the list index for the value to be 991 edited by the Choice button. If indLoc is not None then this 992 must be specified and the <tt class="docutils literal"><span class="pre">indLoc[indKey]</span></tt> will be set. If the value 993 for <tt class="docutils literal"><span class="pre">indLoc[indKey]</span></tt> is not None, it should be an integer in 994 range(len(choiceList)). The Choice button will be initialized to the 995 choice corresponding to the value in this element if not None.</li> 996 <li><strong>strLoc</strong> (<em>dict/list</em>) – a dict or list with the string value corresponding to 997 indLoc/indKey. Default (None) means that this is not used.</li> 998 <li><strong>strKey</strong> (<em>int/str</em>) – the dict key or the list index for the string value 999 The <tt class="docutils literal"><span class="pre">strLoc[strKey]</span></tt> element must exist or strLoc must be None (default).</li> 1000 <li><strong>onChoice</strong> (<em>function</em>) – name of a function to call when the choice is made.</li> 1001 </ul> 1002 </td> 1003 </tr> 1004 </tbody> 1005 </table> 1006 </dd></dl> 1007 1008 <dl class="class"> 1009 <dt id="GSASIIgrid.G2ColumnIDDialog"> 1010 <em class="property">class </em><tt class="descclassname">GSASIIgrid.</tt><tt class="descname">G2ColumnIDDialog</tt><big>(</big><em>parent</em>, <em>title</em>, <em>header</em>, <em>Comments</em>, <em>ChoiceList</em>, <em>ColumnData</em>, <em>monoFont=False</em>, <em>**kw</em><big>)</big><a class="reference internal" href="_modules/GSASIIgrid.html#G2ColumnIDDialog"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIgrid.G2ColumnIDDialog" title="Permalink to this definition">¶</a></dt> 1011 <dd><p>A dialog for matching column data to desired items; some columns may be ignored.</p> 1012 <table class="docutils field-list" frame="void" rules="none"> 1013 <col class="field-name" /> 1014 <col class="field-body" /> 1015 <tbody valign="top"> 1016 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> 1017 <li><strong>ParentFrame</strong> (<em>wx.Frame</em>) – reference to parent frame</li> 1018 <li><strong>title</strong> (<em>str</em>) – heading above list of choices</li> 1019 <li><strong>header</strong> (<em>str</em>) – Title to place on window frame</li> 1020 <li><strong>ChoiceList</strong> (<em>list</em>) – a list of possible choices for the columns</li> 1021 <li><strong>ColumnData</strong> (<em>list</em>) – lists of column data to be matched with ChoiceList</li> 1022 <li><strong>monoFont</strong> (<em>bool</em>) – If False (default), use a variable-spaced font; 1023 if True use a equally-spaced font.</li> 1024 <li><strong>kw</strong> – optional keyword parameters for the wx.Dialog may 1025 be included such as size [which defaults to <cite>(320,310)</cite>] and 1026 style (which defaults to <tt class="docutils literal"><span class="pre">wx.DEFAULT_DIALOG_STYLE</span> <span class="pre">|</span> <span class="pre">wx.RESIZE_BORDER</span> <span class="pre">|</span> <span class="pre">wx.CENTRE</span> <span class="pre">|</span> <span class="pre">wx.OK</span> <span class="pre">|</span> <span class="pre">wx.CANCEL</span></tt>); 1027 note that <tt class="docutils literal"><span class="pre">wx.OK</span></tt> and <tt class="docutils literal"><span class="pre">wx.CANCEL</span></tt> controls 1028 the presence of the eponymous buttons in the dialog.</li> 1029 </ul> 1030 </td> 1031 </tr> 1032 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">the name of the created dialog</p> 1033 </td> 1034 </tr> 1035 </tbody> 1036 </table> 1037 <dl class="method"> 1038 <dt id="GSASIIgrid.G2ColumnIDDialog.GetSelection"> 1039 <tt class="descname">GetSelection</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/GSASIIgrid.html#G2ColumnIDDialog.GetSelection"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIgrid.G2ColumnIDDialog.GetSelection" title="Permalink to this definition">¶</a></dt> 1040 <dd><p>Returns the selected sample parm for each column</p> 1041 </dd></dl> 1042 1043 </dd></dl> 1044 1045 <dl class="class"> 1046 <dt id="GSASIIgrid.G2LoggedButton"> 1047 <em class="property">class </em><tt class="descclassname">GSASIIgrid.</tt><tt class="descname">G2LoggedButton</tt><big>(</big><em>parent</em>, <em>id=-1</em>, <em>label=''</em>, <em>locationcode=''</em>, <em>handler=None</em>, <em>*args</em>, <em>**kwargs</em><big>)</big><a class="reference internal" href="_modules/GSASIIgrid.html#G2LoggedButton"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIgrid.G2LoggedButton" title="Permalink to this definition">¶</a></dt> 1048 <dd><p>A version of wx.Button that creates logging events. Bindings are saved 1049 in the object, and are looked up rather than directly set with a bind. 1050 An index to these buttons is saved as log.ButtonBindingLookup 1051 :param wx.Panel parent: parent widget 1052 :param int id: Id for button 1053 :param str label: label for button 1054 :param str locationcode: a label used internally to uniquely indentify the button 1055 :param function handler: a routine to call when the button is pressed</p> 1056 <dl class="method"> 1057 <dt id="GSASIIgrid.G2LoggedButton.onPress"> 1058 <tt class="descname">onPress</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="_modules/GSASIIgrid.html#G2LoggedButton.onPress"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIgrid.G2LoggedButton.onPress" title="Permalink to this definition">¶</a></dt> 1059 <dd><p>create log event and call handler</p> 1060 </dd></dl> 1061 1062 </dd></dl> 1063 1064 <dl class="class"> 1065 <dt id="GSASIIgrid.G2MultiChoiceDialog"> 1066 <em class="property">class </em><tt class="descclassname">GSASIIgrid.</tt><tt class="descname">G2MultiChoiceDialog</tt><big>(</big><em>parent</em>, <em>title</em>, <em>header</em>, <em>ChoiceList</em>, <em>toggle=True</em>, <em>monoFont=False</em>, <em>filterBox=True</em>, <em>**kw</em><big>)</big><a class="reference internal" href="_modules/GSASIIgrid.html#G2MultiChoiceDialog"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIgrid.G2MultiChoiceDialog" title="Permalink to this definition">¶</a></dt> 1067 <dd><p>A dialog similar to MultiChoiceDialog except that buttons are 1068 added to set all choices and to toggle all choices.</p> 1069 <table class="docutils field-list" frame="void" rules="none"> 1070 <col class="field-name" /> 1071 <col class="field-body" /> 1072 <tbody valign="top"> 1073 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> 1074 <li><strong>ParentFrame</strong> (<em>wx.Frame</em>) – reference to parent frame</li> 1075 <li><strong>title</strong> (<em>str</em>) – heading above list of choices</li> 1076 <li><strong>header</strong> (<em>str</em>) – Title to place on window frame</li> 1077 <li><strong>ChoiceList</strong> (<em>list</em>) – a list of choices where one will be selected</li> 1078 <li><strong>toggle</strong> (<em>bool</em>) – If True (default) the toggle and select all buttons 1079 are displayed</li> 1080 <li><strong>monoFont</strong> (<em>bool</em>) – If False (default), use a variable-spaced font; 1081 if True use a equally-spaced font.</li> 1082 <li><strong>filterBox</strong> (<em>bool</em>) – If True (default) an input widget is placed on 1083 the window and only entries matching the entered text are shown.</li> 1084 <li><strong>kw</strong> – optional keyword parameters for the wx.Dialog may 1085 be included such as size [which defaults to <cite>(320,310)</cite>] and 1086 style (which defaults to <cite>wx.DEFAULT_DIALOG_STYLE|wx.RESIZE_BORDER|wx.CENTRE| wx.OK | wx.CANCEL</cite>); 1087 note that <cite>wx.OK</cite> and <cite>wx.CANCEL</cite> controls 1088 the presence of the eponymous buttons in the dialog.</li> 1089 </ul> 1090 </td> 1091 </tr> 1092 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">the name of the created dialog</p> 1093 </td> 1094 </tr> 1095 </tbody> 1096 </table> 1097 <dl class="method"> 1098 <dt id="GSASIIgrid.G2MultiChoiceDialog.GetSelections"> 1099 <tt class="descname">GetSelections</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/GSASIIgrid.html#G2MultiChoiceDialog.GetSelections"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIgrid.G2MultiChoiceDialog.GetSelections" title="Permalink to this definition">¶</a></dt> 1100 <dd><p>Returns a list of the indices for the selected choices</p> 1101 </dd></dl> 1102 1103 <dl class="method"> 1104 <dt id="GSASIIgrid.G2MultiChoiceDialog.OnCheck"> 1105 <tt class="descname">OnCheck</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="_modules/GSASIIgrid.html#G2MultiChoiceDialog.OnCheck"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIgrid.G2MultiChoiceDialog.OnCheck" title="Permalink to this definition">¶</a></dt> 1106 <dd><p>for CheckListBox events; if Shift key down this sets all unset 1107 entries below the selected one</p> 1108 </dd></dl> 1109 1110 <dl class="method"> 1111 <dt id="GSASIIgrid.G2MultiChoiceDialog.SetSelections"> 1112 <tt class="descname">SetSelections</tt><big>(</big><em>selList</em><big>)</big><a class="reference internal" href="_modules/GSASIIgrid.html#G2MultiChoiceDialog.SetSelections"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIgrid.G2MultiChoiceDialog.SetSelections" title="Permalink to this definition">¶</a></dt> 1113 <dd><p>Sets the selection indices in selList as selected. Resets any previous 1114 selections for compatibility with wx.MultiChoiceDialog. Note that 1115 the state for only the filtered items is shown.</p> 1116 <table class="docutils field-list" frame="void" rules="none"> 1117 <col class="field-name" /> 1118 <col class="field-body" /> 1119 <tbody valign="top"> 1120 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>selList</strong> (<em>list</em>) – indices of items to be selected. These indices 1121 are referenced to the order in self.ChoiceList</td> 1122 </tr> 1123 </tbody> 1124 </table> 1125 </dd></dl> 1126 1127 <dl class="method"> 1128 <dt id="GSASIIgrid.G2MultiChoiceDialog.onChar"> 1129 <tt class="descname">onChar</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="_modules/GSASIIgrid.html#G2MultiChoiceDialog.onChar"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIgrid.G2MultiChoiceDialog.onChar" title="Permalink to this definition">¶</a></dt> 1130 <dd><p>for keyboard events. self.trigger is used in self.OnCheck below</p> 1131 </dd></dl> 1132 1133 </dd></dl> 1134 1135 <dl class="class"> 1136 <dt id="GSASIIgrid.G2SingleChoiceDialog"> 1137 <em class="property">class </em><tt class="descclassname">GSASIIgrid.</tt><tt class="descname">G2SingleChoiceDialog</tt><big>(</big><em>parent</em>, <em>title</em>, <em>header</em>, <em>ChoiceList</em>, <em>monoFont=False</em>, <em>filterBox=True</em>, <em>**kw</em><big>)</big><a class="reference internal" href="_modules/GSASIIgrid.html#G2SingleChoiceDialog"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIgrid.G2SingleChoiceDialog" title="Permalink to this definition">¶</a></dt> 1138 <dd><p>A dialog similar to wx.SingleChoiceDialog except that a filter can be 1139 added.</p> 1140 <table class="docutils field-list" frame="void" rules="none"> 1141 <col class="field-name" /> 1142 <col class="field-body" /> 1143 <tbody valign="top"> 1144 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> 1145 <li><strong>ParentFrame</strong> (<em>wx.Frame</em>) – reference to parent frame</li> 1146 <li><strong>title</strong> (<em>str</em>) – heading above list of choices</li> 1147 <li><strong>header</strong> (<em>str</em>) – Title to place on window frame</li> 1148 <li><strong>ChoiceList</strong> (<em>list</em>) – a list of choices where one will be selected</li> 1149 <li><strong>monoFont</strong> (<em>bool</em>) – If False (default), use a variable-spaced font; 1150 if True use a equally-spaced font.</li> 1151 <li><strong>filterBox</strong> (<em>bool</em>) – If True (default) an input widget is placed on 1152 the window and only entries matching the entered text are shown.</li> 1153 <li><strong>kw</strong> – optional keyword parameters for the wx.Dialog may 1154 be included such as size [which defaults to <cite>(320,310)</cite>] and 1155 style (which defaults to <tt class="docutils literal"><span class="pre">wx.DEFAULT_DIALOG_STYLE</span> <span class="pre">|</span> <span class="pre">wx.RESIZE_BORDER</span> <span class="pre">|</span> <span class="pre">wx.CENTRE</span> <span class="pre">|</span> <span class="pre">wx.OK</span> <span class="pre">|</span> <span class="pre">wx.CANCEL</span></tt>); 1156 note that <tt class="docutils literal"><span class="pre">wx.OK</span></tt> and <tt class="docutils literal"><span class="pre">wx.CANCEL</span></tt> controls 1157 the presence of the eponymous buttons in the dialog.</li> 1158 </ul> 1159 </td> 1160 </tr> 1161 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">the name of the created dialog</p> 1162 </td> 1163 </tr> 1164 </tbody> 1165 </table> 1166 <dl class="method"> 1167 <dt id="GSASIIgrid.G2SingleChoiceDialog.GetSelection"> 1168 <tt class="descname">GetSelection</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/GSASIIgrid.html#G2SingleChoiceDialog.GetSelection"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIgrid.G2SingleChoiceDialog.GetSelection" title="Permalink to this definition">¶</a></dt> 1169 <dd><p>Returns the index of the selected choice</p> 1170 </dd></dl> 1171 1172 </dd></dl> 1173 1174 <dl class="class"> 1175 <dt id="GSASIIgrid.GSGrid"> 1176 <em class="property">class </em><tt class="descclassname">GSASIIgrid.</tt><tt class="descname">GSGrid</tt><big>(</big><em>parent</em>, <em>name=''</em><big>)</big><a class="reference internal" href="_modules/GSASIIgrid.html#GSGrid"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIgrid.GSGrid" title="Permalink to this definition">¶</a></dt> 1177 <dd><p>Basic wx.Grid implementation</p> 1178 <dl class="method"> 1179 <dt id="GSASIIgrid.GSGrid.InstallGridToolTip"> 1180 <tt class="descname">InstallGridToolTip</tt><big>(</big><em>rowcolhintcallback</em>, <em>colLblCallback=None</em>, <em>rowLblCallback=None</em><big>)</big><a class="reference internal" href="_modules/GSASIIgrid.html#GSGrid.InstallGridToolTip"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIgrid.GSGrid.InstallGridToolTip" title="Permalink to this definition">¶</a></dt> 1181 <dd><p>code to display a tooltip for each item on a grid 1182 from <a class="reference external" href="http://wiki.wxpython.org/wxGrid%20ToolTips">http://wiki.wxpython.org/wxGrid%20ToolTips</a> (buggy!), expanded to 1183 column and row labels using hints from 1184 <a class="reference external" href="https://groups.google.com/forum/#!topic/wxPython-users/bm8OARRVDCs">https://groups.google.com/forum/#!topic/wxPython-users/bm8OARRVDCs</a></p> 1185 <table class="docutils field-list" frame="void" rules="none"> 1186 <col class="field-name" /> 1187 <col class="field-body" /> 1188 <tbody valign="top"> 1189 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 1190 <li><strong>rowcolhintcallback</strong> (<em>function</em>) – a routine that returns a text 1191 string depending on the selected row and column, to be used in 1192 explaining grid entries.</li> 1193 <li><strong>colLblCallback</strong> (<em>function</em>) – a routine that returns a text 1194 string depending on the selected column, to be used in 1195 explaining grid columns (if None, the default), column labels 1196 do not get a tooltip.</li> 1197 <li><strong>rowLblCallback</strong> (<em>function</em>) – a routine that returns a text 1198 string depending on the selected row, to be used in 1199 explaining grid rows (if None, the default), row labels 1200 do not get a tooltip.</li> 1201 </ul> 1202 </td> 1203 </tr> 1204 </tbody> 1205 </table> 1206 </dd></dl> 1207 1208 </dd></dl> 1209 1210 <dl class="class"> 1211 <dt id="GSASIIgrid.GSNoteBook"> 1212 <em class="property">class </em><tt class="descclassname">GSASIIgrid.</tt><tt class="descname">GSNoteBook</tt><big>(</big><em>parent</em>, <em>name=''</em>, <em>size=None</em><big>)</big><a class="reference internal" href="_modules/GSASIIgrid.html#GSNoteBook"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIgrid.GSNoteBook" title="Permalink to this definition">¶</a></dt> 1213 <dd><p>Notebook used in various locations; implemented with wx.aui extension</p> 1214 <dl class="method"> 1215 <dt id="GSASIIgrid.GSNoteBook.Bind"> 1216 <tt class="descname">Bind</tt><big>(</big><em>eventtype</em>, <em>handler</em>, <em>*args</em>, <em>**kwargs</em><big>)</big><a class="reference internal" href="_modules/GSASIIgrid.html#GSNoteBook.Bind"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIgrid.GSNoteBook.Bind" title="Permalink to this definition">¶</a></dt> 1217 <dd><p>Override the Bind() function so that page change events can be trapped</p> 1218 </dd></dl> 1219 1220 </dd></dl> 1221 1222 <dl class="function"> 1223 <dt id="GSASIIgrid.GetPatternTreeDataNames"> 1224 <tt class="descclassname">GSASIIgrid.</tt><tt class="descname">GetPatternTreeDataNames</tt><big>(</big><em>G2frame</em>, <em>dataTypes</em><big>)</big><a class="reference internal" href="_modules/GSASIIgrid.html#GetPatternTreeDataNames"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIgrid.GetPatternTreeDataNames" title="Permalink to this definition">¶</a></dt> 1225 <dd><p>Needs a doc string</p> 1226 </dd></dl> 1227 1228 <dl class="function"> 1229 <dt id="GSASIIgrid.GetPatternTreeItemId"> 1230 <tt class="descclassname">GSASIIgrid.</tt><tt class="descname">GetPatternTreeItemId</tt><big>(</big><em>G2frame</em>, <em>parentId</em>, <em>itemText</em><big>)</big><a class="reference internal" href="_modules/GSASIIgrid.html#GetPatternTreeItemId"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIgrid.GetPatternTreeItemId" title="Permalink to this definition">¶</a></dt> 1231 <dd><p>Needs a doc string</p> 1232 </dd></dl> 1233 1234 <dl class="class"> 1235 <dt id="GSASIIgrid.GridFractionEditor"> 1236 <em class="property">class </em><tt class="descclassname">GSASIIgrid.</tt><tt class="descname">GridFractionEditor</tt><big>(</big><em>grid</em><big>)</big><a class="reference internal" href="_modules/GSASIIgrid.html#GridFractionEditor"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIgrid.GridFractionEditor" title="Permalink to this definition">¶</a></dt> 1237 <dd><p>A grid cell editor class that allows entry of values as fractions as well 1238 as sine and cosine values [as s() and c()]</p> 1239 <dl class="method"> 1240 <dt id="GSASIIgrid.GridFractionEditor.ApplyEdit"> 1241 <tt class="descname">ApplyEdit</tt><big>(</big><em>row</em>, <em>col</em>, <em>grid</em><big>)</big><a class="reference internal" href="_modules/GSASIIgrid.html#GridFractionEditor.ApplyEdit"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIgrid.GridFractionEditor.ApplyEdit" title="Permalink to this definition">¶</a></dt> 1242 <dd><p>Called only in wx >= 2.9 1243 Save the value of the control into the grid if EndEdit() returns as True</p> 1244 </dd></dl> 1245 1246 </dd></dl> 1247 1248 <dl class="function"> 1249 <dt id="GSASIIgrid.HorizontalLine"> 1250 <tt class="descclassname">GSASIIgrid.</tt><tt class="descname">HorizontalLine</tt><big>(</big><em>sizer</em>, <em>parent</em><big>)</big><a class="reference internal" href="_modules/GSASIIgrid.html#HorizontalLine"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIgrid.HorizontalLine" title="Permalink to this definition">¶</a></dt> 1251 <dd><p>Draws a horizontal line as wide as the window. 1252 This shows up on the Mac as a very thin line, no matter what I do</p> 1253 </dd></dl> 1254 1255 <dl class="function"> 1256 <dt id="GSASIIgrid.HowDidIgetHere"> 1257 <tt class="descclassname">GSASIIgrid.</tt><tt class="descname">HowDidIgetHere</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/GSASIIgrid.html#HowDidIgetHere"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIgrid.HowDidIgetHere" title="Permalink to this definition">¶</a></dt> 1258 <dd><p>Show a traceback with calls that brought us to the current location. 1259 Used for debugging.</p> 1260 </dd></dl> 1261 1262 <dl class="function"> 1263 <dt id="GSASIIgrid.ItemSelector"> 1264 <tt class="descclassname">GSASIIgrid.</tt><tt class="descname">ItemSelector</tt><big>(</big><em>ChoiceList</em>, <em>ParentFrame=None</em>, <em>title='Select an item'</em>, <em>size=None</em>, <em>header='Item Selector'</em>, <em>useCancel=True</em>, <em>multiple=False</em><big>)</big><a class="reference internal" href="_modules/GSASIIgrid.html#ItemSelector"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIgrid.ItemSelector" title="Permalink to this definition">¶</a></dt> 1265 <dd><p>Provide a wx dialog to select a single item or multiple items from list of choices</p> 1266 <table class="docutils field-list" frame="void" rules="none"> 1267 <col class="field-name" /> 1268 <col class="field-body" /> 1269 <tbody valign="top"> 1270 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> 1271 <li><strong>ChoiceList</strong> (<em>list</em>) – a list of choices where one will be selected</li> 1272 <li><strong>ParentFrame</strong> (<em>wx.Frame</em>) – Name of parent frame (default None)</li> 1273 <li><strong>title</strong> (<em>str</em>) – heading above list of choices (default ‘Select an item’)</li> 1274 <li><strong>size</strong> (<em>wx.Size</em>) – Size for dialog to be created (default None – size as needed)</li> 1275 <li><strong>header</strong> (<em>str</em>) – Title to place on window frame (default ‘Item Selector’)</li> 1276 <li><strong>useCancel</strong> (<em>bool</em>) – If True (default) both the OK and Cancel buttons are offered</li> 1277 <li><strong>multiple</strong> (<em>bool</em>) – If True then multiple items can be selected (default False)</li> 1278 </ul> 1279 </td> 1280 </tr> 1281 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">the selection index or None or a selection list if multiple is true</p> 1282 </td> 1283 </tr> 1284 </tbody> 1285 </table> 1286 </dd></dl> 1287 1288 <dl class="function"> 1289 <dt id="GSASIIgrid.MovePatternTreeToGrid"> 1290 <tt class="descclassname">GSASIIgrid.</tt><tt class="descname">MovePatternTreeToGrid</tt><big>(</big><em>G2frame</em>, <em>item</em><big>)</big><a class="reference internal" href="_modules/GSASIIgrid.html#MovePatternTreeToGrid"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIgrid.MovePatternTreeToGrid" title="Permalink to this definition">¶</a></dt> 1291 <dd><p>Called from GSASII.OnPatternTreeSelChanged when a item is selected on the tree</p> 1292 </dd></dl> 1293 1294 <dl class="class"> 1295 <dt id="GSASIIgrid.MultiStringDialog"> 1296 <em class="property">class </em><tt class="descclassname">GSASIIgrid.</tt><tt class="descname">MultiStringDialog</tt><big>(</big><em>parent</em>, <em>title</em>, <em>prompts</em>, <em>values=</em><span class="optional">[</span><span class="optional">]</span><big>)</big><a class="reference internal" href="_modules/GSASIIgrid.html#MultiStringDialog"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIgrid.MultiStringDialog" title="Permalink to this definition">¶</a></dt> 1297 <dd><p>Dialog to obtain a multi string values from user</p> 1298 <table class="docutils field-list" frame="void" rules="none"> 1299 <col class="field-name" /> 1300 <col class="field-body" /> 1301 <tbody valign="top"> 1302 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 1303 <li><strong>parent</strong> (<em>wx.Frame</em>) – name of parent frame</li> 1304 <li><strong>title</strong> (<em>str</em>) – title string for dialog</li> 1305 <li><strong>prompts</strong> (<em>str</em>) – strings to tell use what they are inputting</li> 1306 <li><strong>values</strong> (<em>str</em>) – default input values, if any</li> 1307 </ul> 1308 </td> 1309 </tr> 1310 </tbody> 1311 </table> 1312 <dl class="method"> 1313 <dt id="GSASIIgrid.MultiStringDialog.GetValues"> 1314 <tt class="descname">GetValues</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/GSASIIgrid.html#MultiStringDialog.GetValues"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIgrid.MultiStringDialog.GetValues" title="Permalink to this definition">¶</a></dt> 1315 <dd><p>Use this method to get the value entered by the user 1316 :returns: string entered by user</p> 1317 </dd></dl> 1318 1319 <dl class="method"> 1320 <dt id="GSASIIgrid.MultiStringDialog.Show"> 1321 <tt class="descname">Show</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/GSASIIgrid.html#MultiStringDialog.Show"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIgrid.MultiStringDialog.Show" title="Permalink to this definition">¶</a></dt> 1322 <dd><p>Use this method after creating the dialog to post it 1323 :returns: True if the user pressed OK; False if the User pressed Cancel</p> 1324 </dd></dl> 1325 1326 </dd></dl> 1327 1328 <dl class="class"> 1329 <dt id="GSASIIgrid.SGMessageBox"> 1330 <em class="property">class </em><tt class="descclassname">GSASIIgrid.</tt><tt class="descname">SGMessageBox</tt><big>(</big><em>parent</em>, <em>title</em>, <em>text</em>, <em>table</em><big>)</big><a class="reference internal" href="_modules/GSASIIgrid.html#SGMessageBox"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIgrid.SGMessageBox" title="Permalink to this definition">¶</a></dt> 1331 <dd><p>Special version of MessageBox that displays space group & super space group text 1332 in two blocks</p> 1333 <dl class="method"> 1334 <dt id="GSASIIgrid.SGMessageBox.Show"> 1335 <tt class="descname">Show</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/GSASIIgrid.html#SGMessageBox.Show"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIgrid.SGMessageBox.Show" title="Permalink to this definition">¶</a></dt> 1336 <dd><p>Use this method after creating the dialog to post it</p> 1337 </dd></dl> 1338 1339 </dd></dl> 1340 1341 <dl class="function"> 1342 <dt id="GSASIIgrid.SetDataMenuBar"> 1343 <tt class="descclassname">GSASIIgrid.</tt><tt class="descname">SetDataMenuBar</tt><big>(</big><em>G2frame</em>, <em>menu=None</em><big>)</big><a class="reference internal" href="_modules/GSASIIgrid.html#SetDataMenuBar"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIgrid.SetDataMenuBar" title="Permalink to this definition">¶</a></dt> 1344 <dd><p>Set the menu for the data frame. On the Mac put this 1345 menu for the data tree window instead.</p> 1346 <p>Note that data frame items do not have menus, for these (menu=None) 1347 display a blank menu or on the Mac display the standard menu for 1348 the data tree window.</p> 1349 </dd></dl> 1350 1351 <dl class="class"> 1352 <dt id="GSASIIgrid.ShowLSParms"> 1353 <em class="property">class </em><tt class="descclassname">GSASIIgrid.</tt><tt class="descname">ShowLSParms</tt><big>(</big><em>parent</em>, <em>title</em>, <em>parmDict</em>, <em>varyList</em>, <em>fullVaryList</em>, <em>size=(300</em>, <em>430)</em><big>)</big><a class="reference internal" href="_modules/GSASIIgrid.html#ShowLSParms"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIgrid.ShowLSParms" title="Permalink to this definition">¶</a></dt> 1354 <dd><p>Create frame to show least-squares parameters</p> 1355 </dd></dl> 1356 1357 <dl class="class"> 1358 <dt id="GSASIIgrid.SingleFloatDialog"> 1359 <em class="property">class </em><tt class="descclassname">GSASIIgrid.</tt><tt class="descname">SingleFloatDialog</tt><big>(</big><em>parent, title, prompt, value, limits=[0.0, 1.0], format='%.5g'</em><big>)</big><a class="reference internal" href="_modules/GSASIIgrid.html#SingleFloatDialog"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIgrid.SingleFloatDialog" title="Permalink to this definition">¶</a></dt> 1360 <dd><p>Dialog to obtain a single float value from user</p> 1361 </dd></dl> 1362 1363 <dl class="class"> 1364 <dt id="GSASIIgrid.SingleStringDialog"> 1365 <em class="property">class </em><tt class="descclassname">GSASIIgrid.</tt><tt class="descname">SingleStringDialog</tt><big>(</big><em>parent</em>, <em>title</em>, <em>prompt</em>, <em>value=''</em>, <em>size=(200</em>, <em>-1)</em><big>)</big><a class="reference internal" href="_modules/GSASIIgrid.html#SingleStringDialog"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIgrid.SingleStringDialog" title="Permalink to this definition">¶</a></dt> 1366 <dd><p>Dialog to obtain a single string value from user</p> 1367 <table class="docutils field-list" frame="void" rules="none"> 1368 <col class="field-name" /> 1369 <col class="field-body" /> 1370 <tbody valign="top"> 1371 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 1372 <li><strong>parent</strong> (<em>wx.Frame</em>) – name of parent frame</li> 1373 <li><strong>title</strong> (<em>str</em>) – title string for dialog</li> 1374 <li><strong>prompt</strong> (<em>str</em>) – string to tell use what they are inputting</li> 1375 <li><strong>value</strong> (<em>str</em>) – default input value, if any</li> 1376 </ul> 1377 </td> 1378 </tr> 1379 </tbody> 1380 </table> 1381 <dl class="method"> 1382 <dt id="GSASIIgrid.SingleStringDialog.GetValue"> 1383 <tt class="descname">GetValue</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/GSASIIgrid.html#SingleStringDialog.GetValue"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIgrid.SingleStringDialog.GetValue" title="Permalink to this definition">¶</a></dt> 1384 <dd><p>Use this method to get the value entered by the user 1385 :returns: string entered by user</p> 1386 </dd></dl> 1387 1388 <dl class="method"> 1389 <dt id="GSASIIgrid.SingleStringDialog.Show"> 1390 <tt class="descname">Show</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/GSASIIgrid.html#SingleStringDialog.Show"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIgrid.SingleStringDialog.Show" title="Permalink to this definition">¶</a></dt> 1391 <dd><p>Use this method after creating the dialog to post it 1392 :returns: True if the user pressed OK; False if the User pressed Cancel</p> 1393 </dd></dl> 1394 1395 </dd></dl> 1396 1397 <dl class="class"> 1398 <dt id="GSASIIgrid.SymOpDialog"> 1399 <em class="property">class </em><tt class="descclassname">GSASIIgrid.</tt><tt class="descname">SymOpDialog</tt><big>(</big><em>parent</em>, <em>SGData</em>, <em>New=True</em>, <em>ForceUnit=False</em><big>)</big><a class="reference internal" href="_modules/GSASIIgrid.html#SymOpDialog"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIgrid.SymOpDialog" title="Permalink to this definition">¶</a></dt> 1400 <dd><p>Class to select a symmetry operator</p> 1401 </dd></dl> 1402 1403 <dl class="class"> 1404 <dt id="GSASIIgrid.Table"> 1405 <em class="property">class </em><tt class="descclassname">GSASIIgrid.</tt><tt class="descname">Table</tt><big>(</big><em>data=</em>, <span class="optional">[</span><span class="optional">]</span><em>rowLabels=None</em>, <em>colLabels=None</em>, <em>types=None</em><big>)</big><a class="reference internal" href="_modules/GSASIIgrid.html#Table"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIgrid.Table" title="Permalink to this definition">¶</a></dt> 1406 <dd><p>Basic data table for use with GSgrid</p> 1407 </dd></dl> 1408 1409 <dl class="function"> 1410 <dt id="GSASIIgrid.UpdateControls"> 1411 <tt class="descclassname">GSASIIgrid.</tt><tt class="descname">UpdateControls</tt><big>(</big><em>G2frame</em>, <em>data</em><big>)</big><a class="reference internal" href="_modules/GSASIIgrid.html#UpdateControls"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIgrid.UpdateControls" title="Permalink to this definition">¶</a></dt> 1412 <dd><p>Edit overall GSAS-II controls in main Controls data tree entry</p> 1413 </dd></dl> 1414 1415 <dl class="function"> 1416 <dt id="GSASIIgrid.UpdateNotebook"> 1417 <tt class="descclassname">GSASIIgrid.</tt><tt class="descname">UpdateNotebook</tt><big>(</big><em>G2frame</em>, <em>data</em><big>)</big><a class="reference internal" href="_modules/GSASIIgrid.html#UpdateNotebook"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIgrid.UpdateNotebook" title="Permalink to this definition">¶</a></dt> 1418 <dd><p>Called when the data tree notebook entry is selected. Allows for 1419 editing of the text in that tree entry</p> 1420 </dd></dl> 1421 1422 <dl class="function"> 1423 <dt id="GSASIIgrid.UpdatePWHKPlot"> 1424 <tt class="descclassname">GSASIIgrid.</tt><tt class="descname">UpdatePWHKPlot</tt><big>(</big><em>G2frame</em>, <em>kind</em>, <em>item</em><big>)</big><a class="reference internal" href="_modules/GSASIIgrid.html#UpdatePWHKPlot"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIgrid.UpdatePWHKPlot" title="Permalink to this definition">¶</a></dt> 1425 <dd><p>Called when the histogram main tree entry is called. Displays the 1426 histogram weight factor, refinement statistics for the histogram 1427 and the range of data for a simulation.</p> 1428 <p>Also invokes a plot of the histogram.</p> 1429 </dd></dl> 1430 1431 <dl class="function"> 1432 <dt id="GSASIIgrid.UpdateSeqResults"> 1433 <tt class="descclassname">GSASIIgrid.</tt><tt class="descname">UpdateSeqResults</tt><big>(</big><em>G2frame</em>, <em>data</em>, <em>prevSize=None</em><big>)</big><a class="reference internal" href="_modules/GSASIIgrid.html#UpdateSeqResults"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIgrid.UpdateSeqResults" title="Permalink to this definition">¶</a></dt> 1434 <dd><p>Called when the Sequential Results data tree entry is selected 1435 to show results from a sequential refinement.</p> 1436 <table class="docutils field-list" frame="void" rules="none"> 1437 <col class="field-name" /> 1438 <col class="field-body" /> 1439 <tbody valign="top"> 1440 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 1441 <li><strong>G2frame</strong> (<em>wx.Frame</em>) – main GSAS-II data tree windows</li> 1442 <li><strong>data</strong> (<em>dict</em>) – <p>a dictionary containing the following items:</p> 1443 <ul> 1444 <li>‘histNames’ - list of histogram names in order as processed by Sequential Refinement</li> 1445 <li>‘varyList’ - list of variables - identical over all refinements in sequence 1446 note that this is the original list of variables, prior to processing 1447 constraints.</li> 1448 <li>‘variableLabels’ – a dict of labels to be applied to each parameter 1449 (this is created as an empty dict if not present in data).</li> 1450 <li>keyed by histName - dictionaries for all data sets processed, which contains:<ul> 1451 <li>‘variables’- result[0] from leastsq call</li> 1452 <li>‘varyList’ - list of variables passed to leastsq call (not same as above)</li> 1453 <li>‘sig’ - esds for variables</li> 1454 <li>‘covMatrix’ - covariance matrix from individual refinement</li> 1455 <li>‘title’ - histogram name; same as dict item name</li> 1456 <li>‘newAtomDict’ - new atom parameters after shifts applied</li> 1457 <li>‘newCellDict’ - refined cell parameters after shifts to A0-A5 from Dij terms applied’</li> 1458 </ul> 1459 </li> 1460 </ul> 1461 </li> 1462 </ul> 1463 </td> 1464 </tr> 1465 </tbody> 1466 </table> 1273 1467 </dd></dl> 1274 1468 … … 1916 2110 <dl class="function"> 1917 2111 <dt id="GSASIIIO.SetNewPhase"> 1918 <tt class="descclassname">GSASIIIO.</tt><tt class="descname">SetNewPhase</tt><big>(</big><em>Name='New Phase'</em>, <em>SGData=None</em>, <em>cell=None</em> <big>)</big><a class="reference internal" href="_modules/GSASIIIO.html#SetNewPhase"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIIO.SetNewPhase" title="Permalink to this definition">¶</a></dt>2112 <tt class="descclassname">GSASIIIO.</tt><tt class="descname">SetNewPhase</tt><big>(</big><em>Name='New Phase'</em>, <em>SGData=None</em>, <em>cell=None</em>, <em>Super=None</em><big>)</big><a class="reference internal" href="_modules/GSASIIIO.html#SetNewPhase"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIIO.SetNewPhase" title="Permalink to this definition">¶</a></dt> 1919 2113 <dd><p>Create a new phase dict with default values for various parameters</p> 1920 2114 <table class="docutils field-list" frame="void" rules="none"> … … 2103 2297 <ul> 2104 2298 <li><a class="reference internal" href="#"><em>GSAS-II GUI Routines</em></a><ul> 2299 <li><a class="reference internal" href="#gsasiictrls-custom-gui-controls"><em>GSASIIctrls: Custom GUI controls</em></a></li> 2105 2300 <li><a class="reference internal" href="#gsasiigrid-basic-gui-routines"><em>GSASIIgrid: Basic GUI routines</em></a></li> 2106 2301 <li><a class="reference internal" href="#gsasiiio-misc-i-o-routines"><em>GSASIIIO: Misc I/O routines</em></a></li>
Note: See TracChangeset
for help on using the changeset viewer.
