Xfce Foundation Classes
Main Page | Index | Namespace List | Alphabetical List | Class List | File List

# utfstring.hh File Reference

UTF-8 string class interface. More...

`#include <xfc/glib/unicode.hh>`
`#include <string>`
`#include <iosfwd>`

## Namespaces

- namespace Xfc
- namespace Xfc::G

## Classes

- class Xfc::StringIterator
    UTF-8 string iterator base class. More...
- class Xfc::Forward_StringIterator
    A const non-random access iterator that iterates over a String in the forward direction. More...
- class Xfc::Reverse_StringIterator
    A const non-random access iterator that iterates over a String in the reverse direction. More...
- class Xfc::String
    A UTF-8 standard string compatible string class. More...

## String i/o stream operators

- std::istream & operator>> (std::istream &is, String &str)
    Read a whitespace-terminated word from an istream to the string str.
- std::ostream & operator<< (std::ostream &os, const String &str)
    Write the string str to an ostream.

## StringIterator comparison operators

- bool operator== (const StringIterator &lhs, const StringIterator &rhs)
    Returns true if the string iterators lhs and rhs point to the same character.
- bool operator!= (const StringIterator &lhs, const StringIterator &rhs)
    Returns true if the string iterators lhs and rhs do not point to the same character.
- bool operator< (const StringIterator &lhs, const StringIterator &rhs)
    Returns true if lhs points to a character in a string that is before the character pointed to by rhs.
- bool operator> (const StringIterator &lhs, const StringIterator &rhs)
    Returns true if lhs points to a character in a string that is after the character pointed to by rhs.
- bool operator<= (const StringIterator &lhs, const StringIterator &rhs)
    Returns true if lhs points to a character in a string that is before the character or is the same character pointed to by rhs.
- bool operator>= (const StringIterator &lhs, const StringIterator &rhs)
    Returns true if lhs points to a character in a string that is the same character or after the character pointed to by rhs.

## String concatenation operators

- String operator+ (const String &lhs, const String &rhs)
    Append the string rhs to the end of the string lhs and return the result as a new String.
- String operator+ (const char *lhs, const String &rhs)
    Append the string rhs to the end of the character array lhs and return the result as a new String.
- String operator+ (char c, const String &rhs)
    Append the string rhs to the character c and return the result as a new String.
- String operator+ (const String &lhs, const char *rhs)
    Append the character array rhs to the end of the string lhs and return the result as a new String.
- String operator+ (const String &lhs, char c)
    Append the character c to the end of the string lhs and return the result as a new String.

## String comparison operators

- bool operator== (const String &lhs, const String &rhs)
    Returns true if the string lhs and the string rhs are characterwise equal.
- bool operator== (const char *lhs, const String &rhs)
    Returns true if the character array lhs and the string rhs are characterwise equal.
- bool operator== (const String &lhs, const char *rhs)
    Returns true if the string lhs and the character array rhs are characterwise equal.
- bool operator!= (const char *lhs, const String &rhs)
    Returns true if the character array lhs and the string rhs are not characterwise equal.
- bool operator!= (const String &lhs, const char *rhs)
    Returns true if the string lhs and the character array rhs are not characterwise equal.
- bool operator< (const String &lhs, const String &rhs)
    Returns true if the string lhs is lexicographically before the string rhs.
- bool operator< (const char *lhs, const String &rhs)
    Returns true if the character array lhs is lexicographically before the string rhs.
- bool operator< (const String &lhs, const char *rhs)
    Returns true if the string lhs is lexicographically before the character array rhs.
- bool operator> (const char *lhs, const String &rhs)
    Returns true if the character array lhs is lexicographically greater the string rhs.
- bool operator> (const String &lhs, const char *rhs)
    Returns true if the string lhs is lexicographically greater the character array rhs.
- bool operator<= (const char *lhs, const String &rhs)
    Returns true if the character array lhs is lexicographically before or equal to the string rhs.
- bool operator<= (const String &lhs, const char *rhs)
    Returns true if the string lhs is lexicographically before or equal to the character array rhs.
- bool operator>= (const char *lhs, const String &rhs)
    Returns true if the character array lhs is lexicographically greater or equal to the string rhs.
- bool operator>= (const String &lhs, const char *rhs)
    Returns true if the string lhs is lexicographically greater or equal to the character array rhs.
- bool operator!= (const String &lhs, const String &rhs)
    Returns true if the string lhs and the string rhs are not characterwise equal.
- bool operator> (const String &lhs, const String &rhs)
    Returns true if the string lhs is lexicographically greater the string rhs.
- bool operator<= (const String &lhs, const String &rhs)
    Returns true if the string lhs is lexicographically before or equal to the string rhs.
- bool operator>= (const String &lhs, const String &rhs)
    Returns true if the string lhs is lexicographically greater or equal to the string rhs.

## Detailed Description

UTF-8 string class interface.

Provides a UTF-8 standard string compatible string class with its own forward and reverse string iterators that know how to count UTF-8 characters.
Xfce Foundation Classes

Copyright © 2004-2005 The XFC Development Team | XFC 4.3