AFXTreeTable

This class combines a tree widget with a table widget to allow associating a row of data with an item in a tree.


AFXTreeTable(p, numVisItems, numVisColumns, numColumns, tgt=None, sel=0, opts=AFXTREETABLE_NORMAL, x=0, y=0, w=0, h=0)

Constructor.

ArgumentTypeDefaultDescription
pFXComposite Parent widget.
numVisItemsInt Number of items to display.
numVisColumnsInt Number of columns in the table to display.
numColumnsInt Number of columns in the table.
tgtFXObjectNoneMessage target.
selInt0Message ID.
optsIntAFXTREETABLE_NORMALOptions and hints.
xInt0X coordinate of the origin.
yInt0Y coordinate of the origin.
wInt0Width of the table widget.
hInt0Height of the table widget.


addItemAfter(other, text, oi=None, ci=None, notify=False)

Appends a new tree item with the given text and optional icon after the other tree item.

ArgumentTypeDefaultDescription
otherFXTreeItem  
textString  
oiFXIconNone 
ciFXIconNone 
notifyBoolFalse 


addItemAfter(other, item, notify=False)

Appends the new tree item after the other tree item.

ArgumentTypeDefaultDescription
otherFXTreeItem  
itemFXTreeItem  
notifyBoolFalse 


addItemBefore(other, text, oi=None, ci=None, notify=False)

Prepends a new tree item with the given text and optional icon prior to the other item.

ArgumentTypeDefaultDescription
otherFXTreeItem  
textString  
oiFXIconNone 
ciFXIconNone 
notifyBoolFalse 


addItemBefore(other, item, notify=False)

Prepends the new item prior to the other tree item.

ArgumentTypeDefaultDescription
otherFXTreeItem  
itemFXTreeItem  
notifyBoolFalse 


addItemFirst(p, text, oi=None, ci=None, notify=False)

Prepends a new tree item with the given text and optional icon as the first child of the parent.

ArgumentTypeDefaultDescription
pFXTreeItem  
textString  
oiFXIconNone 
ciFXIconNone 
notifyBoolFalse 


addItemFirst(p, item, notify=False)

Prepends the new tree item as first child of parent.

ArgumentTypeDefaultDescription
pFXTreeItem  
itemFXTreeItem  
notifyBoolFalse 


addItemLast(p, text, oi=None, ci=None, notify=False)

Appends a new tree item with the given text and optional icon as the last child of the parent.

ArgumentTypeDefaultDescription
pFXTreeItem  
textString  
oiFXIconNone 
ciFXIconNone 
notifyBoolFalse 


addItemLast(p, item, notify=False)

Appends the new tree item as the last child of the parent.

ArgumentTypeDefaultDescription
pFXTreeItem  
itemFXTreeItem  
notifyBoolFalse 


addList(text, opts=AFXTREETABLE_LIST_NORMAL)

Adds a list that have only text items to the table and returns the list ID. The text strings of the list items are delimited by tab "\t" characters in the given text. The list is used by items of type LIST.

ArgumentTypeDefaultDescription
textString Tab "\t" delimited text string (e.g. "0\t50\t100\t150").
optsIntAFXTREETABLE_LIST_NORMALOptions.


addList(opts=AFXTREETABLE_LIST_NORMAL)

Adds a list to the table and returns the list ID. The list is used by items of type LIST.

ArgumentTypeDefaultDescription
optsIntAFXTREETABLE_LIST_NORMALList flag.


appendListItem(listId, text, icon=None)

Appends an item to the specified table list; returns the index of the new item.

ArgumentTypeDefaultDescription
listIdInt ID of the list to append to.
textString Item's text.
iconFXIconNoneItem's icon.


beginEdit(item, column)

Sets the specified item in edit mode if the item is editable.

ArgumentTypeDefaultDescription
itemFXTreeItem Tree item.
columnInt Column index of item.


cancelEdit()

Cancels the edit mode.


