coat.cStr Class Reference

Public Member Functions
	__init__ (self)
	__init__ (self, str Src)
	__init__ (self, str Src, int StartIndex, int Count)
	__init__ (self, any Src)
	__init__ (self, int Length, any Fill)
	__init__ (self)
	Copy (self, str _0)
	----------------------------------------------------------------------—
	Copy (self, str _0, any StartIndex, any Count)
	Copy (self, any _0)
	__assign__ (self, str _0)
	__assign__ (self)
str	ToCharPtr (self)
	----------------------------------------------------------------------—
any	ToNonConstCharPtr (self)
any	__getitem__ (self, int CharIndex)
any	__setitem__ (self, int CharIndex)
int	Length (self)
	----------------------------------------------------------------------—
	SetLength (self, int Length, any Fill)
	Ensures needed capacity and sets a specified length.
	CalcLength (self)
	Fill (self, any c)
	Path.CalcLength();.
bool	IsEmpty (self)
	----------------------------------------------------------------------—
bool	empty (self)
	Clear (self)
bool	StartsWith (self, str Str, bool NoCase=False)
	Case insesitive compare can be specified.
bool	EndsWith (self, str Str, bool NoCase=False)
	Case insesitive compare can be specified.
	Append (self, str _0)
	----------------------------------------------------------------------—
	Append (self, any _0)
	Append (self, str _0, any StartIndex, any Count)
	Append (self, any _0)
	Append (self, any _0, any Count)
	Append (self, bool _0)
	Append (self, int _0)
	Append (self, float _0, int Prec=2)
	Append (self, float _0, int Prec=6)
	__iadd__ (self, str _0)
	__iadd__ (self, any _0)
	__iadd__ (self, any _0)
	__iadd__ (self, bool _0)
	__iadd__ (self, int _0)
	__iadd__ (self, float _0)
	__iadd__ (self, float _0)
	AppendPath (self, str Path)
	----------------------------------------------------------------------—
	Insert (self, int Index, str _1)
	----------------------------------------------------------------------—
	Insert (self, int Index, str _1, any StartIndex, any Count)
	Insert (self, int Index, any _1)
	Insert (self, int Index, any _1, any Count)
	Insert (self, int Index, bool _1)
	Insert (self, int Index, int _1)
	Insert (self, int Index, float _1, int Prec=2)
	Insert (self, int Index, float _1, int Prec=6)
	Remove (self, int StartIndex)
	and continuing through the last position.
	Remove (self, int StartIndex, int Count)
	beginning at a specified position.
	Replace (self, any Char, any WithChar)
	Replaces all occurrences of a specified character in this instance// with another specified character.
	ReplaceCommaWithDot (self)
	Replace (self, any Char, any WithChar, int StartIndex, int Count)
int	Replace (self, str String, str WithString, bool NoCase=False)
	Case insensitive compare can be specified.
int	Replace (self, str String, str WithString, int StartIndex, bool NoCase=False)
	Replaces in a substring beginning from a specified position to the end.
int	Replace (self, str String, str WithString, int StartIndex, int Count, bool NoCase=False)
	Replaces only within a substring of this instance.
int	ReplaceFirst (self, str String, str WithString, bool NoCase=False)
	Replaces first occurrence of a specified string in this instance with another specified string.
int	ReplaceFirst (self, str String, str WithString, int StartIndex, int Count, bool NoCase=False)
	Replaces only within a substring of this instance.
	ReplaceAny (self, str Chars, any WithChar)
	specified list of characters with another specified character.
	ReplaceAny (self, str Chars, any WithChar, int StartIndex, int Count)
	Replaces only within a substring of this instance.
	TrimStart (self, str TrimChars)
	from the beginning of this instance.
	TrimEnd (self, str TrimChars)
	from the end of this instance.
	Trim (self, str TrimChars)
	from the beginning and end of this instance.
	PadLeft (self, int TotalWidth, any PaddingChar)
	spaces or a specified character for a specified total length.
	PadRight (self, int TotalWidth, any PaddingChar)
	spaces or a specified character for a specified total length.
bool	Contains (self, any c)
	Returns a value indicating whether the specified character occurs within this string.
bool	Contains (self, str Str, bool NoCase=False)
	Case insesitive compare can be specified.
