TextElementList

Canonical path: NemAll_Python_BasisElements.TextElementList

List for TextElement objects

Methods:

• __contains__ –

  Check for a value in the list

• __delitem__ –

  Delete a list item

• __eq__ –

  Compare two lists

• __getitem__ –

  Get a list item

• __iadd__ –

  Add a list

• __init__ –

  Overloaded function. See individual overloads.

• __iter__ –

  List iterator

• __len__ –

  Get the list length

• __repr__ –

  Create a string from the elements of the list

• __setitem__ –

  Set a list item

• append –

  Append a list item

• extend –

  Overloaded function. See individual overloads.

__contains__

__contains__(value: TextElement) -> bool

Check for a value in the list

Parameters:

• value (TextElement) –

  Value to check

Returns:

• bool –

  State for value is in the list

__delitem__

__delitem__(value: TextElement)

Delete a list item

Parameters:

• value (TextElement) –

  Value to delete

__eq__

__eq__(compare_list: TextElementList) -> bool

Compare two lists

Parameters:

• compare_list (TextElementList) –

  List to compare

Returns:

• bool –

  Lists are equal state

__getitem__

__getitem__(index: int) -> TextElement

Get a list item

Parameters:

• index (int) –

  Index of the item

Returns:

• TextElement –

  Value for the index

__iadd__

__iadd__(eleList: list) -> TextElementList

Add a list

Parameters:

• eleList (list) –

  TextElement list

Returns:

• TextElementList –

  Lists with the added elements

__init__ overloaded

__init__()

Initialize

__init__(ele: TextElement)

Constructor with a TextElement

Parameters:

• ele (TextElement) –

  TextElement

__init__(eleList: list)

Constructor with a list of TextElement

Parameters:

• eleList (list) –

  TextElement list

__iter__

__iter__() -> Iterator

List iterator

Returns:

• Iterator –

  List iterator

__len__

__len__() -> int

Get the list length

Returns:

• int –

  Length of the list

__repr__

__repr__() -> str

Create a string from the elements of the list

__setitem__

__setitem__(index: int | slice, value: TextElement)

Set a list item

Parameters:

• index (int | slice) –

  Index of the item

• value (TextElement) –

  Value to item

append

append(value: TextElement)

Append a list item

Parameters:

• value (TextElement) –

  Value to append

extend overloaded

extend(iterable: TextElementList)

Add the items from an iterable to the end of the list

Parameters:

• iterable (TextElementList) –

  Iterable to add

extend(eleList: list)

Extend the list

Parameters:

• eleList (list) –

  TextElement list

Placeholder