]> git.sur5r.net Git - glabels/blob - glabels2/docs/libglabels/tmpl/libglabels-unused.sgml
2007-09-27 Jim Evins <evins@snaught.com>
[glabels] / glabels2 / docs / libglabels / tmpl / libglabels-unused.sgml
1 <!-- ##### SECTION ./tmpl/libglabels.sgml:Long_Description ##### -->
2 <para>
3
4 </para>
5
6
7 <!-- ##### SECTION ./tmpl/libglabels.sgml:See_Also ##### -->
8 <para>
9
10 </para>
11
12
13 <!-- ##### SECTION ./tmpl/libglabels.sgml:Short_Description ##### -->
14
15
16
17 <!-- ##### SECTION ./tmpl/libglabels.sgml:Stability_Level ##### -->
18
19
20
21 <!-- ##### SECTION ./tmpl/libglabels.sgml:Title ##### -->
22 libglabels
23
24
25 <!-- ##### MACRO GL_XML_NAME_SPACE ##### -->
26 <para>
27
28 </para>
29
30
31 <!-- ##### STRUCT glCategory ##### -->
32 <para>
33
34 </para>
35
36 @id: 
37 @name: 
38
39 <!-- ##### STRUCT glPaper ##### -->
40 <para>
41
42 </para>
43
44 @id: 
45 @name: 
46 @width: 
47 @height: 
48
49 <!-- ##### STRUCT glTemplate ##### -->
50 <para>
51
52 </para>
53
54 @name: 
55 @description: 
56 @page_size: 
57 @page_width: 
58 @page_height: 
59 @categories: 
60 @frames: 
61 @aliases: 
62
63 <!-- ##### UNION glTemplateFrame ##### -->
64 <para>
65
66 </para>
67
68
69 <!-- ##### STRUCT glTemplateFrameAll ##### -->
70 <para>
71
72 </para>
73
74 @shape: 
75 @id: 
76 @layouts: 
77 @markups: 
78
79 <!-- ##### STRUCT glTemplateFrameCD ##### -->
80 <para>
81
82 </para>
83
84 @shape: 
85 @id: 
86 @layouts: 
87 @markups: 
88 @r1: 
89 @r2: 
90 @w: 
91 @h: 
92 @waste: 
93
94 <!-- ##### STRUCT glTemplateFrameRect ##### -->
95 <para>
96
97 </para>
98
99 @shape: 
100 @id: 
101 @layouts: 
102 @markups: 
103 @w: 
104 @h: 
105 @r: 
106 @x_waste: 
107 @y_waste: 
108
109 <!-- ##### STRUCT glTemplateFrameRound ##### -->
110 <para>
111
112 </para>
113
114 @shape: 
115 @id: 
116 @layouts: 
117 @markups: 
118 @r: 
119 @waste: 
120
121 <!-- ##### ENUM glTemplateFrameShape ##### -->
122 <para>
123
124 </para>
125
126 @GL_TEMPLATE_FRAME_SHAPE_RECT: 
127 @GL_TEMPLATE_FRAME_SHAPE_ROUND: 
128 @GL_TEMPLATE_FRAME_SHAPE_CD: 
129
130 <!-- ##### ENUM glTemplateLabelShape ##### -->
131 <para>
132
133 </para>
134
135 @GL_TEMPLATE_SHAPE_RECT: 
136 @GL_TEMPLATE_SHAPE_ROUND: 
137 @GL_TEMPLATE_SHAPE_CD: 
138
139 <!-- ##### STRUCT glTemplateLabelType ##### -->
140 <para>
141
142 </para>
143
144 @id: 
145 @layouts: 
146 @markups: 
147 @shape: 
148
149 <!-- ##### STRUCT glTemplateLayout ##### -->
150 <para>
151
152 </para>
153
154 @nx: 
155 @ny: 
156 @x0: 
157 @y0: 
158 @dx: 
159 @dy: 
160
161 <!-- ##### UNION glTemplateMarkup ##### -->
162 <para>
163
164 </para>
165
166
167 <!-- ##### STRUCT glTemplateMarkupCircle ##### -->
168 <para>
169
170 </para>
171
172 @type: 
173 @x0: 
174 @y0: 
175 @r: 
176
177 <!-- ##### STRUCT glTemplateMarkupLine ##### -->
178 <para>
179
180 </para>
181
182 @type: 
183 @x1: 
184 @y1: 
185 @x2: 
186 @y2: 
187
188 <!-- ##### STRUCT glTemplateMarkupMargin ##### -->
189 <para>
190
191 </para>
192
193 @type: 
194 @size: 
195
196 <!-- ##### STRUCT glTemplateMarkupRect ##### -->
197 <para>
198
199 </para>
200
201 @type: 
202 @x1: 
203 @y1: 
204 @w: 
205 @h: 
206 @r: 
207
208 <!-- ##### ENUM glTemplateMarkupType ##### -->
209 <para>
210
211 </para>
212
213 @GL_TEMPLATE_MARKUP_MARGIN: 
214 @GL_TEMPLATE_MARKUP_LINE: 
215 @GL_TEMPLATE_MARKUP_CIRCLE: 
216 @GL_TEMPLATE_MARKUP_RECT: 
217
218 <!-- ##### STRUCT glTemplateOrigin ##### -->
219 <para>
220
221 </para>
222
223 @x: 
224 @y: 
225
226 <!-- ##### ENUM glUnitsType ##### -->
227 <para>
228 Enumerations for the units of length supported by libglabels.  Internally
229 all lengths are in points.  Externally libglabels supports points ("pt"),
230 inches ("in"), millimeters ("mm"), centimeters ("cm"), and picas ("pc").
231 These units are identical to the absolute length units supported in
232 the CSS2 Specification (Section 4.3.2).
233 </para>
234
235 @GL_UNITS_POINT: 
236 @GL_UNITS_INCH: 
237 @GL_UNITS_MM: 
238 @GL_UNITS_CM: 
239 @GL_UNITS_PICA: 
240 @GL_UNITS_FIRST: 
241 @GL_UNITS_LAST: 
242
243 <!-- ##### FUNCTION gl_category_dup ##### -->
244 <para>
245
246 </para>
247
248 @orig: 
249 @Returns: 
250
251 <!-- ##### FUNCTION gl_category_free ##### -->
252 <para>
253
254 </para>
255
256 @category: 
257
258 <!-- ##### FUNCTION gl_category_free_name_list ##### -->
259 <para>
260
261 </para>
262
263 @names: 
264
265 <!-- ##### FUNCTION gl_category_from_id ##### -->
266 <para>
267
268 </para>
269
270 @id: 
271 @Returns: 
272
273 <!-- ##### FUNCTION gl_category_from_name ##### -->
274 <para>
275
276 </para>
277
278 @name: 
279 @Returns: 
280
281 <!-- ##### FUNCTION gl_category_get_name_list ##### -->
282 <para>
283
284 </para>
285
286 @Returns: 
287
288 <!-- ##### FUNCTION gl_category_init ##### -->
289 <para>
290
291 </para>
292
293
294 <!-- ##### FUNCTION gl_category_lookup_id_from_name ##### -->
295 <para>
296
297 </para>
298
299 @name: 
300 @Returns: 
301
302 <!-- ##### FUNCTION gl_category_lookup_name_from_id ##### -->
303 <para>
304
305 </para>
306
307 @id: 
308 @Returns: 
309
310 <!-- ##### FUNCTION gl_category_new ##### -->
311 <para>
312
313 </para>
314
315 @id: 
316 @name: 
317 @Returns: 
318
319 <!-- ##### FUNCTION gl_paper_dup ##### -->
320 <para>
321
322 </para>
323
324 @orig: 
325 @Returns: 
326
327 <!-- ##### FUNCTION gl_paper_free ##### -->
328 <para>
329
330 </para>
331
332 @paper: 
333
334 <!-- ##### FUNCTION gl_paper_free_id_list ##### -->
335 <para>
336
337 </para>
338
339 @ids: 
340
341 <!-- ##### FUNCTION gl_paper_free_name_list ##### -->
342 <para>
343
344 </para>
345
346 @names: 
347
348 <!-- ##### FUNCTION gl_paper_from_id ##### -->
349 <para>
350
351 </para>
352
353 @id: 
354 @Returns: 
355
356 <!-- ##### FUNCTION gl_paper_from_name ##### -->
357 <para>
358
359 </para>
360
361 @name: 
362 @Returns: 
363
364 <!-- ##### FUNCTION gl_paper_get_id_list ##### -->
365 <para>
366
367 </para>
368
369 @Returns: 
370
371 <!-- ##### FUNCTION gl_paper_get_name_list ##### -->
372 <para>
373
374 </para>
375
376 @Returns: 
377
378 <!-- ##### FUNCTION gl_paper_init ##### -->
379 <para>
380
381 </para>
382
383
384 <!-- ##### FUNCTION gl_paper_is_id_known ##### -->
385 <para>
386
387 </para>
388
389 @id: 
390 @Returns: 
391
392 <!-- ##### FUNCTION gl_paper_is_id_other ##### -->
393 <para>
394
395 </para>
396
397 @id: 
398 @Returns: 
399
400 <!-- ##### FUNCTION gl_paper_lookup_id_from_name ##### -->
401 <para>
402
403 </para>
404
405 @name: 
406 @Returns: 
407
408 <!-- ##### FUNCTION gl_paper_lookup_name_from_id ##### -->
409 <para>
410
411 </para>
412
413 @id: 
414 @Returns: 
415
416 <!-- ##### FUNCTION gl_paper_new ##### -->
417 <para>
418
419 </para>
420
421 @id: 
422 @name: 
423 @width: 
424 @height: 
425 @Returns: 
426
427 <!-- ##### FUNCTION gl_paper_print_known_papers ##### -->
428 <para>
429
430 </para>
431
432
433 <!-- ##### FUNCTION gl_template_add_alias ##### -->
434 <para>
435
436 </para>
437
438 @template: 
439 @alias: 
440
441 <!-- ##### FUNCTION gl_template_add_category ##### -->
442 <para>
443
444 </para>
445
446 @template: 
447 @category: 
448
449 <!-- ##### FUNCTION gl_template_add_frame ##### -->
450 <para>
451
452 </para>
453
454 @template: 
455 @frame: 
456
457 <!-- ##### FUNCTION gl_template_add_label_type ##### -->
458 <para>
459
460 </para>
461
462 @template: 
463 @label_type: 
464
465 <!-- ##### FUNCTION gl_template_add_layout ##### -->
466 <para>
467
468 </para>
469
470 @frame: 
471 @layout: 
472
473 <!-- ##### FUNCTION gl_template_add_markup ##### -->
474 <para>
475
476 </para>
477
478 @frame: 
479 @markup: 
480
481 <!-- ##### FUNCTION gl_template_cd_label_type_new ##### -->
482 <para>
483
484 </para>
485
486 @id: 
487 @r1: 
488 @r2: 
489 @w: 
490 @h: 
491 @waste: 
492 @Returns: 
493
494 <!-- ##### FUNCTION gl_template_does_category_match ##### -->
495 <para>
496
497 </para>
498
499 @template: 
500 @category: 
501 @Returns: 
502
503 <!-- ##### FUNCTION gl_template_does_page_size_match ##### -->
504 <para>
505
506 </para>
507
508 @template: 
509 @page_size: 
510 @Returns: 
511
512 <!-- ##### FUNCTION gl_template_dup ##### -->
513 <para>
514
515 </para>
516
517 @orig: 
518 @Returns: 
519
520 <!-- ##### FUNCTION gl_template_frame_cd_new ##### -->
521 <para>
522
523 </para>
524
525 @id: 
526 @r1: 
527 @r2: 
528 @w: 
529 @h: 
530 @waste: 
531 @Returns: 
532
533 <!-- ##### FUNCTION gl_template_frame_dup ##### -->
534 <para>
535
536 </para>
537
538 @orig_frame: 
539 @Returns: 
540
541 <!-- ##### FUNCTION gl_template_frame_free ##### -->
542 <para>
543
544 </para>
545
546 @frame: 
547
548 <!-- ##### FUNCTION gl_template_frame_get_n_labels ##### -->
549 <para>
550
551 </para>
552
553 @frame: 
554 @Returns: 
555
556 <!-- ##### FUNCTION gl_template_frame_get_origins ##### -->
557 <para>
558
559 </para>
560
561 @frame: 
562 @Returns: 
563
564 <!-- ##### FUNCTION gl_template_frame_get_size ##### -->
565 <para>
566
567 </para>
568
569 @frame: 
570 @w: 
571 @h: 
572
573 <!-- ##### FUNCTION gl_template_frame_rect_new ##### -->
574 <para>
575
576 </para>
577
578 @id: 
579 @w: 
580 @h: 
581 @r: 
582 @x_waste: 
583 @y_waste: 
584 @Returns: 
585
586 <!-- ##### FUNCTION gl_template_frame_round_new ##### -->
587 <para>
588
589 </para>
590
591 @id: 
592 @r: 
593 @waste: 
594 @Returns: 
595
596 <!-- ##### FUNCTION gl_template_free ##### -->
597 <para>
598
599 </para>
600
601 @template: 
602
603 <!-- ##### FUNCTION gl_template_free_name_list ##### -->
604 <para>
605
606 </para>
607
608 @names: 
609
610 <!-- ##### FUNCTION gl_template_from_name ##### -->
611 <para>
612
613 </para>
614
615 @name: 
616 @Returns: 
617
618 <!-- ##### FUNCTION gl_template_get_first_frame ##### -->
619 <para>
620
621 </para>
622
623 @template: 
624 @Returns: 
625
626 <!-- ##### FUNCTION gl_template_get_first_label_type ##### -->
627 <para>
628
629 </para>
630
631 @template: 
632 @Returns: 
633
634 <!-- ##### FUNCTION gl_template_get_label_size ##### -->
635 <para>
636
637 </para>
638
639 @label_type: 
640 @w: 
641 @h: 
642
643 <!-- ##### FUNCTION gl_template_get_n_labels ##### -->
644 <para>
645
646 </para>
647
648 @label_type: 
649 @Returns: 
650
651 <!-- ##### FUNCTION gl_template_get_name_list ##### -->
652 <para>
653
654 </para>
655
656 @page_size: 
657 @Returns: 
658
659 <!-- ##### FUNCTION gl_template_get_name_list_all ##### -->
660 <para>
661
662 </para>
663
664 @page_size: 
665 @category: 
666 @Returns: 
667
668 <!-- ##### FUNCTION gl_template_get_name_list_unique ##### -->
669 <para>
670
671 </para>
672
673 @page_size: 
674 @category: 
675 @Returns: 
676
677 <!-- ##### FUNCTION gl_template_get_name_with_desc ##### -->
678 <para>
679
680 </para>
681
682 @template: 
683 @Returns: 
684
685 <!-- ##### FUNCTION gl_template_get_origins ##### -->
686 <para>
687
688 </para>
689
690 @label_type: 
691 @Returns: 
692
693 <!-- ##### FUNCTION gl_template_init ##### -->
694 <para>
695
696 </para>
697
698
699 <!-- ##### FUNCTION gl_template_label_type_dup ##### -->
700 <para>
701
702 </para>
703
704 @orig_ltype: 
705 @Returns: 
706
707 <!-- ##### FUNCTION gl_template_label_type_free ##### -->
708 <para>
709
710 </para>
711
712 @ltype: 
713
714 <!-- ##### FUNCTION gl_template_layout_dup ##### -->
715 <para>
716
717 </para>
718
719 @orig_layout: 
720 @Returns: 
721
722 <!-- ##### FUNCTION gl_template_layout_free ##### -->
723 <para>
724
725 </para>
726
727 @layout: 
728
729 <!-- ##### FUNCTION gl_template_layout_new ##### -->
730 <para>
731
732 </para>
733
734 @nx: 
735 @ny: 
736 @x0: 
737 @y0: 
738 @dx: 
739 @dy: 
740 @Returns: 
741
742 <!-- ##### FUNCTION gl_template_markup_circle_new ##### -->
743 <para>
744
745 </para>
746
747 @x0: 
748 @y0: 
749 @r: 
750 @Returns: 
751
752 <!-- ##### FUNCTION gl_template_markup_dup ##### -->
753 <para>
754
755 </para>
756
757 @orig_markup: 
758 @Returns: 
759
760 <!-- ##### FUNCTION gl_template_markup_free ##### -->
761 <para>
762
763 </para>
764
765 @markup: 
766
767 <!-- ##### FUNCTION gl_template_markup_line_new ##### -->
768 <para>
769
770 </para>
771
772 @x1: 
773 @y1: 
774 @x2: 
775 @y2: 
776 @Returns: 
777
778 <!-- ##### FUNCTION gl_template_markup_margin_new ##### -->
779 <para>
780
781 </para>
782
783 @size: 
784 @Returns: 
785
786 <!-- ##### FUNCTION gl_template_markup_rect_new ##### -->
787 <para>
788
789 </para>
790
791 @x1: 
792 @y1: 
793 @w: 
794 @h: 
795 @r: 
796 @Returns: 
797
798 <!-- ##### FUNCTION gl_template_new ##### -->
799 <para>
800
801 </para>
802
803 @name: 
804 @description: 
805 @page_size: 
806 @page_width: 
807 @page_height: 
808 @Returns: 
809
810 <!-- ##### FUNCTION gl_template_print_aliases ##### -->
811 <para>
812
813 </para>
814
815 @template: 
816
817 <!-- ##### FUNCTION gl_template_print_known_templates ##### -->
818 <para>
819
820 </para>
821
822
823 <!-- ##### FUNCTION gl_template_rect_label_type_new ##### -->
824 <para>
825
826 </para>
827
828 @id: 
829 @w: 
830 @h: 
831 @r: 
832 @x_waste: 
833 @y_waste: 
834 @Returns: 
835
836 <!-- ##### FUNCTION gl_template_register ##### -->
837 <para>
838
839 </para>
840
841 @template: 
842
843 <!-- ##### FUNCTION gl_template_round_label_type_new ##### -->
844 <para>
845
846 </para>
847
848 @id: 
849 @r: 
850 @waste: 
851 @Returns: 
852
853 <!-- ##### FUNCTION gl_xml_category_parse_categories_doc ##### -->
854 <para>
855
856 </para>
857
858 @categories_doc: 
859 @Returns: 
860
861 <!-- ##### FUNCTION gl_xml_category_parse_category_node ##### -->
862 <para>
863
864 </para>
865
866 @category_node: 
867 @Returns: 
868
869 <!-- ##### FUNCTION gl_xml_category_read_categories_from_file ##### -->
870 <para>
871
872 </para>
873
874 @utf8_filename: 
875 @Returns: 
876
877 <!-- ##### FUNCTION gl_xml_get_node_content ##### -->
878 <para>
879
880 </para>
881
882 @node: 
883 @Returns: 
884
885 <!-- ##### FUNCTION gl_xml_get_prop_boolean ##### -->
886 <para>
887
888 </para>
889
890 @node: 
891 @property: 
892 @default_val: 
893 @Returns: 
894
895 <!-- ##### FUNCTION gl_xml_get_prop_double ##### -->
896 <para>
897
898 </para>
899
900 @node: 
901 @property: 
902 @default_val: 
903 @Returns: 
904
905 <!-- ##### FUNCTION gl_xml_get_prop_i18n_string ##### -->
906 <para>
907
908 </para>
909
910 @node: 
911 @property: 
912 @default_val: 
913 @Returns: 
914
915 <!-- ##### FUNCTION gl_xml_get_prop_int ##### -->
916 <para>
917
918 </para>
919
920 @node: 
921 @property: 
922 @default_val: 
923 @Returns: 
924
925 <!-- ##### FUNCTION gl_xml_get_prop_length ##### -->
926 <para>
927
928 </para>
929
930 @node: 
931 @property: 
932 @default_val: 
933 @Returns: 
934
935 <!-- ##### FUNCTION gl_xml_get_prop_string ##### -->
936 <para>
937
938 </para>
939
940 @node: 
941 @property: 
942 @default_val: 
943 @Returns: 
944
945 <!-- ##### FUNCTION gl_xml_get_prop_uint ##### -->
946 <para>
947
948 </para>
949
950 @node: 
951 @property: 
952 @default_val: 
953 @Returns: 
954
955 <!-- ##### FUNCTION gl_xml_is_node ##### -->
956 <para>
957
958 </para>
959
960 @node: 
961 @name: 
962 @Returns: 
963
964 <!-- ##### FUNCTION gl_xml_paper_parse_paper_node ##### -->
965 <para>
966
967 </para>
968
969 @paper_node: 
970 @Returns: 
971
972 <!-- ##### FUNCTION gl_xml_paper_parse_papers_doc ##### -->
973 <para>
974
975 </para>
976
977 @papers_doc: 
978 @Returns: 
979
980 <!-- ##### FUNCTION gl_xml_paper_read_papers_from_file ##### -->
981 <para>
982
983 </para>
984
985 @utf8_filename: 
986 @Returns: 
987
988 <!-- ##### FUNCTION gl_xml_set_default_units ##### -->
989 <para>
990
991 </para>
992
993 @units: 
994
995 <!-- ##### FUNCTION gl_xml_set_prop_boolean ##### -->
996 <para>
997
998 </para>
999
1000 @node: 
1001 @property: 
1002 @val: 
1003
1004 <!-- ##### FUNCTION gl_xml_set_prop_double ##### -->
1005 <para>
1006
1007 </para>
1008
1009 @node: 
1010 @property: 
1011 @val: 
1012
1013 <!-- ##### FUNCTION gl_xml_set_prop_int ##### -->
1014 <para>
1015
1016 </para>
1017
1018 @node: 
1019 @property: 
1020 @val: 
1021
1022 <!-- ##### FUNCTION gl_xml_set_prop_length ##### -->
1023 <para>
1024
1025 </para>
1026
1027 @node: 
1028 @property: 
1029 @val: 
1030
1031 <!-- ##### FUNCTION gl_xml_set_prop_string ##### -->
1032 <para>
1033
1034 </para>
1035
1036 @node: 
1037 @property: 
1038 @val: 
1039
1040 <!-- ##### FUNCTION gl_xml_set_prop_uint_hex ##### -->
1041 <para>
1042
1043 </para>
1044
1045 @node: 
1046 @property: 
1047 @val: 
1048
1049 <!-- ##### FUNCTION gl_xml_template_create_template_node ##### -->
1050 <para>
1051
1052 </para>
1053
1054 @template: 
1055 @root: 
1056 @ns: 
1057
1058 <!-- ##### FUNCTION gl_xml_template_create_templates_doc ##### -->
1059 <para>
1060
1061 </para>
1062
1063 @templates: 
1064 @Returns: 
1065
1066 <!-- ##### FUNCTION gl_xml_template_parse_template_node ##### -->
1067 <para>
1068
1069 </para>
1070
1071 @template_node: 
1072 @Returns: 
1073
1074 <!-- ##### FUNCTION gl_xml_template_parse_templates_doc ##### -->
1075 <para>
1076
1077 </para>
1078
1079 @templates_doc: 
1080 @Returns: 
1081
1082 <!-- ##### FUNCTION gl_xml_template_read_templates_from_file ##### -->
1083 <para>
1084
1085 </para>
1086
1087 @utf8_filename: 
1088 @Returns: 
1089
1090 <!-- ##### FUNCTION gl_xml_template_write_template_to_file ##### -->
1091 <para>
1092
1093 </para>
1094
1095 @template: 
1096 @utf8_filename: 
1097
1098 <!-- ##### FUNCTION gl_xml_template_write_templates_to_file ##### -->
1099 <para>
1100
1101 </para>
1102
1103 @templates: 
1104 @utf8_filename: 
1105