Context Navigation

SelectMap__define.html @ 69

Last change on this file since 69 was 69, checked in by smasson, 18 years ago
debug + new xxx
Property svn:executable set to ``*
File size: 18.8 KB

Line
1
2
3	<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4	<head>
5	<title>SelectMap__define.pro (IDLdoc API documentation)</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=""><img src="./../../prev.gif" border="0" alt="Previous"></a></td>
49	<td width="80%" align="center" valign="center">
50	<font size=-1><i>IDLdoc API documentation</i>: <a href="./../../home.html">Overview</a></font></td>
51	<td width="10%" align="right">
52	<a href=""><img src="./../../next.gif" border="0" alt="Next"></a></td>
53	</tr>
54	</table>
55
56
57	<h1><font size="-2">Documentation/perldoc_idl/</font></h1>
58	<h2>SelectMap__define.pro</h2>
59
60	<dl>
61	<dt><b>Last modification:</b></dt>
62	<dd>Wed Dec 1 16:27:19 2004</dd>
63	</dl>
64
65
66
67
68	<h2>Routine summary</h2>
69
70	<dl>
71
72	<dt><a href="#_SelectMap__define">SelectMap__define</a><dt>
73	<dd><font size="-1">--------------------------------------------------------------------------- CLASSNAME: SelectMap AUTHOR: </font></dd>
74
75	<dt><a href="#_SelectMap::Init"><i>result = </i>SelectMap::Init(<i>parent</i>, _EXTRA=<i>_EXTRA</i>)</a><dt>
76	<dd><font size="-1">--------------------------------------------------------------------------- NAME: SelectMap::Init DESCRIPTION: Creates an instance of 'SelectMap' class.</font></dd>
77
78	<dt><a href="#_SelectMap::Initialize">SelectMap::Initialize</a><dt>
79	<dd><font size="-1">--------------------------------------------------------------------------- NAME: SelectMap::Initialize DESCRIPTION: Initialize the state of the object.</font></dd>
80
81	<dt><a href="#_SelectMap::Cleanup">SelectMap::Cleanup</a><dt>
82	<dd><font size="-1">--------------------------------------------------------------------------- NAME: SelectMap::Cleanup DESCRIPTION: Free memory used by the object.</font></dd>
83
84	<dt><a href="#_SelectMap::Clear">SelectMap::Clear</a><dt>
85	<dd><font size="-1">--------------------------------------------------------------------------- NAME: SelectMap::Clear DESCRIPTION: Free memory used by the object.</font></dd>
86
87	<dt><a href="#_SelectMap::SetPalette">SelectMap::SetPalette<i>, colors</i></a><dt>
88	<dd><font size="-1">--------------------------------------------------------------------------- NAME: SelectMap::SetPalette DESCRIPTION: Sets a color palette used to show bachground image.</font></dd>
89
90	<dt><a href="#_SelectMap::SetMap">SelectMap::SetMap<i>, data_map</i></a><dt>
91	<dd><font size="-1">--------------------------------------------------------------------------- NAME: SelectMap::SetMap DESCRIPTION: Sets a background image.</font></dd>
92
93	<dt><a href="#_SelectMap::Draw">SelectMap::Draw</a><dt>
94	<dd><font size="-1">--------------------------------------------------------------------------- NAME: SelectMap::Draw DESCRIPTION: Draws the object.</font></dd>
95
96	<dt><a href="#_SelectMap::GetProperty">SelectMap::GetProperty, ID=<i>ID</i></a><dt>
97	<dd><font size="-1">--------------------------------------------------------------------------- NAME: SelectMap::GetProperty DESCRIPTION: Get the the properties of the object.</font></dd>
98
99	<dt><a href="#_SelectMap::SetProperty">SelectMap::SetProperty, SELECTION_TYPE=<i>SELECTION_TYPE</i>, DYNAMIC_SELECTION=<i>DYNAMIC_SELECTION</i>, HIDE_SELECTION=<i>HIDE_SELECTION</i></a><dt>
100	<dd><font size="-1">--------------------------------------------------------------------------- NAME: SelectMap::SetProperty DESCRIPTION: Sets the properties of the object.</font></dd>
101
102	<dt><a href="#_SelectMap::EventHandler">SelectMap::EventHandler<i>, event</i></a><dt>
103	<dd><font size="-1">--------------------------------------------------------------------------- NAME: SelectMap_EventHandler DESCRIPTION: Object's event handler.</font></dd>
104
105	<dt><a href="#_SelectMap::UpdateLineSelection">SelectMap::UpdateLineSelection<i>, event</i>, ALL=<i>ALL</i></a><dt>
106	<dd><font size="-1">--------------------------------------------------------------------------- NAME: SelectMap::UpdateLineSelection DESCRIPTION: Get the actual coordenate points and convert respect the image size.</font></dd>
107
108	<dt><a href="#_SelectMap::UpdateSquareSelection">SelectMap::UpdateSquareSelection<i>, event</i>, ALL=<i>ALL</i></a><dt>
109	<dd><font size="-1">--------------------------------------------------------------------------- NAME: SelectMap::UpdateSquareSelection DESCRIPTION: Get the actual coordenate points and convert respect the image size.</font></dd>
110
111	<dt><a href="#_SelectMap::ConvertValuesW2M"><i>result = </i>SelectMap::ConvertValuesW2M(<i>values</i>)</a><dt>
112	<dd><font size="-1">--------------------------------------------------------------------------- NAME: SelectMap::ConvertValuesW2M DESCRIPTION: Convert a pair of values from widget size relative coordenatos to the image relativa size coordenates.</font></dd>
113
114	</dl>
115
116	<p> </p>
117
118
119
120	<a name="#_SelectMap__define"></a>
121
122	<h2>SelectMap__define </h2>
123
124	<p><font face="Courier">SelectMap__define</font></p>
125
126	---------------------------------------------------------------------------
127	CLASSNAME: SelectMap
128
129	AUTHOR:
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158	<font size="-3"><p> </p></font>
159	<hr size="1" color="#CCCCCC"/>
160
161	<a name="#_SelectMap::Init"></a>
162
163	<h2>SelectMap::Init </h2>
164
165	<p><font face="Courier"><i>result = </i>SelectMap::Init(<i><a href="#_SelectMap::Init_param_parent">parent</a></i>, <a href="#_SelectMap::Init_keyword__EXTRA">_EXTRA</a>=<i>_EXTRA</i>)</font></p>
166
167	---------------------------------------------------------------------------
168	NAME: SelectMap::Init
169
170	DESCRIPTION:
171	Creates an instance of 'SelectMap' class.
172
173	PARAMETERS:
174	parent - Parents widget ID.
175
176	EXTRA PARAMETERS:
177	extra - Extra KEYWORD with options to be passed to the
178	widget_draw.
179
180
181
182
183
184	<h3>Parameters</h3>
185
186
187	<a name="#_SelectMap::Init_keyword_parent"></a>
188	<h4>parent
189
190
191
192
193
194
195
196
197	</h4>
198
199
200
201
202
203
204	<h3>Keywords</h3>
205
206
207	<a name="#_SelectMap::Init_keyword__EXTRA"></a>
208	<h4>_EXTRA
209
210
211
212
213
214
215
216
217	</h4>
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244	<font size="-3"><p> </p></font>
245	<hr size="1" color="#CCCCCC"/>
246
247	<a name="#_SelectMap::Initialize"></a>
248
249	<h2>SelectMap::Initialize </h2>
250
251	<p><font face="Courier">SelectMap::Initialize</font></p>
252
253	---------------------------------------------------------------------------
254	NAME: SelectMap::Initialize
255
256	DESCRIPTION:
257	Initialize the state of the object. If it is executed when the
258	object is running the object's state goes back to the same as
259	the creation state. All possible used memory are free.
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289	<font size="-3"><p> </p></font>
290	<hr size="1" color="#CCCCCC"/>
291
292	<a name="#_SelectMap::Cleanup"></a>
293
294	<h2>SelectMap::Cleanup </h2>
295
296	<p><font face="Courier">SelectMap::Cleanup</font></p>
297
298	---------------------------------------------------------------------------
299	NAME: SelectMap::Cleanup
300
301	DESCRIPTION:
302	Free memory used by the object.
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332	<font size="-3"><p> </p></font>
333	<hr size="1" color="#CCCCCC"/>
334
335	<a name="#_SelectMap::Clear"></a>
336
337	<h2>SelectMap::Clear </h2>
338
339	<p><font face="Courier">SelectMap::Clear</font></p>
340
341	---------------------------------------------------------------------------
342	NAME: SelectMap::Clear
343
344	DESCRIPTION:
345	Free memory used by the object.
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375	<font size="-3"><p> </p></font>
376	<hr size="1" color="#CCCCCC"/>
377
378	<a name="#_SelectMap::SetPalette"></a>
379
380	<h2>SelectMap::SetPalette </h2>
381
382	<p><font face="Courier">SelectMap::SetPalette<i>, <a href="#_SelectMap::SetPalette_param_colors">colors</a></i></font></p>
383
384	---------------------------------------------------------------------------
385	NAME: SelectMap::SetPalette
386
387	DESCRIPTION:
388	Sets a color palette used to show bachground image. Only takes
389	efect if the background image is a X,Y array.
390
391	PARAMETERS:
392	colors - 256x3 array values (RGB).
393
394
395
396
397
398	<h3>Parameters</h3>
399
400
401	<a name="#_SelectMap::SetPalette_keyword_colors"></a>
402	<h4>colors
403
404
405
406
407
408
409
410
411	</h4>
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440	<font size="-3"><p> </p></font>
441	<hr size="1" color="#CCCCCC"/>
442
443	<a name="#_SelectMap::SetMap"></a>
444
445	<h2>SelectMap::SetMap </h2>
446
447	<p><font face="Courier">SelectMap::SetMap<i>, <a href="#_SelectMap::SetMap_param_data_map">data_map</a></i></font></p>
448
449	---------------------------------------------------------------------------
450	NAME: SelectMap::SetMap
451
452	DESCRIPTION:
453	Sets a background image. The image can be a (x,y) array that
454	will be colored with the specified palette or may be a
455	(3,x,y), (x,3,y) or (x,y,3) array (like an 'jpeg' image).
456
457	PARAMETERS:
458	data_map - Array 2D or 3D with the image to show.
459
460
461
462
463
464	<h3>Parameters</h3>
465
466
467	<a name="#_SelectMap::SetMap_keyword_data_map"></a>
468	<h4>data_map
469
470
471
472
473
474
475
476
477	</h4>
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506	<font size="-3"><p> </p></font>
507	<hr size="1" color="#CCCCCC"/>
508
509	<a name="#_SelectMap::Draw"></a>
510
511	<h2>SelectMap::Draw </h2>
512
513	<p><font face="Courier">SelectMap::Draw</font></p>
514
515	---------------------------------------------------------------------------
516	NAME: SelectMap::Draw
517
518	DESCRIPTION:
519	Draws the object.
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549	<font size="-3"><p> </p></font>
550	<hr size="1" color="#CCCCCC"/>
551
552	<a name="#_SelectMap::GetProperty"></a>
553
554	<h2>SelectMap::GetProperty </h2>
555
556	<p><font face="Courier">SelectMap::GetProperty, <a href="#_SelectMap::GetProperty_keyword_ID">ID</a>=<i>ID</i></font></p>
557
558	---------------------------------------------------------------------------
559	NAME: SelectMap::GetProperty
560
561	DESCRIPTION:
562	Get the the properties of the object.
563
564	KEYWORD PARAMETERS:
565	id - ID of the WIDGET_BASE over the object are created.
566
567
568
569
570
571
572
573	<h3>Keywords</h3>
574
575
576	<a name="#_SelectMap::GetProperty_keyword_ID"></a>
577	<h4>ID
578
579
580
581
582
583
584
585
586	</h4>
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613	<font size="-3"><p> </p></font>
614	<hr size="1" color="#CCCCCC"/>
615
616	<a name="#_SelectMap::SetProperty"></a>
617
618	<h2>SelectMap::SetProperty </h2>
619
620	<p><font face="Courier">SelectMap::SetProperty, <a href="#_SelectMap::SetProperty_keyword_SELECTION_TYPE">SELECTION_TYPE</a>=<i>SELECTION_TYPE</i>, <a href="#_SelectMap::SetProperty_keyword_DYNAMIC_SELECTION">DYNAMIC_SELECTION</a>=<i>DYNAMIC_SELECTION</i>, <a href="#_SelectMap::SetProperty_keyword_HIDE_SELECTION">HIDE_SELECTION</a>=<i>HIDE_SELECTION</i></font></p>
621
622	---------------------------------------------------------------------------
623	NAME: SelectMap::SetProperty
624
625	DESCRIPTION:
626	Sets the properties of the object.
627
628	KEYWORD PARAMETERS:
629	hide_selection - Show/hide the selection line.
630	dynamic_selection - If true, SELECTION events are emited while a
631	selecction is doing.
632
633
634
635
636
637
638
639	<h3>Keywords</h3>
640
641
642	<a name="#_SelectMap::SetProperty_keyword_SELECTION_TYPE"></a>
643	<h4>SELECTION_TYPE
644
645
646
647
648
649
650
651
652	</h4>
653
654
655
656	<a name="#_SelectMap::SetProperty_keyword_DYNAMIC_SELECTION"></a>
657	<h4>DYNAMIC_SELECTION
658
659
660
661
662
663
664
665
666	</h4>
667
668
669
670	<a name="#_SelectMap::SetProperty_keyword_HIDE_SELECTION"></a>
671	<h4>HIDE_SELECTION
672
673
674
675
676
677
678
679
680	</h4>
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707	<font size="-3"><p> </p></font>
708	<hr size="1" color="#CCCCCC"/>
709
710	<a name="#_SelectMap::EventHandler"></a>
711
712	<h2>SelectMap::EventHandler </h2>
713
714	<p><font face="Courier">SelectMap::EventHandler<i>, <a href="#_SelectMap::EventHandler_param_event">event</a></i></font></p>
715
716	---------------------------------------------------------------------------
717	NAME: SelectMap_EventHandler
718
719	DESCRIPTION:
720	Object's event handler.
721
722
723
724
725
726	<h3>Parameters</h3>
727
728
729	<a name="#_SelectMap::EventHandler_keyword_event"></a>
730	<h4>event
731
732
733
734
735
736
737
738
739	</h4>
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768	<font size="-3"><p> </p></font>
769	<hr size="1" color="#CCCCCC"/>
770
771	<a name="#_SelectMap::UpdateLineSelection"></a>
772
773	<h2>SelectMap::UpdateLineSelection </h2>
774
775	<p><font face="Courier">SelectMap::UpdateLineSelection<i>, <a href="#_SelectMap::UpdateLineSelection_param_event">event</a></i>, <a href="#_SelectMap::UpdateLineSelection_keyword_ALL">ALL</a>=<i>ALL</i></font></p>
776
777	---------------------------------------------------------------------------
778	NAME: SelectMap::UpdateLineSelection
779
780	DESCRIPTION:
781	Get the actual coordenate points and convert respect the image
782	size.
783
784	KEYWORD PARAMETERS:
785	all - If set specify that the two points (origin, final) of
786	the selection line must to be initialize. If not set,
787	only the final point is converted.
788
789	NOTE: The 0 and 2 points of the square are the initial and final
790	points respectively.
791
792
793
794
795
796	<h3>Parameters</h3>
797
798
799	<a name="#_SelectMap::UpdateLineSelection_keyword_event"></a>
800	<h4>event
801
802
803
804
805
806
807
808
809	</h4>
810
811
812
813
814
815
816	<h3>Keywords</h3>
817
818
819	<a name="#_SelectMap::UpdateLineSelection_keyword_ALL"></a>
820	<h4>ALL
821
822
823
824
825
826
827
828
829	</h4>
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856	<font size="-3"><p> </p></font>
857	<hr size="1" color="#CCCCCC"/>
858
859	<a name="#_SelectMap::UpdateSquareSelection"></a>
860
861	<h2>SelectMap::UpdateSquareSelection </h2>
862
863	<p><font face="Courier">SelectMap::UpdateSquareSelection<i>, <a href="#_SelectMap::UpdateSquareSelection_param_event">event</a></i>, <a href="#_SelectMap::UpdateSquareSelection_keyword_ALL">ALL</a>=<i>ALL</i></font></p>
864
865	---------------------------------------------------------------------------
866	NAME: SelectMap::UpdateSquareSelection
867
868	DESCRIPTION:
869	Get the actual coordenate points and convert respect the image
870	size.
871
872	KEYWORD PARAMETERS:
873	all - If set specify that the two points (origin, final) of
874	the selection line must to be initialize. If not set,
875	only the final point is converted.
876
877	NOTE: The 0 and 2 points of the square are the initial and final
878	points respectively.
879
880
881
882
883
884	<h3>Parameters</h3>
885
886
887	<a name="#_SelectMap::UpdateSquareSelection_keyword_event"></a>
888	<h4>event
889
890
891
892
893
894
895
896
897	</h4>
898
899
900
901
902
903
904	<h3>Keywords</h3>
905
906
907	<a name="#_SelectMap::UpdateSquareSelection_keyword_ALL"></a>
908	<h4>ALL
909
910
911
912
913
914
915
916
917	</h4>
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944	<font size="-3"><p> </p></font>
945	<hr size="1" color="#CCCCCC"/>
946
947	<a name="#_SelectMap::ConvertValuesW2M"></a>
948
949	<h2>SelectMap::ConvertValuesW2M </h2>
950
951	<p><font face="Courier"><i>result = </i>SelectMap::ConvertValuesW2M(<i><a href="#_SelectMap::ConvertValuesW2M_param_values">values</a></i>)</font></p>
952
953	---------------------------------------------------------------------------
954	NAME: SelectMap::ConvertValuesW2M
955
956	DESCRIPTION:
957	Convert a pair of values from widget size relative coordenatos
958	to the image relativa size coordenates.
959
960
961
962
963
964	<h3>Parameters</h3>
965
966
967	<a name="#_SelectMap::ConvertValuesW2M_keyword_values"></a>
968	<h4>values
969
970
971
972
973
974
975
976
977	</h4>
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006	<font size="-3"><p> </p></font>
1007	<hr size="1" color="#CCCCCC"/>
1008
1009
1010
1011
1012	<p><font color="gray" size="-3">  Produced by IDLdoc 2.0 on Thu Mar 23 10:02:35 2006.</font></p>
1013
1014	</body>
1015	</html>

Note: See TracBrowser for help on using the repository browser.

Context Navigation

source: trunk/Documentation/perldoc_idl/SelectMap__define.html @ 69

Download in other formats: