Pango.Item

record (struct)

The PangoItem structure stores information about a segment of text.

You typically obtain PangoItems by itemizing a piece of text with itemize.

Constructors

new

@classmethod
def new(cls) -> Item

Creates a new PangoItem structure initialized to default values.

Methods

apply_attrs

def apply_attrs(self, iter: AttrIterator) -> None

Add attributes to a PangoItem.

The idea is that you have attributes that don't affect itemization, such as font features, so you filter them out using AttrList.filter, itemize your text, then reapply the attributes to the resulting items using this function.

The iter should be positioned before the range of the item, and will be advanced past it. This function is meant to be called in a loop over the items resulting from itemization, while passing the iter to each call.

Parameters:

• iter — a PangoAttrIterator

copy

def copy(self) -> Item | None

Copy an existing PangoItem structure.

free

def free(self) -> None

Free a PangoItem and all associated memory.

get_char_offset

def get_char_offset(self) -> int

Returns the character offset of the item from the beginning of the itemized text.

If the item has not been obtained from Pango's itemization machinery, then the character offset is not available. In that case, this function returns -1.

split

def split(self, split_index: int, split_offset: int) -> Item

Modifies orig to cover only the text after split_index, and returns a new item that covers the text before split_index that used to be in orig.

You can think of split_index as the length of the returned item. split_index may not be 0, and it may not be greater than or equal to the length of orig (that is, there must be at least one byte assigned to each item, you can't create a zero-length item). split_offset is the length of the first item in chars, and must be provided because the text used to generate the item isn't available, so pango_item_split() can't count the char length of the split items itself.

Parameters:

• split_index — byte index of position to split item, relative to the start of the item
• split_offset — number of chars between start of orig and split_index

Properties

offset

offset: int  # read/write

length

length: int  # read/write

num_chars

num_chars: int  # read/write

analysis

analysis: Analysis  # read/write