Class uifcTable

# include <uifcTable.h>

class
uifcTable
: public virtual
uifcSelection
{
xaideclare(uifcTable)
...
};


Description
Method Summary
void
void
CreateTimer (uifcTableTimer_ptr timer, xrstring timerName, xbool writeInTrail)
void
void
void
void
void
void
void
void
void
void
void
void
void
void
void
void
void
void
void
void
void
void
void
void
void
void
void
void
void
void
void
void
void
void
void
void
void
void
void
void
void
void
void
void
void
void
void
void
void
void
void
void
void
void
SetHeight (xint value)
void
void
void
void
void
void
void
void
void
void
void
void
void
void
void
void
void
void
void
void
void
void
void
void
void
SetWidth (xint value)
void
StartTimer (xrstring timerName, xint duration)
void
StopTimer (xrstring timerName)
Methods Inherited from Class uifcComponent::
Methods Inherited from Class uifcSelection::
Method Detail
void
InsertColumn
(uifcTableColumn_ptr tablecolumn, uifcColumnPositionData_ptr col_pos_data)
Parameters:
tablecolumn
col_pos_data
Returns:
void
DeleteColumnsByIndex
(xintsequence_ptr columns)
Identical to DeleteColumnsByName operation but with the columns passed as indices into the ColumnNameArray attribute, as obtained via ColumnGetByName operation with Index attribute.
Parameters:
columns
Returns:
GetFrameOrigin
()
Determine the position of the component, in pixels, relative to its parent.
Returns:
void
InsertColumns
Parameters:
tablecolumns
posData
Returns:
void
SelectCellsOfColumnByIndex
(xintsequence_ptr columns, xbool select)
Identical to SelectCellsOfColumnByName operation but with the columns passed as indices into the ColumnNameArray attribute, as obtained via ColumnGetByName operation with Index attribute.
Parameters:
columns
select
Returns:
GetMostRecentCellName
()
Determine the coordinates of the last entered cell.
Returns:
void
SelectCellsOfColumnByName
(xstringsequence_ptr names, xbool select)
Select or deselect the cells of the given columns of the Table.
Parameters:
names
select
Returns:
GetAnchorCellName
()
Determine the coordinates of the selection anchor cell.
Returns:
GetAnchorCellIndex
()
Identical to AnchorCellName operation but with the row and column passed as indices into the RowNameArray attribute and ColumnNameArray attribute respectively, as obtained via RowGetByName operation and ColumnGetByName operation with Index attribute.
Returns:
void
SelectCellsOfRowByIndex
(xintsequence_ptr rows, xbool select)
Identical to SelectCellsOfRowByName operation but with the rows passed as indices into the RowNameArray attribute, as obtained via RowGetByName operation with Index attribute.
Parameters:
rows
select
Returns:
GetDragCellName
()
Determine the coordinates of the cell / row / column being dragged. If neither the row nor the column are returned as "" then the object being dragged is the cell located in the given row and column. If the row is returned as "" then the object being dragged is the named column. If the column is returned as "" then the object being dragged is the named row.
Returns:
void
DeleteColumnsByName
Delete columns from the Table.
Parameters:
names
Returns:
void
InsertRow
(uifcTableRow_ptr tablerow, uifcRowPositionData_ptr row_pos_data)
Parameters:
tablerow
row_pos_data
Returns:
GetFocusCellName
()
Determine the coordinates of the selection focus cell.
Returns:
void
DeleteRowsByIndex
Identical to DeleteRowsByName operation but with the rows passed as indices into the RowNameArray attribute, as obtained via RowGetByName operation with Index attribute.
Parameters:
rows
Returns:
InsertPopupMenu
(uifcComponent_ptr component)
Add a MenuPane to be displayed when the user presses the right mouse button over the component.
Parameters:
component
Returns:
GetFrameSize
()
Determine the size of the component, in pixels.
Returns:
InsertChild
(uifcComponent_ptr component)
Parameters:
component
Returns:
GetDropCellIndex
()
Identical to DropCellName operation but with the row and column passed as indices into the RowNameArray attribute and ColumnNameArray attribute respectively, as obtained via RowGetByName operation and ColumnGetByName operation with Index attribute.
Returns:
void
SetFocusCellName
Set the coordinates of the selection focus cell.
Parameters:
value
Returns:
void
MoveColumnsByIndex
(xint column, xintsequence_ptr columns)
Identical to MoveColumnsByName operation but with the columns passed as indices into the ColumnNameArray attribute, as obtained via ColumnGetByName operation with Index attribute.
Parameters:
column
columns
Returns:
void
DeleteChild
(xrstring name)
Delete a component from the parent.
Parameters:
name
Returns:
void
SetAnchorCellName
Set the coordinates of the selection anchor cell.
Parameters:
value
Returns:
void
MoveRowsByName
Reorders the rows of the Table so that a given array of rows is placed in a given order immediately after the named row. If row is given as NULL then the rows are moved to the start of the rows of the Table. The list of row names can be the complete list of rows in the Table. When the rows are reordered any row-related data is also reordered, i.e. the labels, foreground and background colors and the visibilities.
Parameters:
row
names
Returns:
void
DeletePopupMenu
()
Delete a MenuPane from the component.
Returns:
GetMostRecentCellIndex
()
Identical to MostRecentCellName operation but with the row and column passed as indices into the RowNameArray attribute and ColumnNameArray attribute respectively, as obtained via RowGetByName operation and ColumnGetByName operation with Index attribute.
Returns:
void
MoveColumnsByName
(xrstring column, xstringsequence_ptr names)
Reorders the columns of the Table so that the given array of columns are placed in the given order (implied by the order of names in the array) immediately after the named column. If column is given as NULL then the columns are moved to the start of the columns of the Table. The list of column names can be the complete list of columns in the Table. When the columns are reordered any column-related data is also reordered, i.e. the labels, widths, resizabilities, foreground and background colors and the visibilities.
Parameters:
column
names
Returns:
void
SetTextOfColumnCells
(xrstring column, xrstring labels)
Set the labels of all of the cells in a column of the Table. The label is constructed using the newline character as a separator so that List-like behaviour can be achieved. e.g. This\nis\na\nlabel will set the cell labels as This is a label
Parameters:
column
labels
Returns:
void
SetFrameSize
Set the size of the component, in pixels. This operation is only supported when the component's parent is one of the following classes : DrawingArea NakedWindow PGLWindow
Parameters:
value
Returns:
GetScreenOrigin
()
Determine the screen position of the component, in pixels.
Returns:
void
SelectCellsOfRowByName
(xstringsequence_ptr rows, xbool select)
Select or deselect the cells of the given rows of the Table.
Parameters:
rows
select
Returns:
void
MoveRowsByIndex
(xint row, xintsequence_ptr rows)
Identical to MoveRowsByName operation but with the rows passed as indices into the RowNameArray attribute, as obtained via RowGetByName operation with Index attribute.
Parameters:
row
rows
Returns:
GetFrameRectangle
()
Determine the size and position of the component, in pixels.
Returns:
GetDropCellName
()
Determine the coordinates of the cell / row / column being dragged over or dropped into. This can be called in response to receiving a DRAG_ENTER_ACTION, DRAG_OVER_ACTION or DROP_ACTION callback for the Table. If neither the row nor the column are returned as "" then the object being dragged over or dropped into is the cell located in the given row and column. If the row is returned as "" then the object being dragged over or dropped into is the named column. If the column is returned as "" then the object being dragged over or dropped into is the named row.
Returns:
void
SetTextOfRowCells
(xrstring row, xrstring labels)
Set the labels of all of the cells in a row of the Table. The label is constructed using the tab character as a separator so that List-like behaviour can be achieved. e.g. This\tis\ta\tlabel will set the cell labels as This - is - a - label
Parameters:
row
labels
Returns:
void
SetFrameOrigin
(uifcPoint_ptr value)
Set the screen position of the component, in pixels, relative to its parent. This operation is only supported when the component's parent is one of the following classes : DrawingArea NakedWindow PGLWindow
Parameters:
value
Returns:
GetFrameMinimumSize
()
Determine the minimum size of the component, in pixels.
Returns:
void
DeleteRowsByName
Delete rows from the Table.
Parameters:
names
Returns:
void
InsertRows
Parameters:
tablerows
posData
Returns:
GetFocusCellIndex
()
Identical to FocusCellName operation but with the row and column passed as indices into the RowNameArray attribute and ColumnNameArray attribute respectively, as obtained via RowGetByName operation and ColumnGetByName operation with Index attribute.
Returns:
GetScreenRectangle
()
Determine the size and screen position of the component, in pixels.
Returns:
void
SetFrameRectangle
Set the size and screen position of the component, in pixels. This operation is only supported when the component's parent is one of the following classes : DrawingArea NakedWindow PGLWindow
Parameters:
rect
Returns:
GetDragCellIndex
()
Identical to DragCellName operation but with the row and column passed as indices into the RowNameArray attribute and ColumnNameArray attribute respectively, as obtained via RowGetByName operation and ColumnGetByName operation with Index attribute.
Returns:
GetRectangleOfMonitor
()
Determine the rectangle of the screen upon which the majority of the given component is displayed.
Returns:
DoesActivateOnReturn
()
Returns:
Flag indicating whether a RETURN key press should generate a OnCellActivate() callback or whether it should cause the default button in the Dialog to be pressed.
void
SetActivateOnReturn
(xbool flag)
Sets flag indicating whether a RETURN key press should generate a OnCellActivate() callback or whether it should cause the default button in the Dialog to be pressed.
Parameters:
flag
Returns:
GetWidth
()
Returns:
The width of the Table, in character widths.
void
SetWidth
(xint value)
Sets the width of the Table, in character widths.
Parameters:
value
Returns:
GetSelectedCellNameArray
()
Returns:
The array of selections of the Table. This is an array of length
(2 * number of selections)
and is arranged in row-column pairs, i.e.
sel_names [0] = row of first selected cell
sel_names [1] = column of first selected cell
sel_names [2] = row of second selected cell
sel_names [3] = column of second selected cell
...
void
SetSelectedCellNameArray
Sets the array of selections of the Table. This is an array of length
(2 * number of selections)
and is arranged in row-column pairs, i.e.
sel_names [0] = row of first selected cell
sel_names [1] = column of first selected cell
sel_names [2] = row of second selected cell
sel_names [3] = column of second selected cell
...
Parameters:
values
Returns:
DoesDynamicUpdate
()
Returns:
Flag indicating whether to scroll the table contents whilst the scrollbar is being moved (xtrue) or whether to update the view after the scrollbar has been moved (xfalse).
void
SetDynamicUpdate
(xbool flag)
Sets flag indicating whether to scroll the table contents whilst the scrollbar is being moved (xtrue) or whether to update the view after the scrollbar has been moved (xfalse).
Parameters:
flag
Returns:
GetColumnNameArray
()
Returns:
The names of the columns of the Table.
void
SetColumnNameArray
Sets the names of the columns of the Table.
Parameters:
values
Returns:
GetMinimumWidth
()
Returns:
The minimum width of the Table, in character widths.
void
SetMinimumWidth
(xint value)
Sets the minimum width of the Table, in character widths.
Parameters:
value
Returns:
GetMinimumHeight
()
Returns:
The minimum number of visible rows of the Table.
void
SetMinimumHeight
(xint value)
Sets the minimum number of visible rows of the Table.
Parameters:
value
Returns:
GetRowBackgroundColorArray
()
Returns:
The background colors of the rows of the Table.
void
SetRowBackgroundColorArray
(uifcColors_ptr colors)
Sets the background colors of the rows of the Table.
Parameters:
colors
Returns:
DoesAllowReturnInput
()
Returns:
Flag indicating whether to allow RETURN key presses to be ignored by the Table itself and instead passed to the application via a OnKeyDown() callback.
void
SetAllowReturnInput
(xbool flag)
Sets flag indicating whether to allow RETURN key presses to be ignored by the Table itself and instead passed to the application via a OnKeyDown() callback.
Parameters:
flag
Returns:
CanDrawContentDisabled
()
Returns:
Flag indicating whether the images embedded in the label of a cell of the Table should be greyed-out whenever the cell is insensitive.
void
SetCanDrawContentDisabled
(xbool flag)
Sets flag indicating whether the images embedded in the label of a cell of the Table should be greyed-out whenever the cell is insensitive.
Parameters:
flag
Returns:
GetColumnSelectionPolicy
()
Returns:
The selection policy of the columns of the Table.
NO_SELECTION_POLICY
No selected columns
SELECTION_POLICY_SINGLE
1 or 0 selected columns
SELECTION_POLICY_BROWSE
Always 1 selected column
SELECTION_POLICY_MULTIPLE
Any number of selected columns
SELECTION_POLICY_EXTENDED
Any number of selected columns, including support for range selection
void
SetColumnSelectionPolicy
Sets the selection policy of the columns of the Table.
NO_SELECTION_POLICY
No selected columns
SELECTION_POLICY_SINGLE
1 or 0 selected columns
SELECTION_POLICY_BROWSE
Always 1 selected column
SELECTION_POLICY_MULTIPLE
Any number of selected columns
SELECTION_POLICY_EXTENDED
Any number of selected columns, including support for range selection
Parameters:
value
Returns:
GetDefaultHelpText
()
Returns:
The popup help-text to be displayed whilst the pointer is over the component but is not over any of the cells of the Table.
void
SetDefaultHelpText
(xrstring value)
Sets the popup help-text to be displayed whilst the pointer is over the component but is not over any of the cells of the Table.
Parameters:
value
Returns:
GetHeight
()
Returns:
The number of visible rows of the Table.
void
SetHeight
(xint value)
Sets the number of visible rows of the Table.
Parameters:
value
Returns:
HasScrollBarsWhenNeeded
()
Returns:
Flag indicating whether scrollbars should only be displayed when they are required (xtrue) or whether they should always be displayed (xfalse).
void
SetHasScrollBarsWhenNeeded
(xbool flag)
Sets flag indicating whether scrollbars should only be displayed when they are required (xtrue) or whether they should always be displayed (xfalse).
Parameters:
flag
Returns:
GetDragCursorImage
()
Returns:
The cursor to use when the user starts a drag & drop operation by dragging the component and the pointer is over a valid drop-site.
void
SetDragCursorImage
(xrstring value)
Sets the cursor to use when the user starts a drag & drop operation by dragging the component and the pointer is over a valid drop-site.
Parameters:
value
Returns:
GetRowTextArray
()
Returns:
The labels of the rows of the Table. If labels are specified then the Table will display row headers, otherwise no row headers are displayed.
void
SetRowTextArray
Sets the labels of the rows of the Table. If labels are specified then the Table will display row headers, otherwise no row headers are displayed.
Parameters:
values
Returns:
GetColumnWidthArray
()
Returns:
The widths of the columns of the Table, in character widths. The default is specified by the value of DefaultColumnWidth attribute.
void
SetColumnWidthArray
(xintsequence_ptr values)
Sets the widths of the columns of the Table, in character widths. The default is specified by the value of DefaultColumnWidth attribute.
Parameters:
values
Returns:
GetLockedRows
()
Returns:
The number of locked rows of the Table.
void
SetLockedRows
(xint value)
Sets the number of locked rows of the Table.
Parameters:
value
Returns:
GetKeyPressed
()
Returns:
The key pressed which generated a OnKeyDown(). To indicate to the Table that the key should not be passed on to, for example, the mapkey buffer you should modify this attribute to KEY_NONE at the end of your OnKeyDown() callback.
void
SetKeyPressed
(uifcKey_ptr key)
Sets the key pressed which generated a OnKeyDown(). To indicate to the Table that the key should not be passed on to, for example, the mapkey buffer you should modify this attribute to KEY_NONE at the end of your OnKeyDown() callback.
Parameters:
key
Returns:
DoesSizeByContents
()
Returns:
Reserved.
void
SetSizeByContents
(xbool flag)
Sets reserved.
Parameters:
flag
Returns:
GetTextAlignment
()
Returns:
The alignment of the text in the column and row header labels of the Table.
void
SetTextAlignment
(uifcAlignment value)
Sets the alignment of the text in the column and row header labels of the Table.
Parameters:
value
Returns:
GetColumnResizingArray
()
Returns:
The resizing factors of the columns of the Table, default is 0.
void
SetColumnResizingArray
(xintsequence_ptr values)
Sets the resizing factors of the columns of the Table, default is 0.
Parameters:
values
Returns:
GetColumnBackgroundColorArray
()
Returns:
The background colors of the columns of the Table.
void
SetColumnBackgroundColorArray
(uifcColors_ptr colors)
Sets the background colors of the columns of the Table.
Parameters:
colors
Returns:
GetRowVisibleArray
()
Returns:
The visible states of the rows of the Table.
void
SetRowVisibleArray
(xintsequence_ptr values)
Sets the visible states of the rows of the Table.
Parameters:
values
Returns:
GetSelectedColumnNameArray
()
Returns:
The names of the selected columns of the Table.
void
SetSelectedColumnNameArray
Sets the names of the selected columns of the Table.
Parameters:
values
Returns:
DoesRowHighlight
()
Returns:
Flag indicating whether to highlight the entire row when a selection is made in a cell in the row.
void
SetRowHighlight
(xbool flag)
Sets flag indicating whether to highlight the entire row when a selection is made in a cell in the row.
Parameters:
flag
Returns:
GetDragNotValidCursorImage
()
Returns:
The cursor to use when the user starts a drag & drop operation by dragging the component and the pointer is over an invalid drop-site.
void
SetDragNotValidCursorImage
(xrstring value)
Sets the cursor to use when the user starts a drag & drop operation by dragging the component and the pointer is over an invalid drop-site.
Parameters:
value
Returns:
GetColumnTextColorArray
()
Returns:
The foreground colors of the columns of the Table.
void
SetColumnTextColorArray
(uifcColors_ptr colors)
Sets the foreground colors of the columns of the Table.
Parameters:
colors
Returns:
GetColumnTextArray
()
Returns:
The labels of the columns of the Table. If labels are specified then the Table will display column headers, otherwise no column headers are displayed.
void
SetColumnTextArray
Sets the labels of the columns of the Table. If labels are specified then the Table will display column headers, otherwise no column headers are displayed.
Parameters:
values
Returns:
GetAlternateRowColor
()
Returns:
The color of alternate rows of the Table as a uifcColor.
void
SetAlternateRowColor
(uifcColor_ptr color)
Sets the color of alternate rows of the Table as a uifcColor.
Parameters:
color
Returns:
IsGridVisible
()
Returns:
Flag indicating whether to display the grid lines of the Table.
void
SetGridVisible
(xbool flag)
Sets flag indicating whether to display the grid lines of the Table.
Parameters:
flag
Returns:
GetLockedColumns
()
Returns:
The number of locked columns of the Table.
void
SetLockedColumns
(xint value)
Sets the number of locked columns of the Table.
Parameters:
value
Returns:
IsValidDragSite
()
Returns:
Flag indicating whether the component can be dragged to start a drag & drop operation.
void
SetValidDragSite
(xbool flag)
Sets flag indicating whether the component can be dragged to start a drag & drop operation.
Parameters:
flag
Returns:
GetColumnVisibleArray
()
Returns:
The visible states of the columns of the Table.
void
SetColumnVisibleArray
(xintsequence_ptr values)
Sets the visible states of the columns of the Table.
Parameters:
values
Returns:
GetScrollBarPosition
()
Returns:
The position of the scrollbars of the component.
SCROLLBAR_POSITION_CENTER
No scrollbars
SCROLLBAR_POSITION_TOP
A horizontal scrollbar at the top
SCROLLBAR_POSITION_BOTTOM
A horizontal scrollbar at the bottom
SCROLLBAR_POSITION_LEFT
A vertical scrollbar at the left
SCROLLBAR_POSITION_RIGHT
A vertical scrollbar at the right
SCROLLBAR_POSITION_TOP_LEFT
A horizontal scrollbar at the top and a vertical scrollbar at the left
SCROLLBAR_POSITION_TOP_RIGHT
A horizontal scrollbar at the top and a vertical scrollbar at the right
SCROLLBAR_POSITION_BOTTOM_LEFT
A horizontal scrollbar at the bottom and a vertical scrollbar at the left
SCROLLBAR_POSITION_BOTTOM_RIGHT
A horizontal scrollbar at the bottom and a vertical scrollbar at the right
void
SetScrollBarPosition
Sets the position of the scrollbars of the component.
SCROLLBAR_POSITION_CENTER
No scrollbars
SCROLLBAR_POSITION_TOP
A horizontal scrollbar at the top
SCROLLBAR_POSITION_BOTTOM
A horizontal scrollbar at the bottom
SCROLLBAR_POSITION_LEFT
A vertical scrollbar at the left
SCROLLBAR_POSITION_RIGHT
A vertical scrollbar at the right
SCROLLBAR_POSITION_TOP_LEFT
A horizontal scrollbar at the top and a vertical scrollbar at the left
SCROLLBAR_POSITION_TOP_RIGHT
A horizontal scrollbar at the top and a vertical scrollbar at the right
SCROLLBAR_POSITION_BOTTOM_LEFT
A horizontal scrollbar at the bottom and a vertical scrollbar at the left
SCROLLBAR_POSITION_BOTTOM_RIGHT
A horizontal scrollbar at the bottom and a vertical scrollbar at the right
Parameters:
value
Returns:
CanTruncateText
()
Returns:
Flag indicating whether to truncate the labels of newly created cells in the Table to the size of their cell. The default value of a cell's own CanTruncateText attribute comes from this value. NOTE: Modifying this after adding rows and columns will have no effect on any existing cell's attributes, and when a cell is drawn it is only the cell's own attribute which is used.
void
SetCanTruncateText
(xbool flag)
Sets flag indicating whether to truncate the labels of newly created cells in the Table to the size of their cell. The default value of a cell's own CanTruncateText attribute comes from this value. NOTE: Modifying this after adding rows and columns will have no effect on any existing cell's attributes, and when a cell is drawn it is only the cell's own attribute which is used.
Parameters:
flag
Returns:
DoesCellSelectOnRMB
()
Returns:
Flag to indicate whether the Table should select the item over which the right mouse button is clicked.
void
SetCellSelectOnRMB
(xbool flag)
Sets flag to indicate whether the Table should select the item over which the right mouse button is clicked.
Parameters:
flag
Returns:
GetCellSelectionDelay
()
Returns:
The delay time in milliseconds which the Table should allow to elapse before issuing a OnCellSelect() callback.
This is designed to allow applications to implement lengthy operations triggered from a OnCellSelect() callback, but without adversely interfering with the keyboard navigation and RMB user-model.
A value < 0 signifies that the system-defined double-click time should be used, to allow the user the opportunity to perform a OnCellActivate() via a left-mouse-button double-click, without being hindered by the length of time taken for the preceding OnCellSelect() callback to be processed by the application.
void
SetCellSelectionDelay
(xint value)
Sets the delay time in milliseconds which the Table should allow to elapse before issuing a OnCellSelect() callback.
This is designed to allow applications to implement lengthy operations triggered from a OnCellSelect() callback, but without adversely interfering with the keyboard navigation and RMB user-model.
A value < 0 signifies that the system-defined double-click time should be used, to allow the user the opportunity to perform a OnCellActivate() via a left-mouse-button double-click, without being hindered by the length of time taken for the preceding OnCellSelect() callback to be processed by the application.
Parameters:
value
Returns:
IsSelectionVisible
()
Returns:
Flag to indicate the color of highlighted items in a Table that doesn't have the focus. If xtrue the highlight color is blue. If xfalse the highlight color is grey.
void
SetSelectionVisible
(xbool flag)
Sets flag to indicate the color of highlighted items in a Table that doesn't have the focus. If xtrue the highlight color is blue. If xfalse the highlight color is grey.
Parameters:
flag
Returns:
DoesAllowSpaceInput
()
Returns:
Flag indicating whether to allow SPACE key presses to be ignored by the Table itself and instead passed to the application via a OnKeyDown() callback.
void
SetAllowSpaceInput
(xbool flag)
Sets flag indicating whether to allow SPACE key presses to be ignored by the Table itself and instead passed to the application via a OnKeyDown() callback.
Parameters:
flag
Returns:
CanRedraw
()
Returns:
Flag indicating whether redraws are permitted in the Table.
void
SetCanRedraw
(xbool flag)
Sets flag indicating whether redraws are permitted in the Table.
Parameters:
flag
Returns:
GetPrompt
()
Returns:
The text to be displayed in the Table when the component's contents are empty.
void
SetPrompt
(xrstring value)
Sets the text to be displayed in the Table when the component's contents are empty.
Parameters:
value
Returns:
void
SetItemTextArray
Sets the labels of the cells of the rows of the Table, as tab-separated wide-strings.
Parameters:
values
Returns:
GetColumnResizableArray
()
Returns:
The flags indicating whether the columns of the Table can be resized by the user dragging the column header separators.
void
SetColumnResizableArray
(xintsequence_ptr values)
Sets the flags indicating whether the columns of the Table can be resized by the user dragging the column header separators.
Parameters:
values
Returns:
GetRowTextColorArray
()
Returns:
The foreground colors of the rows of the Table.
void
SetRowTextColorArray
(uifcColors_ptr colors)
Sets the foreground colors of the rows of the Table.
Parameters:
colors
Returns:
GetCellSelectionPolicy
()
Returns:
The selection policy of the component.
NO_SELECTION_POLICY
No selected items
SELECTION_POLICY_SINGLE
1 or 0 selected items
SELECTION_POLICY_BROWSE
Always 1 selected item
SELECTION_POLICY_MULTIPLE
Any number of selected items
SELECTION_POLICY_EXTENDED
Any number of selected items, including support for range selection
void
SetCellSelectionPolicy
Sets the selection policy of the component.
NO_SELECTION_POLICY
No selected items
SELECTION_POLICY_SINGLE
1 or 0 selected items
SELECTION_POLICY_BROWSE
Always 1 selected item
SELECTION_POLICY_MULTIPLE
Any number of selected items
SELECTION_POLICY_EXTENDED
Any number of selected items, including support for range selection
Parameters:
value
Returns:
GetDefaultColumnWidth
()
Returns:
The default column width if no widths are specified or if any of the widths are <= 0.
void
SetDefaultColumnWidth
(xint value)
Sets the default column width if no widths are specified or if any of the widths are <= 0.
Parameters:
value
Returns:
GetSelectedRowNameArray
()
Returns:
The names of the selected rows of the Table.
void
SetSelectedRowNameArray
Sets the names of the selected rows of the Table.
Parameters:
values
Returns:
GetRowNameArray
()
Returns:
The names of the rows of the Table.
void
SetRowNameArray
Sets the names of the rows of the Table.
Parameters:
values
Returns:
HasBorder
()
Returns:
Flag indicating whether the Table has a decorated shadow border.
void
SetHasBorder
(xbool flag)
Sets flag indicating whether the Table has a decorated shadow border.
Parameters:
flag
Returns:
GetRowSelectionPolicy
()
Returns:
The selection policy of the rows of the Table.
NO_SELECTION_POLICY
No selected rows
SELECTION_POLICY_SINGLE
1 or 0 selected rows
SELECTION_POLICY_BROWSE
Always 1 selected row
SELECTION_POLICY_MULTIPLE
Any number of selected rows
SELECTION_POLICY_EXTENDED
Any number of selected rows, including support for range selection
void
SetRowSelectionPolicy
Sets the selection policy of the rows of the Table.
NO_SELECTION_POLICY
No selected rows
SELECTION_POLICY_SINGLE
1 or 0 selected rows
SELECTION_POLICY_BROWSE
Always 1 selected row
SELECTION_POLICY_MULTIPLE
Any number of selected rows
SELECTION_POLICY_EXTENDED
Any number of selected rows, including support for range selection
Parameters:
value
Returns:
DoesAllowTabInput
()
Returns:
Flag indicating whether to allow TAB key presses to be ignored by the Table itself and instead passed to the application via a OnKeyDown() callback.
void
SetAllowTabInput
(xbool flag)
Sets flag indicating whether to allow TAB key presses to be ignored by the Table itself and instead passed to the application via a OnKeyDown() callback.
Parameters:
flag
Returns:
GetViewableItemNameArray
()
Returns:
The row names of the Table that are currently viewable by the user.
DoesAllowKeyboardInput
()
Returns:
Method is now obsolete.
void
SetAllowKeyboardInput
(xbool flag)
Sets method is now obsolete.
Parameters:
flag
Returns:
void
AddActionListener
Parameters:
listener
Returns:
void
PushAction
(uifcTableAction action)
Parameters:
action
Returns:
void
CreateTimer
(uifcTableTimer_ptr timer, xrstring timerName, xbool writeInTrail)
Parameters:
timer
timerName
writeInTrail
Returns:
void
StartTimer
(xrstring timerName, xint duration)
Parameters:
timerName
duration
Returns:
void
StopTimer
(xrstring timerName)
Parameters:
timerName
Returns:
Was this helpful?