source: trunk/SRC/Documentation/idldoc_assistant_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: 12.3 KB
RevLine 
[163]1
2
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4  <head>
5    <title>cw_calendar.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="cw_bgroup.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="cw_combobox_pm.html"><img src="./../../../next.gif" border="0" alt="Next"></a></td>
53  </tr>
54</table>
55
56
57    <h1><font size="-2">ToBeReviewed/WIDGET/COMPOUND_WIDGET/</font></h1>
58    <h2>cw_calendar.pro</h2>
59
60    <dl>
61    </dl>
62
63   
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83   
84    <h2>Routine summary</h2>
85
86    <dl>
87     
88      <dt><a href="#_cw_calendar_set_value">cw_calendar_set_value<i>, id, value</i></a><dt>
[234]89      <dd><font size="-1"> </font></dd>
[163]90     
91      <dt><a href="#_cw_calendar_get_value"><i>result = </i>cw_calendar_get_value(<i>id</i>)</a><dt>
92      <dd><font size="-1"></font></dd>
93     
94      <dt><a href="#_get_cal_value"><i>result = </i>get_cal_value(<i>id, winfoid</i>)</a><dt>
95      <dd><font size="-1"></font></dd>
96     
97      <dt><a href="#_set_cal_combobox">set_cal_combobox<i>, event, casename, date0</i></a><dt>
98      <dd><font size="-1"></font></dd>
99     
[290]100      <dt><a href="#_cw_cal_move">cw_cal_move<i>, event, casename</i></a><dt>
[163]101      <dd><font size="-1"></font></dd>
102     
103      <dt><a href="#_cw_calendar_event"><i>result = </i>cw_calendar_event(<i>event</i>)</a><dt>
[338]104      <dd><font size="-1"> </font></dd>
[163]105     
[234]106      <dt><a href="#_cw_calendar"><i>result = </i>cw_calendar(<i>parent, calendar, jdate0</i>, CALTYPE=<i>CALTYPE</i>, FAKECAL=<i>FAKECAL</i>, UVALUE=<i>UVALUE</i>, UNAME=<i>UNAME</i>, _EXTRA=<i>_EXTRA</i>)</a><dt>
[338]107      <dd><font size="-1"> </font></dd>
[163]108     
109    </dl>
110
111    <p>&nbsp;</p>
112   
113
114     
115      <a name="#_cw_calendar_set_value"></a>
116
117      <h2>cw_calendar_set_value  <font size="-1" color="#006633">
118 Compound widget
[234]119</font></h2>
[163]120
121      <p><font face="Courier">cw_calendar_set_value<i>, <a href="#_cw_calendar_set_value_keyword_id">id</a>, <a href="#_cw_calendar_set_value_keyword_value">value</a></i></font></p>
122
123   
124
[234]125
[163]126    <h3>Return value</h3>
127
[234]128
[163]129   
130    <h3>Parameters</h3>
131   
132
133    <a name="#_cw_calendar_set_value_keyword_id"></a>
134    <h4>id&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
135     
136     
137     
138     
139     
140     
141     
142     
143    </h4>
144
145   
146
147   
148
149    <a name="#_cw_calendar_set_value_keyword_value"></a>
150    <h4>value&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
151     
152     
153     
154     
155     
156     
157     
158     
159    </h4>
160
161   
162 It is the default tick mark value (a floating-point number).
163
164   
165   
166
167   
168
[234]169    <h3>Examples</h3><pre>
170
171    </pre><h3>Version history</h3>
[163]172   
[234]173    <h4>Version</h4>
[402]174 $Id: cw_calendar.pro 371 2008-08-07 09:32:02Z pinsard $
[338]175
[163]176    <h4>History</h4>
[234]177
[163]178   
179
180    <h3>Known issues</h3>
181   
182   
183   
184    <h4>Restrictions</h4>
185
[234]186
[163]187    <h3>Other attributes</h3>
188   
189   
190    <h4>Uses routines</h4>
[234]191
[163]192   
193   
194   
195
196    <font size="-3"><p>&nbsp;</p></font>
197    <hr size="1" color="#CCCCCC"/>
198     
199      <a name="#_cw_calendar_get_value"></a>
200
201      <h2>cw_calendar_get_value  <font size="-1" color="#006633">
202 Compound widget
[234]203</font></h2>
[163]204
205      <p><font face="Courier"><i>result = </i>cw_calendar_get_value(<i><a href="#_cw_calendar_get_value_keyword_id">id</a></i>)</font></p>
206
207   
208
209    <h3>Return value</h3>
210
[234]211
[163]212   
213    <h3>Parameters</h3>
214   
215
216    <a name="#_cw_calendar_get_value_keyword_id"></a>
217    <h4>id&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
218     
219     
220     
221     
222     
223     
224     
225     
226    </h4>
227
228   
229
230
231   
232   
233
234   
235
[234]236    <h3>Examples</h3><pre>
237
238    </pre><h3>Version history</h3>
[163]239   
[234]240    <h4>Version</h4>
[402]241 $Id: cw_calendar.pro 371 2008-08-07 09:32:02Z pinsard $
[338]242
[163]243    <h4>History</h4>
[234]244
[163]245   
246
247    <h3>Known issues</h3>
248   
249   
250   
251    <h4>Restrictions</h4>
252
[234]253
[163]254    <h3>Other attributes</h3>
255   
256   
257    <h4>Uses routines</h4>
[234]258
[163]259   
260   
261   
262
263    <font size="-3"><p>&nbsp;</p></font>
264    <hr size="1" color="#CCCCCC"/>
265     
266      <a name="#_get_cal_value"></a>
267
268      <h2>get_cal_value  <font size="-1" color="#006633">
269 Compound widget
[234]270</font></h2>
[163]271
272      <p><font face="Courier"><i>result = </i>get_cal_value(<i><a href="#_get_cal_value_keyword_id">id</a>, <a href="#_get_cal_value_keyword_winfoid">winfoid</a></i>)</font></p>
273
274   
275
276    <h3>Return value</h3>
277
[234]278
[163]279   
280    <h3>Parameters</h3>
281   
282
283    <a name="#_get_cal_value_keyword_id"></a>
284    <h4>id&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
285     
286     
287     
288     
289     
290     
291     
292     
293    </h4>
294
295   
296
297
298   
299
300    <a name="#_get_cal_value_keyword_winfoid"></a>
301    <h4>winfoid&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
302     
303     
304     
305     
306     
307     
308     
309     
310    </h4>
311
312   
313
314
315   
316   
317
318   
319
[234]320    <h3>Examples</h3><pre>
321
322    </pre><h3>Version history</h3>
[163]323   
[234]324    <h4>Version</h4>
[402]325 $Id: cw_calendar.pro 371 2008-08-07 09:32:02Z pinsard $
[338]326
[163]327    <h4>History</h4>
[234]328
[163]329   
330
331    <h3>Known issues</h3>
332   
333   
334   
335    <h4>Restrictions</h4>
336
[234]337
[163]338    <h3>Other attributes</h3>
339   
340   
341    <h4>Uses routines</h4>
[234]342
[163]343   
344   
345   
346
347    <font size="-3"><p>&nbsp;</p></font>
348    <hr size="1" color="#CCCCCC"/>
349     
350      <a name="#_set_cal_combobox"></a>
351
352      <h2>set_cal_combobox  <font size="-1" color="#006633">
353 Compound widget
[234]354</font></h2>
[163]355
356      <p><font face="Courier">set_cal_combobox<i>, <a href="#_set_cal_combobox_keyword_event">event</a>, <a href="#_set_cal_combobox_keyword_casename">casename</a>, <a href="#_set_cal_combobox_keyword_date0">date0</a></i></font></p>
357
358   
359
360    <h3>Return value</h3>
361
[234]362
[163]363   
364    <h3>Parameters</h3>
365   
366
367    <a name="#_set_cal_combobox_keyword_event"></a>
368    <h4>event&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
369     
370     
371     
372     
373     
374     
375     
376     
377    </h4>
378
379   
380
381   
382
383    <a name="#_set_cal_combobox_keyword_casename"></a>
384    <h4>casename&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
385     
386     
387     
388     
389     
390     
391     
392     
393    </h4>
394
395   
396
397   
398
399    <a name="#_set_cal_combobox_keyword_date0"></a>
400    <h4>date0&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
401     
402     
403     
404     
405     
406     
407     
408     
409    </h4>
410
411   
412
413   
414   
415
416   
417
[234]418    <h3>Examples</h3><pre>
419
420    </pre><h3>Version history</h3>
[163]421   
[234]422    <h4>Version</h4>
[402]423 $Id: cw_calendar.pro 371 2008-08-07 09:32:02Z pinsard $
[338]424
[163]425    <h4>History</h4>
[234]426
[163]427   
428
429    <h3>Known issues</h3>
430   
431   
432   
[338]433    <h4>Restrictions</h4>
[163]434
[234]435
[163]436    <h3>Other attributes</h3>
437   
438   
439    <h4>Uses routines</h4>
[234]440
[163]441   
442   
443   
444
445    <font size="-3"><p>&nbsp;</p></font>
446    <hr size="1" color="#CCCCCC"/>
447     
[290]448      <a name="#_cw_cal_move"></a>
[163]449
[290]450      <h2>cw_cal_move  <font size="-1" color="#006633">
[163]451 Compound widget
[234]452</font></h2>
[163]453
[290]454      <p><font face="Courier">cw_cal_move<i>, <a href="#_cw_cal_move_keyword_event">event</a>, <a href="#_cw_cal_move_keyword_casename">casename</a></i></font></p>
[163]455
456   
457
458    <h3>Return value</h3>
459
[234]460
[163]461   
462    <h3>Parameters</h3>
463   
464
[290]465    <a name="#_cw_cal_move_keyword_event"></a>
[163]466    <h4>event&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
467     
468     
469     
470     
471     
472     
473     
474     
475    </h4>
476
477   
478
479
480   
481
[290]482    <a name="#_cw_cal_move_keyword_casename"></a>
[163]483    <h4>casename&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
484     
485     
486     
487     
488     
489     
490     
491     
492    </h4>
493
494   
495
496
497   
498   
499
500   
501
[234]502    <h3>Examples</h3><pre>
503
504    </pre><h3>Version history</h3>
[163]505   
[234]506    <h4>Version</h4>
[402]507 $Id: cw_calendar.pro 371 2008-08-07 09:32:02Z pinsard $
[338]508
[163]509    <h4>History</h4>
[234]510
[163]511   
512
513    <h3>Known issues</h3>
514   
515   
516   
517    <h4>Restrictions</h4>
518
[234]519
[163]520    <h3>Other attributes</h3>
521   
522   
523    <h4>Uses routines</h4>
[234]524
[163]525   
526   
527   
528
529    <font size="-3"><p>&nbsp;</p></font>
530    <hr size="1" color="#CCCCCC"/>
531     
532      <a name="#_cw_calendar_event"></a>
533
534      <h2>cw_calendar_event  <font size="-1" color="#006633">
535 Compound widget
[234]536</font></h2>
[163]537
538      <p><font face="Courier"><i>result = </i>cw_calendar_event(<i><a href="#_cw_calendar_event_keyword_event">event</a></i>)</font></p>
539
540   
541
[338]542
[163]543    <h3>Return value</h3>
544
[234]545
[163]546   
547    <h3>Parameters</h3>
548   
549
550    <a name="#_cw_calendar_event_keyword_event"></a>
551    <h4>event&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
552     
553     
554     
555     
556     
557     
558     
559     
560    </h4>
561
562   
563
564
565   
566   
567
568   
569
[234]570    <h3>Examples</h3><pre>
571
572    </pre><h3>Version history</h3>
[163]573   
[234]574    <h4>Version</h4>
[402]575 $Id: cw_calendar.pro 371 2008-08-07 09:32:02Z pinsard $
[338]576
[163]577    <h4>History</h4>
[234]578
[163]579   
580
581    <h3>Known issues</h3>
582   
583   
584   
585    <h4>Restrictions</h4>
586
[234]587
[163]588    <h3>Other attributes</h3>
589   
590   
591    <h4>Uses routines</h4>
[234]592
[163]593   
594   
595   
596
597    <font size="-3"><p>&nbsp;</p></font>
598    <hr size="1" color="#CCCCCC"/>
599     
600      <a name="#_cw_calendar"></a>
601
602      <h2>cw_calendar  <font size="-1" color="#006633">
603 Compound widget
[234]604</font></h2>
[163]605
[234]606      <p><font face="Courier"><i>result = </i>cw_calendar(<i><a href="#_cw_calendar_keyword_parent">parent</a>, <a href="#_cw_calendar_keyword_calendar">calendar</a>, <a href="#_cw_calendar_keyword_jdate0">jdate0</a></i>, <a href="#_cw_calendar_keyword_CALTYPE">CALTYPE</a>=<i>CALTYPE</i>, <a href="#_cw_calendar_keyword_FAKECAL">FAKECAL</a>=<i>FAKECAL</i>, <a href="#_cw_calendar_keyword_UVALUE">UVALUE</a>=<i>UVALUE</i>, <a href="#_cw_calendar_keyword_UNAME">UNAME</a>=<i>UNAME</i>, <a href="#_cw_calendar_keyword__EXTRA">_EXTRA</a>=<i>_EXTRA</i>)</font></p>
[163]607
608   
609
[338]610
[163]611    <h3>Return value</h3>
612
[234]613
[163]614   
615    <h3>Parameters</h3>
616   
617
618    <a name="#_cw_calendar_keyword_parent"></a>
619    <h4>parent&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
620      <font size="-1" color="#006633">in</font>
621     
622     
623      <font size="-1" color="#006633">required</font>
624     
625     
626     
627     
628    </h4>
629
630   
631 The widget ID of the parent widget.
632
633   
634
635    <a name="#_cw_calendar_keyword_calendar"></a>
636    <h4>calendar&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
637     
638     
639     
640     
641     
642     
643     
644     
645    </h4>
646
647   
648
649
650   
651
652    <a name="#_cw_calendar_keyword_jdate0"></a>
653    <h4>jdate0&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
654     
655     
656     
657     
658     
659     
660     
661     
662    </h4>
663
664   
665
666   
667   
668
669   
670    <h3>Keywords</h3>
671
672   
673    <a name="#_cw_calendar_keyword_CALTYPE"></a>
674    <h4>CALTYPE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
675     
676     
677     
678     
679     
680     
681     
682     
683    </h4>
684
685   
[234]686
[163]687   
688    <a name="#_cw_calendar_keyword_FAKECAL"></a>
689    <h4>FAKECAL&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
690     
691     
692     
693     
694     
695     
696     
697     
698    </h4>
699
700   
701
[234]702
[163]703   
704    <a name="#_cw_calendar_keyword_UVALUE"></a>
705    <h4>UVALUE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
706     
707     
708     
709     
710     
711     
712     
713     
714    </h4>
715
716   
717
718   
719    <a name="#_cw_calendar_keyword_UNAME"></a>
720    <h4>UNAME&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
721     
722     
723     
724     
725     
726     
727     
728     
729    </h4>
730
731   
732
[234]733
[163]734   
[234]735    <a name="#_cw_calendar_keyword__EXTRA"></a>
736    <h4>_EXTRA&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
[163]737     
738     
739     
740     
741     
742     
743     
744     
745    </h4>
746
747   
[234]748 Used to pass keywords
749
[163]750   
751   
752
[234]753    <h3>Examples</h3><pre>
754
755    </pre><h3>Version history</h3>
[163]756   
[234]757    <h4>Version</h4>
[402]758 $Id: cw_calendar.pro 371 2008-08-07 09:32:02Z pinsard $
[163]759
760    <h4>History</h4>
[234]761
[163]762   
763
764    <h3>Known issues</h3>
765   
766   
767    <h4>Todo items</h4>
768 seb
[234]769
[163]770    <h4>Restrictions</h4>
771
[234]772
[163]773    <h3>Other attributes</h3>
774   
775   
776    <h4>Uses routines</h4>
[234]777
[163]778   
779   
780   
781
782    <font size="-3"><p>&nbsp;</p></font>
783    <hr size="1" color="#CCCCCC"/>
784     
785
786   
787
[187]788    <p><font color="gray" size="-3">&nbsp;&nbsp;Produced by IDLdoc 2.0.</font></p>
[163]789
790  </body>
[249]791</html>
Note: See TracBrowser for help on using the repository browser.