tgui::String Class Reference

Wrapper class to store strings. More...

#include <TGUI/String.hpp>

Public Types
using	iterator = std::u32string::iterator
using	const_iterator = std::u32string::const_iterator
using	reverse_iterator = std::u32string::reverse_iterator
using	const_reverse_iterator = std::u32string::const_reverse_iterator
using	value_type = char32_t
using	reference = char32_t&
using	const_reference = const char32_t&

Public Member Functions
TGUI_NODISCARD bool	attemptToInt (int &result) const
	Converts the string to an integer.
TGUI_NODISCARD bool	attemptToUInt (unsigned int &result) const
	Converts the string to an unsigned int.
TGUI_NODISCARD bool	attemptToFloat (float &result) const
	Converts the string to a float.
TGUI_NODISCARD int	toInt (int defaultValue=0) const
	Converts the string to an integer.
TGUI_NODISCARD unsigned int	toUInt (unsigned int defaultValue=0) const
	Converts the string to an unsigned int.
TGUI_NODISCARD float	toFloat (float defaultValue=0) const
	Converts the string to a float.
TGUI_NODISCARD String	trim () const
	Returns a string with the whitespace at the start and end of this string removed.
TGUI_NODISCARD String	toLower () const
	Converts the ASCII characters in the string to lowercase.
TGUI_NODISCARD String	toUpper () const
	Converts the ASCII characters in the string to uppercase.
TGUI_NODISCARD bool	equalIgnoreCase (const String &other) const
	Compares this string to another and checks if they are equal if ASCII letters would have been lowercase.
TGUI_NODISCARD bool	startsWith (const String &substring) const
	Checks whether the first part of the string matches the given substring.
TGUI_NODISCARD bool	startsWithIgnoreCase (const String &substring) const
	Checks whether the first part of the string matches the given substring, case-insensitive.
TGUI_NODISCARD bool	endsWith (const String &substring) const
	Checks whether the last part of the string matches the given substring.
TGUI_NODISCARD bool	endsWithIgnoreCase (const String &substring) const
	Checks whether the last part of the string matches the given substring, case-insensitive.
String &	replace (const String &searchFor, const String &replaceWith)
	Replaces all occurrences of a substring with a replacement string.
void	remove (const String &substring)
	Removes all occurrences of the given substring.
TGUI_NODISCARD std::vector< String >	split (const String &delimiter, bool trim=false) const
	Splits the string into multiple substrings given the delimiter that separates them.
	String (const std::string &str)
	String (const std::wstring &str)
	String (const std::u16string &str)
	String (const std::u32string &str)
	String (std::u32string &&str)
	String (char ansiChar)
	String (wchar_t wideChar)
	String (char16_t utfChar)
	String (char32_t utfChar)
	String (const char *str)
	String (const wchar_t *str)
	String (const char16_t *str)
	String (const char32_t *str)
template<typename T , typename = typename std::enable_if_t<std::is_arithmetic<T>::value, T>>
	String (T number)
	String (std::size_t count, char ch)
	String (std::size_t count, wchar_t ch)
	String (std::size_t count, char16_t ch)
	String (std::size_t count, char32_t ch)
	String (const std::string &str, std::size_t pos)
	String (const std::wstring &str, std::size_t pos)
	String (const std::u16string &str, std::size_t pos)
	String (const std::u32string &str, std::size_t pos)
	String (const std::string &str, std::size_t pos, std::size_t count)
	String (const std::wstring &str, std::size_t pos, std::size_t count)
	String (const std::u16string &str, std::size_t pos, std::size_t count)
	String (const std::u32string &str, std::size_t pos, std::size_t count)
	String (const char *str, std::size_t count)
	String (const wchar_t *str, std::size_t count)
	String (const char16_t *str, std::size_t count)
	String (const char32_t *str, std::size_t count)
	String (std::initializer_list< char > chars)
	String (std::initializer_list< wchar_t > chars)
	String (std::initializer_list< char16_t > chars)
	String (std::initializer_list< char32_t > chars)
	String (std::string::const_iterator first, std::string::const_iterator last)
	String (std::wstring::const_iterator first, std::wstring::const_iterator last)
	String (std::u16string::const_iterator first, std::u16string::const_iterator last)
	String (std::u32string::const_iterator first, std::u32string::const_iterator last)
template<typename StringViewType , typename = IsStringViewType<StringViewType>>
	String (const StringViewType &stringView)
template<typename StringViewType , typename = IsStringViewType<StringViewType>>
	String (const StringViewType &stringView, std::size_t pos, std::size_t count)
	String (const sf::String &str)
	operator sf::String () const
	operator std::string () const
	operator std::wstring () const
	operator std::u16string () const
	operator const std::u32string & () const
	operator StringView () const noexcept