int	IndexOf (self, any c)
	where the specified character is found, or -1 if it is not.
int	IndexOfAny (self, str Chars)
	where any character from the specified list of characters is found, or -1 if it is not.
int	IndexOfAny (self, str Chars, int StartIndex)
	The search starts at a specified character position.
int	IndexOfAny (self, str Chars, int StartIndex, int Count)
	The search starts at a specified character position and examines a specified number of character positions.
int	LastIndexOf (self, any c)
	where the specified character is found, or -1 if it is not.
int	LastIndexOf (self, any c, int StartIndex)
	proceeds backwards towards the beginning.
int	LastIndexOf (self, any c, int StartIndex, int Count)
	or a specified number of character positions have been examined.
int	LastIndexOf (self, str Str, bool NoCase=False)
	Case insesitive compare can be specified.
int	LastIndexOf (self, str Str, int StartIndex, bool NoCase=False)
	The search starts at a specified character position and proceeds backwards towards the beginning.
int	LastIndexOf (self, str Str, int StartIndex, int Count, bool NoCase=False)
	until either the string is found or a specified character positions have been examined.
int	LastIndexOfAny (self, str Chars)
	where any character from the specified list of characters is found, or -1 if it is not.
int	LastIndexOfAny (self, str Chars, int StartIndex)
	proceeds backwards towards the beginning.
int	LastIndexOfAny (self, str Chars, int StartIndex, int Count)
	is found or a specified number of character positions have been examined.
	MakeLower (self, int start=0)
	MakeUpper (self, int start=0)
	Converts this string instance to lowercase.
int	GetHashCode (self, bool NoCase=False)
	----------------------------------------------------------------------—
	RemoveFileExtension (self)
	----------------------------------------------------------------------—
	RemoveFileName (self)
	RemoveFilePath (self)
	RemoveFileAbsPath (self, str AbsPath)
	If string contains absolute path to file below specified "AbsPath", it will be removed.
	AppendFileRelPath (self, str RelPath)
	SetFileExtension (self, str Extension)
	----------------------------------------------------------------------—
	SetFileDefaultExtension (self, str DefaultExtension)
	SetFilePath (self, str Path)
	If there's no extension set the default.
	SetFileDefaultPath (self, str DefaultPath)
	EnsureTrailingBackslash (self)
	If there's no path set the default.
	EnsureTrailingSlash (self)
	EnsureTrailingPlatformSlash (self)
	SlashesToBackSlashes (self)
	BackSlashesToSlashes (self)
	Replaces '/' with '\'.
	MakePlatformSlashes (self)
	Replaces '\' with '/'.
int	CalcUTF8Length (self, int StartIndex)
	Init (self)
	Free (self)
	__init__ (self, any Src)
	__init__ (self, str Src)
	Copy (self, any _0)
	Copy (self, any _0)
	__assign__ (self, any _0)
	__assign__ (self, any _0)
	toWstring (self, any ws)
any	toWstring (self)
	Append (self, str _0)
	Append (self, any _0)
	__iadd__ (self, str _0)
	__iadd__ (self, any _0)

Static Public Member Functions
bool	Equals (str _0, str _1)
	----------------------------------------------------------------------—
bool	EqualsNoCase (str _0, str _1)
bool	EqualsNoCase (str _0, str _1, any MaxLength)
int	Compare (str _0, str _1)
	----------------------------------------------------------------------—
int	Compare (str _0, str _1, any MaxLength)
int	CompareNoCase (str _0, str _1)
int	CompareNoCase (str _0, str _1, any MaxLength)
bool	EqualsPath (str _0, str _1)
	----------------------------------------------------------------------—
bool	EqualsPath (str _0, str _1, any MaxLength)
int	ComparePath (str _0, str _1)
	----------------------------------------------------------------------—
int	ComparePath (str _0, str _1, any MaxLength)
any	ToLower (any c)
	----------------------------------------------------------------------—
any	ToUpper (any c)
bool	CharIsLower (int c)
	----------------------------------------------------------------------—
