← Back to branch summary

~ubuntu-branches/ubuntu/karmic/libgsf/karmic

« back to all changes in this revision

Viewing changes to doc/xml/utils.xml

  • Committer: Bazaar Package Importer
  • Author(s): Sebastian Dröge
  • Date: 2006-06-30 15:46:51 UTC
  • mfrom: (1.1.3 upstream)
  • Revision ID: james.westby@ubuntu.com-20060630154651-3wyy7y8c2zj7l5e0
Tags: 1.14.1-2ubuntu1
* Sync with Debian:
  Remaining Ubuntu Changes
  + Call intltool-update -p at build time to get a .pot file 

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/xml/utils.xml
201
201
<indexterm><primary>libgsf_major_version</primary></indexterm><programlisting>extern int libgsf_major_version;
202
202
</programlisting>
203
203
<para>
204
 
The major version number of the GSF library. 
205
 
(e.g. in GSF version 1.2.5 this is 1.)
206
 
</para>
207
204
 
208
 
<para>
209
 
This variable is in the library and thus represents the
210
 
GSF library you have linked against (which may be different from the version
211
 
of the GSF library from which you have included the headers).
212
205
</para></refsect2>
213
206
<refsect2>
214
207
<title><anchor id="libgsf-minor-version" role="variable"/>libgsf_minor_version</title>
215
208
<indexterm><primary>libgsf_minor_version</primary></indexterm><programlisting>extern int libgsf_minor_version;
216
209
</programlisting>
217
210
<para>
218
 
The minor version number of the GLib library.
219
 
(e.g. in GLib version 1.2.5 this is 2.)
220
 
</para>
221
211
 
222
 
<para>
223
 
This variable is in the library and thus represents the
224
 
GSF library you have linked against (which may be different from the version
225
 
of the GSF library from which you have included the headers).
226
212
</para></refsect2>
227
213
<refsect2>
228
214
<title><anchor id="libgsf-micro-version" role="variable"/>libgsf_micro_version</title>
229
215
<indexterm><primary>libgsf_micro_version</primary></indexterm><programlisting>extern int libgsf_micro_version;
230
216
</programlisting>
231
217
<para>
232
 
The micro version number of the GSF library.
233
 
(e.g. in GSF version 1.2.5 this is 5.)
234
 
</para>
235
218
 
236
 
<para>
237
 
This variable is in the library and thus represents the
238
 
GSF library you have linked against (which may be different from the version
239
 
of the GSF library from which you have included the headers).
240
219
</para></refsect2>
241
220
<refsect2>
242
221
<title><anchor id="GSF-CLASS:CAPS" role="macro"/>GSF_CLASS()</title>
281
260
</simpara></listitem></varlistentry>
282
261
<varlistentry><term><parameter>base_finalize</parameter>&nbsp;:</term>
283
262
<listitem><simpara>
284
 
@\
285
 
                           class_init:
286
263
</simpara></listitem></varlistentry>
287
264
<varlistentry><term><parameter>class_init</parameter>&nbsp;:</term>
288
265
<listitem><simpara>
295
272
</simpara></listitem></varlistentry>
296
273
<varlistentry><term><parameter>parent_type</parameter>&nbsp;:</term>
297
274
<listitem><simpara>
298
 
@\
299
 
                       abstract:
300
275
</simpara></listitem></varlistentry>
301
276
<varlistentry><term><parameter>abstract</parameter>&nbsp;:</term>
302
277
<listitem><simpara>
407
382
</simpara></listitem></varlistentry>
408
383
<varlistentry><term><parameter>base_finalize</parameter>&nbsp;:</term>
409
384
<listitem><simpara>
410
 
@\
411
 
                                   class_init:
412
385
</simpara></listitem></varlistentry>
413
386
<varlistentry><term><parameter>class_init</parameter>&nbsp;:</term>
414
387
<listitem><simpara>
421
394
</simpara></listitem></varlistentry>
422
395
<varlistentry><term><parameter>parent_type</parameter>&nbsp;:</term>
423
396
<listitem><simpara>
424
 