TGUI_NODISCARD std::string	toStdString () const
TGUI_NODISCARD std::wstring	toWideString () const
TGUI_NODISCARD std::u16string	toUtf16 () const
TGUI_NODISCARD const std::u32string &	toUtf32 () const
String &	assign (std::size_t count, char ch)
String &	assign (std::size_t count, wchar_t ch)
String &	assign (std::size_t count, char16_t ch)
String &	assign (std::size_t count, char32_t ch)
String &	assign (StringView sv)
String &	assign (const char32_t *str)
String &	assign (const std::u32string &str)
String &	assign (const String &str)
String &	assign (StringView sv, std::size_t pos, std::size_t count=npos)
String &	assign (const std::string &str, std::size_t pos, std::size_t count=npos)
String &	assign (const std::wstring &str, std::size_t pos, std::size_t count=npos)
String &	assign (const std::u16string &str, std::size_t pos, std::size_t count=npos)
String &	assign (const std::u32string &str, std::size_t pos, std::size_t count=npos)
String &	assign (const String &str, std::size_t pos, std::size_t count=npos)
String &	assign (std::u32string &&str)
String &	assign (String &&str)
String &	assign (const char *str, std::size_t count)
String &	assign (const wchar_t *str, std::size_t count)
String &	assign (const char16_t *str, std::size_t count)
String &	assign (const char32_t *str, std::size_t count)
String &	assign (std::initializer_list< char > chars)
String &	assign (std::initializer_list< wchar_t > chars)
String &	assign (std::initializer_list< char16_t > chars)
String &	assign (std::initializer_list< char32_t > chars)
String &	assign (std::string::const_iterator first, std::string::const_iterator last)
String &	assign (std::wstring::const_iterator first, std::wstring::const_iterator last)
String &	assign (std::u16string::const_iterator first, std::u16string::const_iterator last)
String &	assign (std::u32string::const_iterator first, std::u32string::const_iterator last)
String &	assign (StringView::const_iterator first, StringView::const_iterator last)
TGUI_NODISCARD reference	at (std::size_t pos)
TGUI_NODISCARD const_reference	at (std::size_t pos) const
TGUI_NODISCARD const_reference	operator[] (std::size_t index) const
TGUI_NODISCARD reference	operator[] (std::size_t index)
TGUI_NODISCARD reference	front ()
TGUI_NODISCARD const_reference	front () const
TGUI_NODISCARD reference	back ()
TGUI_NODISCARD const_reference	back () const
TGUI_NODISCARD const char32_t *	data () const noexcept
TGUI_NODISCARD char32_t *	data () noexcept
TGUI_NODISCARD const char32_t *	c_str () const noexcept
TGUI_NODISCARD iterator	begin () noexcept
TGUI_NODISCARD const_iterator	begin () const noexcept
TGUI_NODISCARD const_iterator	cbegin () const noexcept
TGUI_NODISCARD iterator	end () noexcept
TGUI_NODISCARD const_iterator	end () const noexcept
TGUI_NODISCARD const_iterator	cend () const noexcept
TGUI_NODISCARD reverse_iterator	rbegin () noexcept
TGUI_NODISCARD const_reverse_iterator	rbegin () const noexcept
TGUI_NODISCARD const_reverse_iterator	crbegin () const noexcept
TGUI_NODISCARD reverse_iterator	rend () noexcept
TGUI_NODISCARD const_reverse_iterator	rend () const noexcept
TGUI_NODISCARD const_reverse_iterator	crend () const noexcept
TGUI_NODISCARD bool	empty () const noexcept
TGUI_NODISCARD std::size_t	size () const noexcept
TGUI_NODISCARD std::size_t	length () const noexcept
TGUI_NODISCARD std::size_t	max_size () const noexcept
void	reserve (std::size_t newCap)
TGUI_NODISCARD std::size_t	capacity () const noexcept
void	shrink_to_fit ()
void	clear () noexcept
String &	insert (std::size_t index, std::size_t count, char ch)
String &	insert (std::size_t index, std::size_t count, wchar_t ch)
String &	insert (std::size_t index, std::size_t count, char16_t ch)
String &	insert (std::size_t index, std::size_t count, char32_t ch)
String &	insert (std::size_t index, StringView sv)
String &	insert (std::size_t index, const char32_t *str)
String &	insert (std::size_t index, const std::u32string &str)
String &	insert (std::size_t index, const String &str)
String &	insert (std::size_t index, StringView sv, std::size_t pos, std::size_t count=npos)
String &	insert (std::size_t index, const std::string &str, std::size_t pos, std::size_t count=npos)
String &	insert (std::size_t index, const std::wstring &str, std::size_t pos, std::size_t count=npos)
String &	insert (std::size_t index, const std::u16string &str, std::size_t pos, std::size_t count=npos)
String &	insert (std::size_t index, const std::u32string &str, std::size_t pos, std::size_t count=npos)
String &	insert (std::size_t index, const String &str, std::size_t pos, std::size_t count=npos)
String &	insert (std::size_t index, const char *str, std::size_t count)
String &	insert (std::size_t index, const wchar_t *str, std::size_t count)
String &	insert (std::size_t index, const char16_t *str, std::size_t count)
String &	insert (std::size_t index, const char32_t *str, std::size_t count)
iterator	insert (const_iterator pos, char ch)
iterator	insert (const_iterator pos, wchar_t ch)
iterator	insert (const_iterator pos, char16_t ch)
iterator	insert (const_iterator pos, char32_t ch)
iterator	insert (const_iterator pos, std::size_t count, char ch)
iterator	insert (const_iterator pos, std::size_t count, wchar_t ch)
iterator	insert (const_iterator pos, std::size_t count, char16_t ch)
iterator	insert (const_iterator pos, std::size_t count, char32_t ch)
iterator	insert (const_iterator pos, std::initializer_list< char > chars)
iterator	insert (const_iterator pos, std::initializer_list< wchar_t > chars)
iterator	insert (const_iterator pos, std::initializer_list< char16_t > chars)
iterator	insert (const_iterator pos, std::initializer_list< char32_t > chars)
iterator	insert (const_iterator pos, std::string::const_iterator first, std::string::const_iterator last)
iterator	insert (const_iterator pos, std::wstring::const_iterator first, std::wstring::const_iterator last)
iterator	insert (const_iterator pos, std::u16string::const_iterator first, std::u16string::const_iterator last)
iterator	insert (const_iterator pos, std::u32string::const_iterator first, std::u32string::const_iterator last)
iterator	insert (const_iterator pos, StringView::const_iterator first, StringView::const_iterator last)
String &	erase (std::size_t index=0, std::size_t count=npos)
iterator	erase (const_iterator position)
iterator	erase (const_iterator first, const_iterator last)
void	push_back (char ch)
void	push_back (wchar_t ch)
void	push_back (char16_t ch)
void	push_back (char32_t ch)
void	pop_back ()
String &	append (std::size_t count, char ch)
String &	append (std::size_t count, wchar_t ch)
String &	append (std::size_t count, char16_t ch)
String &	append (std::size_t count, char32_t ch)
String &	append (StringView sv)
String &	append (const char32_t *str)
String &	append (const std::u32string &str)
String &	append (const String &str)
String &	append (StringView sv, std::size_t pos, std::size_t count=npos)
String &	append (const std::string &str, std::size_t pos, std::size_t count=npos)
String &	append (const std::wstring &str, std::size_t pos, std::size_t count=npos)
String &	append (const std::u16string &str, std::size_t pos, std::size_t count=npos)
String &	append (const std::u32string &str, std::size_t pos, std::size_t count=npos)
String &	append (const String &str, std::size_t pos, std::size_t count=npos)
String &	append (const char *str, std::size_t count)
String &	append (const wchar_t *str, std::size_t count)
String &	append (const char16_t *str, std::size_t count)
String &	append (const char32_t *str, std::size_t count)
String &	append (std::string::const_iterator first, std::string::const_iterator last)
String &	append (std::wstring::const_iterator first, std::wstring::const_iterator last)
String &	append (std::u16string::const_iterator first, std::u16string::const_iterator last)
String &	append (std::u32string::const_iterator first, std::u32string::const_iterator last)
String &	append (StringView::const_iterator first, StringView::const_iterator last)
String &	append (std::initializer_list< char > chars)
String &	append (std::initializer_list< wchar_t > chars)
String &	append (std::initializer_list< char16_t > chars)
String &	append (std::initializer_list< char32_t > chars)
String &	operator+= (const String &str)
TGUI_NODISCARD int	compare (StringView sv) const noexcept
TGUI_NODISCARD int	compare (const char32_t *s) const
TGUI_NODISCARD int	compare (const std::u32string &str) const noexcept
TGUI_NODISCARD int	compare (const String &str) const noexcept
TGUI_NODISCARD int	compare (std::size_t pos1, std::size_t count1, StringView sv) const
TGUI_NODISCARD int	compare (std::size_t pos1, std::size_t count1, const char32_t *s) const
TGUI_NODISCARD int	compare (std::size_t pos1, std::size_t count1, const std::u32string &str) const
TGUI_NODISCARD int	compare (std::size_t pos1, std::size_t count1, const String &str) const
TGUI_NODISCARD int	compare (std::size_t pos1, std::size_t count1, StringView sv, std::size_t pos2, std::size_t count2=npos) const
TGUI_NODISCARD int	compare (std::size_t pos1, std::size_t count1, const std::string &str, std::size_t pos2, std::size_t count2=npos) const
TGUI_NODISCARD int	compare (std::size_t pos1, std::size_t count1, const std::wstring &str, std::size_t pos2, std::size_t count2=npos) const
TGUI_NODISCARD int	compare (std::size_t pos1, std::size_t count1, const std::u16string &str, std::size_t pos2, std::size_t count2=npos) const
TGUI_NODISCARD int	compare (std::size_t pos1, std::size_t count1, const std::u32string &str, std::size_t pos2, std::size_t count2=npos) const
TGUI_NODISCARD int	compare (std::size_t pos1, std::size_t count1, const String &str, std::size_t pos2, std::size_t count2=npos) const
TGUI_NODISCARD int	compare (std::size_t pos1, std::size_t count1, const char *s, std::size_t count2) const
TGUI_NODISCARD int	compare (std::size_t pos1, std::size_t count1, const wchar_t *s, std::size_t count2) const
TGUI_NODISCARD int	compare (std::size_t pos1, std::size_t count1, const char16_t *s, std::size_t count2) const
TGUI_NODISCARD int	compare (std::size_t pos1, std::size_t count1, const char32_t *s, std::size_t count2) const
String &	replace (std::size_t pos, std::size_t count, StringView sv)
String &	replace (std::size_t pos, std::size_t count, const char32_t *cstr)
String &	replace (std::size_t pos, std::size_t count, const std::u32string &str)
String &	replace (std::size_t pos, std::size_t count, const String &str)
String &	replace (const_iterator first, const_iterator last, StringView sv)
String &	replace (const_iterator first, const_iterator last, const char32_t *cstr)
String &	replace (const_iterator first, const_iterator last, const std::u32string &str)
String &	replace (const_iterator first, const_iterator last, const String &str)
String &	replace (std::size_t pos, std::size_t count, StringView sv, std::size_t pos2, std::size_t count2=npos)
String &	replace (std::size_t pos, std::size_t count, const std::string &str, std::size_t pos2, std::size_t count2=npos)
String &	replace (std::size_t pos, std::size_t count, const std::wstring &str, std::size_t pos2, std::size_t count2=npos)
String &	replace (std::size_t pos, std::size_t count, const std::u16string &str, std::size_t pos2, std::size_t count2=npos)
String &	replace (std::size_t pos, std::size_t count, const std::u32string &str, std::size_t pos2, std::size_t count2=npos)
String &	replace (std::size_t pos, std::size_t count, const String &str, std::size_t pos2, std::size_t count2=npos)
String &	replace (const_iterator first, const_iterator last, std::string::const_iterator first2, std::string::const_iterator last2)
String &	replace (const_iterator first, const_iterator last, std::wstring::const_iterator first2, std::wstring::const_iterator last2)
String &	replace (const_iterator first, const_iterator last, std::u16string::const_iterator first2, std::u16string::const_iterator last2)
String &	replace (const_iterator first, const_iterator last, std::u32string::const_iterator first2, std::u32string::const_iterator last2)
String &	replace (const_iterator first, const_iterator last, StringView::const_iterator first2, StringView::const_iterator last2)
String &	replace (std::size_t pos, std::size_t count, const char *cstr, std::size_t count2)
String &	replace (std::size_t pos, std::size_t count, const wchar_t *cstr, std::size_t count2)
String &	replace (std::size_t pos, std::size_t count, const char16_t *cstr, std::size_t count2)
String &	replace (std::size_t pos, std::size_t count, const char32_t *cstr, std::size_t count2)
String &	replace (const_iterator first, const_iterator last, const char *cstr, std::size_t count2)
String &	replace (const_iterator first, const_iterator last, const wchar_t *cstr, std::size_t count2)
String &	replace (const_iterator first, const_iterator last, const char16_t *cstr, std::size_t count2)
String &	replace (const_iterator first, const_iterator last, const char32_t *cstr, std::size_t count2)
String &	replace (std::size_t pos, std::size_t count, std::size_t count2, char ch)
String &	replace (std::size_t pos, std::size_t count, std::size_t count2, wchar_t ch)
String &	replace (std::size_t pos, std::size_t count, std::size_t count2, char16_t ch)
String &	replace (std::size_t pos, std::size_t count, std::size_t count2, char32_t ch)
String &	replace (const_iterator first, const_iterator last, std::size_t count2, char ch)
String &	replace (const_iterator first, const_iterator last, std::size_t count2, wchar_t ch)
String &	replace (const_iterator first, const_iterator last, std::size_t count2, char16_t ch)
String &	replace (const_iterator first, const_iterator last, std::size_t count2, char32_t ch)
String &	replace (const_iterator first, const_iterator last, std::initializer_list< char > chars)
String &	replace (const_iterator first, const_iterator last, std::initializer_list< wchar_t > chars)
String &	replace (const_iterator first, const_iterator last, std::initializer_list< char16_t > chars)
String &	replace (const_iterator first, const_iterator last, std::initializer_list< char32_t > chars)
TGUI_NODISCARD String	substr (std::size_t pos=0, std::size_t count=npos) const
std::size_t	copy (char32_t *dest, std::size_t count, std::size_t pos=0) const
void	resize (std::size_t count)
void	resize (std::size_t count, char ch)
void	resize (std::size_t count, wchar_t ch)
void	resize (std::size_t count, char16_t ch)
void	resize (std::size_t count, char32_t ch)
void	swap (String &other)
TGUI_NODISCARD bool	contains (char c) const noexcept
TGUI_NODISCARD bool	contains (wchar_t c) const noexcept
TGUI_NODISCARD bool	contains (char16_t c) const noexcept
TGUI_NODISCARD bool	contains (char32_t c) const noexcept
TGUI_NODISCARD bool	contains (StringView sv) const noexcept
TGUI_NODISCARD bool	contains (const char32_t *s) const
TGUI_NODISCARD bool	contains (const std::u32string &s) const
TGUI_NODISCARD bool	contains (const String &s) const
TGUI_NODISCARD std::size_t	find (StringView sv, std::size_t pos=0) const noexcept
TGUI_NODISCARD std::size_t	find (const char32_t *s, std::size_t pos=0) const
TGUI_NODISCARD std::size_t	find (const std::u32string &str, std::size_t pos=0) const noexcept
TGUI_NODISCARD std::size_t	find (const String &str, std::size_t pos=0) const noexcept
TGUI_NODISCARD std::size_t	find (const char *s, std::size_t pos, std::size_t count) const
TGUI_NODISCARD std::size_t	find (const wchar_t *s, std::size_t pos, std::size_t count) const
TGUI_NODISCARD std::size_t	find (const char16_t *s, std::size_t pos, std::size_t count) const
TGUI_NODISCARD std::size_t	find (const char32_t *s, std::size_t pos, std::size_t count) const
TGUI_NODISCARD std::size_t	find (char ch, std::size_t pos=0) const noexcept
TGUI_NODISCARD std::size_t	find (wchar_t ch, std::size_t pos=0) const noexcept
TGUI_NODISCARD std::size_t	find (char16_t ch, std::size_t pos=0) const noexcept
TGUI_NODISCARD std::size_t	find (char32_t ch, std::size_t pos=0) const noexcept
TGUI_NODISCARD std::size_t	find_first_of (StringView sv, std::size_t pos=0) const noexcept
TGUI_NODISCARD std::size_t	find_first_of (const char32_t *s, std::size_t pos=0) const
TGUI_NODISCARD std::size_t	find_first_of (const std::u32string &str, std::size_t pos=0) const noexcept
TGUI_NODISCARD std::size_t	find_first_of (const String &str, std::size_t pos=0) const noexcept
TGUI_NODISCARD std::size_t	find_first_of (const char *s, std::size_t pos, std::size_t count) const
TGUI_NODISCARD std::size_t	find_first_of (const wchar_t *s, std::size_t pos, std::size_t count) const
TGUI_NODISCARD std::size_t	find_first_of (const char16_t *s, std::size_t pos, std::size_t count) const
TGUI_NODISCARD std::size_t	find_first_of (const char32_t *s, std::size_t pos, std::size_t count) const
TGUI_NODISCARD std::size_t	find_first_of (char ch, std::size_t pos=0) const noexcept
TGUI_NODISCARD std::size_t	find_first_of (wchar_t ch, std::size_t pos=0) const noexcept
TGUI_NODISCARD std::size_t	find_first_of (char16_t ch, std::size_t pos=0) const noexcept
TGUI_NODISCARD std::size_t	find_first_of (char32_t ch, std::size_t pos=0) const noexcept
TGUI_NODISCARD std::size_t	find_first_not_of (StringView sv, std::size_t pos=0) const noexcept
TGUI_NODISCARD std::size_t	find_first_not_of (const char32_t *s, std::size_t pos=0) const
TGUI_NODISCARD std::size_t	find_first_not_of (const std::u32string &str, std::size_t pos=0) const noexcept
TGUI_NODISCARD std::size_t	find_first_not_of (const String &str, std::size_t pos=0) const noexcept
TGUI_NODISCARD std::size_t	find_first_not_of (const char *s, std::size_t pos, std::size_t count) const
TGUI_NODISCARD std::size_t	find_first_not_of (const wchar_t *s, std::size_t pos, std::size_t count) const
TGUI_NODISCARD std::size_t	find_first_not_of (const char16_t *s, std::size_t pos, std::size_t count) const
TGUI_NODISCARD std::size_t	find_first_not_of (const char32_t *s, std::size_t pos, std::size_t count) const
TGUI_NODISCARD std::size_t	find_first_not_of (char ch, std::size_t pos=0) const noexcept
TGUI_NODISCARD std::size_t	find_first_not_of (wchar_t ch, std::size_t pos=0) const noexcept
TGUI_NODISCARD std::size_t	find_first_not_of (char16_t ch, std::size_t pos=0) const noexcept
TGUI_NODISCARD std::size_t	find_first_not_of (char32_t ch, std::size_t pos=0) const noexcept
TGUI_NODISCARD std::size_t	rfind (StringView sv, std::size_t pos=npos) const noexcept
TGUI_NODISCARD std::size_t	rfind (const char32_t *s, std::size_t pos=npos) const
TGUI_NODISCARD std::size_t	rfind (const std::u32string &str, std::size_t pos=npos) const noexcept
TGUI_NODISCARD std::size_t	rfind (const String &str, std::size_t pos=npos) const noexcept
TGUI_NODISCARD std::size_t	rfind (const char *s, std::size_t pos, std::size_t count) const
TGUI_NODISCARD std::size_t	rfind (const wchar_t *s, std::size_t pos, std::size_t count) const
TGUI_NODISCARD std::size_t	rfind (const char16_t *s, std::size_t pos, std::size_t count) const
TGUI_NODISCARD std::size_t	rfind (const char32_t *s, std::size_t pos, std::size_t count) const
TGUI_NODISCARD std::size_t	rfind (char ch, std::size_t pos=npos) const noexcept
TGUI_NODISCARD std::size_t	rfind (wchar_t ch, std::size_t pos=npos) const noexcept
TGUI_NODISCARD std::size_t	rfind (char16_t ch, std::size_t pos=npos) const noexcept
TGUI_NODISCARD std::size_t	rfind (char32_t ch, std::size_t pos=npos) const noexcept
TGUI_NODISCARD std::size_t	find_last_of (StringView sv, std::size_t pos=npos) const noexcept
TGUI_NODISCARD std::size_t	find_last_of (const char32_t *s, std::size_t pos=npos) const
TGUI_NODISCARD std::size_t	find_last_of (const std::u32string &str, std::size_t pos=npos) const noexcept
TGUI_NODISCARD std::size_t	find_last_of (const String &str, std::size_t pos=npos) const noexcept
TGUI_NODISCARD std::size_t	find_last_of (const char *s, std::size_t pos, std::size_t count) const
TGUI_NODISCARD std::size_t	find_last_of (const wchar_t *s, std::size_t pos, std::size_t count) const
TGUI_NODISCARD std::size_t	find_last_of (const char16_t *s, std::size_t pos, std::size_t count) const
TGUI_NODISCARD std::size_t	find_last_of (const char32_t *s, std::size_t pos, std::size_t count) const
TGUI_NODISCARD std::size_t	find_last_of (char ch, std::size_t pos=npos) const noexcept
TGUI_NODISCARD std::size_t	find_last_of (wchar_t ch, std::size_t pos=npos) const noexcept
TGUI_NODISCARD std::size_t	find_last_of (char16_t ch, std::size_t pos=npos) const noexcept
TGUI_NODISCARD std::size_t	find_last_of (char32_t ch, std::size_t pos=npos) const noexcept
TGUI_NODISCARD std::size_t	find_last_not_of (StringView sv, std::size_t pos=npos) const noexcept
TGUI_NODISCARD std::size_t	find_last_not_of (const char32_t *s, std::size_t pos=npos) const
TGUI_NODISCARD std::size_t	find_last_not_of (const std::u32string &str, std::size_t pos=npos) const noexcept
TGUI_NODISCARD std::size_t	find_last_not_of (const String &str, std::size_t pos=npos) const noexcept
TGUI_NODISCARD std::size_t	find_last_not_of (const char *s, std::size_t pos, std::size_t count) const
TGUI_NODISCARD std::size_t	find_last_not_of (const wchar_t *s, std::size_t pos, std::size_t count) const
TGUI_NODISCARD std::size_t	find_last_not_of (const char16_t *s, std::size_t pos, std::size_t count) const
TGUI_NODISCARD std::size_t	find_last_not_of (const char32_t *s, std::size_t pos, std::size_t count) const
TGUI_NODISCARD std::size_t	find_last_not_of (char ch, std::size_t pos=npos) const noexcept
TGUI_NODISCARD std::size_t	find_last_not_of (wchar_t ch, std::size_t pos=npos) const noexcept
TGUI_NODISCARD std::size_t	find_last_not_of (char16_t ch, std::size_t pos=npos) const noexcept
TGUI_NODISCARD std::size_t	find_last_not_of (char32_t ch, std::size_t pos=npos) const noexcept
TGUI_NODISCARD bool	starts_with (StringView sv) const noexcept
TGUI_NODISCARD bool	starts_with (const char32_t *s) const
TGUI_NODISCARD bool	starts_with (const std::u32string &s) const
TGUI_NODISCARD bool	starts_with (const String &s) const
TGUI_NODISCARD bool	starts_with (char ch) const noexcept
TGUI_NODISCARD bool	starts_with (wchar_t ch) const noexcept
TGUI_NODISCARD bool	starts_with (char16_t ch) const noexcept
TGUI_NODISCARD bool	starts_with (char32_t ch) const noexcept
TGUI_NODISCARD bool	ends_with (StringView sv) const noexcept
TGUI_NODISCARD bool	ends_with (const char32_t *s) const
TGUI_NODISCARD bool	ends_with (const std::u32string &s) const
TGUI_NODISCARD bool	ends_with (const String &s) const
TGUI_NODISCARD bool	ends_with (char ch) const noexcept
TGUI_NODISCARD bool	ends_with (wchar_t ch) const noexcept
TGUI_NODISCARD bool	ends_with (char16_t ch) const noexcept
TGUI_NODISCARD bool	ends_with (char32_t ch) const noexcept
TGUI_NODISCARD std::size_t	count (const char ch, const std::size_t pos=0) const noexcept
TGUI_NODISCARD std::size_t	count (const wchar_t ch, const std::size_t pos=0) const noexcept
TGUI_NODISCARD std::size_t	count (const char16_t ch, const std::size_t pos=0) const noexcept
TGUI_NODISCARD std::size_t	count (const char32_t ch, const std::size_t pos=0) const noexcept

