source: trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/WIDGET/xnotice.html @ 89

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

add idldoc html output. see Documentation/idldoc_html_output/index.html
File size: 4.1 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>xnotice.pro (IDLdoc API 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="xnotice.pro (IDLdoc API documentation)";
19      }
20    </script>
21  </head>
22
23  <body onload="setTitle();">
24
25    <div id="navbar_title">
26  <h1>IDLdoc API 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?format=raw" title="Overview of library">Overview</a></td>
36     
37
38     
39      <td >Directory</td>
40     
41
42     
43      <td><a href="./../../idldoc-categories.html?format=raw" title="Browse library by category">Categories</a></td>
44     
45
46     
47      <td><a href="./../../idldoc-index.html?format=raw" title="Index of files, routines, and parameters">Index</a></td>
48     
49
50     
51      <td><a href="./../../search-page.html?format=raw" title="Search library">Search</a></td>
52     
53
54      <td id="selected">File</td>
55
56     
57      <td >Source</td>
58     
59
60     
61      <td><a href="./../../idldoc-help.html?format=raw" 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="slec.html">&lt;&lt;prev file</a> | <a href="xquestion.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="xnotice.html" target="_TOP">view single page</a> | <a href="./../../index.html?format=raw" target="_TOP">view frames</a>&nbsp;&nbsp;&nbsp;&nbsp;summary: fields | routine&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?format=raw">ToBeReviewed/WIDGET/</a></h1>
82      <h2 class="pro_file">xnotice.pro</h2>
83
84      <div id="file_attr">
85        <dl>
86        </dl>
87      </div>
88
89      <div id="file_comments"></div>
90
91     
92
93     
94
95     
96
97     
98
99      <div id="routine_details">
100       
101
102        <div class="routine_details" id="_xnotice">
103
104          <h2><a class="top" href="#container">top</a>xnotice </h2>
105       
106          <p class="header">
107            <span class="result">result = </span>xnotice(<span class="result"><a href="#_xnotice_param_text">text</a></span>, <a href="#_xnotice_keyword_CHKWIDGET">CHKWIDGET</a>=<span class="result">CHKWIDGET</span>)</p>
108       
109          <div class="comments">
110 NAME:xnotice
111
112 PURPOSE:cree un widget avec du texte au milieu de la fenetre.
113
114 CATEGORY:information
115
116 CALLING SEQUENCE:widgetid=xnotice(text)
117 
118 INPUTS:text: un string ou un vecteur de string. Si c''est un
119 scalaire on cherche le separateur de ligne !C pour creer un texte a
120 plusieurs lignes.
121
122 KEYWORD PARAMETERS:chkwidget: oblige a verifier qu''il y a des
123 widgets actif pour creer un widget, sinon imprime au prompt
124
125 OUTPUTS:lidentite du widget cree
126
127 COMMON BLOCKS
128
129 SIDE EFFECTS:ne fait pas appelle a xmanager -> ne cree aucun event!
130 il faut detruire ce widget a la main:
131 widget_control, widgetid, /destroy
132
133 RESTRICTIONS:
134
135 EXAMPLE:
136    IDL> id=xnotice('ca marche !C ou pas?')
137    IDL> widget_control, id, /destroy
138</div>
139
140         
141
142         
143            <h3>Parameters</h3>
144       
145           
146            <h4 id="_xnotice_param_text">text&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
147             
148             
149             
150             
151             
152             
153             
154             
155            </h4>
156       
157          <div class="comments"></div>
158           
159
160         
161
162         
163
164            <h3>Keywords</h3>
165           
166            <h4 id="_xnotice_keyword_CHKWIDGET">CHKWIDGET&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
167             
168             
169             
170             
171             
172             
173             
174             
175            </h4>
176       
177            <div class="comments"></div>
178           
179         
180
181         
182         
183         
184         
185         
186         
187         
188         
189         
190         
191         
192         
193       
194         
195         
196         
197         
198         
199         
200         
201       
202         
203       
204        </div>
205       
206      </div>
207
208     
209
210      <div id="tagline">Produced by IDLdoc 2.0.</div>
211
212    </div>
213
214  </body>
215</html>
Note: See TracBrowser for help on using the repository browser.