clearContents(startItem, startColumn, endItem, endColumn, clearEditableOnly=True)

Clears the text in the items in the specified range.

ArgumentTypeDefaultDescription
startItemFXTreeItem Tree item in which to start clearing.
startColumnInt Column in which to start clearing.
endItemFXTreeItem Tree item in which to end clearing.
endColumnInt Column in which to end clearing.
clearEditableOnlyBoolTrueSpecify True to clear the text of editable items only.


clearItems(notify=False)

Removes all tree items and table rows.

ArgumentTypeDefaultDescription
notifyBoolFalse 


clearListItems(listId)

Removes all items from the specified table list.

ArgumentTypeDefaultDescription
listIdInt ID of the list to clear.


closeItem(item, notify=False)

Closes the specified item.

ArgumentTypeDefaultDescription
itemFXTreeItem  
notifyBoolFalse 


collapseTree(item, notify=False)

Collapses the specified item to hide its children.

ArgumentTypeDefaultDescription
itemFXTreeItem  
notifyBoolFalse 


deleteColumns(startColumn, numColumns=1, notify=False)

Deletes columns starting at the specified column.

ArgumentTypeDefaultDescription
startColumnInt Starting column.
numColumnsInt1Number of columns to delete.
notifyBoolFalseSpecify True to notify target of the deletion.


deselectItem(item, column, notify=False)

Deselects the specified item.

ArgumentTypeDefaultDescription
itemFXTreeItem Tree item.
columnInt Column index of item.
notifyBoolFalse 


deselectRow(item, notify=False)

Deselects all items in the row.

ArgumentTypeDefaultDescription
itemFXTreeItem Tree item.
notifyBoolFalse 


expandTree(item, notify=False)

Expands the specified item to show its children.

ArgumentTypeDefaultDescription
itemFXTreeItem  
notifyBoolFalse 


getColumnWidth(column)

Returns the width, in pixels, of the specified column.

ArgumentTypeDefaultDescription
columnInt Column index.


getCurrentColumn()

Returns the column index of the current item.


getCurrentItem()

Returns the current item, if any.


getDefaultColumnWidth()

Returns the default column width, in pixels, of the table.


getDefaultHeight()

Return default height.

Reimplemented from FXScrollArea.


getDefaultWidth()

Return default width.

Reimplemented from FXScrollArea.


getFirstItem()

Returns the first root tree item.


getItemBoolValue(item, column)

Returns the value of a table item of type BOOL.

ArgumentTypeDefaultDescription
itemFXTreeItem Tree item.
columnInt Column index of table item.


getItemCheck(item)

Returns the item checked state.

ArgumentTypeDefaultDescription
itemFXTreeItem  


getItemClosedIcon(item)

Returns the tree item's closed icon.

ArgumentTypeDefaultDescription
itemFXTreeItem  


getItemColor(item, column)

Returns the color of a table item of type COLOR. The color is "As is", "Default", or a color hex specification in the form of "RRGGBB" (e.g., "#0A1B2C").

ArgumentTypeDefaultDescription
itemFXTreeItem Tree item.
columnInt Column index of table item.


getItemFloatValue(item, column)

Returns the value of a table item of type FLOAT.

ArgumentTypeDefaultDescription
itemFXTreeItem Tree item.
columnInt Column index of table item.


getItemFormat(item, column)

Returns the format of a table item of type REAL (see RealFormat).

ArgumentTypeDefaultDescription
itemFXTreeItem Tree item.
columnInt Column index of table item.


getItemIcon(item, column)

Returns the icon of a table item of type ICON.

ArgumentTypeDefaultDescription
itemFXTreeItem Tree item.
columnInt Column index of table item.


getItemIntValue(item, column)

Returns the value of a table item of type INT.

ArgumentTypeDefaultDescription
itemFXTreeItem Tree item.
columnInt Column index of table item.


getItemListId(item, column)