Static Public Member Functions
static TGUI_NODISCARD String	join (const std::vector< String > &segments, const String &separator)
	Joins multiple string segments into a single string.
template<typename T >
static TGUI_NODISCARD String	fromNumber (T value)
	Construct the string from a number.
template<typename T >
static TGUI_NODISCARD String	fromNumberRounded (T value, unsigned int decimals)
	Construct the string from a floating point number, keeping only a certain amount of decimals behind the comma.

Static Public Attributes
static constexpr auto	npos = std::u32string_view::npos

Friends
bool	operator== (const String &left, StringView right)
bool	operator== (const String &left, const char32_t *right)
bool	operator== (const String &left, const std::u32string &right)
bool	operator== (const String &left, const String &right)
bool	operator!= (const String &left, StringView right)
bool	operator!= (const String &left, const char32_t *right)
bool	operator!= (const String &left, const std::u32string &right)
bool	operator!= (const String &left, const String &right)
bool	operator< (const String &left, StringView right)
bool	operator< (const String &left, const char32_t *right)
bool	operator< (const String &left, const std::u32string &right)
bool	operator< (const String &left, const String &right)
bool	operator<= (const String &left, StringView right)
bool	operator<= (const String &left, const char32_t *right)
bool	operator<= (const String &left, const std::u32string &right)
bool	operator<= (const String &left, const String &right)
bool	operator> (const String &left, StringView right)
bool	operator> (const String &left, const char32_t *right)
bool	operator> (const String &left, const std::u32string &right)
bool	operator> (const String &left, const String &right)
bool	operator>= (const String &left, StringView right)
bool	operator>= (const String &left, const char32_t *right)
bool	operator>= (const String &left, const std::u32string &right)
bool	operator>= (const String &left, const String &right)
String	operator+ (const String &left, const String &right)
String	operator+ (const String &left, String &&right)
String	operator+ (String &&left, const String &right)
String	operator+ (String &&left, String &&right)