@\
425
 
                               abstract:
426
397
</simpara></listitem></varlistentry>
427
398
<varlistentry><term><parameter>abstract</parameter>&nbsp;:</term>
428
399
<listitem><simpara>
507
478
<indexterm><primary>GSF_ERROR</primary></indexterm><programlisting>#define GSF_ERROR (gsf_error_quark ())
508
479
</programlisting>
509
480
<para>
510
 
  This convenience macro simply calls <link linkend="gsf-error-quark"><function>gsf_error_quark()</function></link>.  You can use
511
 
  it in calls to <link linkend="g-error-matches"><function>g_error_matches()</function></link>, for example.  The macro returns
512
 
  the <link linkend="GQuark"><type>GQuark</type></link> that is used to identify errors from libgsf functions.
513
 
  Specific error codes come from the <link linkend="GsfError"><type>GsfError</type></link> enumeration.
 
481
 
514
482
</para></refsect2>
515
483
<refsect2>
516
484
<title><anchor id="GsfError" role="enum"/>enum GsfError</title>
520
488
} GsfError;
521
489
</programlisting>
522
490
<para>
523
 
   Error codes that can be returned from libgsf functions in <link linkend="GError"><type>GError</type></link> structures.
524
 
</para><variablelist role="enum">
525
 
<varlistentry>
526
 
<term><literal>GSF_ERROR_OUT_OF_MEMORY</literal></term>
527
 
<listitem><simpara>Not enough memory could be allocated to hold
528
 
a structure or object.
529
 
</simpara></listitem>
530
 
</varlistentry>
531
 
<varlistentry>
532
 
<term><literal>GSF_ERROR_INVALID_DATA</literal></term>
533
 
<listitem><simpara>A file being read contained invalid or
534
 
inconsistent data.
535
491
 
536
 
</simpara></listitem>
537
 
</varlistentry>
538
 
</variablelist></refsect2>
 
492
</para></refsect2>
539
493
<refsect2>
540
494
<title><anchor id="gsf-error-quark" role="function"/>gsf_error_quark ()</title>
541
495
<indexterm><primary>gsf_error_quark</primary></indexterm><programlisting><link linkend="GQuark">GQuark</link>      gsf_error_quark                 (void);</programlisting>
785
739
<indexterm><primary>GSF_LE_GET_GINT8</primary></indexterm><programlisting>#define GSF_LE_GET_GINT8(p) ((gint8)GSF_LE_GET_GUINT8(p))
786
740
</programlisting>
787
741
<para>
788
 
Interpret data as an 8 bit integer value in little endian order.
 
742
 
789
743
</para><variablelist role="params">
790
744
<varlistentry><term><parameter>p</parameter>&nbsp;:</term>
791
 
<listitem><simpara>Pointer to storage
 
745
<listitem><simpara>
792
746
 
793
747
 
794
748
</simpara></listitem></varlistentry>
798
752
<indexterm><primary>GSF_LE_GET_GUINT64</primary></indexterm><programlisting>#define GSF_LE_GET_GUINT64(p) (gsf_le_get_guint64 (p))
799
753
</programlisting>
800
754
<para>
801
 
Interpret data as a 64 bit unsigned integer value in little endian order.
 
755
 
802
756
</para><variablelist role="params">
803
757
<varlistentry><term><parameter>p</parameter>&nbsp;:</term>
804
 
<listitem><simpara>Pointer to storage
 
758
<listitem><simpara>
805
759
 
806
760
 
807
761
</simpara></listitem></varlistentry>
811
765
<indexterm><primary>GSF_LE_GET_GINT16</primary></indexterm><programlisting>#define GSF_LE_GET_GINT16(p) ((gint16)GSF_LE_GET_GUINT16(p))
812
766
</programlisting>
813
767
<para>
814
 
Interpret data as a 16 bit integer value in little endian order.
 
768
 
815
769
</para><variablelist role="params">
816
770
<varlistentry><term><parameter>p</parameter>&nbsp;:</term>
817
 