Returns the list ID of a table item of type LIST.

ArgumentTypeDefaultDescription
itemFXTreeItem Tree item.
columnInt Column index of table item.


getItemListIndex(item, column)

Returns the list index (selection) of a table item of type LIST.

ArgumentTypeDefaultDescription
itemFXTreeItem Tree item.
columnInt Column index of table item.


getItemNumDigits(item, column)

Returns the number of digits to the left of the decimal point for a table item of type REAL.

ArgumentTypeDefaultDescription
itemFXTreeItem Tree item.
columnInt Column index of table item.


getItemOpenIcon(item)

Returns the tree item's open icon.

ArgumentTypeDefaultDescription
itemFXTreeItem  


getItemPrecision(item, column)

Returns the precision for a table item of type REAL.

ArgumentTypeDefaultDescription
itemFXTreeItem Tree item.
columnInt Column index of table item.


getItemText(item, column)

Returns the text of an item of type TEXT.

ArgumentTypeDefaultDescription
itemFXTreeItem Tree item.
columnInt Column index of item.


getItemType(item, column)

Returns the type of a table item.

ArgumentTypeDefaultDescription
itemFXTreeItem Tree item.
columnInt Column index of table item.


getItemValue(item, column)

Returns the text-form value of a table item of any type.

ArgumentTypeDefaultDescription
itemFXTreeItem Tree item.
columnInt Column index of table item.


getLastItem()

Returns the last root tree item.


getListItemIcon(listId, index)

Returns the icon of the item at the specified index of the specified table list.

ArgumentTypeDefaultDescription
listIdInt ID of the list.
indexInt Index into the list of the item to return.


getListItemIndex(listId, icon)

Returns the index of the item of the specified table list that has the specified icon. Returns -1 if no such item exists.

ArgumentTypeDefaultDescription
listIdInt ID of the list.
iconFXIcon Icon.


getListItemIndex(listId, text)

Returns the index of the item of the specified table list that has the specified text. Returns -1 if no such item exists.

ArgumentTypeDefaultDescription
listIdInt ID of the list.
textString Text.


getListItemText(listId, index)

Returns the text of the item at the specified index of the specified table list.

ArgumentTypeDefaultDescription
listIdInt ID of the list.
indexInt Index into the list of the item to return.


getNumColumns()

Returns the number of columns.


getNumItems()

Returns the number of items.


getNumListItems(listId)

Returns the number of items in the specified table list.

ArgumentTypeDefaultDescription
listIdInt ID of the list.


getTableStyle()

Returns the options related only to the table.


getTreeColumn()

Returns the column index of the tree.


getVisibleColumns()

Returns the number of visible columns.


getVisibleItems()

Returns the number of visible items.


insertColumns(startColumn, numColumns=1, notify=False)

Inserts columns at the specified location.

ArgumentTypeDefaultDescription
startColumnInt Starting column.
numColumnsInt1Number of columns to insert.
notifyBoolFalseSpecify True to notify target of the insertion.


isAnyItemInColumnSelected(column)

Returns True if any item in the column is selected.

ArgumentTypeDefaultDescription
columnInt Column index.


isAnyItemInRowSelected(item)

Returns True if any item in the row is selected.

ArgumentTypeDefaultDescription
itemFXTreeItem Tree item.


isColumnSelected(column)

Returns True if all items in the column are selected.

ArgumentTypeDefaultDescription
columnInt Column index.


isItemBool(item, column)

Returns True if the specified table item is of type BOOL.

ArgumentTypeDefaultDescription
itemFXTreeItem Tree item.
columnInt Column index of table item.


isItemColor(item, column)

Returns True if the specified table item is of type COLOR.

ArgumentTypeDefaultDescription
itemFXTreeItem Tree item.
columnInt Column index of table item.


isItemEditable(item, column)

Returns True if the table item is editable.

ArgumentTypeDefaultDescription
itemFXTreeItem Tree item.
columnInt Column index of table item.


