API Reference - Seg-mel/kivy_table_widget GitHub Wiki

Classes

##Classes

For more information about classes look at the source code of the table module.

kivy_table_widget.Table()

Properties

cols

This property that will set/return a column count.
row_count

This property that will return a row count.
grid

The grid of this table (GridTable object).

Example:

table.grid.color = [1, 0, 0, 1] table.grid.cells[1][1].text = 'edited textinput text' table.grid.cells[3][0].height = 100

* __label_panel__

The label panel of this table ([LabelPanel](#kivy_table_widgettablelabelpanel) object).
And also the panel include the one instance of [NullLabel](#kivy_table_widgettablenulllabel) class and variable quantity of instances of [NewLabel](#kivy_table_widgettablenewlabel) class.

Example:
``` Python
table.label_panel.labels[1].text = 'New name'
table.label_panel.height = 100

number_panel

The number panel of this table (NumberPanel object). And also the panel include variable quantity of instances of NewNumberLabel class.

Example:

table.number_panel.auto_width = False table.number_panel.width_widget = 100 table.number_panel.visible = False

* __scroll_view__ 

The scroll view of this table ([ScrollViewTable](#kivy_table_widgettablescrollviewtable) object)

Example:
``` Python
table.scroll_view.bar_width = 10
table.scroll_view.scroll_type = ['bars']

Methods

add_button_row(*args)

Add new row to table with Button widgets. Argument count must match the number of columns.

Example:

table.add_button_row('123','foo')

* __add_row(_*args_)__

Add new row to table with custom widgets (only [Button](http://kivy.org/docs/api-kivy.uix.button.html) and [TextInput](http://kivy.org/docs/api-kivy.uix.textinput.html) at this time). The widgets, that you pass as an argument, are extending [NewCell](#kivy_table_widgettablenewcell) class.
Argument count must match the number of columns.

Example:
``` Python
table.add_row([Button, {'text':'button2',
                          'color_widget': [0, 0, .5, 1],
                          'color_click': [0, 1, 0, 1]
                         }], 
                [TextInput, {'text':'textinput2',
                             'color_click': [1, 0, .5, 1]
                            }])

choose_row([row_num=0])

Choose a row in our table.
del_row(number)

Delete a row by number.

kivy_table_widget.table.GridTable()

This class extends the GridLayout Kivy class. For more information and customisation your table look at this.

Properties

cells

Two-level array of cells objects

color

Background color

current_cell

Current cell

kivy_table_widget.table.LabelPanel()

This class extends the BoxLayout Kivy class. For more information and customisation your table look at this.

Properties

color

Background color

height_widget

Get/set panel height

labels

List of label objects

visible

Get/set panel visibility

kivy_table_widget.table.NumberPanel()

This class extends the BoxLayout Kivy class. For more information and customisation your table look at this.

Properties

auto_width

Auto width this panel

color

Background color

visible

Get/set panel visibility

width_widget

Get/set panel width

kivy_table_widget.table.ScrollViewTable()

This class extends the ScrollView Kivy class. For more information and customisation your table look at this.

Properties

color

Background color

Methods

up()

Scrolling up when the chosen row is out of view

down()

Scrolling down when the chosen row is out of view

pgup([row_count=10])

Scrolling up when the chosen row is out of view, but with step

pgdn([row_count=10])

Scrolling down when the chosen row is out of view, but with step

home()

Scrolling to the top of the table

end()

Scrolling to the bottom of the table

kivy_table_widget.table.NewCell()

This class extends the object that you added. For more information and customisation your table look at this.

Properties

color_widget

Cell color

color_click

Cell click color

kivy_table_widget.table.NullLabel()

This class extends the Button Kivy class. For more information and customisation your table look at this.

Properties

color

Background color

kivy_table_widget.table.NewLabel()

This class extends the Button Kivy class. For more information and customisation your table look at this.

kivy_table_widget.table.NewNumberLabel()

This class extends the Button Kivy class. For more information and customisation your table look at this.