<listitem><simpara>Pointer to storage
 
771
<listitem><simpara>
818
772
 
819
773
 
820
774
</simpara></listitem></varlistentry>
824
778
<indexterm><primary>GSF_LE_GET_GUINT8</primary></indexterm><programlisting>#define GSF_LE_GET_GUINT8(p) (*(guint8 const *)(p))
825
779
</programlisting>
826
780
<para>
827
 
Interpret data as an 8 bit unsigned integer value in little endian order.
 
781
 
828
782
</para><variablelist role="params">
829
783
<varlistentry><term><parameter>p</parameter>&nbsp;:</term>
830
 
<listitem><simpara>Pointer to storage
 
784
<listitem><simpara>
831
785
 
832
786
 
833
787
</simpara></listitem></varlistentry>
837
791
<indexterm><primary>GSF_LE_GET_GINT32</primary></indexterm><programlisting>#define GSF_LE_GET_GINT32(p) ((gint32)GSF_LE_GET_GUINT32(p))
838
792
</programlisting>
839
793
<para>
840
 
Interpret data as a 32 bit integer value in little endian order.
 
794
 
841
795
</para><variablelist role="params">
842
796
<varlistentry><term><parameter>p</parameter>&nbsp;:</term>
843
 
<listitem><simpara>Pointer to storage
 
797
<listitem><simpara>
844
798
 
845
799
 
846
800
</simpara></listitem></varlistentry>
849
803
<title><anchor id="GSF-LE-GET-GUINT16:CAPS" role="macro"/>GSF_LE_GET_GUINT16()</title>
850
804
<indexterm><primary>GSF_LE_GET_GUINT16</primary></indexterm><programlisting>#define     GSF_LE_GET_GUINT16(p)</programlisting>
851
805
<para>
852
 
Interpret data as a 16 bit unsigned integer value in little endian order.
 
806
 
853
807
</para><variablelist role="params">
854
808
<varlistentry><term><parameter>p</parameter>&nbsp;:</term>
855
 
<listitem><simpara>Pointer to storage
 
809
<listitem><simpara>
856
810
 
857
811
 
858
812
</simpara></listitem></varlistentry>
861
815
<title><anchor id="GSF-LE-GET-GUINT32:CAPS" role="macro"/>GSF_LE_GET_GUINT32()</title>
862
816
<indexterm><primary>GSF_LE_GET_GUINT32</primary></indexterm><programlisting>#define     GSF_LE_GET_GUINT32(p)</programlisting>
863
817
<para>
864
 
Interpret data as a 32 bit unsigned integer value in little endian order.
 
818
 
865
819
</para><variablelist role="params">
866
820
<varlistentry><term><parameter>p</parameter>&nbsp;:</term>
867
 
<listitem><simpara>Pointer to storage
 
821
<listitem><simpara>
868
822
 
869
823
 
870
824
</simpara></listitem></varlistentry>
874
828
<indexterm><primary>GSF_LE_GET_GINT64</primary></indexterm><programlisting>#define GSF_LE_GET_GINT64(p) ((gint64)GSF_LE_GET_GUINT64(p))
875
829
</programlisting>
876
830
<para>
877
 
Interpret data as a 64 bit integer value in little endian order.
 
831
 
878
832
</para><variablelist role="params">
879
833
<varlistentry><term><parameter>p</parameter>&nbsp;:</term>
880
 
<listitem><simpara>Pointer to storage
 
834
<listitem><simpara>
881
835
 
882
836
 
883
837
</simpara></listitem></varlistentry>
902
856
<indexterm><primary>GSF_LE_GET_FLOAT</primary></indexterm><programlisting>#define GSF_LE_GET_FLOAT(p) (gsf_le_get_float (p))
903
857
</programlisting>
904
858
<para>
905
 
Interpret data as a float value in little endian order.
 
859
 
906
860
</para><variablelist role="params">
907
861
<varlistentry><term><parameter>p</parameter>&nbsp;:</term>
908
 
<listitem><simpara>Pointer to storage
 