isItemEmpty(item, column)

Returns True if the specified table item does not have a value.

ArgumentTypeDefaultDescription
itemFXTreeItem Tree item.
columnInt Column index of table item.


isItemExpanded(item)

Returns True if the tree item is expanded, False otherwise.

ArgumentTypeDefaultDescription
itemFXTreeItem  


isItemFloat(item, column)

Returns True if the specified table item is of type FLOAT.

ArgumentTypeDefaultDescription
itemFXTreeItem Tree item.
columnInt Column index of table item.


isItemIcon(item, column)

Returns True if the specified table item is of type ICON.

ArgumentTypeDefaultDescription
itemFXTreeItem Tree item.
columnInt Column index of table item.


isItemInt(item, column)

Returns True if the specified table item is of type INT.

ArgumentTypeDefaultDescription
itemFXTreeItem Tree item.
columnInt Column index of table item.


isItemLeaf(item)

Returns True if the tree item is a leaf-item (has no children), False otherwise.

ArgumentTypeDefaultDescription
itemFXTreeItem  


isItemList(item, column)

Returns True if the specified tabl eitem is of type LIST.

ArgumentTypeDefaultDescription
itemFXTreeItem Tree item.
columnInt Column index of table item.


isItemOpened(item)

Returns True if the tree item is opened, False otherwise.

ArgumentTypeDefaultDescription
itemFXTreeItem  


isItemSelected(item, column)

Returns True if the specified item is selected.

ArgumentTypeDefaultDescription
itemFXTreeItem Tree item.
columnInt Column index of item.


isItemText(item, column)

Returns True if the specified table item is of type TEXT.

ArgumentTypeDefaultDescription
itemFXTreeItem Tree item.
columnInt Column index of table item.


isItemVisible(item, column)

Returns True if the specified item is visible.

ArgumentTypeDefaultDescription
itemFXTreeItem Tree item.
columnInt Column index of item.


isRowSelected(item)

Returns True if all items in the row are selected.

ArgumentTypeDefaultDescription
itemFXTreeItem  


killSelection(notify=False)

Deselects all items.

ArgumentTypeDefaultDescription
notifyBoolFalse 


makePositionVisible(item, column)

Scrolls to make the specified row, column fully visible.

ArgumentTypeDefaultDescription
itemFXTreeItem Tree item.
columnInt Column index of item.


makeRowVisible(item)

Scrolls vertically (only) to make the specified row fully visible.

ArgumentTypeDefaultDescription
itemFXTreeItem Tree item.


openItem(item, notify=False)

Opens the specified item.

ArgumentTypeDefaultDescription
itemFXTreeItem  
notifyBoolFalse 


removeItem(item, notify=False)

Removes the specified tree item and corresponding table row.

ArgumentTypeDefaultDescription
itemFXTreeItem  
notifyBoolFalse 


removeItems(from, to, notify=False)

Removes the specified tree items and their corresponding table rows, inclusively.

ArgumentTypeDefaultDescription
fromFXTreeItem  
toFXTreeItem  
notifyBoolFalse 


removeListItem(listId, index)

Removes the item at the specified index from the specified table list; returns the number of items remaining in list.

ArgumentTypeDefaultDescription
listIdInt ID of the list to remove from.
indexInt Index of the list item to remove.


selectItem(item, column, notify=False)

Selects the specified item.

ArgumentTypeDefaultDescription
itemFXTreeItem Tree item.
columnInt Column index of item.
notifyBoolFalse 


selectRow(item, notify=False)

Selects all items in the row.

ArgumentTypeDefaultDescription
itemFXTreeItem Tree item.
notifyBoolFalse 


setColumnBoolIcons(column, trueIcon=None, falseIcon=None)

Sets the True and False icons of all existing and future table items in a column of type BOOL. Specifying -1 for the column will change all columns in the table and set the default for the table.

