CIP C++ documentation for class "uifcTable"

Class uifcTable

# include <uifcTable.h> class uifcTable : public virtual uifcSelection { xaideclare(uifcTable) ... };

Description

Method Summary


`void`	`AddActionListener (uifcTableListener_ptr listener)`


`xbool`	`CanDrawContentDisabled ()`


`xbool`	`CanRedraw ()`


`xbool`	`CanTruncateText ()`


`void`	`CreateTimer (uifcTableTimer_ptr timer, xrstring timerName, xbool writeInTrail)`


`void`	`DeleteChild (xrstring name)`


`void`	`DeleteColumnsByIndex (xintsequence_ptr columns)`


`void`	`DeleteColumnsByName (xstringsequence_ptr names)`


`void`	`DeletePopupMenu ()`


`void`	`DeleteRowsByIndex (xintsequence_ptr rows)`


`void`	`DeleteRowsByName (xstringsequence_ptr names)`


`xbool`	`DoesActivateOnReturn ()`


`xbool`	`DoesAllowKeyboardInput ()`


`xbool`	`DoesAllowReturnInput ()`


`xbool`	`DoesAllowSpaceInput ()`


`xbool`	`DoesAllowTabInput ()`


`xbool`	`DoesCellSelectOnRMB ()`


`xbool`	`DoesDynamicUpdate ()`


`xbool`	`DoesRowHighlight ()`


`xbool`	`DoesSizeByContents ()`


`uifcColor_ptr`	`GetAlternateRowColor ()`


`uifcPoint_ptr`	`GetAnchorCellIndex ()`


`uifcTableCellCoordinates_ptr`	`GetAnchorCellName ()`


`xint`	`GetCellSelectionDelay ()`


`uifcSelectionPolicy`	`GetCellSelectionPolicy ()`


`uifcColors_ptr`	`GetColumnBackgroundColorArray ()`


`xstringsequence_ptr`	`GetColumnNameArray ()`


`xintsequence_ptr`	`GetColumnResizableArray ()`


`xintsequence_ptr`	`GetColumnResizingArray ()`


`uifcSelectionPolicy`	`GetColumnSelectionPolicy ()`


`xstringsequence_ptr`	`GetColumnTextArray ()`


`uifcColors_ptr`	`GetColumnTextColorArray ()`


`xintsequence_ptr`	`GetColumnVisibleArray ()`


`xintsequence_ptr`	`GetColumnWidthArray ()`


`xint`	`GetDefaultColumnWidth ()`


`xstring`	`GetDefaultHelpText ()`


`uifcPoint_ptr`	`GetDragCellIndex ()`


`uifcTableCellCoordinates_ptr`	`GetDragCellName ()`


`xstring`	`GetDragCursorImage ()`


`xstring`	`GetDragNotValidCursorImage ()`


`uifcPoint_ptr`	`GetDropCellIndex ()`


`uifcTableCellCoordinates_ptr`	`GetDropCellName ()`


`uifcPoint_ptr`	`GetFocusCellIndex ()`


`uifcTableCellCoordinates_ptr`	`GetFocusCellName ()`


`uifcDimension_ptr`	`GetFrameMinimumSize ()`


`uifcPoint_ptr`	`GetFrameOrigin ()`


`uifcRectangle_ptr`	`GetFrameRectangle ()`


`uifcDimension_ptr`	`GetFrameSize ()`


`xint`	`GetHeight ()`


`uifcKey_ptr`	`GetKeyPressed ()`


`xint`	`GetLockedColumns ()`


`xint`	`GetLockedRows ()`


`xint`	`GetMinimumHeight ()`


`xint`	`GetMinimumWidth ()`


`uifcPoint_ptr`	`GetMostRecentCellIndex ()`


`uifcTableCellCoordinates_ptr`	`GetMostRecentCellName ()`


`xstring`	`GetPrompt ()`


`uifcRectangle_ptr`	`GetRectangleOfMonitor ()`


`uifcColors_ptr`	`GetRowBackgroundColorArray ()`


`xstringsequence_ptr`	`GetRowNameArray ()`


`uifcSelectionPolicy`	`GetRowSelectionPolicy ()`


`xstringsequence_ptr`	`GetRowTextArray ()`


`uifcColors_ptr`	`GetRowTextColorArray ()`


`xintsequence_ptr`	`GetRowVisibleArray ()`


`uifcPoint_ptr`	`GetScreenOrigin ()`


`uifcRectangle_ptr`	`GetScreenRectangle ()`


`uifcScrollBarPosition`	`GetScrollBarPosition ()`


`xstringsequence_ptr`	`GetSelectedCellNameArray ()`