862
<listitem><simpara>
909
863
 
910
864
 
911
865
</simpara></listitem></varlistentry>
929
883
<indexterm><primary>GSF_LE_GET_DOUBLE</primary></indexterm><programlisting>#define GSF_LE_GET_DOUBLE(p) (gsf_le_get_double (p))
930
884
</programlisting>
931
885
<para>
932
 
Interpret data as a double value in little endian order.
 
886
 
933
887
</para><variablelist role="params">
934
888
<varlistentry><term><parameter>p</parameter>&nbsp;:</term>
935
 
<listitem><simpara>Pointer to storage
 
889
<listitem><simpara>
936
890
 
937
891
 
938
892
</simpara></listitem></varlistentry>
955
909
<title><anchor id="GSF-LE-SET-GUINT8:CAPS" role="macro"/>GSF_LE_SET_GUINT8()</title>
956
910
<indexterm><primary>GSF_LE_SET_GUINT8</primary></indexterm><programlisting>#define     GSF_LE_SET_GUINT8(p, dat)</programlisting>
957
911
<para>
958
 
Store an 8 bit unsigned integer value in memory in little endian order.
 
912
 
959
913
</para><variablelist role="params">
960
914
<varlistentry><term><parameter>p</parameter>&nbsp;:</term>
961
 
<listitem><simpara>Pointer to storage
 
915
<listitem><simpara>
962
916
</simpara></listitem></varlistentry>
963
917
<varlistentry><term><parameter>dat</parameter>&nbsp;:</term>
964
 
<listitem><simpara>Value to be stored
 
918
<listitem><simpara>
965
919
 
966
920
 
967
921
</simpara></listitem></varlistentry>
970
924
<title><anchor id="GSF-LE-SET-GUINT16:CAPS" role="macro"/>GSF_LE_SET_GUINT16()</title>
971
925
<indexterm><primary>GSF_LE_SET_GUINT16</primary></indexterm><programlisting>#define     GSF_LE_SET_GUINT16(p, dat)</programlisting>
972
926
<para>
973
 
Store a 16 bit unsigned integer value in memory in little endian order.
 
927
 
974
928
</para><variablelist role="params">
975
929
<varlistentry><term><parameter>p</parameter>&nbsp;:</term>
976
 
<listitem><simpara>Pointer to storage
 
930
<listitem><simpara>
977
931
</simpara></listitem></varlistentry>
978
932
<varlistentry><term><parameter>dat</parameter>&nbsp;:</term>
979
 
<listitem><simpara>Value to be stored
 
933
<listitem><simpara>
980
934
 
981
935
 
982
936
</simpara></listitem></varlistentry>
985
939
<title><anchor id="GSF-LE-SET-GUINT32:CAPS" role="macro"/>GSF_LE_SET_GUINT32()</title>
986
940
<indexterm><primary>GSF_LE_SET_GUINT32</primary></indexterm><programlisting>#define     GSF_LE_SET_GUINT32(p, dat)</programlisting>
987
941
<para>
988
 
Store a 32 bit unsigned integer value in memory in little endian order.
 
942
 
989
943
</para><variablelist role="params">
990
944
<varlistentry><term><parameter>p</parameter>&nbsp;:</term>
991
 
<listitem><simpara>Pointer to storage
 
945
<listitem><simpara>
992
946
</simpara></listitem></varlistentry>
993
947
<varlistentry><term><parameter>dat</parameter>&nbsp;:</term>
994
 
<listitem><simpara>Value to be stored
 
948
<listitem><simpara>
995
949
 
996
950
 
997
951
</simpara></listitem></varlistentry>
1001
955
<indexterm><primary>GSF_LE_SET_GINT8</primary></indexterm><programlisting>#define GSF_LE_SET_GINT8(p,dat) GSF_LE_SET_GUINT8((p),(dat))
1002
956
</programlisting>
1003
957
<para>
1004
 
Store an 8 bit integer value in memory in little endian order.
 
958
 
1005
959
</para><variablelist role="params">
1006
960
<varlistentry><term><parameter>p</parameter>&nbsp;:</term>
1007
 