ArgumentTypeDefaultDescription
columnInt Table column index.
trueIconFXIconNoneIcon displayed when value is True; 0 = default icon.
falseIconFXIconNoneIcon displayed when value is False; 0 = default icon.


setColumnBoolValue(column, value)

Sets the value of all existing and future table items in a column of type BOOL. Specifying -1 for the column will change all columns in the table and set the default for the table.

ArgumentTypeDefaultDescription
columnInt Table column index.
valueBool Specify True or False.


setColumnColor(column, color)

Sets the color of all existing and future table items in a column of type COLOR. The color can be "As is", "Default", a color hex specification in the form of "RRGGBB" (e.g., "#0A1B2C"), or a pre-defined color name (e.g., "Red"). Specifying -1 for the column will change all columns in the table and set the default for the table.

ArgumentTypeDefaultDescription
columnInt Table column index.
colorString Color.


setColumnColorItemDefault(column, color)

Sets the color of the color item in the flyout menu for all existing and future table items that display "As is" or "Default" in a column of type COLOR. The color is either a color hex specification in the form of "RRGGBB" (e.g., "#0A1B2C") or a pre-defined color name (e.g., "Red"). Specifying -1 for the column will change all columns in the table and set the default for the table.

ArgumentTypeDefaultDescription
columnInt Table column index.
colorString Color.


setColumnColorOptions(column, opts)

Sets the color flyout options for all existing and future table items in a column of type COLOR. Specifying -1 for the column will change all columns in the table and set the default for the table.

ArgumentTypeDefaultDescription
columnInt Table column index.
optsInt Options (see ColorFlyoutOptions).


setColumnEditable(column, editable)

Sets the editability of all existing and future table items in a column. Specifying -1 for the column will change all columns in the table and set the default for the table.

ArgumentTypeDefaultDescription
columnInt Table column index.
editableBool Specify True for editable, False for read-only.


setColumnFloatValue(column, value)

Sets the value of all existing and future table items in a column of type FLOAT. Specifying -1 for the column will change all columns in the table and set the default for the table.

ArgumentTypeDefaultDescription
columnInt Table column index.
valueFloat Floating-point value.


setColumnFormat(column, format)

Sets the real format for all existing and future table items in a column of type REAL.

ArgumentTypeDefaultDescription
columnInt Table column index.
formatInt Default format of REAL values in column (see RealFormat).


setColumnIcon(column, icon=None)

Sets the icon of all existing and future table items in a column of type ICON. Specifying -1 for the column will change all columns in the table and set the default for the table.

ArgumentTypeDefaultDescription
columnInt Table column index.
iconFXIconNoneIcon.


setColumnIntValue(column, value)

Sets the value of all existing and future table items in a column of type INT. Specifying -1 for the column will change all columns in the table and set the default for the table.

ArgumentTypeDefaultDescription
columnInt Table column index.
valueInt Integer value.


setColumnJustify(column, justify)

Sets the justification of all existing and future table items in a column. Specifying -1 for the column will change all columns in the table and set the default for the table.

ArgumentTypeDefaultDescription
columnInt Table column index.
justifyInt Justification (see ItemJustify).


setColumnListId(column, listId)

Sets the list ID of all existing and future table items in a column of type LIST. Specifying -1 for the column will change all columns in the table and set the default for the table.

ArgumentTypeDefaultDescription
columnInt Table column index.
listIdInt List ID.


setColumnListIndex(column, index)

Sets the list index (selection) of all existing and future table items in a column of type LIST. Specifying -1 for the column will change all columns in the table and set the default for the table.

ArgumentTypeDefaultDescription
columnInt Table column index.
indexInt Index of item to be selected.


setColumnNumDigits(column, numDigits)

Sets the number of digits to the left of the decimal point for all existing and future table items in a column of type REAL.

ArgumentTypeDefaultDescription
columnInt Table column index.
numDigitsInt Default number of digits the left of the decimal point.