`xstringsequence_ptr`	`GetSelectedColumnNameArray ()`


`xstringsequence_ptr`	`GetSelectedRowNameArray ()`


`uifcAlignment`	`GetTextAlignment ()`


`xstringsequence_ptr`	`GetViewableItemNameArray ()`


`xint`	`GetWidth ()`


`xbool`	`HasBorder ()`


`xbool`	`HasScrollBarsWhenNeeded ()`


`xint`	`InsertChild (uifcComponent_ptr component)`


`void`	`InsertColumn (uifcTableColumn_ptr tablecolumn, uifcColumnPositionData_ptr col_pos_data)`


`void`	`InsertColumns (uifcTableColumns_ptr tablecolumns, uifcColumnPositionData_ptr posData)`


`xint`	`InsertPopupMenu (uifcComponent_ptr component)`


`void`	`InsertRow (uifcTableRow_ptr tablerow, uifcRowPositionData_ptr row_pos_data)`


`void`	`InsertRows (uifcTableRows_ptr tablerows, uifcRowPositionData_ptr posData)`


`xbool`	`IsGridVisible ()`


`xbool`	`IsSelectionVisible ()`


`xbool`	`IsValidDragSite ()`


`void`	`MoveColumnsByIndex (xint column, xintsequence_ptr columns)`


`void`	`MoveColumnsByName (xrstring column, xstringsequence_ptr names)`


`void`	`MoveRowsByIndex (xint row, xintsequence_ptr rows)`


`void`	`MoveRowsByName (xrstring row, xstringsequence_ptr names)`


`void`	`PushAction (uifcTableAction action)`


`void`	`SelectCellsOfColumnByIndex (xintsequence_ptr columns, xbool select)`


`void`	`SelectCellsOfColumnByName (xstringsequence_ptr names, xbool select)`


`void`	`SelectCellsOfRowByIndex (xintsequence_ptr rows, xbool select)`


`void`	`SelectCellsOfRowByName (xstringsequence_ptr rows, xbool select)`


`void`	`SetActivateOnReturn (xbool flag)`


`void`	`SetAllowKeyboardInput (xbool flag)`


`void`	`SetAllowReturnInput (xbool flag)`


`void`	`SetAllowSpaceInput (xbool flag)`


`void`	`SetAllowTabInput (xbool flag)`


`void`	`SetAlternateRowColor (uifcColor_ptr color)`


`void`	`SetAnchorCellName (uifcTableCellCoordinates_ptr value)`


`void`	`SetCanDrawContentDisabled (xbool flag)`


`void`	`SetCanRedraw (xbool flag)`


`void`	`SetCanTruncateText (xbool flag)`


`void`	`SetCellSelectionDelay (xint value)`


`void`	`SetCellSelectionPolicy (uifcSelectionPolicy value)`


`void`	`SetCellSelectOnRMB (xbool flag)`


`void`	`SetColumnBackgroundColorArray (uifcColors_ptr colors)`


`void`	`SetColumnNameArray (xstringsequence_ptr values)`


`void`	`SetColumnResizableArray (xintsequence_ptr values)`


`void`	`SetColumnResizingArray (xintsequence_ptr values)`


`void`	`SetColumnSelectionPolicy (uifcSelectionPolicy value)`


`void`	`SetColumnTextArray (xstringsequence_ptr values)`


`void`	`SetColumnTextColorArray (uifcColors_ptr colors)`


`void`	`SetColumnVisibleArray (xintsequence_ptr values)`


`void`	`SetColumnWidthArray (xintsequence_ptr values)`


`void`	`SetDefaultColumnWidth (xint value)`


`void`	`SetDefaultHelpText (xrstring value)`


`void`	`SetDragCursorImage (xrstring value)`


`void`	`SetDragNotValidCursorImage (xrstring value)`


`void`	`SetDynamicUpdate (xbool flag)`


`void`	`SetFocusCellName (uifcTableCellCoordinates_ptr value)`


`void`	`SetFrameOrigin (uifcPoint_ptr value)`


`void`	`SetFrameRectangle (uifcRectangle_ptr rect)`


`void`	`SetFrameSize (uifcDimension_ptr value)`


`void`	`SetGridVisible (xbool flag)`


`void`	`SetHasBorder (xbool flag)`


`void`	`SetHasScrollBarsWhenNeeded (xbool flag)`


`void`	`SetHeight (xint value)`


`void`	`SetItemTextArray (xstringsequence_ptr values)`


`void`	`SetKeyPressed (uifcKey_ptr key)`


`void`	`SetLockedColumns (xint value)`


