X-Git-Url: https://git.sur5r.net/?a=blobdiff_plain;f=docs%2Flibglabels%2Fhtml%2Flibglabels-3.0-str.html;h=182f4f5be4ad025e73972b2714a193abe122c658;hb=8e4c50283c4f353b18c68474f91209b8bd050557;hp=72c75367f800b51175734f992e8ebc110f13c784;hpb=7163b4618939eb14d7781b4100f73270ea2f70fa;p=glabels diff --git a/docs/libglabels/html/libglabels-3.0-str.html b/docs/libglabels/html/libglabels-3.0-str.html index 72c75367..182f4f5b 100644 --- a/docs/libglabels/html/libglabels-3.0-str.html +++ b/docs/libglabels/html/libglabels-3.0-str.html @@ -2,29 +2,26 @@ -String Utility Functions - +LibGlabels 3.0 Reference Manual: String Utility Functions + - + - - - - - - - - - - + + + + + + +
@@ -32,18 +29,51 @@

String Utility Functions

String Utility Functions — String utility functions provided by libglabels

- +
-
-

Synopsis

-
-#include <libglabels/lgl-str.h>
-
-gint                lgl_str_utf8_casecmp                (const gchar *s1,
-                                                         const gchar *s2);
-gint                lgl_str_part_name_cmp               (const gchar *s1,
-                                                         const gchar *s2);
-gchar *             lgl_str_format_fraction             (gdouble x);
+

+
Functions

+

++++
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+





+gint
+
+lgl_str_utf8_casecmp ()
+

+gint
+
+lgl_str_part_name_cmp ()
+

+gchar *
+
+lgl_str_format_fraction ()
+

+

+

+
Object Hierarchy

+
+

+

+

+
Includes

+
#include <libglabels/lgl-str.h>
 

 

 

@@ -54,116 +84,129 @@ possible use to a user of libglabels.
 

 

 

-
Details

+
Functions

 

-
lgl_str_utf8_casecmp ()

-
gint                lgl_str_utf8_casecmp                (const gchar *s1,
-                                                         const gchar *s2);

-

-Compare two UTF-8 strings, ignoring the case of characters.
-

-

-This function should be used only on strings that are known to be encoded
-in UTF-8 or a compatible UTF-8 subset.
-

-

-+
lgl_str_utf8_casecmp ()

+
gint
+lgl_str_utf8_casecmp (const gchar *s1,
+                      const gchar *s2);

+
Compare two UTF-8 strings, ignoring the case of characters.

+
This function should be used only on strings that are known to be encoded
+in UTF-8 or a compatible UTF-8 subset.

+

+
Parameters

+



+++++
-
-
-
-
-
-
+
+
+
-
-
+
+
+





 
 
s1 :
string to compare with s2.
s2 :
string to compare with s1.
s1
string to compare with s2.
 
 

 
Returns :
0 if the strings match, a negative value if s1 < s2,
-or a positive value if s1 > s2.
s2
string to compare with s1.
 
 

 
 

 

+

+
Returns

+
 0 if the strings match, a negative value if s1 < s2,
+or a positive value if s1 > s2.

+

+

+

 

 

-
lgl_str_part_name_cmp ()

-
gint                lgl_str_part_name_cmp               (const gchar *s1,
-                                                         const gchar *s2);

-

-Compare two UTF-8 strings representing part names or numbers.  This function
-uses a natural sort order:
-

-

- - Ignores case.
-

-

- - Strings are divided into chunks (numeric and non-numeric)
-

-

- - Non-numeric chunks are compared character by character
-

-

- - Numerical chunks are compared numerically, so that "20" precedes "100".
-

-

- - Comparison of chunks is performed left to right until the first difference
-   is encountered or all chunks evaluate as equal.
-

-

-This function should be used only on strings that are known to be encoded
-in UTF-8 or a compatible UTF-8 subset.
-

-

-Numeric chunks are converted to 64 bit unsigned integers for comparison,
+
lgl_str_part_name_cmp ()

+
gint
+lgl_str_part_name_cmp (const gchar *s1,
+                       const gchar *s2);

+
Compare two UTF-8 strings representing part names or numbers.  This function
+uses a natural sort order:

+
    
+
  • Ignores case.
    • 
+
  • Strings are divided into chunks (numeric and non-numeric)
    • 
+
  • Non-numeric chunks are compared character by character
    • 
+
  • Numerical chunks are compared numerically, so that "20" precedes "100".
    • 
+
  • Comparison of chunks is performed left to right until the first difference
+is encountered or all chunks evaluate as equal.
    • 
+

+
This function should be used only on strings that are known to be encoded
+in UTF-8 or a compatible UTF-8 subset.

+
Numeric chunks are converted to 64 bit unsigned integers for comparison,
 so the behaviour may be unpredictable for numeric chunks that exceed
-18446744073709551615.
-

-

-+18446744073709551615.

+

+
Parameters

+



+++++
-
-
+
+
+
-
-
-
-
-
-
+
+
+





 
 
s1 :
string to compare with s2.
s1
string to compare with s2.
 
 

 
s2 :
string to compare with s1.
Returns :
0 if the strings match, a negative value if s1 < s2,
-or a positive value if s1 > s2.
s2
string to compare with s1.
 
 

 
 

 

+

+
Returns

+
 0 if the strings match, a negative value if s1 < s2,
+or a positive value if s1 > s2.

+

+

+
-

lgl_str_format_fraction ()

-
gchar *             lgl_str_format_fraction             (gdouble x);
-

-Create fractional representation of number, if possible. Uses UTF-8 superscripts and -subscripts for numerator and denominator values respecively. -

-
-- - - - - - - - - - +

lgl_str_format_fraction ()

+
gchar *
+lgl_str_format_fraction (gdouble x);
+

Create fractional representation of number, if possible. Uses UTF-8 superscripts and +subscripts for numerator and denominator values respecively.

+
+

Parameters

+

x :

Floating point number to convert to fractional notation

Returns :

UTF-8 string containing fractional representation of x.
+++++ + + + + +

x

Floating point number to convert to fractional notation

 
+
+

Returns

+

UTF-8 string containing fractional representation of x.

+

+
+
+ +
+

Types and Values

- Generated by GTK-Doc V1.18
+ Generated by GTK-Doc V1.20 \ No newline at end of file