setColumnPrecision(column, precision)

Sets the precision for all existing and future table items in a column of type REAL.

ArgumentTypeDefaultDescription
columnInt Table column index.
precisionInt Number of digits to the right of the decimal point.


setColumnText(column, text)

Sets the text of all existing and future table items in a column of type TEXT. Specifying -1 for the column will change all columns in the table and set the default for the table.

ArgumentTypeDefaultDescription
columnInt Table column index.
textString Text.


setColumnType(column, type)

Sets the type of a column. Specifying -1 for the table column will change all columns in the table and set the default for the table.

ArgumentTypeDefaultDescription
columnInt Table column index.
typeInt Type (see Flags for item types).


setColumnWidth(column, width)

Sets the width, in pixels, of the specified column. Specifying -1 for the column will change all non-leading and non-trailing columns in the table and set the default for the table. Specify -1 for the width will resize each specified column to best fit the width of the title(s) currently shown in its leading and trailing items.

ArgumentTypeDefaultDescription
columnInt Column index.
widthInt Width in pixels.


setColumnWidthInChars(column, numChars)

Sets the width, in number of characters, of the specified column. Specifying -1 for the column will change all non-leading and non-trailing columns in the table and set the default for the table.

ArgumentTypeDefaultDescription
columnInt Column index.
numCharsInt Width in number of characters.


setCurrentItem(item, column, notify=False)

Sets the current item.

ArgumentTypeDefaultDescription
itemFXTreeItem Tree item.
columnInt Column index of item.
notifyBoolFalse 


setDefaultBoolIcons(trueIcon=None, falseIcon=None)

Sets the default True and False icons for the table (0 = default icon).

ArgumentTypeDefaultDescription
trueIconFXIconNoneIcon displayed when value is True; 0 = default icon.
falseIconFXIconNoneIcon displayed when value is False; 0 = default icon.


setDefaultBoolValue(value)

Sets the default bool value for the table.

ArgumentTypeDefaultDescription
valueBool Specify True or False.


setDefaultColor(color)

Sets the default color for all items of type COLOR in the table. The color can be "As is", "Default", a color hex specification in the form of "RRGGBB" (e.g., "#0A1B2C"), or a pre-defined color name (e.g., "Red").

ArgumentTypeDefaultDescription
colorString Color.


setDefaultColumnWidth(width)

Sets the default width, in pixels, for all columns.

ArgumentTypeDefaultDescription
widthInt Width in pixels.


setDefaultFloatValue(value)

Sets the default floating-point value for the table.

ArgumentTypeDefaultDescription
valueFloat Floating-point value.


setDefaultFormat(format)

Sets the default real format for the table.

ArgumentTypeDefaultDescription
formatInt Format flag.


setDefaultIntValue(value)

Sets the default integer value for the table.

ArgumentTypeDefaultDescription
valueInt Integer value.


setDefaultJustify(justify)

Sets the default justification for the table.

ArgumentTypeDefaultDescription
justifyInt Justification (see ItemJustify).


setDefaultNumDigits(numDigits)

Sets the default number of digits to the left of the decimal point for the table.

ArgumentTypeDefaultDescription
numDigitsInt Number of digits.


setDefaultPrecision(precision)

Sets the precision for the table.

ArgumentTypeDefaultDescription
precisionInt Precision.


setDefaultText(text)

Sets the default text for the table.

ArgumentTypeDefaultDescription
textString Text.


setDefaultType(type)

Sets the default type for the table.

ArgumentTypeDefaultDescription
typeInt Type (see Flags for item types).


setItemBoolIcons(item, column, trueIcon=None, falseIcon=None)

Sets the True and False icons of a table item of type BOOL.

ArgumentTypeDefaultDescription
itemFXTreeItem Tree item.
columnInt Column index of table item.
trueIconFXIconNoneIcon displayed when value is True; 0 = default icon.
falseIconFXIconNoneIcon displayed when value is False; 0 = default icon.


