mirror of
https://github.com/pocoproject/poco.git
synced 2025-05-02 23:42:29 +02:00
trunk/branch integration: documentation
This commit is contained in:
parent
4d860e1b18
commit
73d3dceb86
@ -64,12 +64,14 @@ class Foundation_API TextIterator
|
|||||||
/// int n = 0;
|
/// int n = 0;
|
||||||
/// while (it != end) { ++n; ++it; }
|
/// while (it != end) { ++n; ++it; }
|
||||||
///
|
///
|
||||||
/// NOTE: When an UTF-16 encoding is used, surrogate pairs will be
|
/// NOTE: When an UTF-16 encoding is used, surrogate pairs will be
|
||||||
/// reported as two separate characters, due to restrictions of
|
/// reported as two separate characters, due to restrictions of
|
||||||
/// the TextEncoding class.
|
/// the TextEncoding class.
|
||||||
|
///
|
||||||
|
/// For iterating over char buffers, see the TextBufferIterator class.
|
||||||
{
|
{
|
||||||
public:
|
public:
|
||||||
TextIterator();
|
TextIterator();
|
||||||
/// Creates an uninitialized TextIterator.
|
/// Creates an uninitialized TextIterator.
|
||||||
|
|
||||||
TextIterator(const std::string& str, const TextEncoding& encoding);
|
TextIterator(const std::string& str, const TextEncoding& encoding);
|
||||||
@ -114,12 +116,16 @@ public:
|
|||||||
bool operator == (const TextIterator& it) const;
|
bool operator == (const TextIterator& it) const;
|
||||||
/// Compares two iterators for equality.
|
/// Compares two iterators for equality.
|
||||||
|
|
||||||
bool operator != (const TextIterator& it) const;
|
bool operator != (const TextIterator& it) const;
|
||||||
/// Compares two iterators for inequality.
|
/// Compares two iterators for inequality.
|
||||||
|
|
||||||
|
TextIterator end() const;
|
||||||
|
/// Returns the end iterator for the range handled
|
||||||
|
/// by the iterator.
|
||||||
|
|
||||||
private:
|
private:
|
||||||
const TextEncoding* _pEncoding;
|
const TextEncoding* _pEncoding;
|
||||||
std::string::const_iterator _it;
|
std::string::const_iterator _it;
|
||||||
std::string::const_iterator _end;
|
std::string::const_iterator _end;
|
||||||
};
|
};
|
||||||
|
|
||||||
@ -145,6 +151,12 @@ inline void swap(TextIterator& it1, TextIterator& it2)
|
|||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
|
inline TextIterator TextIterator::end() const
|
||||||
|
{
|
||||||
|
return TextIterator(_end);
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
} // namespace Poco
|
} // namespace Poco
|
||||||
|
|
||||||
|
|
||||||
|
Loading…
x
Reference in New Issue
Block a user