source: trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/STRING/string2struct.html @ 191

Last change on this file since 191 was 191, checked in by pinsard, 18 years ago

remove format=raw in all html files 2+ : correction for all_plots; suppression of css and correction of Source links in idldoc html output
File size: 6.8 KB
Line 
1
2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
3 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
4
5<!-- Generated by IDLdoc 2.0 -->
6
7<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
8  <head>
9    <title>string2struct.pro (SAXO Documentation)</title>
10
11   
12    <link rel="stylesheet" type="text/css" media="all" href="./../../main_files.css" />
13    <link rel="stylesheet" type="text/css" media="print" href="./../../main_files_print.css" />
14   
15
16    <script type="text/javascript">
17      function setTitle() {
18        parent.document.title="string2struct.pro (SAXO Documentation)";
19      }
20    </script>
21  </head>
22
23  <body onload="setTitle();">
24
25    <div id="navbar_title">
26  <h1>SAXO Documentation</h1>
27</div>
28
29
30<div id="main_navbar">
31
32  <table cellspacing="0">
33    <tr>
34     
35      <td><a href="./../../overview.html" title="Overview of library">Overview</a></td>
36     
37
38     
39      <td >Directory</td>
40     
41
42     
43      <td><a href="./../../idldoc-categories.html" title="Browse library by category">Categories</a></td>
44     
45
46     
47      <td><a href="./../../idldoc-index.html" title="Index of files, routines, and parameters">Index</a></td>
48     
49
50     
51      <td><a href="./../../search-page.html" title="Search library">Search</a></td>
52     
53
54      <td id="selected">File</td>
55
56     
57      <td><a href="../../../../ToBeReviewed/STRING//string2struct.pro" title="Source code of a file">Source</a></td>
58     
59
60     
61      <td><a href="./../../idldoc-help.html" title="Help on IDLdoc">Help</a></td>
62     
63
64      <td >Etc</td>
65
66      <td id="flexible">Developer&nbsp;documentation</td>
67    </tr>
68  </table>
69
70</div>
71
72<div id="secondary_navbar">
73
74<a href="str_size.html">&lt;&lt;prev file</a> | <a href="strkeywd.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="string2struct.html" target="_TOP">view single page</a> | <a href="./../../index.html" target="_TOP">view frames</a>&nbsp;&nbsp;&nbsp;&nbsp;summary: fields | <a href="#routine_summary">routine</a>&nbsp;&nbsp;&nbsp;&nbsp;details: <a href="#routine_details">routine</a>
75
76</div>
77
78
79    <div id="container">
80
81      <h1 class="directory"><a href="directory-overview.html">ToBeReviewed/STRING/</a></h1>
82      <h2 class="pro_file">string2struct.pro</h2>
83
84      <div id="file_attr">
85        <dl>
86        </dl>
87      </div>
88
89      <div id="file_comments">
90 This is a really, really cool way to turn keywords into
91 a structure.
92 
93
94 Takes an input string set up as keywords and returns an anonymous structure.
95 This is particularly useful for taking keywords entered by a user in a text
96 field and passing then to other routines.
97</div>
98
99     
100
101     
102
103     
104
105     
106      <div id="routine_summary">               
107        <h2>Routine summary</h2>
108       
109        <dl>
110         
111          <dt><p><a href="#_too_cool"><span class="result">result = </span>too_cool(_extra=<span class="result">_extra</span>)</a></p><dt>
112          <dd></dd>     
113         
114          <dt><p><a href="#_string2struct"><span class="result">result = </span>string2struct(<span class="result">strVal</span>)</a></p><dt>
115          <dd> </dd>   
116               
117        </dl>
118      </div>
119     
120
121      <div id="routine_details">
122       
123
124        <div class="routine_details" id="_too_cool">
125
126          <h2><a class="top" href="#container">top</a>too_cool <span class="categories">
127
128</span></h2>
129       
130          <p class="header">
131            <span class="result">result = </span>too_cool(<a href="#_too_cool_keyword__extra">_extra</a>=<span class="result">_extra</span>)</p>
132       
133          <div class="comments"></div>
134
135          <h3>Return value</h3><div class="preformat">
136
137</div>
138
139         
140
141         
142
143            <h3>Keywords</h3>
144           
145            <h4 id="_too_cool_keyword__extra">_extra&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
146             
147             
148             
149             
150             
151             
152             
153             
154            </h4>
155       
156            <div class="comments">
157 used to pass your keywords
158</div>
159           
160         
161
162          <h3>Examples</h3><div class="preformat">
163
164</div>
165          <h3>Version history</h3>
166         
167          <h4>Version</h4><div class="preformat">
168 $Id: string2struct.pro 157 2006-08-21 09:01:50Z navarro $</div>
169          <h4>History</h4><div class="preformat">
170
171</div>
172         
173         
174          <h3>Known issues</h3>
175         
176         
177         
178          <h4>Restrictions</h4><div class="preformat">
179
180</div>
181       
182         
183         
184         
185         
186         
187         
188         
189       
190          <h3>Statistics</h3>
191          <table class="statistics">
192            <tr><td>McCabe cyclic</td><td>           1</td></tr>
193            <tr><td>McCabe essential</td><td>           1</td></tr>
194            <tr><td>McCabe modular design</td><td>           1</td></tr>
195          </table>
196         
197       
198        </div>
199       
200
201        <div class="routine_details" id="_string2struct">
202
203          <h2><a class="top" href="#container">top</a>string2struct <span class="categories">
204 Utilities
205</span></h2>
206       
207          <p class="header">
208            <span class="result">result = </span>string2struct(<span class="result"><a href="#_string2struct_param_strVal">strVal</a></span>)</p>
209       
210          <div class="comments">
211</div>
212
213          <h3>Return value</h3><div class="preformat"> 
214 This function returns the string as an anonymous structure. If an
215 error was found then this function returns a structure with a null field.
216</div>
217
218         
219            <h3>Parameters</h3>
220       
221           
222            <h4 id="_string2struct_param_strVal">strVal&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
223              <span class="attr">in</span>
224             
225             
226              <span class="attr">required</span>
227             
228             
229             
230             
231            </h4>
232       
233          <div class="comments">
234 String set up as keywords. Keywords require a little special treatment. Such as
235 plot,findgen(100),_extra=stringToStructure('title="testing"')
236</div>
237           
238
239         
240
241         
242
243          <h3>Examples</h3><div class="preformat">
244       The code below creates a widget that uses this routine.
245       pro tPlot,event
246       widget_control,event.top,get_uvalue=field
247       widget_control,field,get_value=strVal
248       extra = stringToStructure(strVal)
249       plot,findgen(100),_extra=extra
250       wshow
251       return
252       end
253
254       pro testWid
255       ;enter any keyword to plot and see how it works
256       base = widget_base(/col)
257       field = cw_field(base,title='test',value='ax=0',/string)
258       void = widget_button(base,value='plot',event_pro='tPlot')
259       widget_control,base,/realize,set_uvalue=field
260       xmanager,'testWid',base,/no_block
261       return
262       end
263</div>
264          <h3>Version history</h3>
265         
266          <h4>Version</h4><div class="preformat">
267 $Id: string2struct.pro 157 2006-08-21 09:01:50Z navarro $
268</div>
269          <h4>History</h4><div class="preformat">
270       Written by:
271       RLK, Ronn Kling Consulting.
272       ronn@rlkling.com
273       www.rlkling.com
274               May, 1999
275</div>
276         
277         
278         
279         
280         
281         
282         
283       
284         
285         
286         
287         
288         
289         
290         
291       
292          <h3>Statistics</h3>
293          <table class="statistics">
294            <tr><td>McCabe cyclic</td><td>           2</td></tr>
295            <tr><td>McCabe essential</td><td>           1</td></tr>
296            <tr><td>McCabe modular design</td><td>           1</td></tr>
297          </table>
298         
299       
300        </div>
301       
302      </div>
303
304     
305
306      <div id="tagline">Produced by IDLdoc 2.0.</div>
307
308    </div>
309
310  </body>
311</html>
Note: See TracBrowser for help on using the repository browser.