setItemBoolValue(item, column, value)

Sets the value of a table item of type BOOL.

ArgumentTypeDefaultDescription
itemFXTreeItem Tree item.
columnInt Column index of table item.
valueBool Specify True or False.


setItemCheck(item, check, notify=False)

Sets the item checked state. Valid states are True, False and MAYBE. Returns True if the check value has changed, False otherwise.

ArgumentTypeDefaultDescription
itemFXTreeItem  
checkInt  
notifyBoolFalse 


setItemClosedIcon(item, icon)

Changes the tree item's closed icon.

ArgumentTypeDefaultDescription
itemFXTreeItem  
iconFXIcon  


setItemColor(item, column, color)

Sets the color of a table item of type COLOR. The color can be "As is", "Default", a color hex specification in the form of "RRGGBB" (e.g., "#0A1B2C"), or a pre-defined color name (e.g., "Red").

ArgumentTypeDefaultDescription
itemFXTreeItem Tree item.
columnInt Column index of table item.
colorString Color.


setItemEditable(item, column, editable)

Sets the editability of a table item.

ArgumentTypeDefaultDescription
itemFXTreeItem Tree item.
columnInt Column index of table item.
editableBool Specify True for editable, False for read-only.


setItemFloatValue(item, column, value)

Sets the value of a table item of type FLOAT.

ArgumentTypeDefaultDescription
itemFXTreeItem Tree item.
columnInt Column index of table item.
valueFloat Floating-point value.


setItemFormat(item, column, format)

Sets the format for a table item of type REAL (see RealFormat).

ArgumentTypeDefaultDescription
itemFXTreeItem Tree item.
columnInt Table column index of item.
formatInt Format of table item (see RealFormat).


setItemIcon(item, column, icon=None)

Sets the icon of a table item of type ICON.

ArgumentTypeDefaultDescription
itemFXTreeItem Tree item.
columnInt Column index of table item.
iconFXIconNoneIcon.


setItemIntValue(item, column, value)

Sets the value of a table item of type INT.

ArgumentTypeDefaultDescription
itemFXTreeItem Tree item.
columnInt Column index of table item.
valueInt Integer value.


setItemJustify(item, column, justify)

Sets the justification of an item.

ArgumentTypeDefaultDescription
itemFXTreeItem Tree item.
columnInt Column index of table item.
justifyInt Justification (see ItemJustify).


setItemListId(item, column, listId)

Sets the list ID of a table item of type LIST.

ArgumentTypeDefaultDescription
itemFXTreeItem Tree item.
columnInt Column index of table item.
listIdInt List ID.


setItemListIndex(item, column, index)

Sets the list index (selection) of a table item of type LIST.

ArgumentTypeDefaultDescription
itemFXTreeItem Tree item.
columnInt Column index of table item.
indexInt Index of item to be selected.


setItemNumDigits(item, column, numDigits)

Sets the number of digits to the left of the decimal point for a table item of type REAL.

ArgumentTypeDefaultDescription
itemFXTreeItem Tree item.
columnInt Column index of table item.
numDigitsInt Number of digits.


setItemOpenIcon(item, icon)

Sets the tree item's open icon.

ArgumentTypeDefaultDescription
itemFXTreeItem  
iconFXIcon  


setItemPrecision(item, column, precision)

Sets the precision for a table item of type REAL.

ArgumentTypeDefaultDescription
itemFXTreeItem Tree item.
columnInt Column index of table item.
precisionInt Number of digits to the right of the decimal point.


setItemText(item, column, text)

Sets the text of an item of type TEXT.

ArgumentTypeDefaultDescription
itemFXTreeItem Tree item.
columnInt Column index of item.
textString Text.


setItemType(item, column, type)

Sets the type of a table item.

ArgumentTypeDefaultDescription
itemFXTreeItem Tree item.
columnInt Column index of table item.
typeInt Type (see Flags for item types).


