FBStringList Class Reference

#include <mobu-python-api.h>

Class Description

String list.

See the C++ reference

Inheritance diagram for FBStringList:

Public Member Functions
	__reduce__ ()
	__init__ (...)
int	Add (FBStringList arg1, str arg2, object arg3)
	Add a string to the list. More...
	Clear (FBStringList arg1)
	Clear the list (remove all the items). More...
	Find (...)
str	GetAt (FBStringList arg1, object arg2)
	Get the string at pIndex. More...
int	__len__ (FBStringList arg1)
int	GetReferenceAt (FBStringList arg1, object arg2)
	Get the reference store with the string at pIndex. More...
int	IndexOf (FBStringList arg1, str arg2)
	Get the index of a string. More...
	InsertAt (FBStringList arg1, object arg2, str arg3, object arg4)
	Insert an entry at pIndex. More...
str	__getitem__ (FBStringList arg1, object arg2)
bool	__setitem__ (FBStringList arg1, object arg2, str arg3)
int	Remove (FBStringList arg1, str arg2)
	Remove a string from the list. More...
	RemoveAt (FBStringList arg1, object arg2)
	Remove an entry at pIndex. More...
bool	SetAt (FBStringList arg1, object arg2, str arg3)
	Set the string at pIndex. More...
	SetReferenceAt (FBStringList arg1, object arg2, object arg3)
	Set the reference stored with the string at pIndex. More...
	Sort (FBStringList arg1)
	Sort the string list (ascending) More...
str	AsString (FBStringList arg1, str arg2)
	Get as string. More...
bool	SetString (FBStringList arg1, str arg2, str arg3)
	Set string for list. More...

Member Function Documentation

str __getitem__	(	FBStringList	arg1,
		object	arg2
	)

Python Docstring:

__getitem__( (FBStringList)arg1, (object)arg2) -> str 

__init__

(

...

)

Python Docstring:

__init__( (object)arg1) -> None

__init__( (object)arg1, (str)arg2 [, (str)arg3]) -> None 

C++ Constructors:
The reference documentation for the following C++ symbols may contain additional relevant information.

 FBStringList()
 FBStringList(const char * pString, const char pSeparator = '~')
 FBStringList(const ORSDK2018::FBStringList & pOther)

int __len__

(

FBStringList

arg1

)

Python Docstring:

__len__( (FBStringList)arg1) -> int 

__reduce__

(

)

bool __setitem__	(	FBStringList	arg1,
		object	arg2,
		str	arg3
	)

Python Docstring:

__setitem__( (FBStringList)arg1, (object)arg2, (str)arg3) -> bool 

int Add	(	FBStringList	arg1,
		str	arg2,
		object	arg3
	)

Add a string to the list.

Python Docstring:

Add( (FBStringList)arg1, (str)arg2 [, (object)arg3]) -> int 

C++ Signature:

int Add(const char * S, kReference pRef = 0) 

Parameters

S	String to add to list.
pRef	Reference to store with string (default = 0)

Returns

Index where item was stored.

See the C++ reference

str AsString	(	FBStringList	arg1,
		str	arg2
	)

Get as string.

Python Docstring:

AsString( (FBStringList)arg1 [, (str)arg2]) -> str 

C++ Signature:

const char * AsString(const char pSeparator = '~') 

Parameters

pSeparator

the string list separator.

Returns

String list.

See the C++ reference

Clear

(

FBStringList

arg1

)

Clear the list (remove all the items).

Python Docstring:

Clear( (FBStringList)arg1) -> None 

C++ Signature:

void Clear() 

See the C++ reference

Find

(

...

)

Python Docstring:

Find( (FBStringList)arg1, (object)arg2) -> int

Find( (FBStringList)arg1, (str)arg2 [, (object)arg3 [, (object)arg4]]) -> int 

Related C++ documentation:
The reference documentation for the following C++ symbols may contain additional relevant information.

