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

Last change on this file since 402 was 402, checked in by smasson, 15 years ago

update documentation
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 a structure.
65
66
67 Takes an input string set up as keywords and returns an anonymous structure.
68 This is particularly useful for taking keywords entered by a user in a text
69 field and passing then to other routines.
70
71
72   
73    <h2>Routine summary</h2>
74
75    <dl>
76     
77      <dt><a href="#_too_cool"><i>result = </i>too_cool(_EXTRA=<i>_EXTRA</i>)</a><dt>
78      <dd><font size="-1"> </font></dd>
79     
80      <dt><a href="#_string2struct"><i>result = </i>string2struct(<i>strval</i>)</a><dt>
81      <dd><font size="-1"> </font></dd>
82     
83    </dl>
84
85    <p>&nbsp;</p>
86   
87
88     
89      <a name="#_too_cool"></a>
90
91      <h2>too_cool  <font size="-1" color="#006633">
92</font></h2>
93
94      <p><font face="Courier"><i>result = </i>too_cool(<a href="#_too_cool_keyword__EXTRA">_EXTRA</a>=<i>_EXTRA</i>)</font></p>
95
96   
97
98
99    <h3>Return value</h3>
100
101
102   
103
104   
105    <h3>Keywords</h3>
106
107   
108    <a name="#_too_cool_keyword__EXTRA"></a>
109    <h4>_EXTRA&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
110     
111     
112     
113     
114     
115     
116     
117     
118    </h4>
119
120   
121 Used to pass keywords
122
123   
124   
125
126    <h3>Examples</h3><pre>
127
128    </pre><h3>Version history</h3>
129   
130    <h4>Version</h4>
131 $Id: string2struct.pro 374 2008-08-08 15:12:27Z pinsard $
132
133    <h4>History</h4>
134
135   
136
137    <h3>Known issues</h3>
138   
139   
140   
141    <h4>Restrictions</h4>
142
143
144   
145   
146   
147   
148   
149   
150   
151
152    <font size="-3"><p>&nbsp;</p></font>
153    <hr size="1" color="#CCCCCC"/>
154     
155      <a name="#_string2struct"></a>
156
157      <h2>string2struct  <font size="-1" color="#006633">
158 Utilities
159</font></h2>
160
161      <p><font face="Courier"><i>result = </i>string2struct(<i><a href="#_string2struct_keyword_strval">strval</a></i>)</font></p>
162
163   
164
165
166    <h3>Return value</h3>
167 This function returns the string as an anonymous structure. If an
168 error was found then this function returns a structure with a null field.
169
170
171   
172    <h3>Parameters</h3>
173   
174
175    <a name="#_string2struct_keyword_strval"></a>
176    <h4>strval&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
177      <font size="-1" color="#006633">in</font>
178     
179     
180      <font size="-1" color="#006633">required</font>
181     
182     
183     
184     
185    </h4>
186
187   
188 String set up as keywords. Keywords require a little special treatment.
189 Such as
190
191 plot,findgen(100),_extra=string2struct('title="testing"')
192
193   
194   
195
196   
197
198    <h3>Examples</h3><pre>
199       The code below creates a widget that uses this routine.
200       pro tPlot,event
201       widget_control,event.top,get_uvalue=field
202       widget_control,field,get_value=strval
203       extra = string2struct(strval)
204       plot,findgen(100),_extra=extra
205       wshow
206       return
207       end
208
209       pro testWid
210       ;enter any keyword to plot and see how it works
211       base = widget_base(/col)
212       field = cw_field(base,title='test',value='ax=0',/string)
213       void = widget_button(base,value='plot',event_pro='tPlot')
214       widget_control,base,/realize,set_uvalue=field
215       xmanager,'testWid',base,/no_block
216       return
217       end
218
219    </pre><h3>Version history</h3>
220   
221    <h4>Version</h4>
222 $Id: string2struct.pro 374 2008-08-08 15:12:27Z pinsard $
223
224    <h4>History</h4>
225       Written by:
226       RLK, Ronn Kling Consulting.
227       ronn@rlkling.com
228       www.rlkling.com
229               May, 1999
230
231   
232
233   
234   
235   
236   
237   
238
239   
240   
241   
242   
243   
244   
245   
246
247    <font size="-3"><p>&nbsp;</p></font>
248    <hr size="1" color="#CCCCCC"/>
249     
250
251   
252
253    <p><font color="gray" size="-3">&nbsp;&nbsp;Produced by IDLdoc 2.0.</font></p>
254
255  </body>
256</html>
Note: See TracBrowser for help on using the repository browser.