<listitem><simpara>Pointer to storage
 
961
<listitem><simpara>
1008
962
</simpara></listitem></varlistentry>
1009
963
<varlistentry><term><parameter>dat</parameter>&nbsp;:</term>
1010
 
<listitem><simpara>Value to be stored
 
964
<listitem><simpara>
1011
965
 
1012
966
 
1013
967
</simpara></listitem></varlistentry>
1017
971
<indexterm><primary>GSF_LE_SET_GINT16</primary></indexterm><programlisting>#define GSF_LE_SET_GINT16(p,dat) GSF_LE_SET_GUINT16((p),(dat))
1018
972
</programlisting>
1019
973
<para>
1020
 
Store a 16 bit integer value in memory in little endian order.
 
974
 
1021
975
</para><variablelist role="params">
1022
976
<varlistentry><term><parameter>p</parameter>&nbsp;:</term>
1023
 
<listitem><simpara>Pointer to storage
 
977
<listitem><simpara>
1024
978
</simpara></listitem></varlistentry>
1025
979
<varlistentry><term><parameter>dat</parameter>&nbsp;:</term>
1026
 
<listitem><simpara>Value to be stored
 
980
<listitem><simpara>
1027
981
 
1028
982
 
1029
983
</simpara></listitem></varlistentry>
1033
987
<indexterm><primary>GSF_LE_SET_GINT32</primary></indexterm><programlisting>#define GSF_LE_SET_GINT32(p,dat) GSF_LE_SET_GUINT32((p),(dat))
1034
988
</programlisting>
1035
989
<para>
1036
 
Store a 32 bit integer value in memory in little endian order.
 
990
 
1037
991
</para><variablelist role="params">
1038
992
<varlistentry><term><parameter>p</parameter>&nbsp;:</term>
1039
 
<listitem><simpara>Pointer to storage
 
993
<listitem><simpara>
1040
994
</simpara></listitem></varlistentry>
1041
995
<varlistentry><term><parameter>dat</parameter>&nbsp;:</term>
1042
 
<listitem><simpara>Value to be stored
 
996
<listitem><simpara>
1043
997
 
1044
998
 
1045
999
</simpara></listitem></varlistentry>
1049
1003
<indexterm><primary>GSF_LE_SET_GINT64</primary></indexterm><programlisting>#define GSF_LE_SET_GINT64(p,dat) GSF_LE_SET_GUINT64((p),(dat))
1050
1004
</programlisting>
1051
1005
<para>
1052
 
Store a 64 bit integer value in memory in little endian order.
 
1006
 
1053
1007
</para><variablelist role="params">
1054
1008
<varlistentry><term><parameter>p</parameter>&nbsp;:</term>
1055
 
<listitem><simpara>Pointer to storage
 
1009
<listitem><simpara>
1056
1010
</simpara></listitem></varlistentry>
1057
1011
<varlistentry><term><parameter>dat</parameter>&nbsp;:</term>
1058
 
<listitem><simpara>Value to be stored
 
1012
<listitem><simpara>
1059
1013
 
1060
1014
 
1061
1015
</simpara></listitem></varlistentry>
1064
1018
<title><anchor id="GSF-LE-SET-GUINT64:CAPS" role="macro"/>GSF_LE_SET_GUINT64()</title>
1065
1019
<indexterm><primary>GSF_LE_SET_GUINT64</primary></indexterm><programlisting>#define     GSF_LE_SET_GUINT64(p, dat)</programlisting>
1066
1020
<para>
1067
 
Store a 64 bit unsigned integer value in memory in little endian order.
 
1021
 
1068
1022
</para><variablelist role="params">
1069
1023
<varlistentry><term><parameter>p</parameter>&nbsp;:</term>
1070
 
<listitem><simpara>Pointer to storage
 
1024
<listitem><simpara>
1071
1025
</simpara></listitem></varlistentry>
1072
1026
<varlistentry><term><parameter>dat</parameter>&nbsp;:</term>
1073
 
