u5e
UnicodeTextC++Library
Public Types | Public Member Functions | List of all members
u5e::basic_grapheme< UnderlyingEncodedStringView > Class Template Reference

Represents a single grapheme cluster. More...

#include <u5e/basic_grapheme.hpp>

Public Types

typedef UnderlyingEncodedStringView::const_iterator const_codepoint_iterator
 

Public Member Functions

 basic_grapheme ()
 
 basic_grapheme (const_codepoint_iterator b, const_codepoint_iterator e)
 
const_codepoint_iterator codepoint_begin ()
 
const_codepoint_iterator codepoint_end ()
 

Detailed Description

template<typename UnderlyingEncodedStringView>
class u5e::basic_grapheme< UnderlyingEncodedStringView >

Represents a single grapheme cluster.

It works by holding start and end values for an underlying encodedstring_view-like object.

Template Parameters
UnderlyingEncodedStringViewa basic_encodedstring instantiation.

Definition at line 15 of file basic_grapheme.hpp.

Member Typedef Documentation

template<typename UnderlyingEncodedStringView >
typedef UnderlyingEncodedStringView::const_iterator u5e::basic_grapheme< UnderlyingEncodedStringView >::const_codepoint_iterator

const_codepoint_iterator allows you to traverse the codepoints inside this grapheme.

Definition at line 22 of file basic_grapheme.hpp.

Constructor & Destructor Documentation

template<typename UnderlyingEncodedStringView >
u5e::basic_grapheme< UnderlyingEncodedStringView >::basic_grapheme ( )
inline

Default constructor is only valid if the underlying type allows it

Definition at line 39 of file basic_grapheme.hpp.

template<typename UnderlyingEncodedStringView >
u5e::basic_grapheme< UnderlyingEncodedStringView >::basic_grapheme ( const_codepoint_iterator  b,
const_codepoint_iterator  e 
)
inline

Construct it with the iterators representing the begin and the end of the grapheme.

Definition at line 45 of file basic_grapheme.hpp.

Member Function Documentation

template<typename UnderlyingEncodedStringView >
const_codepoint_iterator u5e::basic_grapheme< UnderlyingEncodedStringView >::codepoint_begin ( )
inline

get the beginning of the codepoints

Definition at line 52 of file basic_grapheme.hpp.

template<typename UnderlyingEncodedStringView >
const_codepoint_iterator u5e::basic_grapheme< UnderlyingEncodedStringView >::codepoint_end ( )
inline

get the end of the codepoints

Definition at line 59 of file basic_grapheme.hpp.


The documentation for this class was generated from the following file: