source: trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/WIDGET/COMPOUND_WIDGET/cw_calendar.html @ 402

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

update documentation
File size: 16.9 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>cw_calendar.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="cw_calendar.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/WIDGET/COMPOUND_WIDGET//cw_calendar.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="cw_bgroup.html">&lt;&lt;prev file</a> | <a href="cw_combobox_pm.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="cw_calendar.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/WIDGET/COMPOUND_WIDGET/</a></h1>
82      <h2 class="pro_file">cw_calendar.pro</h2>
83
84      <div id="file_attr">
85        <dl>
86        </dl>
87      </div>
88
89      <div id="file_comments">
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107</div>
108
109     
110
111     
112
113     
114
115     
116      <div id="routine_summary">               
117        <h2>Routine summary</h2>
118       
119        <dl>
120         
121          <dt><p><a href="#_cw_calendar_set_value">cw_calendar_set_value<span class="result">, id, value</span></a></p><dt>
122          <dd> </dd>   
123         
124          <dt><p><a href="#_cw_calendar_get_value"><span class="result">result = </span>cw_calendar_get_value(<span class="result">id</span>)</a></p><dt>
125          <dd></dd>     
126         
127          <dt><p><a href="#_get_cal_value"><span class="result">result = </span>get_cal_value(<span class="result">id, winfoid</span>)</a></p><dt>
128          <dd></dd>     
129         
130          <dt><p><a href="#_set_cal_combobox">set_cal_combobox<span class="result">, event, casename, date0</span></a></p><dt>
131          <dd></dd>     
132         
133          <dt><p><a href="#_cw_cal_move">cw_cal_move<span class="result">, event, casename</span></a></p><dt>
134          <dd></dd>     
135         
136          <dt><p><a href="#_cw_calendar_event"><span class="result">result = </span>cw_calendar_event(<span class="result">event</span>)</a></p><dt>
137          <dd> </dd>   
138         
139          <dt><p><a href="#_cw_calendar"><span class="result">result = </span>cw_calendar(<span class="result">parent, calendar, jdate0</span>, CALTYPE=<span class="result">CALTYPE</span>, FAKECAL=<span class="result">FAKECAL</span>, UVALUE=<span class="result">UVALUE</span>, UNAME=<span class="result">UNAME</span>, _EXTRA=<span class="result">_EXTRA</span>)</a></p><dt>
140          <dd> </dd>   
141               
142        </dl>
143      </div>
144     
145
146      <div id="routine_details">
147       
148
149        <div class="routine_details" id="_cw_calendar_set_value">
150
151          <h2><a class="top" href="#container">top</a>cw_calendar_set_value <span class="categories">
152 Compound widget
153</span></h2>
154       
155          <p class="header">
156            cw_calendar_set_value<span class="result">, <a href="#_cw_calendar_set_value_param_id">id</a>, <a href="#_cw_calendar_set_value_param_value">value</a></span></p>
157       
158          <div class="comments">
159</div>
160
161          <h3>Return value</h3><div class="preformat">
162</div>
163
164         
165            <h3>Parameters</h3>
166       
167           
168            <h4 id="_cw_calendar_set_value_param_id">id&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
169             
170             
171             
172             
173             
174             
175             
176             
177            </h4>
178       
179          <div class="comments">
180</div>
181           
182            <h4 id="_cw_calendar_set_value_param_value">value&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
183             
184             
185             
186             
187             
188             
189             
190             
191            </h4>
192       
193          <div class="comments">
194 It is the default tick mark value (a floating-point number).
195</div>
196           
197
198         
199
200         
201
202          <h3>Examples</h3><div class="preformat">
203</div>
204          <h3>Version history</h3>
205         
206          <h4>Version</h4><div class="preformat">
207 $Id: cw_calendar.pro 371 2008-08-07 09:32:02Z pinsard $
208</div>
209          <h4>History</h4><div class="preformat">
210</div>
211         
212         
213          <h3>Known issues</h3>
214         
215         
216         
217          <h4>Restrictions</h4><div class="preformat">
218</div>
219       
220          <h3>Other attributes</h3>
221         
222         
223          <h4>Uses routines</h4><div class="preformat">
224</div>
225         
226         
227         
228       
229          <h3>Statistics</h3>
230          <table class="statistics">
231            <tr><td>McCabe cyclic</td><td>           6</td></tr>
232            <tr><td>McCabe essential</td><td>           1</td></tr>
233            <tr><td>McCabe modular design</td><td>           1</td></tr>
234          </table>
235         
236       
237        </div>
238       
239
240        <div class="routine_details" id="_cw_calendar_get_value">
241
242          <h2><a class="top" href="#container">top</a>cw_calendar_get_value <span class="categories">
243 Compound widget
244</span></h2>
245       
246          <p class="header">
247            <span class="result">result = </span>cw_calendar_get_value(<span class="result"><a href="#_cw_calendar_get_value_param_id">id</a></span>)</p>
248       
249          <div class="comments"></div>
250
251          <h3>Return value</h3><div class="preformat">
252</div>
253
254         
255            <h3>Parameters</h3>
256       
257           
258            <h4 id="_cw_calendar_get_value_param_id">id&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
259             
260             
261             
262             
263             
264             
265             
266             
267            </h4>
268       
269          <div class="comments">
270
271</div>
272           
273
274         
275
276         
277
278          <h3>Examples</h3><div class="preformat">
279</div>
280          <h3>Version history</h3>
281         
282          <h4>Version</h4><div class="preformat">
283 $Id: cw_calendar.pro 371 2008-08-07 09:32:02Z pinsard $
284</div>
285          <h4>History</h4><div class="preformat">
286</div>
287         
288         
289          <h3>Known issues</h3>
290         
291         
292         
293          <h4>Restrictions</h4><div class="preformat">
294</div>
295       
296          <h3>Other attributes</h3>
297         
298         
299          <h4>Uses routines</h4><div class="preformat">
300</div>
301         
302         
303         
304       
305          <h3>Statistics</h3>
306          <table class="statistics">
307            <tr><td>McCabe cyclic</td><td>           1</td></tr>
308            <tr><td>McCabe essential</td><td>           1</td></tr>
309            <tr><td>McCabe modular design</td><td>           1</td></tr>
310          </table>
311         
312       
313        </div>
314       
315
316        <div class="routine_details" id="_get_cal_value">
317
318          <h2><a class="top" href="#container">top</a>get_cal_value <span class="categories">
319 Compound widget
320</span></h2>
321       
322          <p class="header">
323            <span class="result">result = </span>get_cal_value(<span class="result"><a href="#_get_cal_value_param_id">id</a>, <a href="#_get_cal_value_param_winfoid">winfoid</a></span>)</p>
324       
325          <div class="comments"></div>
326
327          <h3>Return value</h3><div class="preformat">
328</div>
329
330         
331            <h3>Parameters</h3>
332       
333           
334            <h4 id="_get_cal_value_param_id">id&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
335             
336             
337             
338             
339             
340             
341             
342             
343            </h4>
344       
345          <div class="comments">
346
347</div>
348           
349            <h4 id="_get_cal_value_param_winfoid">winfoid&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
350             
351             
352             
353             
354             
355             
356             
357             
358            </h4>
359       
360          <div class="comments">
361
362</div>
363           
364
365         
366
367         
368
369          <h3>Examples</h3><div class="preformat">
370</div>
371          <h3>Version history</h3>
372         
373          <h4>Version</h4><div class="preformat">
374 $Id: cw_calendar.pro 371 2008-08-07 09:32:02Z pinsard $
375</div>
376          <h4>History</h4><div class="preformat">
377</div>
378         
379         
380          <h3>Known issues</h3>
381         
382         
383         
384          <h4>Restrictions</h4><div class="preformat">
385</div>
386       
387          <h3>Other attributes</h3>
388         
389         
390          <h4>Uses routines</h4><div class="preformat">
391</div>
392         
393         
394         
395       
396          <h3>Statistics</h3>
397          <table class="statistics">
398            <tr><td>McCabe cyclic</td><td>           4</td></tr>
399            <tr><td>McCabe essential</td><td>           1</td></tr>
400            <tr><td>McCabe modular design</td><td>           1</td></tr>
401          </table>
402         
403       
404        </div>
405       
406
407        <div class="routine_details" id="_set_cal_combobox">
408
409          <h2><a class="top" href="#container">top</a>set_cal_combobox <span class="categories">
410 Compound widget
411</span></h2>
412       
413          <p class="header">
414            set_cal_combobox<span class="result">, <a href="#_set_cal_combobox_param_event">event</a>, <a href="#_set_cal_combobox_param_casename">casename</a>, <a href="#_set_cal_combobox_param_date0">date0</a></span></p>
415       
416          <div class="comments"></div>
417
418          <h3>Return value</h3><div class="preformat">
419</div>
420
421         
422            <h3>Parameters</h3>
423       
424           
425            <h4 id="_set_cal_combobox_param_event">event&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
426             
427             
428             
429             
430             
431             
432             
433             
434            </h4>
435       
436          <div class="comments">
437</div>
438           
439            <h4 id="_set_cal_combobox_param_casename">casename&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
440             
441             
442             
443             
444             
445             
446             
447             
448            </h4>
449       
450          <div class="comments">
451</div>
452           
453            <h4 id="_set_cal_combobox_param_date0">date0&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
454             
455             
456             
457             
458             
459             
460             
461             
462            </h4>
463       
464          <div class="comments">
465</div>
466           
467
468         
469
470         
471
472          <h3>Examples</h3><div class="preformat">
473</div>
474          <h3>Version history</h3>
475         
476          <h4>Version</h4><div class="preformat">
477 $Id: cw_calendar.pro 371 2008-08-07 09:32:02Z pinsard $
478</div>
479          <h4>History</h4><div class="preformat">
480</div>
481         
482         
483          <h3>Known issues</h3>
484         
485         
486         
487          <h4>Restrictions</h4><div class="preformat">
488</div>
489       
490          <h3>Other attributes</h3>
491         
492         
493          <h4>Uses routines</h4><div class="preformat">
494</div>
495         
496         
497         
498       
499          <h3>Statistics</h3>
500          <table class="statistics">
501            <tr><td>McCabe cyclic</td><td>          15</td></tr>
502            <tr><td>McCabe essential</td><td>           1</td></tr>
503            <tr><td>McCabe modular design</td><td>           1</td></tr>
504          </table>
505         
506       
507        </div>
508       
509
510        <div class="routine_details" id="_cw_cal_move">
511
512          <h2><a class="top" href="#container">top</a>cw_cal_move <span class="categories">
513 Compound widget
514</span></h2>
515       
516          <p class="header">
517            cw_cal_move<span class="result">, <a href="#_cw_cal_move_param_event">event</a>, <a href="#_cw_cal_move_param_casename">casename</a></span></p>
518       
519          <div class="comments"></div>
520
521          <h3>Return value</h3><div class="preformat">
522</div>
523
524         
525            <h3>Parameters</h3>
526       
527           
528            <h4 id="_cw_cal_move_param_event">event&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
529             
530             
531             
532             
533             
534             
535             
536             
537            </h4>
538       
539          <div class="comments">
540
541</div>
542           
543            <h4 id="_cw_cal_move_param_casename">casename&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
544             
545             
546             
547             
548             
549             
550             
551             
552            </h4>
553       
554          <div class="comments">
555
556</div>
557           
558
559         
560
561         
562
563          <h3>Examples</h3><div class="preformat">
564</div>
565          <h3>Version history</h3>
566         
567          <h4>Version</h4><div class="preformat">
568 $Id: cw_calendar.pro 371 2008-08-07 09:32:02Z pinsard $
569</div>
570          <h4>History</h4><div class="preformat">
571</div>
572         
573         
574          <h3>Known issues</h3>
575         
576         
577         
578          <h4>Restrictions</h4><div class="preformat">
579</div>
580       
581          <h3>Other attributes</h3>
582         
583         
584          <h4>Uses routines</h4><div class="preformat">
585</div>
586         
587         
588         
589       
590          <h3>Statistics</h3>
591          <table class="statistics">
592            <tr><td>McCabe cyclic</td><td>           3</td></tr>
593            <tr><td>McCabe essential</td><td>           1</td></tr>
594            <tr><td>McCabe modular design</td><td>           1</td></tr>
595          </table>
596         
597       
598        </div>
599       
600
601        <div class="routine_details" id="_cw_calendar_event">
602
603          <h2><a class="top" href="#container">top</a>cw_calendar_event <span class="categories">
604 Compound widget
605</span></h2>
606       
607          <p class="header">
608            <span class="result">result = </span>cw_calendar_event(<span class="result"><a href="#_cw_calendar_event_param_event">event</a></span>)</p>
609       
610          <div class="comments">
611</div>
612
613          <h3>Return value</h3><div class="preformat">
614</div>
615
616         
617            <h3>Parameters</h3>
618       
619           
620            <h4 id="_cw_calendar_event_param_event">event&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
621             
622             
623             
624             
625             
626             
627             
628             
629            </h4>
630       
631          <div class="comments">
632
633</div>
634           
635
636         
637
638         
639
640          <h3>Examples</h3><div class="preformat">
641</div>
642          <h3>Version history</h3>
643         
644          <h4>Version</h4><div class="preformat">
645 $Id: cw_calendar.pro 371 2008-08-07 09:32:02Z pinsard $
646</div>
647          <h4>History</h4><div class="preformat">
648</div>
649         
650         
651          <h3>Known issues</h3>
652         
653         
654         
655          <h4>Restrictions</h4><div class="preformat">
656</div>
657       
658          <h3>Other attributes</h3>
659         
660         
661          <h4>Uses routines</h4><div class="preformat">
662</div>
663         
664         
665         
666       
667          <h3>Statistics</h3>
668          <table class="statistics">
669            <tr><td>McCabe cyclic</td><td>           7</td></tr>
670            <tr><td>McCabe essential</td><td>           1</td></tr>
671            <tr><td>McCabe modular design</td><td>           1</td></tr>
672          </table>
673         
674       
675        </div>
676       
677
678        <div class="routine_details" id="_cw_calendar">
679
680          <h2><a class="top" href="#container">top</a>cw_calendar <span class="categories">
681 Compound widget
682</span></h2>
683       
684          <p class="header">
685            <span class="result">result = </span>cw_calendar(<span class="result"><a href="#_cw_calendar_param_parent">parent</a>, <a href="#_cw_calendar_param_calendar">calendar</a>, <a href="#_cw_calendar_param_jdate0">jdate0</a></span>, <a href="#_cw_calendar_keyword_CALTYPE">CALTYPE</a>=<span class="result">CALTYPE</span>, <a href="#_cw_calendar_keyword_FAKECAL">FAKECAL</a>=<span class="result">FAKECAL</span>, <a href="#_cw_calendar_keyword_UVALUE">UVALUE</a>=<span class="result">UVALUE</span>, <a href="#_cw_calendar_keyword_UNAME">UNAME</a>=<span class="result">UNAME</span>, <a href="#_cw_calendar_keyword__EXTRA">_EXTRA</a>=<span class="result">_EXTRA</span>)</p>
686       
687          <div class="comments">
688</div>
689
690          <h3>Return value</h3><div class="preformat">
691</div>
692
693         
694            <h3>Parameters</h3>
695       
696           
697            <h4 id="_cw_calendar_param_parent">parent&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
698              <span class="attr">in</span>
699             
700             
701              <span class="attr">required</span>
702             
703             
704             
705             
706            </h4>
707       
708          <div class="comments">
709 The widget ID of the parent widget.
710</div>
711           
712            <h4 id="_cw_calendar_param_calendar">calendar&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
713             
714             
715             
716             
717             
718             
719             
720             
721            </h4>
722       
723          <div class="comments">
724
725</div>
726           
727            <h4 id="_cw_calendar_param_jdate0">jdate0&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
728             
729             
730             
731             
732             
733             
734             
735             
736            </h4>
737       
738          <div class="comments">
739</div>
740           
741
742         
743
744         
745
746            <h3>Keywords</h3>
747           
748            <h4 id="_cw_calendar_keyword_CALTYPE">CALTYPE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
749             
750             
751             
752             
753             
754             
755             
756             
757            </h4>
758       
759            <div class="comments">
760</div>
761           
762            <h4 id="_cw_calendar_keyword_FAKECAL">FAKECAL&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
763             
764             
765             
766             
767             
768             
769             
770             
771            </h4>
772       
773            <div class="comments">
774
775</div>
776           
777            <h4 id="_cw_calendar_keyword_UVALUE">UVALUE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
778             
779             
780             
781             
782             
783             
784             
785             
786            </h4>
787       
788            <div class="comments">
789</div>
790           
791            <h4 id="_cw_calendar_keyword_UNAME">UNAME&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
792             
793             
794             
795             
796             
797             
798             
799             
800            </h4>
801       
802            <div class="comments">
803
804</div>
805           
806            <h4 id="_cw_calendar_keyword__EXTRA">_EXTRA&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
807             
808             
809             
810             
811             
812             
813             
814             
815            </h4>
816       
817            <div class="comments">
818 Used to pass keywords
819</div>
820           
821         
822
823          <h3>Examples</h3><div class="preformat">
824</div>
825          <h3>Version history</h3>
826         
827          <h4>Version</h4><div class="preformat">
828 $Id: cw_calendar.pro 371 2008-08-07 09:32:02Z pinsard $
829</div>
830          <h4>History</h4><div class="preformat">
831</div>
832         
833         
834          <h3>Known issues</h3>
835         
836         
837          <h4>Todo items</h4><div class="preformat">
838 seb
839</div>
840          <h4>Restrictions</h4><div class="preformat">
841</div>
842       
843          <h3>Other attributes</h3>
844         
845         
846          <h4>Uses routines</h4><div class="preformat">
847</div>
848         
849         
850         
851       
852          <h3>Statistics</h3>
853          <table class="statistics">
854            <tr><td>McCabe cyclic</td><td>          13</td></tr>
855            <tr><td>McCabe essential</td><td>           1</td></tr>
856            <tr><td>McCabe modular design</td><td>           1</td></tr>
857          </table>
858         
859       
860        </div>
861       
862      </div>
863
864     
865
866      <div id="tagline">Produced by IDLdoc 2.0.</div>
867
868    </div>
869
870  </body>
871</html>
Note: See TracBrowser for help on using the repository browser.