source: trunk/SRC/Documentation/idldoc_assistant_output/ToBeReviewed/STRING/string2struct.html @ 163

Last change on this file since 163 was 163, checked in by navarro, 18 years ago

header improvements : type of parameters and keywords, default values, spell checking + idldoc assistant (IDL online_help)
File size: 5.0 KB
Line 
1
2
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4  <head>
5    <title>string2struct.pro (SAXO Documentation Assistant)</title>
6  </head>
7
8  <body text="#000000" bgcolor="#FFFFFF">
9
10   
11<!-- Navbar template takes a structure with the following fields:
12       overview_href :
13       overview_selected :
14       dir_overview_href :
15       dir_overview_selected :
16       categories_href :
17       categories_selected :
18       index_href :
19       index_selected :
20       search_href :
21       search_selected :
22       file_selected :
23       source_href :
24       source_selected :
25       help_href :
26       help_selected :
27       etc_selected :
28
29       prev_file_href :
30       next_file_href :
31
32       view_single_page_href :
33       view_frames_href :
34
35       summary_fields_href :
36       summary_routine_href :
37       details_routine_href :
38
39       title :
40       subtitle :
41       user :
42-->
43
44
45<table border="0" cellpadding="0" cellspacing="0" width="98%" bgcolor="#F0F0FF" valign="bottom">
46  <tr>
47    <td width="10%">
48<a href="str_size.html"><img src="./../../prev.gif" border="0" alt="Previous"></a></td>
49    <td width="80%" align="center" valign="center">
50<font size=-1><i>SAXO Documentation Assistant</i>: <a href="./../../home.html">Overview</a></font></td>
51    <td width="10%" align="right">
52<a href="strkeywd.html"><img src="./../../next.gif" border="0" alt="Next"></a></td>
53  </tr>
54</table>
55
56
57    <h1><font size="-2">ToBeReviewed/STRING/</font></h1>
58    <h2>string2struct.pro</h2>
59
60    <dl>
61    </dl>
62
63   
64 This is a really, really cool way to turn keywords into
65 a structure.
66 
67
68 Takes an input string set up as keywords and returns an anonymous structure.
69 This is particularly useful for taking keywords entered by a user in a text
70 field and passing then to other routines.
71
72
73   
74    <h2>Routine summary</h2>
75
76    <dl>
77     
78      <dt><a href="#_too_cool"><i>result = </i>too_cool(_extra=<i>_extra</i>)</a><dt>
79      <dd><font size="-1"></font></dd>
80     
81      <dt><a href="#_string2struct"><i>result = </i>string2struct(<i>strVal</i>)</a><dt>
82      <dd><font size="-1"> </font></dd>
83     
84    </dl>
85
86    <p>&nbsp;</p>
87   
88
89     
90      <a name="#_too_cool"></a>
91
92      <h2>too_cool  <font size="-1" color="#006633">
93
94</font></h2>
95
96      <p><font face="Courier"><i>result = </i>too_cool(<a href="#_too_cool_keyword__extra">_extra</a>=<i>_extra</i>)</font></p>
97
98   
99
100    <h3>Return value</h3>
101
102
103
104   
105
106   
107    <h3>Keywords</h3>
108
109   
110    <a name="#_too_cool_keyword__extra"></a>
111    <h4>_extra&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
112     
113     
114     
115     
116     
117     
118     
119     
120    </h4>
121
122   
123 used to pass your keywords
124
125   
126   
127
128    <h3>Examples</h3>
129
130
131    <h3>Version history</h3>
132   
133    <h4>Version</h4>
134 $Id: string2struct.pro 157 2006-08-21 09:01:50Z navarro $
135    <h4>History</h4>
136
137
138   
139
140    <h3>Known issues</h3>
141   
142   
143   
144    <h4>Restrictions</h4>
145
146
147
148   
149   
150   
151   
152   
153   
154   
155
156    <font size="-3"><p>&nbsp;</p></font>
157    <hr size="1" color="#CCCCCC"/>
158     
159      <a name="#_string2struct"></a>
160
161      <h2>string2struct  <font size="-1" color="#006633">
162 Utilities
163</font></h2>
164
165      <p><font face="Courier"><i>result = </i>string2struct(<i><a href="#_string2struct_keyword_strVal">strVal</a></i>)</font></p>
166
167   
168
169
170    <h3>Return value</h3> 
171 This function returns the string as an anonymous structure. If an
172 error was found then this function returns a structure with a null field.
173
174
175   
176    <h3>Parameters</h3>
177   
178
179    <a name="#_string2struct_keyword_strVal"></a>
180    <h4>strVal&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
181      <font size="-1" color="#006633">in</font>
182     
183     
184      <font size="-1" color="#006633">required</font>
185     
186     
187     
188     
189    </h4>
190
191   
192 String set up as keywords. Keywords require a little special treatment. Such as
193 plot,findgen(100),_extra=stringToStructure('title="testing"')
194
195   
196   
197
198   
199
200    <h3>Examples</h3>
201       The code below creates a widget that uses this routine.
202       pro tPlot,event
203       widget_control,event.top,get_uvalue=field
204       widget_control,field,get_value=strVal
205       extra = stringToStructure(strVal)
206       plot,findgen(100),_extra=extra
207       wshow
208       return
209       end
210
211       pro testWid
212       ;enter any keyword to plot and see how it works
213       base = widget_base(/col)
214       field = cw_field(base,title='test',value='ax=0',/string)
215       void = widget_button(base,value='plot',event_pro='tPlot')
216       widget_control,base,/realize,set_uvalue=field
217       xmanager,'testWid',base,/no_block
218       return
219       end
220
221    <h3>Version history</h3>
222   
223    <h4>Version</h4>
224 $Id: string2struct.pro 157 2006-08-21 09:01:50Z navarro $
225
226    <h4>History</h4>
227       Written by:
228       RLK, Ronn Kling Consulting.
229       ronn@rlkling.com
230       www.rlkling.com
231               May, 1999
232
233   
234
235   
236   
237   
238   
239   
240
241   
242   
243   
244   
245   
246   
247   
248
249    <font size="-3"><p>&nbsp;</p></font>
250    <hr size="1" color="#CCCCCC"/>
251     
252
253   
254
255    <p><font color="gray" size="-3">&nbsp;&nbsp;Produced by IDLdoc 2.0 on Tue Aug 29 14:50:31 2006.</font></p>
256
257  </body>
258</html>
Note: See TracBrowser for help on using the repository browser.