Detailed Description

Wrapper class to store strings.

A constructor and conversion operator are provided for sf::String to easily convert between sf::String and tgui::String.

The interface is similar to std::basic_string, but functions accept char, wchar_t, char8_t, char16_t and char32_t. Some extra helper functions are also provided to e.g. convert the string to an integer or float or to lowercase.

Note that when converting to std::string, an UTF-8 encoded string will be returned. Similarly, when passing an std::string or const char* to this class, the encoding is assumed to be UTF-8.

Data is stored in UTF-32, so any parameter or operator using a different encoding will have to convert the string internally and may be slightly slower than the variants that use UTF-32.

Member Function Documentation

attemptToFloat()

TGUI_NODISCARD bool tgui::String::attemptToFloat

(

float &

result

)

const

Converts the string to a float.

Parameters

result

Float value if the string contains a float. Unmodified if string is invalid.

Returns

Returns whether the string was valid and a value has been placed into the reference parameter.

attemptToInt()

TGUI_NODISCARD bool tgui::String::attemptToInt

(

int &

result

)

const

Converts the string to an integer.

Parameters

result

Integer value if the string contains a base 10 integer. Unmodified if string is invalid.

Returns

Returns whether the string was valid and a value has been placed into the reference parameter.

attemptToUInt()

TGUI_NODISCARD bool tgui::String::attemptToUInt