`void`	`SetLockedRows (xint value)`


`void`	`SetMinimumHeight (xint value)`


`void`	`SetMinimumWidth (xint value)`


`void`	`SetPrompt (xrstring value)`


`void`	`SetRowBackgroundColorArray (uifcColors_ptr colors)`


`void`	`SetRowHighlight (xbool flag)`


`void`	`SetRowNameArray (xstringsequence_ptr values)`


`void`	`SetRowSelectionPolicy (uifcSelectionPolicy value)`


`void`	`SetRowTextArray (xstringsequence_ptr values)`


`void`	`SetRowTextColorArray (uifcColors_ptr colors)`


`void`	`SetRowVisibleArray (xintsequence_ptr values)`


`void`	`SetScrollBarPosition (uifcScrollBarPosition value)`


`void`	`SetSelectedCellNameArray (xstringsequence_ptr values)`


`void`	`SetSelectedColumnNameArray (xstringsequence_ptr values)`


`void`	`SetSelectedRowNameArray (xstringsequence_ptr values)`


`void`	`SetSelectionVisible (xbool flag)`


`void`	`SetSizeByContents (xbool flag)`


`void`	`SetTextAlignment (uifcAlignment value)`


`void`	`SetTextOfColumnCells (xrstring column, xrstring labels)`


`void`	`SetTextOfRowCells (xrstring row, xrstring labels)`


`void`	`SetValidDragSite (xbool flag)`


`void`	`SetWidth (xint value)`


`void`	`StartTimer (xrstring timerName, xint duration)`


`void`	`StopTimer (xrstring timerName)`

Methods Inherited from Class uifcComponent:: GetDialog, GetComponent, CreateInParent, AddPopupMenu, IsVisible, SetVisible, GetComponentClass, GetComponentClassName, IsAlwaysAtFront, SetAlwaysAtFront, GetBackgroundColor, SetBackgroundColor, IsAttachedAtBottom, SetAttachedAtBottom, GetBottomOffset, SetBottomOffset, GetCursorImage, SetCursorImage, GetTextColor, SetTextColor, GetHelpTextAlignment, SetHelpTextAlignment, GetHelpTextWidth, SetHelpTextWidth, GetHelpTextOriginX, SetHelpTextOriginX, GetHelpTextOriginY, SetHelpTextOriginY, CanInheritPopupMenu, SetCanInheritPopupMenu, IsAttachedAtLeft, SetAttachedAtLeft, GetLeftOffset, SetLeftOffset, DoesReserveSpace, SetReserveSpace, GetParentName, GetPopupMenuName, SetPopupMenuName, CanPopupMenuWhenDisabled, SetCanPopupMenuWhenDisabled, IsAttachedAtRight, SetAttachedAtRight, GetRightOffset, SetRightOffset, IsAttachedAtTop, SetAttachedAtTop, GetTopOffset, SetTopOffset, IsValidDropSite, SetValidDropSite, GetValidDropTypeFlags, SetValidDropTypeFlags, GetChildNameArray, DoesAllowTrailRecording, SetAllowTrailRecording, CanReduceHeight, SetCanReduceHeight, CanReduceWidth, SetCanReduceWidth

Methods Inherited from Class uifcSelection:: IsInMixedState, SetInMixedState, GetTextFormat, SetTextFormat, GetFontName, SetFontName, GetFontClass, SetFontClass, GetFontSize, SetFontSize, IsEnabled, SetEnabled, GetHelpText, SetHelpText, GetFontStyle, SetFontStyle

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:

uifcPoint_ptr GetFrameOrigin ()

Determine the position of the component, in pixels, relative to its parent.

Returns:

void InsertColumns (uifcTableColumns_ptr tablecolumns, uifcColumnPositionData_ptr posData)

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:

uifcTableCellCoordinates_ptr 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:

uifcTableCellCoordinates_ptr GetAnchorCellName ()

Determine the coordinates of the selection anchor cell.

Returns:

uifcPoint_ptr 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:

uifcTableCellCoordinates_ptr 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 (xstringsequence_ptr names)

Delete columns from the Table.

Parameters:

names

Returns:

void InsertRow (uifcTableRow_ptr tablerow, uifcRowPositionData_ptr row_pos_data)

Parameters:

tablerow
row_pos_data

Returns:

uifcTableCellCoordinates_ptr GetFocusCellName ()

Determine the coordinates of the selection focus cell.

Returns:

void DeleteRowsByIndex (xintsequence_ptr rows)

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:

xint InsertPopupMenu (uifcComponent_ptr component)

Add a MenuPane to be displayed when the user presses the right mouse button over the component.

Parameters:

component