setItemValue(item, column, valueText)

Sets the value of a table item of any type that can interpret a text string for its value. Returns True if the value of the specified item is set successfully.

ArgumentTypeDefaultDescription
itemFXTreeItem Tree item.
columnInt Column index of table item.
valueTextString Text-form value of table item.


setLeadingRowLabels(str)

Set the labels of the leading row. Note: this API must be used to set the header row labels, otherwise labels will be overwritten by auto-numbering.

ArgumentTypeDefaultDescription
strString Tab "\t" delimited list, can also contain newline characters indicating that label contains multiple lines of text (e.g. "Young's\nModulus\tPoisson's\nRatio").


setListMaxVisible(maxVisible)

Sets the maximum number of visible items for all table lists.

ArgumentTypeDefaultDescription
maxVisibleInt Maximum number of visible items.


setTableStyle(style)

Sets the table options.

ArgumentTypeDefaultDescription
styleInt Style flag (see Flags for AFX table options).


setVisibleColumns(visibleColumns)

Sets the number of visible columns.

ArgumentTypeDefaultDescription
visibleColumnsInt Number of visible columns.


setVisibleItems(visibleItems)

Sets the number of visible items.

ArgumentTypeDefaultDescription
visibleItemsInt Number of visible items.


shadeReadOnlyItems(shadeItems)

Makes the table to use a different, typically shaded, background color for read-only items if True is passed to the method. The table would use the same regular background color for both editable and read-only items if False is passed to the method.

ArgumentTypeDefaultDescription
shadeItemsBool Specify True to use a different background color for read-only items.


Class flags

Flags for color flyouts (used for items of type COLOR).

COLOR_INCLUDE_COLOR_ONLY

Color item has no As Is and Default in its flyout.

COLOR_INCLUDE_AS_IS

Color item has As Is in its flyout.

COLOR_INCLUDE_DEFAULT

Color item has Default in its flyout.

COLOR_INCLUDE_ALL

Color item has both As Is and Default in its flyout. This is the default option.

Flags for item alignment.

REAL

Not yet implemented (Real).

LEFT

Left justified.

RIGHT

Right justified.

CENTER

Center justified (horizontal).

TOP

Top justified.

BOTTOM

Bottom justified.

MIDDLE

Middle justified (vertical).

Flags for item types.

TEXT

Item accepts a text string via a text field.

FLOAT

Item accepts a floating-point number via a text field.

INT

Item accepts an integer via a text field.

LIST

Item accepts input from a list.

BOOL

Item is a boolean; displayed as an icon.

ICON

Item displays an icon and does not accept input.

COLOR

Item accepts color selection via a color flyout.

Flags for real formats.

GENERAL

General.

SCIENTIFIC

Scientific.

AUTOMATIC

Automatic.


Global flags

Flags for AFX tree table options.

AFXTREETABLE_COLUMN_RESIZABLE

Allow users to resize columns.

AFXTREETABLE_NO_COLUMN_SELECT

Disallow column selections (selecting a header/footer item in a column selects the whole column).

AFXTREETABLE_ROW_MODE

Selecting any item in a row selects the whole row.

AFXTREETABLE_EXTENDED_SELECT

Use extended selection mode that allows multiple items to be selected and allows users to drag-select a range of items.

AFXTREETABLE_SINGLE_SELECT

Use single selection mode that allows up to one item to be selected.

AFXTREETABLE_BROWSE_SELECT

Use browse selection mode that enforces one single item to be selected at all times.

AFXTREETABLE_CHECK_BOXES

Show item check boxes.

AFXTREETABLE_PROPAGATE_CHECKS

Propagate checked state to children and parents.

AFXTREETABLE_NORMAL

Default table options--use extended selection mode, columns are resizable, and layout fills both X and Y directions.

Flags for the table's list (for items of type LIST).

AFXTREETABLE_LIST_PRESELECT_NONE

Do not pre-select any list item.