bool	CharIsUpper (int c)
bool	CharIsAlpha (int c)
bool	CharIsNumeric (int c)
bool	CharIsHexadecimal (int c)
bool	CharIsNewLine (int c)
bool	CharIsTab (int c)
bool	CharIsWhitespace (int c)
bool	CharIsDecimalPoint (int c)
bool	CharIsSign (int c)
bool	CharIsExponent (int c)
bool	ToInt (str Str, int Value)
	----------------------------------------------------------------------—
bool	ToFloat (str Str, float Value)
	Digits Are one or more decimal digits.

Constructor & Destructor Documentation

__init__() [1/8]

coat.cStr.__init__

(

self

)

__init__() [2/8]

coat.cStr.__init__	(		self,
		str	Src )

__init__() [3/8]

coat.cStr.__init__	(		self,
		str	Src,
		int	StartIndex,
		int	Count )

__init__() [4/8]

coat.cStr.__init__	(		self,
		any	Src )

__init__() [5/8]

coat.cStr.__init__	(		self,
		int	Length,
		any	Fill )

__init__() [6/8]

coat.cStr.__init__

(

self

)

__init__() [7/8]

coat.cStr.__init__	(		self,
		any	Src )

__init__() [8/8]

coat.cStr.__init__	(		self,
		str	Src )

Member Function Documentation

__assign__() [1/4]

coat.cStr.__assign__

(

self

)

__assign__() [2/4]

coat.cStr.__assign__	(		self,
		any	_0 )

__assign__() [3/4]

coat.cStr.__assign__	(		self,
		any	_0 )

__assign__() [4/4]

coat.cStr.__assign__	(		self,
		str	_0 )

__getitem__()

any coat.cStr.__getitem__	(		self,
		int	CharIndex )

__iadd__() [1/9]

coat.cStr.__iadd__	(		self,
		any	_0 )

__iadd__() [2/9]

coat.cStr.__iadd__	(		self,
		any	_0 )

__iadd__() [3/9]

coat.cStr.__iadd__	(		self,
		any	_0 )

__iadd__() [4/9]

coat.cStr.__iadd__	(		self,
		bool	_0 )

__iadd__() [5/9]

coat.cStr.__iadd__	(		self,
		float	_0 )

__iadd__() [6/9]

coat.cStr.__iadd__	(		self,
		float	_0 )

__iadd__() [7/9]

coat.cStr.__iadd__	(		self,
		int	_0 )

__iadd__() [8/9]

coat.cStr.__iadd__	(		self,
		str	_0 )

__iadd__() [9/9]

coat.cStr.__iadd__	(		self,
		str	_0 )

__setitem__()

any coat.cStr.__setitem__	(		self,
		int	CharIndex )

Append() [1/11]

coat.cStr.Append	(		self,
		any	_0 )

Append() [2/11]

coat.cStr.Append	(		self,
		any	_0 )

Append() [3/11]

coat.cStr.Append	(		self,
		any	_0 )

Append() [4/11]

coat.cStr.Append	(		self,
		any	_0,
		any	Count )

Append() [5/11]

coat.cStr.Append	(		self,
		bool	_0 )

Append() [6/11]

coat.cStr.Append	(		self,
		float	_0,
		int	Prec = 2 )

Append() [7/11]

coat.cStr.Append	(		self,
		float	_0,
		int	Prec = 6 )

Append() [8/11]

coat.cStr.Append	(		self,
		int	_0 )

Append() [9/11]

coat.cStr.Append	(		self,
		str	_0 )

----------------------------------------------------------------------—

Append() [10/11]

coat.cStr.Append	(		self,
		str	_0 )

Append() [11/11]

coat.cStr.Append	(		self,
		str	_0,
		any	StartIndex,
		any	Count )

AppendFileRelPath()

coat.cStr.AppendFileRelPath	(		self,
		str	RelPath )

AppendPath()

coat.cStr.AppendPath	(		self,
		str	Path )

----------------------------------------------------------------------—

BackSlashesToSlashes()

coat.cStr.BackSlashesToSlashes

(

self

)

Replaces '/' with '\'.

CalcLength()

coat.cStr.CalcLength

(

self

)

CalcUTF8Length()

int coat.cStr.CalcUTF8Length	(		self,
		int	StartIndex )

CharIsAlpha()

bool coat.cStr.CharIsAlpha ( int c )

static

CharIsDecimalPoint()

bool coat.cStr.CharIsDecimalPoint ( int c )