int Find(kReference pRef)
int Find(const char * pString, bool pCaseSensitive = true, bool pStartWith = false)

str GetAt	(	FBStringList	arg1,
		object	arg2
	)

Get the string at pIndex.

Python Docstring:

GetAt( (FBStringList)arg1, (object)arg2) -> str 

C++ Signature:

const char * GetAt(int pIndex) 

Parameters

pIndex

Index to get string at.

Returns

String at pIndex.

See the C++ reference

int GetReferenceAt	(	FBStringList	arg1,
		object	arg2
	)

Get the reference store with the string at pIndex.

Python Docstring:

GetReferenceAt( (FBStringList)arg1, (object)arg2) -> int 

C++ Signature:

kReference GetReferenceAt(int pIndex) 

Parameters

pIndex

Index to get reference at.

Returns

Reference stored with value at pIndex.

See the C++ reference

int IndexOf	(	FBStringList	arg1,
		str	arg2
	)

Get the index of a string.

Python Docstring:

IndexOf( (FBStringList)arg1, (str)arg2) -> int 

C++ Signature:

int IndexOf(const char * S) 

Parameters

S	String to look for.

Returns

Index where string S was found.

See the C++ reference

InsertAt	(	FBStringList	arg1,
		object	arg2,
		str	arg3,
		object	arg4
	)

Insert an entry at pIndex.

Python Docstring:

InsertAt( (FBStringList)arg1, (object)arg2, (str)arg3 [, (object)arg4]) -> None 

C++ Signature:

void InsertAt(int pIndex, const char * S, kReference pRef = 0) 

Parameters

pIndex	Index where item is to be inserted.
S	String to insert.
pRef	Reference to store with string(default=0).

See the C++ reference

int Remove	(	FBStringList	arg1,
		str	arg2
	)

Remove a string from the list.

Python Docstring:

Remove( (FBStringList)arg1, (str)arg2) -> int 

C++ Signature:

int Remove(const char * S) 

Parameters

S	String to remove from the list.

Returns

Index where item was found.

See the C++ reference

RemoveAt	(	FBStringList	arg1,
		object	arg2
	)

Remove an entry at pIndex.

Python Docstring:

RemoveAt( (FBStringList)arg1, (object)arg2) -> None 

C++ Signature:

void RemoveAt(int pIndex) 

Parameters

pIndex

Index where item is to be removed from.

See the C++ reference

bool SetAt	(	FBStringList	arg1,
		object	arg2,
		str	arg3
	)

Set the string at pIndex.

Python Docstring:

SetAt( (FBStringList)arg1, (object)arg2, (str)arg3) -> bool 

C++ Signature:

bool SetAt(int pIndex, const char * pString) 

Parameters

pIndex	Index where string is to be set.
pString	String to set value at pIndex with.

See the C++ reference

SetReferenceAt	(	FBStringList	arg1,
		object	arg2,
		object	arg3
	)

Set the reference stored with the string at pIndex.

Python Docstring:

SetReferenceAt( (FBStringList)arg1, (object)arg2, (object)arg3) -> None 

C++ Signature:

void SetReferenceAt(int pIndex, kReference pRef) 

Parameters

pIndex	Index to store reference at.
pRef	Reference to store at pIndex.

See the C++ reference

bool SetString	(	FBStringList	arg1,
		str	arg2,
		str	arg3
	)

Set string for list.

Python Docstring:

SetString( (FBStringList)arg1, (str)arg2 [, (str)arg3]) -> bool 

C++ Signature:

bool SetString(const char * pString, const char pSeparator = '~') 

Parameters

pSeparator	the string list separator.
pString	String to set for list.

See the C++ reference

Sort

(

FBStringList

arg1

)

Sort the string list (ascending)

Python Docstring:

Sort( (FBStringList)arg1) -> None 

C++ Signature:

void Sort() 

See the C++ reference