(

unsigned int &

result

)

const

Converts the string to an unsigned int.

Parameters

result

Unsigned integer value if the string contains a base 10 unsigned int. Unmodified if string is invalid.

Returns

Returns whether the string was valid and a value has been placed into the reference parameter.

endsWith()

TGUI_NODISCARD bool tgui::String::endsWith

(

const String &

substring

)

const

Checks whether the last part of the string matches the given substring.

Parameters

substring

Characters to compare against the final part of the string

Returns

Does the back of the string match the given substring?

Deprecated

Replaced by ends_with in TGUI 1.0

endsWithIgnoreCase()

TGUI_NODISCARD bool tgui::String::endsWithIgnoreCase

(

const String &

substring

)

const

Checks whether the last part of the string matches the given substring, case-insensitive.

Parameters

substring

Characters to compare against the final part of the string

Returns

Does the back of the string match the given substring if we ignore the case?

equalIgnoreCase()

TGUI_NODISCARD bool tgui::String::equalIgnoreCase

(

const String &

other

)

const

Compares this string to another and checks if they are equal if ASCII letters would have been lowercase.

Parameters

other

The other string to compare this one with

Returns

Are the strings equal except for the case of ASCII letters?

fromNumber()

template<typename T >

static TGUI_NODISCARD String tgui::String::fromNumber ( T value )

