source: trunk/SRC/Documentation/idldoc_assistant_output/ToBeReviewed/WIDGET/xnotice.html @ 338

Last change on this file since 338 was 338, checked in by smasson, 16 years ago

update documentation

File size: 3.5 KB
Line 
1
2
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4  <head>
5    <title>xnotice.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="slec.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="xquestion.html"><img src="./../../next.gif" border="0" alt="Next"></a></td>
53  </tr>
54</table>
55
56
57    <h1><font size="-2">ToBeReviewed/WIDGET/</font></h1>
58    <h2>xnotice.pro</h2>
59
60    <dl>
61    </dl>
62
63   
64 Create a widget with some text at the middle of the window
65
66
67   
68
69     
70      <a name="#_xnotice"></a>
71
72      <h2>xnotice  <font size="-1" color="#006633">
73 Information
74</font></h2>
75
76      <p><font face="Courier"><i>result = </i>xnotice(<i><a href="#_xnotice_keyword_text">text</a></i>, <a href="#_xnotice_keyword_CHKWIDGET">CHKWIDGET</a>=<i>CHKWIDGET</i>)</font></p>
77
78   
79
80
81    <h3>Return value</h3>
82 The identity of the created widget
83
84
85   
86    <h3>Parameters</h3>
87   
88
89    <a name="#_xnotice_keyword_text"></a>
90    <h4>text&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
91      <font size="-1" color="#006633">in</font>
92     
93     
94      <font size="-1" color="#006633">required</font>
95     
96      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>string vector or scalar</i></font>
97     
98     
99    </h4>
100
101   
102 it is a string or a vector of string. If it is a scalar, we
103 look for the line separator !C to create a text with several lines.
104
105   
106   
107
108   
109    <h3>Keywords</h3>
110
111   
112    <a name="#_xnotice_keyword_CHKWIDGET"></a>
113    <h4>CHKWIDGET&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
114     
115     
116     
117     
118     
119     
120     
121     
122    </h4>
123
124   
125 Force to verify that they are some active widget to create a widget,
126 otherwise print at the prompt
127
128   
129   
130
131    <h3>Examples</h3><pre>
132    IDL> id=xnotice('ca marche !C ou pas?')
133    IDL> widget_control, id, /destroy
134
135    </pre><h3>Version history</h3>
136   
137    <h4>Version</h4>
138 $Id: xnotice.pro 327 2007-12-13 16:22:35Z pinsard $
139
140    <h4>History</h4>
141 Sebastien Masson (smasson@lodyc.jussieu.fr)
142                      2000 3 17
143
144   
145
146    <h3>Known issues</h3>
147   
148   
149   
150    <h4>Restrictions</h4>
151 It do not call xmanager -> It do not create any event!
152 We have to delete this widget manually:
153 widget_control, widgetid, /destroy
154
155
156   
157   
158   
159   
160   
161   
162   
163
164    <font size="-3"><p>&nbsp;</p></font>
165    <hr size="1" color="#CCCCCC"/>
166     
167
168   
169
170    <p><font color="gray" size="-3">&nbsp;&nbsp;Produced by IDLdoc 2.0.</font></p>
171
172  </body>
173</html>
Note: See TracBrowser for help on using the repository browser.