<listitem><simpara>Value to be stored
 
1027
<listitem><simpara>
1074
1028
 
1075
1029
 
1076
1030
</simpara></listitem></varlistentry>
1080
1034
<indexterm><primary>GSF_LE_SET_FLOAT</primary></indexterm><programlisting>#define GSF_LE_SET_FLOAT(p,dat) gsf_le_set_float((p),(dat))
1081
1035
</programlisting>
1082
1036
<para>
1083
 
Store a float value in memory in little endian order.
 
1037
 
1084
1038
</para><variablelist role="params">
1085
1039
<varlistentry><term><parameter>p</parameter>&nbsp;:</term>
1086
 
<listitem><simpara>Pointer to storage
 
1040
<listitem><simpara>
1087
1041
</simpara></listitem></varlistentry>
1088
1042
<varlistentry><term><parameter>dat</parameter>&nbsp;:</term>
1089
 
<listitem><simpara>Value to be stored
 
1043
<listitem><simpara>
1090
1044
 
1091
1045
 
1092
1046
</simpara></listitem></varlistentry>
1096
1050
<indexterm><primary>GSF_LE_SET_DOUBLE</primary></indexterm><programlisting>#define GSF_LE_SET_DOUBLE(p,dat) gsf_le_set_double((p),(dat))
1097
1051
</programlisting>
1098
1052
<para>
1099
 
Store a double value in memory in little endian order.
 
1053
 
1100
1054
</para><variablelist role="params">
1101
1055
<varlistentry><term><parameter>p</parameter>&nbsp;:</term>
1102
 
<listitem><simpara>Pointer to storage
 
1056
<listitem><simpara>
1103
1057
</simpara></listitem></varlistentry>
1104
1058
<varlistentry><term><parameter>dat</parameter>&nbsp;:</term>
1105
 
<listitem><simpara>Value to be stored
 
1059
<listitem><simpara>
1106
1060
 
1107
1061
 
1108
1062
</simpara></listitem></varlistentry>
1182
1136
<title><anchor id="gsf-timestamp-as-string" role="function"/>gsf_timestamp_as_string ()</title>
1183
1137
<indexterm><primary>gsf_timestamp_as_string</primary></indexterm><programlisting><link linkend="char">char</link>*       gsf_timestamp_as_string         (<link linkend="GsfTimestamp">GsfTimestamp</link> const *stamp);</programlisting>
1184
1138
<para>
1185
 
Produce a string representation of <parameter>stamp</parameter>.</para>
 
1139
Produce a string representation (ISO 8601 format) of <parameter>stamp</parameter>.</para>
1186
1140
<para>
1187
1141
 
1188
1142
</para><variablelist role="params">
1198
1152
<indexterm><primary>gsf_timestamp_parse</primary></indexterm><programlisting><link linkend="int">int</link>         gsf_timestamp_parse             (<link linkend="char">char</link> const *spec,
1199
1153
                                             <link linkend="GsfTimestamp">GsfTimestamp</link> *stamp);</programlisting>
1200
1154
<para>
1201
 
Very simple parser for time stamps.  Currently requires
 
1155
Very simple parser for time stamps.  Currently requires a format of
1202
1156
        'YYYY-MM-DDThh:mm:ss'
1203
 
and does no bounds checking.</para>
 
1157
and does no bounds checking.
 
1158
</para>
 
1159
<para>
 
1160
ICK ICK ICK
 
1161
This routine should be called _from_sting.</para>
1204
1162
<para>
1205
1163
 
1206
1164
</para><variablelist role="params">
1369
1327
<listitem><simpara>
1370
1328
 
1371
1329
 
1372
 
 
1373
 
<!--
1374
 
Local variables:
1375
 
mode: sgml
1376
 
sgml-parent-document: ("../gsf-docs.sgml" "book" "refsect1")
1377
 
End:
1378
 
-->
1379
 
 
1380
 
 
1381
1330
</simpara></listitem></varlistentry>
1382
1331
</variablelist></refsect2>
1383
1332