inlinestatic

Construct the string from a number.

Parameters

value

Number to convert to string

Returns

String representing given number

fromNumberRounded()

template<typename T >

static TGUI_NODISCARD String tgui::String::fromNumberRounded ( T value, unsigned int decimals )

inlinestatic

Construct the string from a floating point number, keeping only a certain amount of decimals behind the comma.

Parameters

value	Number to convert to string
decimals	Digits to keep behind the comma

Returns

String representing given number, rounded to the given decimals

join()

static TGUI_NODISCARD String tgui::String::join ( const std::vector< String > & segments, const String & separator )

static

Joins multiple string segments into a single string.

Parameters

segments	Substrings that need to concatenated behind each other (with optional separators inbetween)
separator	Character that separates the substrings

remove()

void tgui::String::remove

(

const String &

substring

)

Removes all occurrences of the given substring.

Parameters

substring

The value to search for and which should be removed

replace()

String & tgui::String::replace	(	const String &	searchFor,
		const String &	replaceWith )

Replaces all occurrences of a substring with a replacement string.

Parameters

searchFor	The value being searched for
replaceWith	The value that replaces found searchFor values

Returns

Reference to this object.

split()

TGUI_NODISCARD std::vector< String > tgui::String::split	(	const String &	delimiter,
		bool	trim = false ) const