Returns:

uifcDimension_ptr GetFrameSize ()

Determine the size of the component, in pixels.

Returns:

xint InsertChild (uifcComponent_ptr component)

Parameters:

component

Returns:

uifcPoint_ptr 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 (uifcTableCellCoordinates_ptr value)

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 (uifcTableCellCoordinates_ptr value)

Set the coordinates of the selection anchor cell.

Parameters:

value

Returns:

void MoveRowsByName (xrstring row, xstringsequence_ptr names)

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:

uifcPoint_ptr 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 (uifcDimension_ptr value)

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:

uifcPoint_ptr 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:

uifcRectangle_ptr GetFrameRectangle ()

Determine the size and position of the component, in pixels.

Returns:

uifcTableCellCoordinates_ptr 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:

uifcDimension_ptr GetFrameMinimumSize ()

Determine the minimum size of the component, in pixels.

Returns:

void DeleteRowsByName (xstringsequence_ptr names)

Delete rows from the Table.

Parameters:

names

Returns:

void InsertRows (uifcTableRows_ptr tablerows, uifcRowPositionData_ptr posData)

Parameters:

tablerows
posData

Returns:

uifcPoint_ptr 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:

uifcRectangle_ptr GetScreenRectangle ()

Determine the size and screen position of the component, in pixels.

Returns:

void SetFrameRectangle (uifcRectangle_ptr rect)

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:

uifcPoint_ptr 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:

uifcRectangle_ptr GetRectangleOfMonitor ()

Determine the rectangle of the screen upon which the majority of the given component is displayed.

Returns:

xbool 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:

xint 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:

xstringsequence_ptr 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 (xstringsequence_ptr values)

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:

xbool 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:

xstringsequence_ptr GetColumnNameArray ()

Returns:: The names of the columns of the Table.

void SetColumnNameArray (xstringsequence_ptr values)

Sets the names of the columns of the Table.

Parameters:

values

Returns:

xint 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:

xint 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:

uifcColors_ptr 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:

xbool 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:

xbool 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:

uifcSelectionPolicy 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 (uifcSelectionPolicy value)

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:

xstring 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:

xint 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:

xbool 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:

xstring 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:

xstringsequence_ptr 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 (xstringsequence_ptr values)

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:

xintsequence_ptr 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:

xint 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:

uifcKey_ptr 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:

xbool DoesSizeByContents ()

Returns:: Reserved.

void SetSizeByContents (xbool flag)

Sets reserved.

Parameters:

flag

Returns:

uifcAlignment 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:

xintsequence_ptr 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:

uifcColors_ptr 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:

xintsequence_ptr 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:

xstringsequence_ptr GetSelectedColumnNameArray ()

Returns:: The names of the selected columns of the Table.

void SetSelectedColumnNameArray (xstringsequence_ptr values)

Sets the names of the selected columns of the Table.

Parameters:

values

Returns:

xbool 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:

xstring 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:

uifcColors_ptr 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:

xstringsequence_ptr 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 (xstringsequence_ptr values)

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:

uifcColor_ptr 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:

xbool 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:

xint 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:

xbool 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:

xintsequence_ptr 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:

uifcScrollBarPosition 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 (uifcScrollBarPosition value)

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:

xbool 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:

xbool 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:

xint 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:

xbool 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:

xbool 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:

xbool 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:

xstring 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 (xstringsequence_ptr values)

Sets the labels of the cells of the rows of the Table, as tab-separated wide-strings.

Parameters:

values

Returns:

xintsequence_ptr 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:

uifcColors_ptr 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:

uifcSelectionPolicy 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 (uifcSelectionPolicy value)

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:

xint 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:

xstringsequence_ptr GetSelectedRowNameArray ()

Returns:: The names of the selected rows of the Table.

void SetSelectedRowNameArray (xstringsequence_ptr values)

Sets the names of the selected rows of the Table.

Parameters:

values

Returns:

xstringsequence_ptr GetRowNameArray ()

Returns:: The names of the rows of the Table.

void SetRowNameArray (xstringsequence_ptr values)

Sets the names of the rows of the Table.

Parameters:

values

Returns:

xbool 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:

uifcSelectionPolicy 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 (uifcSelectionPolicy value)

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:

xbool 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:

xstringsequence_ptr GetViewableItemNameArray ()

Returns:: The row names of the Table that are currently viewable by the user.

xbool DoesAllowKeyboardInput ()

Returns:: Method is now obsolete.

void SetAllowKeyboardInput (xbool flag)

Sets method is now obsolete.

Parameters:

flag

Returns:

void AddActionListener (uifcTableListener_ptr listener)

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: