ITK Function Reference
(V10000.1.0.60_20160308.00)
prop.h
Go to the documentation of this file.
1 /*==============================================================================
2  Copyright (c) 2003-2005 UGS Corporation
3  Unpublished - All Rights Reserved
4  ==============================================================================*/
5 
12 /* */
13 
14 #ifndef PROP_H
15 #define PROP_H
16 
17 #include <pom/pom/pom_tokens.h>
18 #include <unidefs.h>
19 #include <property/propdesc.h>
20 #include <property/prop_msg.h>
21 #include <property/libproperty_exports.h>
22 
30 #define PROP_NAME_DISPLAY_PREF "PROP_Show_Actual_Names"
31 
32 #define PROP_DISPLAY_PRESENTATION_NAMES 1
33 #define PROP_DISPLAY_ACTUAL_NAMES 2
34 
35 #ifdef __cplusplus
36  extern "C"{
37 #endif
38 
45 extern PROPERTY_API int PROP_list_properties(
46  tag_t object_tag,
47  int* num,
48  tag_t** prop_tags
49  );
50 
59 extern PROPERTY_API int PROP_ask_property_by_name(
60  tag_t object_tag,
61  const char* prop_name,
62  tag_t* prop_tag
63  );
64 
73 extern PROPERTY_API int PROP_set_value_string(
74  tag_t prop_tag,
75  const char* value
76  );
77 
87 extern PROPERTY_API int PROP_set_value_strings(
88  tag_t prop_tag,
89  int num,
90  char** values
94  );
95 
105 extern PROPERTY_API int PROP_set_value_string_at(
106  tag_t prop_tag,
107  int position,
111  const char* value
112  );
113 
122 extern PROPERTY_API int PROP_ask_value_string(
123  tag_t prop_tag,
124  char** value
125  );
126 
136 extern PROPERTY_API int PROP_ask_value_strings(
137  tag_t prop_tag,
138  int* num,
139  char*** values
143  );
144 
155 extern PROPERTY_API int PROP_ask_value_string_at(
156  tag_t prop_tag,
157  int position,
161  char** value
162  );
163 
172 extern PROPERTY_API int PROP_set_value_date(
173  tag_t prop_tag,
174  date_t value
175  );
176 
186 extern PROPERTY_API int PROP_set_value_dates(
187  tag_t prop_tag,
188  int num,
189  const date_t* values
193  );
194 
204 extern PROPERTY_API int PROP_set_value_date_at(
205  tag_t prop_tag,
206  int position,
210  date_t value
211  );
212 
221 extern PROPERTY_API int PROP_set_value_double(
222  tag_t prop_tag,
223  double value
224  );
225 
235 extern PROPERTY_API int PROP_set_value_doubles(
236  tag_t prop_tag,
237  int num,
238  const double* values
242  );
243 
253 extern PROPERTY_API int PROP_set_value_double_at(
254  tag_t prop_tag,
255  int position,
259  double value
260  );
261 
270 extern PROPERTY_API int PROP_set_value_int(
271  tag_t prop_tag,
272  int value
273  );
274 
284 extern PROPERTY_API int PROP_set_value_ints(
285  tag_t prop_tag,
286  int num,
287  const int* values
291  );
292 
302 extern PROPERTY_API int PROP_set_value_int_at(
303  tag_t prop_tag,
304  int position,
308  int value
309  );
310 
319 extern PROPERTY_API int PROP_set_value_logical(
320  tag_t prop_tag,
321  logical value
322  );
323 
333 extern PROPERTY_API int PROP_set_value_logicals(
334  tag_t prop_tag,
335  int num,
336  const logical* values
340  );
341 
351 extern PROPERTY_API int PROP_set_value_logical_at(
352  tag_t prop_tag,
353  int position,
357  logical value
358  );
359 
368 extern PROPERTY_API int PROP_set_value_tag(
369  tag_t prop_tag,
370  tag_t value
371  );
372 
382 extern PROPERTY_API int PROP_set_value_tags(
383  tag_t prop_tag,
384  int num,
385  const tag_t* values
389  );
390 
400 extern PROPERTY_API int PROP_set_value_tag_at(
401  tag_t prop_tag,
402  int position,
406  tag_t value
407  );
408 
417 extern PROPERTY_API int PROP_set_value_char(
418  tag_t prop_tag,
419  char value
420  );
421 
431 extern PROPERTY_API int PROP_set_value_chars(
432  tag_t prop_tag,
433  int num,
434  const char* values
438  );
439 
449 extern PROPERTY_API int PROP_set_value_char_at(
450  tag_t prop_tag,
451  int position,
455  char value
456  );
457 
466 extern PROPERTY_API int PROP_ask_value_date(
467  tag_t prop_tag,
468  date_t* value
469  );
470 
480 extern PROPERTY_API int PROP_ask_value_dates(
481  tag_t prop_tag,
482  int* num,
483  date_t** values
487  );
488 
499 extern PROPERTY_API int PROP_ask_value_date_at(
500  tag_t prop_tag,
501  int position,
505  date_t* value
506  );
507 
516 extern PROPERTY_API int PROP_ask_value_double(
517  tag_t prop_tag,
518  double* value
519  );
520 
529 extern PROPERTY_API int PROP_ask_value_doubles(
530  tag_t prop_tag,
531  int* num,
532  double** values
536  );
537 
548 extern PROPERTY_API int PROP_ask_value_double_at(
549  tag_t prop_tag,
550  int position,
554  double* value
555  );
556 
565 extern PROPERTY_API int PROP_ask_value_int(
566  tag_t prop_tag,
567  int* value
568  );
569 
578 extern PROPERTY_API int PROP_ask_value_ints(
579  tag_t prop_tag,
580  int* num,
581  int** values
585  );
586 
597 extern PROPERTY_API int PROP_ask_value_int_at(
598  tag_t prop_tag,
599  int position,
603  int* value
604  );
605 
614 extern PROPERTY_API int PROP_ask_value_logical(
615  tag_t prop_tag,
616  logical* value
617  );
618 
627 extern PROPERTY_API int PROP_ask_value_logicals(
628  tag_t prop_tag,
629  int* num,
630  logical** values
634  );
635 
646 extern PROPERTY_API int PROP_ask_value_logical_at(
647  tag_t prop_tag,
648  int position,
652  logical* value
653  );
654 
663 extern PROPERTY_API int PROP_ask_value_tag(
664  tag_t prop_tag,
665  tag_t* value
666  );
667 
676 extern PROPERTY_API int PROP_ask_value_tags(
677  tag_t prop_tag,
678  int* num,
679  tag_t** values
683  );
684 
695 extern PROPERTY_API int PROP_ask_value_tag_at(
696  tag_t prop_tag,
697  int position,
701  tag_t* value
702  );
703 
712 extern PROPERTY_API int PROP_ask_value_char(
713  tag_t prop_tag,
714  char* value
715  );
716 
725 extern PROPERTY_API int PROP_ask_value_chars(
726  tag_t prop_tag,
727  int* num,
728  char** values
732  );
733 
744 extern PROPERTY_API int PROP_ask_value_char_at(
745  tag_t prop_tag,
746  int position,
750  char* value
751  );
752 
758 extern PROPERTY_API int PROP_ask_owning_object(
759  tag_t prop_tag,
760  tag_t* obj_tag
761  );
762 
772 extern PROPERTY_API int PROP_ask_num_elements(
773  tag_t prop_tag,
774  int* num_elem
775  );
776 
786 extern PROPERTY_API int PROP_is_modifiable(
787  tag_t prop_tag,
788  logical* mod_flag
790  );
791 
798 extern PROPERTY_API int PROP_ask_descriptor(
799  tag_t prop_tag,
800  tag_t* prop_desc_tag
801  );
802 
811 extern PROPERTY_API int PROP_ask_lov(
812  tag_t prop_tag,
813  tag_t* lov_tag
814  );
815 
828 extern PROPERTY_API int PROP_ask_name(
829  tag_t prop_tag,
830  char** name
831  );
832 
836 extern PROPERTY_API int PROP_ask_object_type(
837  tag_t prop_tag,
838  tag_t* type_tag
839  );
840 
848 extern PROPERTY_API int PROP_ask_property_type(
849  tag_t prop_tag,
850  PROP_type_t* proptype,
851  char** proptype_n
852  );
853 
861 extern PROPERTY_API int PROP_ask_value_type(
862  tag_t prop_tag,
863  PROP_value_type_t* valtype,
864  char** valtype_n
865  );
866 
873 extern PROPERTY_API int PROP_ask_max_num_elements(
874  tag_t prop_tag,
875  int* maxnumelem
878  );
879 
886 extern PROPERTY_API int PROP_ask_max_string_length(
887  tag_t prop_tag,
888  int* maxstrlen
889  );
890 
907 extern PROPERTY_API int PROP_UIF_ask_property_by_name(
908  tag_t object_tag,
909  const char* disp_name,
910  tag_t* prop_tag
911  );
912 
919 extern PROPERTY_API int PROP_UIF_ask_name(
920  tag_t prop_tag,
921  char** disp_name
922  );
923 
930 extern PROPERTY_API int PROP_UIF_is_displayable(
931  tag_t prop_tag,
932  logical* is_display
934  );
935 
936 extern PROPERTY_API int PROP_UIF_is_enabled(
937  tag_t prop_tag,
938  logical* is_enabled
939  );
940 
968 extern PROPERTY_API int PROP_UIF_ask_value(
969  tag_t prop_tag,
970  char** d_value
971  );
972 
999 extern PROPERTY_API int PROP_UIF_set_value(
1000  tag_t prop_tag,
1001  const char* value
1002  );
1003 
1004 extern PROPERTY_API int PROP_UIF_list_displayable_properties(
1005  tag_t object_tag,
1006  int* num,
1007  tag_t** prop_tags
1008  );
1009 
1010 extern PROPERTY_API int PROP_list_common_modifiable_properties(
1011  int object_count,
1012  tag_t* object_tags,
1013  int* prop_count,
1014  char*** prop_names
1015  );
1016 
1017 extern PROPERTY_API int PROP_is_property_localizable(
1018  tag_t object_tag,
1019  char* prop_name,
1020  logical* is_localizable
1021  );
1022 
1071 extern PROPERTY_API int PROP_ask_composite_property(
1072  tag_t component,
1073  const char* composite_property,
1074  char** value
1075  );
1076 
1093 extern PROPERTY_API int PROP_ask_composite_property_objs(
1094  tag_t component,
1095  const char* composite_property,
1096  int* n_related_components,
1097  tag_t** related_components
1099  );
1100 
1101 
1106 #ifdef __cplusplus
1107 }
1108 #endif
1109 
1110 #include <property/libproperty_undef.h>
1111 
1112 #endif