static

CharIsExponent()

bool coat.cStr.CharIsExponent ( int c )

static

CharIsHexadecimal()

bool coat.cStr.CharIsHexadecimal ( int c )

static

CharIsLower()

bool coat.cStr.CharIsLower ( int c )

static

----------------------------------------------------------------------—

CharIsNewLine()

bool coat.cStr.CharIsNewLine ( int c )

static

CharIsNumeric()

bool coat.cStr.CharIsNumeric ( int c )

static

CharIsSign()

bool coat.cStr.CharIsSign ( int c )

static

CharIsTab()

bool coat.cStr.CharIsTab ( int c )

static

CharIsUpper()

bool coat.cStr.CharIsUpper ( int c )

static

CharIsWhitespace()

bool coat.cStr.CharIsWhitespace ( int c )

static

Clear()

coat.cStr.Clear

(

self

)

Compare() [1/2]

int coat.cStr.Compare ( str _0, str _1 )

static

----------------------------------------------------------------------—

Compare() [2/2]

int coat.cStr.Compare ( str _0, str _1, any MaxLength )

static

CompareNoCase() [1/2]

int coat.cStr.CompareNoCase ( str _0, str _1 )

static

CompareNoCase() [2/2]

int coat.cStr.CompareNoCase ( str _0, str _1, any MaxLength )

static

ComparePath() [1/2]

int coat.cStr.ComparePath ( str _0, str _1 )

static

----------------------------------------------------------------------—

ComparePath() [2/2]

int coat.cStr.ComparePath ( str _0, str _1, any MaxLength )

static

Contains() [1/2]

bool coat.cStr.Contains	(		self,
		any	c )

Returns a value indicating whether the specified character occurs within this string.

Contains() [2/2]

bool coat.cStr.Contains	(		self,
		str	Str,
		bool	NoCase = False )

Case insesitive compare can be specified.

Copy() [1/5]

coat.cStr.Copy	(		self,
		any	_0 )

Copy() [2/5]

coat.cStr.Copy	(		self,
		any	_0 )

Copy() [3/5]

coat.cStr.Copy	(		self,
		any	_0 )

Copy() [4/5]

coat.cStr.Copy	(		self,
		str	_0 )

----------------------------------------------------------------------—

Copy() [5/5]

coat.cStr.Copy	(		self,
		str	_0,
		any	StartIndex,
		any	Count )

empty()

bool coat.cStr.empty

(

self

)

EndsWith()

bool coat.cStr.EndsWith	(		self,
		str	Str,
		bool	NoCase = False )

Case insesitive compare can be specified.

EnsureTrailingBackslash()

coat.cStr.EnsureTrailingBackslash

(

self

)

If there's no path set the default.

EnsureTrailingPlatformSlash()

coat.cStr.EnsureTrailingPlatformSlash

(

self

)

EnsureTrailingSlash()

coat.cStr.EnsureTrailingSlash

(

self

)

Equals()

bool coat.cStr.Equals ( str _0, str _1 )

static

----------------------------------------------------------------------—

EqualsNoCase() [1/2]

bool coat.cStr.EqualsNoCase ( str _0, str _1 )

static

EqualsNoCase() [2/2]

bool coat.cStr.EqualsNoCase ( str _0, str _1, any MaxLength )

static

EqualsPath() [1/2]

bool coat.cStr.EqualsPath ( str _0, str _1 )

static

----------------------------------------------------------------------—

EqualsPath() [2/2]

bool coat.cStr.EqualsPath ( str _0, str _1, any MaxLength )

static

Fill()

coat.cStr.Fill	(		self,
		any	c )

Path.CalcLength();.

Free()

coat.cStr.Free

(

self

)

GetHashCode()

int coat.cStr.GetHashCode	(		self,
		bool	NoCase = False )

----------------------------------------------------------------------—

IndexOf()

int coat.cStr.IndexOf	(		self,
		any	c )

where the specified character is found, or -1 if it is not.

IndexOfAny() [1/3]

int coat.cStr.IndexOfAny	(		self,
		str	Chars )

where any character from the specified list of characters is found, or -1 if it is not.

IndexOfAny() [2/3]

int coat.cStr.IndexOfAny	(		self,
		str	Chars,
		int	StartIndex )

