TableRow

Represents a row in a Tableview object

Source code in src/ttkbootstrap/widgets/tableview.py

class TableRow:
    """Represents a row in a Tableview object"""

    _cnt = 0

    def __init__(self, tableview: "Tableview", values: Sequence[Any]) -> None:
        """
        Parameters:

            tableview (Tableview):
                The Tableview widget that contains this row

            values (list[Any, ...]):
                A list of values to display in the row
        """
        self.view: ttk.Treeview = tableview.view
        self._values = list(values)
        self._iid = None
        self._sort = TableRow._cnt + 1
        self._table = tableview

        # increment cnt
        TableRow._cnt += 1

    @property
    def values(self) -> List[Any]:
        """The table row values"""
        return self._values

    @values.setter
    def values(self, values: Sequence[Any]) -> None:
        self._values = values
        self.refresh()

    @property
    def iid(self) -> str:
        """A unique record identifier"""
        return str(self._iid)

    def configure(self, opt: Optional[str] = None, **kwargs: Any) -> Union[Any, None]:
        """Configure the row. If opt is provided, the
        current value is returned, otherwise, sets the widget
        options specified in kwargs. See the documentation for
        `Tableview.insert_row` for configurable options.

        Parameters:

            opt (str):
                A configuration option to query.

            **kwargs { values, tags }:
                Optional keyword arguments used to configure the
                row.
        """
        if self._iid is None:
            self.build()

        if opt is not None:
            return self.view.item(self.iid, opt)
        elif 'values' in kwargs:
            values = kwargs.pop('values')
            self.values = values
        else:
            self.view.item(self.iid, **kwargs)

    def show(self, striped: bool = False) -> None:
        """Show the row in the data table view"""
        if self._iid is None:
            self.build()
        self.view.reattach(self.iid, "", END)

        # remove existing stripes
        tags = list(self.view.item(self.iid, "tags"))
        try:
            tags.remove("striped")
        except ValueError:
            pass

        # add stripes (if needed)
        if striped:
            tags.append("striped")
        self.view.item(self.iid, tags=tags)

    def delete(self) -> None:
        """Delete the row from the dataset"""
        if self.iid:
            self._table.iidmap.pop(self.iid)
            self._table.tablerows_visible.remove(self)
            self._table._tablerows.remove(self)
            self._table.load_table_data()
            self.view.delete(self.iid)

    def hide(self) -> None:
        """Remove the row from the data table view"""
        self.view.detach(self.iid)

    def refresh(self) -> None:
        """Syncs the tableview values with the object values"""
        if self._iid:
            self.view.item(self.iid, values=self.values)

    def build(self) -> None:
        """Create the row object in the `Treeview` and capture
        the resulting item id (iid).
        """
        if self._iid is None:
            # Use custom iid from specified field if configured
            if self._table._iid_field_index is not None:
                try:
                    custom_iid = str(self.values[self._table._iid_field_index])
                    self._iid = self.view.insert("", END, iid=custom_iid, values=self.values)
                except (IndexError, tk.TclError):
                    # Fall back to auto-generated iid if field doesn't exist or iid already exists
                    self._iid = self.view.insert("", END, values=self.values)
            else:
                self._iid = self.view.insert("", END, values=self.values)
            self._table.iidmap[self.iid] = self

iid property

A unique record identifier

values property writable

The table row values

__init__(tableview, values)

Parameters:

tableview (Tableview):
    The Tableview widget that contains this row

values (list[Any, ...]):
    A list of values to display in the row

Source code in src/ttkbootstrap/widgets/tableview.py

def __init__(self, tableview: "Tableview", values: Sequence[Any]) -> None:
    """
    Parameters:

        tableview (Tableview):
            The Tableview widget that contains this row

        values (list[Any, ...]):
            A list of values to display in the row
    """
    self.view: ttk.Treeview = tableview.view
    self._values = list(values)
    self._iid = None
    self._sort = TableRow._cnt + 1
    self._table = tableview

    # increment cnt
    TableRow._cnt += 1

build()

Create the row object in the Treeview and capture the resulting item id (iid).

Source code in src/ttkbootstrap/widgets/tableview.py

def build(self) -> None:
    """Create the row object in the `Treeview` and capture
    the resulting item id (iid).
    """
    if self._iid is None:
        # Use custom iid from specified field if configured
        if self._table._iid_field_index is not None:
            try:
                custom_iid = str(self.values[self._table._iid_field_index])
                self._iid = self.view.insert("", END, iid=custom_iid, values=self.values)
            except (IndexError, tk.TclError):
                # Fall back to auto-generated iid if field doesn't exist or iid already exists
                self._iid = self.view.insert("", END, values=self.values)
        else:
            self._iid = self.view.insert("", END, values=self.values)
        self._table.iidmap[self.iid] = self

configure(opt=None, **kwargs)

Configure the row. If opt is provided, the current value is returned, otherwise, sets the widget options specified in kwargs. See the documentation for Tableview.insert_row for configurable options.

Parameters:

opt (str):
    A configuration option to query.

**kwargs { values, tags }:
    Optional keyword arguments used to configure the
    row.

Source code in src/ttkbootstrap/widgets/tableview.py

def configure(self, opt: Optional[str] = None, **kwargs: Any) -> Union[Any, None]:
    """Configure the row. If opt is provided, the
    current value is returned, otherwise, sets the widget
    options specified in kwargs. See the documentation for
    `Tableview.insert_row` for configurable options.

    Parameters:

        opt (str):
            A configuration option to query.

        **kwargs { values, tags }:
            Optional keyword arguments used to configure the
            row.
    """
    if self._iid is None:
        self.build()

    if opt is not None:
        return self.view.item(self.iid, opt)
    elif 'values' in kwargs:
        values = kwargs.pop('values')
        self.values = values
    else:
        self.view.item(self.iid, **kwargs)

delete()

Delete the row from the dataset

Source code in src/ttkbootstrap/widgets/tableview.py

def delete(self) -> None:
    """Delete the row from the dataset"""
    if self.iid:
        self._table.iidmap.pop(self.iid)
        self._table.tablerows_visible.remove(self)
        self._table._tablerows.remove(self)
        self._table.load_table_data()
        self.view.delete(self.iid)

hide()

Remove the row from the data table view

Source code in src/ttkbootstrap/widgets/tableview.py

def hide(self) -> None:
    """Remove the row from the data table view"""
    self.view.detach(self.iid)

refresh()

Syncs the tableview values with the object values

Source code in src/ttkbootstrap/widgets/tableview.py

def refresh(self) -> None:
    """Syncs the tableview values with the object values"""
    if self._iid:
        self.view.item(self.iid, values=self.values)

show(striped=False)

Show the row in the data table view

Source code in src/ttkbootstrap/widgets/tableview.py

def show(self, striped: bool = False) -> None:
    """Show the row in the data table view"""
    if self._iid is None:
        self.build()
    self.view.reattach(self.iid, "", END)

    # remove existing stripes
    tags = list(self.view.item(self.iid, "tags"))
    try:
        tags.remove("striped")
    except ValueError:
        pass

    # add stripes (if needed)
    if striped:
        tags.append("striped")
    self.view.item(self.iid, tags=tags)