Splits the string into multiple substrings given the delimiter that separates them.

Parameters

delimiter	String that separates the substrings
trim	Should whitespace be removed at the start and end of each part?

startsWith()

TGUI_NODISCARD bool tgui::String::startsWith

(

const String &

substring

)

const

Checks whether the first part of the string matches the given substring.

Parameters

substring

Characters to compare against the first part of the string

Returns

Does the first part of the string match the given substring?

Deprecated

Replaced by starts_with in TGUI 1.0

startsWithIgnoreCase()

TGUI_NODISCARD bool tgui::String::startsWithIgnoreCase

(

const String &

substring

)

const

Checks whether the first part of the string matches the given substring, case-insensitive.

Parameters

substring

Characters to compare against the first part of the string

Returns

Does the first part of the string match the given substring if we ignore the case?

toFloat()

TGUI_NODISCARD float tgui::String::toFloat

(

float

defaultValue = 0

)

const

Converts the string to a float.

Parameters

defaultValue

Value to return if conversion fails

Returns

Returns the float value or defaultValue if the string didn't contain an float

toInt()

TGUI_NODISCARD int tgui::String::toInt

(

int

defaultValue = 0

)

const

Converts the string to an integer.

Parameters

defaultValue

Value to return if conversion fails

Returns

Returns the integer value or defaultValue if the string didn't contain a base 10 integer

toLower()

TGUI_NODISCARD String tgui::String::toLower

(

)

const

Converts the ASCII characters in the string to lowercase.

Returns

Lowercase string

toUInt()

TGUI_NODISCARD unsigned int tgui::String::toUInt

(

unsigned int

defaultValue = 0

)

const

Converts the string to an unsigned int.

Parameters

defaultValue

Value to return if conversion fails

Returns

Returns the unsigned integer value or defaultValue if the string didn't contain a base 10 unsigned integer

toUpper()

TGUI_NODISCARD String tgui::String::toUpper

(

)

const

Converts the ASCII characters in the string to uppercase.

Returns

Uppercase string

trim()

TGUI_NODISCARD String tgui::String::trim

(

)

const

Returns a string with the whitespace at the start and end of this string removed.

Returns

Trimmed string

---

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

• include/TGUI/String.hpp