The search starts at a specified character position.

IndexOfAny() [3/3]

int coat.cStr.IndexOfAny	(		self,
		str	Chars,
		int	StartIndex,
		int	Count )

The search starts at a specified character position and examines a specified number of character positions.

Init()

coat.cStr.Init

(

self

)

Insert() [1/8]

coat.cStr.Insert	(		self,
		int	Index,
		any	_1 )

Insert() [2/8]

coat.cStr.Insert	(		self,
		int	Index,
		any	_1,
		any	Count )

Insert() [3/8]

coat.cStr.Insert	(		self,
		int	Index,
		bool	_1 )

Insert() [4/8]

coat.cStr.Insert	(		self,
		int	Index,
		float	_1,
		int	Prec = 2 )

Insert() [5/8]

coat.cStr.Insert	(		self,
		int	Index,
		float	_1,
		int	Prec = 6 )

Insert() [6/8]

coat.cStr.Insert	(		self,
		int	Index,
		int	_1 )

Insert() [7/8]

coat.cStr.Insert	(		self,
		int	Index,
		str	_1 )

----------------------------------------------------------------------—

Insert() [8/8]

coat.cStr.Insert	(		self,
		int	Index,
		str	_1,
		any	StartIndex,
		any	Count )

IsEmpty()

bool coat.cStr.IsEmpty

(

self

)

----------------------------------------------------------------------—

LastIndexOf() [1/6]

int coat.cStr.LastIndexOf	(		self,
		any	c )

where the specified character is found, or -1 if it is not.

LastIndexOf() [2/6]

int coat.cStr.LastIndexOf	(		self,
		any	c,
		int	StartIndex )

proceeds backwards towards the beginning.

LastIndexOf() [3/6]

int coat.cStr.LastIndexOf	(		self,
		any	c,
		int	StartIndex,
		int	Count )

or a specified number of character positions have been examined.

LastIndexOf() [4/6]

int coat.cStr.LastIndexOf	(		self,
		str	Str,
		bool	NoCase = False )

Case insesitive compare can be specified.

LastIndexOf() [5/6]

int coat.cStr.LastIndexOf	(		self,
		str	Str,
		int	StartIndex,
		bool	NoCase = False )

The search starts at a specified character position and proceeds backwards towards the beginning.

LastIndexOf() [6/6]

int coat.cStr.LastIndexOf	(		self,
		str	Str,
		int	StartIndex,
		int	Count,
		bool	NoCase = False )

until either the string is found or a specified character positions have been examined.

LastIndexOfAny() [1/3]

int coat.cStr.LastIndexOfAny	(		self,
		str	Chars )

where any character from the specified list of characters is found, or -1 if it is not.

LastIndexOfAny() [2/3]

int coat.cStr.LastIndexOfAny	(		self,
		str	Chars,
		int	StartIndex )

proceeds backwards towards the beginning.

LastIndexOfAny() [3/3]

int coat.cStr.LastIndexOfAny	(		self,
		str	Chars,
		int	StartIndex,
		int	Count )

is found or a specified number of character positions have been examined.

Length()

int coat.cStr.Length

(

self

)

----------------------------------------------------------------------—

MakeLower()

coat.cStr.MakeLower	(		self,
		int	start = 0 )

MakePlatformSlashes()

coat.cStr.MakePlatformSlashes

(

self

)

Replaces '\' with '/'.

MakeUpper()

coat.cStr.MakeUpper	(		self,
		int	start = 0 )

Converts this string instance to lowercase.

PadLeft()

coat.cStr.PadLeft	(		self,
		int	TotalWidth,
		any	PaddingChar )

spaces or a specified character for a specified total length.

PadRight()

coat.cStr.PadRight	(		self,
		int	TotalWidth,
		any	PaddingChar )

spaces or a specified character for a specified total length.

Remove() [1/2]

coat.cStr.Remove	(		self,
		int	StartIndex )

and continuing through the last position.

Remove() [2/2]

coat.cStr.Remove	(		self,
		int	StartIndex,
		int	Count )

beginning at a specified position.

RemoveFileAbsPath()

coat.cStr.RemoveFileAbsPath	(		self,
		str	AbsPath )

If string contains absolute path to file below specified "AbsPath", it will be removed.

RemoveFileExtension()

coat.cStr.RemoveFileExtension

(

self

)

----------------------------------------------------------------------—

RemoveFileName()

coat.cStr.RemoveFileName

(

self

)

RemoveFilePath()

coat.cStr.RemoveFilePath

(

self

)

Replace() [1/5]

coat.cStr.Replace	(		self,
		any	Char,
		any	WithChar )

Replaces all occurrences of a specified character in this instance// with another specified character.

Replace() [2/5]

coat.cStr.Replace	(		self,
		any	Char,
		any	WithChar,
		int	StartIndex,
		int	Count )

Replace() [3/5]

int coat.cStr.Replace	(		self,
		str	String,
		str	WithString,
		bool	NoCase = False )

Case insensitive compare can be specified.

Replace() [4/5]

int coat.cStr.Replace	(		self,
		str	String,
		str	WithString,
		int	StartIndex,
		bool	NoCase = False )

Replaces in a substring beginning from a specified position to the end.

Replace() [5/5]

int coat.cStr.Replace	(		self,
		str	String,
		str	WithString,
		int	StartIndex,
		int	Count,
		bool	NoCase = False )

Replaces only within a substring of this instance.

ReplaceAny() [1/2]

coat.cStr.ReplaceAny	(		self,
		str	Chars,
		any	WithChar )

specified list of characters with another specified character.

ReplaceAny() [2/2]

coat.cStr.ReplaceAny	(		self,
		str	Chars,
		any	WithChar,
		int	StartIndex,
		int	Count )

Replaces only within a substring of this instance.

ReplaceCommaWithDot()

coat.cStr.ReplaceCommaWithDot

(

self

)

ReplaceFirst() [1/2]

int coat.cStr.ReplaceFirst	(		self,
		str	String,
		str	WithString,
		bool	NoCase = False )

Replaces first occurrence of a specified string in this instance with another specified string.

ReplaceFirst() [2/2]

int coat.cStr.ReplaceFirst	(		self,
		str	String,
		str	WithString,
		int	StartIndex,
		int	Count,
		bool	NoCase = False )

Replaces only within a substring of this instance.

SetFileDefaultExtension()

coat.cStr.SetFileDefaultExtension	(		self,
		str	DefaultExtension )

SetFileDefaultPath()

coat.cStr.SetFileDefaultPath	(		self,
		str	DefaultPath )

SetFileExtension()

coat.cStr.SetFileExtension	(		self,
		str	Extension )

----------------------------------------------------------------------—

SetFilePath()

coat.cStr.SetFilePath	(		self,
		str	Path )

If there's no extension set the default.

SetLength()

coat.cStr.SetLength	(		self,
		int	Length,
		any	Fill )

Ensures needed capacity and sets a specified length.

Fill char can be specified.

SlashesToBackSlashes()

coat.cStr.SlashesToBackSlashes

(

self

)

StartsWith()

bool coat.cStr.StartsWith	(		self,
		str	Str,
		bool	NoCase = False )

Case insesitive compare can be specified.

ToCharPtr()

str coat.cStr.ToCharPtr

(

self

)

----------------------------------------------------------------------—

ToFloat()

bool coat.cStr.ToFloat ( str Str, float Value )

static

Digits Are one or more decimal digits.

ToInt()

bool coat.cStr.ToInt ( str Str, int Value )

static

----------------------------------------------------------------------—

ToLower()

any coat.cStr.ToLower ( any c )

static

----------------------------------------------------------------------—

ToNonConstCharPtr()

any coat.cStr.ToNonConstCharPtr

(

self

)

ToUpper()

any coat.cStr.ToUpper ( any c )

static

toWstring() [1/2]

any coat.cStr.toWstring

(

self

)

toWstring() [2/2]

coat.cStr.toWstring	(		self,
		any	ws )

Trim()

coat.cStr.Trim	(		self,
		str	TrimChars )

from the beginning and end of this instance.

TrimEnd()

coat.cStr.TrimEnd	(		self,
		str	TrimChars )

from the end of this instance.

TrimStart()

coat.cStr.TrimStart	(		self,
		str	TrimChars )

from the beginning of this instance.

---

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

• doxy/src/coat.py