CIP C++ documentation for class "uifcList"

Class uifcList

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

Description

Method Summary


`void`	`AddActionListener (uifcListListener_ptr listener)`


`xbool`	`CanDrawContentDisabled ()`


`xbool`	`CanRedraw ()`


`xbool`	`CanResizeWhenNeeded ()`


`xbool`	`CanTruncateText ()`


`xbool`	`CanWrap ()`


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


`void`	`DeleteChild (xrstring name)`


`void`	`DeleteGroupsByName (xstringsequence_ptr names)`


`void`	`DeleteItemsByIndex (xintsequence_ptr items)`


`void`	`DeleteItemsByName (xstringsequence_ptr names)`


`void`	`DeletePopupMenu ()`


`xbool`	`DoesItemSelectOnRMB ()`


`xbool`	`DoesScrollOnKeyboardInput ()`


`xbool`	`DoesSizeByContents ()`


`uifcColor_ptr`	`GetAlternateRowColor ()`


`xstring`	`GetColumnHeaderText ()`


`uifcAlignment`	`GetColumnHeaderTextAlignment ()`


`xint`	`GetContentArrangement ()`


`xint`	`GetDefaultColumnWidth ()`


`xstring`	`GetDefaultHelpText ()`


`xint`	`GetDefaultTabStop ()`


`xstring`	`GetDragCursorImage ()`


`xstring`	`GetDragGroupName ()`


`xstring`	`GetDragItemName ()`


`xstring`	`GetDragNotValidCursorImage ()`


`xstring`	`GetDropGroupName ()`


`xstring`	`GetDropItemName ()`


`xstringsequence_ptr`	`GetEnabledItemNameArray ()`


`xstring`	`GetFocusGroupName ()`


`xstring`	`GetFocusItemName ()`


`uifcDimension_ptr`	`GetFrameMinimumSize ()`


`uifcPoint_ptr`	`GetFrameOrigin ()`


`uifcRectangle_ptr`	`GetFrameRectangle ()`


`uifcDimension_ptr`	`GetFrameSize ()`


`xstringsequence_ptr`	`GetGroupHelpTextArray ()`


`xstringsequence_ptr`	`GetGroupImageArray ()`


`xstringsequence_ptr`	`GetGroupItemNameArray ()`


`xstringsequence_ptr`	`GetGroupNameArray ()`


`xintsequence_ptr`	`GetGroupOpenArray ()`


`xstringsequence_ptr`	`GetGroupTextArray ()`


`xint`	`GetHeight ()`


`xint`	`GetHorizontalCells ()`


`xint`	`GetImageHeight ()`


`xint`	`GetImageWidth ()`


`uifcColors_ptr`	`GetItemBackgroundColorArray ()`


`xintsequence_ptr`	`GetItemCheckedStateArray ()`


`xstringsequence_ptr`	`GetItemHelpTextArray ()`


`xstringsequence_ptr`	`GetItemImageArray ()`


`xstringsequence_ptr`	`GetItemNameArray ()`


`xint`	`GetItemSelectionDelay ()`


`uifcSelectionPolicy`	`GetItemSelectionPolicy ()`


`xstringsequence_ptr`	`GetItemTextArray ()`


`uifcColors_ptr`	`GetItemTextColorArray ()`


`uifcKey_ptr`	`GetKeyPressed ()`


`uifcListType`	`GetListType ()`


`xint`	`GetMaximumWidth ()`


`xint`	`GetMinimumHeight ()`


`xint`	`GetMinimumWidth ()`


`xstring`	`GetMixedStateImage ()`


`xstring`	`GetMostRecentGroupName ()`


`xstring`	`GetMostRecentItemName ()`


`uifcOrientation`	`GetOrientation ()`


`xstring`	`GetPrompt ()`


`uifcRectangle_ptr`	`GetRectangleOfMonitor ()`


`uifcPoint_ptr`	`GetScreenOrigin ()`


`uifcRectangle_ptr`	`GetScreenRectangle ()`


`uifcScrollBarPosition`	`GetScrollBarPosition ()`


`xint`	`GetSelectedItemIndex ()`


`xstring`	`GetSelectedItemName ()`


`xstringsequence_ptr`	`GetSelectedItemNameArray ()`


`xstring`	`GetSetStateImage ()`


`xintsequence_ptr`	`GetTabStopArray ()`


`xstring`	`GetUnsetStateImage ()`


`xint`	`GetVerticalCells ()`


`xint`	`GetWidth ()`


`xbool`	`HasBorder ()`


`xbool`	`HasScrollBarsWhenNeeded ()`


`xint`	`InsertChild (uifcComponent_ptr component)`


`void`	`InsertGroup (uifcListGroup_ptr listgroup, uifcItemPositionData_ptr item_pos_data)`


`void`	`InsertGroups (uifcListGroups_ptr listgroups, uifcItemPositionData_ptr posData)`


`void`	`InsertItem (uifcListItem_ptr listitem, uifcItemPositionData_ptr item_pos_data)`


`void`	`InsertItems (uifcListItems_ptr listitems, uifcItemPositionData_ptr posData)`


`xint`	`InsertPopupMenu (uifcComponent_ptr component)`


`xbool`	`IsSelectionVisible ()`


`xbool`	`IsValidDragSite ()`


`void`	`MoveItemsByIndex (xint item, xintsequence_ptr items)`


`void`	`MoveItemsByName (xrstring name, xstringsequence_ptr names)`


`xstring`	`OnlyScrollItemNameIntoView ()`


`void`	`PushAction (uifcListAction action)`


`void`	`ScrollItemNameIntoView (xrstring value)`


`void`	`SetAlternateRowColor (uifcColor_ptr color)`


`void`	`SetCanDrawContentDisabled (xbool flag)`


`void`	`SetCanRedraw (xbool flag)`


`void`	`SetCanResizeWhenNeeded (xbool flag)`


`void`	`SetCanTruncateText (xbool flag)`


`void`	`SetCanWrap (xbool flag)`


`void`	`SetColumnHeaderText (xrstring value)`


`void`	`SetColumnHeaderTextAlignment (uifcAlignment value)`


`void`	`SetContentArrangement (xint value)`


`void`	`SetDefaultColumnWidth (xint value)`


`void`	`SetDefaultHelpText (xrstring value)`


`void`	`SetDefaultTabStop (xint value)`


`void`	`SetDragCursorImage (xrstring value)`


`void`	`SetDragGroupName (xrstring value)`


`void`	`SetDragNotValidCursorImage (xrstring value)`


`void`	`SetEnabledItemNameArray (xstringsequence_ptr values)`


`void`	`SetFocusGroupName (xrstring value)`


`void`	`SetFocusItemName (xrstring value)`


`void`	`SetFrameOrigin (uifcPoint_ptr value)`


`void`	`SetFrameRectangle (uifcRectangle_ptr rect)`


`void`	`SetFrameSize (uifcDimension_ptr value)`


`void`	`SetGroupHelpTextArray (xstringsequence_ptr values)`


`void`	`SetGroupImageArray (xstringsequence_ptr values)`


`void`	`SetGroupItemNameArray (xstringsequence_ptr values)`


`void`	`SetGroupNameArray (xstringsequence_ptr values)`


`void`	`SetGroupOpenArray (xintsequence_ptr values)`


`void`	`SetGroupTextArray (xstringsequence_ptr values)`


`void`	`SetHasBorder (xbool flag)`


`void`	`SetHasScrollBarsWhenNeeded (xbool flag)`


`void`	`SetHeight (xint value)`


`void`	`SetHorizontalCells (xint value)`


`void`	`SetImageHeight (xint value)`


`void`	`SetImageWidth (xint value)`


`void`	`SetItemBackgroundColorArray (uifcColors_ptr colors)`


`void`	`SetItemCheckedStateArray (xintsequence_ptr values)`


`void`	`SetItemHelpTextArray (xstringsequence_ptr values)`


`void`	`SetItemImageArray (xstringsequence_ptr values)`


`void`	`SetItemNameArray (xstringsequence_ptr values)`


`void`	`SetItemSelectionDelay (xint value)`


`void`	`SetItemSelectionPolicy (uifcSelectionPolicy value)`


`void`	`SetItemSelectOnRMB (xbool flag)`


`void`	`SetItemTextArray (xstringsequence_ptr values)`


`void`	`SetItemTextColorArray (uifcColors_ptr colors)`


`void`	`SetKeyPressed (uifcKey_ptr key)`


`void`	`SetListType (uifcListType value)`


`void`	`SetMaximumWidth (xint value)`


`void`	`SetMinimumHeight (xint value)`


`void`	`SetMinimumWidth (xint value)`


`void`	`SetMixedStateImage (xrstring value)`


`void`	`SetOrientation (uifcOrientation value)`


`void`	`SetPrompt (xrstring value)`


`void`	`SetScrollBarPosition (uifcScrollBarPosition value)`


`void`	`SetScrollOnKeyboardInput (xbool flag)`


`void`	`SetSelectedItemIndex (xint value)`


`void`	`SetSelectedItemName (xrstring value)`


`void`	`SetSelectedItemNameArray (xstringsequence_ptr values)`


`void`	`SetSelectionVisible (xbool flag)`


`void`	`SetSetStateImage (xrstring value)`


`void`	`SetSizeByContents (xbool flag)`


`void`	`SetTabStopArray (xintsequence_ptr values)`


`void`	`SetUnsetStateImage (xrstring value)`


`void`	`SetValidDragSite (xbool flag)`


`void`	`SetVerticalCells (xint value)`


`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

uifcPoint_ptr GetFrameOrigin ()

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

Returns:

void DeleteGroupsByName (xstringsequence_ptr names)

Delete groups from the component.

Parameters:

names

Returns:

void InsertGroups (uifcListGroups_ptr listgroups, uifcItemPositionData_ptr posData)

Parameters:

listgroups
posData

Returns:

void MoveItemsByName (xrstring name, xstringsequence_ptr names)

Reorders the items of the component so that the given array of items are placed in the given order (implied by the order of names in the array) immediately after the named item. When the items are reordered any item-related data is also reordered, i.e. the labels, help-texts, states, foreground and background colors, etc.

Parameters:

name
names

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:

xint InsertChild (uifcComponent_ptr component)

Parameters:

component

Returns:

void InsertGroup (uifcListGroup_ptr listgroup, uifcItemPositionData_ptr item_pos_data)

Parameters:

listgroup
item_pos_data

Returns:

void MoveItemsByIndex (xint item, xintsequence_ptr items)

Reorders the items of the component so that the given array of items are placed in the given order (implied by the order of names in the array) immediately after the named item indices. When the items are reordered any item-related data is also reordered, i.e. the labels, help-texts, states, foreground and background colors, etc.

Parameters:

item
items

Returns:

void DeleteChild (xrstring name)

Delete a component from the parent.

Parameters:

name

Returns:

uifcDimension_ptr GetFrameSize ()

Determine the size of the component, in pixels.

Returns:

void DeletePopupMenu ()

Delete a MenuPane from the component.

Returns:

void InsertItem (uifcListItem_ptr listitem, uifcItemPositionData_ptr item_pos_data)

Parameters:

listitem
item_pos_data

Returns:

uifcPoint_ptr GetScreenOrigin ()

Determine the screen position of the component, in pixels.

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:

void InsertItems (uifcListItems_ptr listitems, uifcItemPositionData_ptr posData)

Parameters:

listitems
posData

Returns:

uifcRectangle_ptr GetFrameRectangle ()

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

Returns:

void DeleteItemsByName (xstringsequence_ptr names)

Delete items from the component.

Parameters:

names

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:

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:

void DeleteItemsByIndex (xintsequence_ptr items)

Delete items from the component using item indices.

Parameters:

items

Returns:

uifcRectangle_ptr GetRectangleOfMonitor ()

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

Returns:

xint GetMinimumWidth ()

Returns:: The minimum width of the List, in character widths.

void SetMinimumWidth (xint value)

Sets the minimum width of the List, in character widths.

Parameters:

value

Returns:

xint GetWidth ()

Returns:: The width of the List, in character widths.

void SetWidth (xint value)

Sets the width of the List, in character widths.

Parameters:

value

Returns:

xstringsequence_ptr GetSelectedItemNameArray ()

Returns:: The names of the selected items of the component.

void SetSelectedItemNameArray (xstringsequence_ptr values)

Sets the names of the selected items of the component.

Parameters:

values

Returns:

xint GetMinimumHeight ()

Returns:: The minimum number of visible rows of the List.

void SetMinimumHeight (xint value)

Sets the minimum number of visible rows of the List.

Parameters:

value

Returns:

xstring GetColumnHeaderText ()

Returns:: The tab-separated labels to be displayed as the column headers of the List.

void SetColumnHeaderText (xrstring value)

Sets the tab-separated labels to be displayed as the column headers of the List.

Parameters:

value

Returns:

xstringsequence_ptr GetGroupItemNameArray ()

Returns:: The names of the first item of each of the groups of the List.

void SetGroupItemNameArray (xstringsequence_ptr values)

Sets the names of the first item of each of the groups of the List.

Parameters:

values

Returns:

xstring GetMixedStateImage ()

Returns:: The check mark image to be displayed next to an item when the state of the item is mixed.

void SetMixedStateImage (xrstring value)

Sets the check mark image to be displayed next to an item when the state of the item is mixed.

Parameters:

value

Returns:

xstringsequence_ptr GetGroupNameArray ()

Returns:: The names of the group headers of the List.

void SetGroupNameArray (xstringsequence_ptr values)

Sets the names of the group headers of the List.

Parameters:

values

Returns:

xbool CanDrawContentDisabled ()

Returns:: Flag indicating whether the images embedded in the label of an item of the List should be greyed-out whenever the item is insensitive.

void SetCanDrawContentDisabled (xbool flag)

Sets flag indicating whether the images embedded in the label of an item of the List should be greyed-out whenever the item is insensitive.

Parameters:

flag

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 items of the List.

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 items of the List.

Parameters:

value

Returns:

xint GetHeight ()

Returns:: The number of visible rows of the List.

void SetHeight (xint value)

Sets the number of visible rows of the List.

Parameters:

value

Returns:

xstring GetDragItemName ()

Returns:: The name of the item being dragged when the user starts a drag & drop operation by dragging within the component.

uifcOrientation GetOrientation ()

Returns:

The orientation of the List.

ORIENTATION_HORIZONTAL	Horizontal, with the items arranged in a row
ORIENTATION_VERTICAL	Vertical, with the items arranged in a column

void SetOrientation (uifcOrientation value)

Sets the orientation of the List.

ORIENTATION_HORIZONTAL	Horizontal, with the items arranged in a row
ORIENTATION_VERTICAL	Vertical, with the items arranged in a column

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:

xintsequence_ptr GetGroupOpenArray ()

Returns:: The expanded / collapsed state of each of the group headers of the List.

void SetGroupOpenArray (xintsequence_ptr values)

Sets the expanded / collapsed state of each of the group headers of the List.

Parameters:

values

Returns:

uifcKey_ptr GetKeyPressed ()

Returns:: The key pressed which generated a OnKeyDown(). To indicate to the List 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 List 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:: Flag indicating whether the List should be initially sized according to its contents (xtrue).

void SetSizeByContents (xbool flag)

Sets flag indicating whether the List should be initially sized according to its contents (xtrue).

Parameters:

flag

Returns:

xstring GetDropGroupName ()

Returns:: The name of the group beneath the pointer whilst the pointer is over the component during a drag & drop operation.

uifcAlignment GetColumnHeaderTextAlignment ()

Returns:

The alignment of the text in the column header labels of the List.

ALIGNMENT_LEFT	Left aligned
ALIGNMENT_CENTER	Center aligned
ALIGNMENT_RIGHT	Right aligned

void SetColumnHeaderTextAlignment (uifcAlignment value)

Sets the alignment of the text in the column header labels of the List.

ALIGNMENT_LEFT	Left aligned
ALIGNMENT_CENTER	Center aligned
ALIGNMENT_RIGHT	Right aligned

Parameters:

value

Returns:

xstring GetFocusGroupName ()

Returns:: The group of the List which should have the focus when the List component itself receives the focus.

void SetFocusGroupName (xrstring value)

Sets the group of the List which should have the focus when the List component itself receives the focus.

Parameters:

value

Returns:

xbool CanWrap ()

Returns:: Flag to indicate whether the list items should wrap. If xtrue then wrap the list items horizontally. If xfalse then no wrapping is done.

void SetCanWrap (xbool flag)

Sets flag to indicate whether the list items should wrap. If xtrue then wrap the list items horizontally. If xfalse then no wrapping is done.

Parameters:

flag

Returns:

uifcListType GetListType ()

Returns:

The display type of the List.

LIST_TYPE_STANDARD	No column headers or check marks
LIST_TYPE_COLUMNS	Display column headers, but do not display check marks
LIST_TYPE_CHECKBOXES	Display check marks, but do not display column headers
LIST_TYPE_COLUMNS_AND_CHECKBOXES	Display both column headers and check marks

void SetListType (uifcListType value)

Sets the display type of the List.

LIST_TYPE_STANDARD	No column headers or check marks
LIST_TYPE_COLUMNS	Display column headers, but do not display check marks
LIST_TYPE_CHECKBOXES	Display check marks, but do not display column headers
LIST_TYPE_COLUMNS_AND_CHECKBOXES	Display both column headers and check marks

Parameters:

value

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 GetItemTextColorArray ()

Returns:: The foreground colors of the items of the component, as a uifcColor.

void SetItemTextColorArray (uifcColors_ptr colors)

Sets the foreground colors of the items of the component, as a uifcColor.

Parameters:

colors

Returns:

xint GetContentArrangement ()

Returns:

The alignment of the image and label of the items of the List.
This is made up of between 1 and 4 digits which represent the relative locations of the image and label.
The first digit is the image alignment within the bounds of the item:

1	2	3
4	5	6
7	8	9

The second digit is optional and is the label alignment within the bounds of the item, using the same scheme as above. If no digit is specified then the label alignment is assumed to be the same as the image alignment.
The third digit is also optional and is the relative position of the image and the label if the first 2 digits are equal. If no digit is specified then the relative position is assumed to be 1.

1	The image to the left of the label
2	The image to the right of the label
3	The image above the label
4	The image below the label

The fourth digit is also optional and is a flag representing whether how the image and label should be displayed. If no digit is specified then then fourth digit is assumed to be 1.

1	Display both the image and label
2	Display only the image
3	Display only the label

void SetContentArrangement (xint value)

Sets the alignment of the image and label of the items of the List.
This is made up of between 1 and 4 digits which represent the relative locations of the image and label.
The first digit is the image alignment within the bounds of the item:

1	2	3
4	5	6
7	8	9

1	The image to the left of the label
2	The image to the right of the label
3	The image above the label
4	The image below the label

The fourth digit is also optional and is a flag representing whether how the image and label should be displayed. If no digit is specified then then fourth digit is assumed to be 1.

1	Display both the image and label
2	Display only the image
3	Display only the label

Parameters:

value

Returns:

xint GetVerticalCells ()

Returns:: When wrapping is enabled, and the orientation is ORIENTATION_VERTICAL, determines the number of vertical cells before wrapping onto a new column.

void SetVerticalCells (xint value)

Sets when wrapping is enabled, and the orientation is ORIENTATION_VERTICAL, determines the number of vertical cells before wrapping onto a new column.

Parameters:

value

Returns:

xstring GetDropItemName ()

Returns:: The name of the item beneath the pointer whilst the pointer is over the component during a drag & drop operation.

xstringsequence_ptr GetItemImageArray ()

Returns:: The images of the items of the component.
Each image may be a BIF (the .bif extension is optional) file or a JPG, PNG, PCX, GIF, BMP, ICO or CUR file.

void SetItemImageArray (xstringsequence_ptr values)

Sets the images of the items of the component.
Each image may be a BIF (the .bif extension is optional) file or a JPG, PNG, PCX, GIF, BMP, ICO or CUR file.

Parameters:

values

Returns:

xint GetDefaultTabStop ()

Returns:: The number of characters used as the default tab-stop of the List.

void SetDefaultTabStop (xint value)

Sets the number of characters used as the default tab-stop of the List.

Parameters:

value

Returns:

xintsequence_ptr GetItemCheckedStateArray ()

Returns:: The state of each of the items of the List.

void SetItemCheckedStateArray (xintsequence_ptr values)

Sets the state of each of the items of the List.

Parameters:

values

Returns:

uifcColor_ptr GetAlternateRowColor ()

Returns:: The color of alternate rows of the List as a uifcColor.

void SetAlternateRowColor (uifcColor_ptr color)

Sets the color of alternate rows of the List as a uifcColor.

Parameters:

color

Returns:

xstringsequence_ptr GetItemHelpTextArray ()

Returns:: The popup help-text to be displayed for the items of the component whilst the pointer is over the component.

void SetItemHelpTextArray (xstringsequence_ptr values)

Sets the popup help-text to be displayed for the items of the component whilst the pointer is over the component.

Parameters:

values

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:

xint GetImageWidth ()

Returns:: The width of the images of the List, in pixels

void SetImageWidth (xint value)

Sets the width of the images of the List, in pixels

Parameters:

value

Returns:

uifcColors_ptr GetItemBackgroundColorArray ()

Returns:: The background colors of the items of the component, as a uifcColor.

void SetItemBackgroundColorArray (uifcColors_ptr colors)

Sets the background colors of the items of the component, as a uifcColor.

Parameters:

colors

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:

xstring GetDragGroupName ()

Returns:: The name of the group being dragged when the user starts a drag & drop operation by dragging within the component.

void SetDragGroupName (xrstring value)

Sets the name of the group being dragged when the user starts a drag & drop operation by dragging within the component.

Parameters:

value

Returns:

xbool CanTruncateText ()

Returns:: Flag indicating whether to truncate the labels of the items of the List with ellipsis if there is insufficient space to display the entire text string.

void SetCanTruncateText (xbool flag)

Sets flag indicating whether to truncate the labels of the items of the List with ellipsis if there is insufficient space to display the entire text string.

Parameters:

flag

Returns:

xbool DoesItemSelectOnRMB ()

Returns:: Flag to indicate whether the List should select the item over which the right mouse button is clicked.

void SetItemSelectOnRMB (xbool flag)

Sets flag to indicate whether the List should select the item over which the right mouse button is clicked.

Parameters:

flag

Returns:

xint GetHorizontalCells ()

Returns:: When wrapping is enabled, and the orientation is ORIENTATION_HORIZONTAL, determines the number of horizontal cells before wrapping onto a new row.

void SetHorizontalCells (xint value)

Sets when wrapping is enabled, and the orientation is ORIENTATION_HORIZONTAL, determines the number of horizontal cells before wrapping onto a new row.

Parameters:

value

Returns:

xint GetMaximumWidth ()

Returns:: The maximum width of the List, in character widths.
When SizeByContents attribute is xtrue, this value limits the width of the List, with a value of 0 indicating that the List should indeed size itself based upon its contents.

void SetMaximumWidth (xint value)

Sets the maximum width of the List, in character widths.
When SizeByContents attribute is xtrue, this value limits the width of the List, with a value of 0 indicating that the List should indeed size itself based upon its contents.

Parameters:

value

Returns:

xstringsequence_ptr GetItemNameArray ()

Returns:: The names of the items of the component.

void SetItemNameArray (xstringsequence_ptr values)

Sets the names of the items of the component.

Parameters:

values

Returns:

xint GetItemSelectionDelay ()

Returns:: The delay time in milliseconds which the List should allow to elapse before issuing a OnItemSelect() callback.
This is designed to allow applications to implement lengthy operations triggered from a OnItemSelect() 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 OnItemActivate() via a left-mouse-button double-click, without being hindered by the length of time taken for the preceding OnItemSelect() callback to be processed by the application.

void SetItemSelectionDelay (xint value)

Sets the delay time in milliseconds which the List should allow to elapse before issuing a OnItemSelect() callback.
This is designed to allow applications to implement lengthy operations triggered from a OnItemSelect() 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 OnItemActivate() via a left-mouse-button double-click, without being hindered by the length of time taken for the preceding OnItemSelect() callback to be processed by the application.

Parameters:

value

Returns:

xint GetImageHeight ()

Returns:: The height of the images of the List, in pixels

void SetImageHeight (xint value)

Sets the height of the images of the List, in pixels

Parameters:

value

Returns:

xbool IsSelectionVisible ()

Returns:: Flag to indicate the color of highlighted items in a List 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 List that doesn't have the focus. If xtrue the highlight color is blue. If xfalse the highlight color is grey.

Parameters:

flag

Returns:

xbool CanResizeWhenNeeded ()

Returns:: Flag indicating whether the List should attempt to resize when its contents are changed.

void SetCanResizeWhenNeeded (xbool flag)

Sets flag indicating whether the List should attempt to resize when its contents are changed.

Parameters:

flag

Returns:

xstring GetUnsetStateImage ()

Returns:: The check mark image to be displayed next to an item when the state of the item is False.

void SetUnsetStateImage (xrstring value)

Sets the check mark image to be displayed next to an item when the state of the item is False.

Parameters:

value

Returns:

xstringsequence_ptr GetEnabledItemNameArray ()

Returns:: The names of the selectable items of the component. An empty array indicates that every item of the component may be selected.

void SetEnabledItemNameArray (xstringsequence_ptr values)

Sets the names of the selectable items of the component. An empty array indicates that every item of the component may be selected.

Parameters:

values

Returns:

xstring GetFocusItemName ()

Returns:: The item of the List which should have the focus when the List component itself receives the focus.

void SetFocusItemName (xrstring value)

Sets the item of the List which should have the focus when the List component itself receives the focus.

Parameters:

value

Returns:

xbool CanRedraw ()

Returns:: Flag indicating whether redraws are permitted in the List.

void SetCanRedraw (xbool flag)

Sets flag indicating whether redraws are permitted in the List.

Parameters:

flag

Returns:

xstring GetMostRecentGroupName ()

Returns:: The group heading which was beneath the pointer the last time the pointer was over the component.

xstringsequence_ptr GetGroupHelpTextArray ()

Returns:: The popup help-text to be displayed for the group headers of the List whilst the pointer is over the component.

void SetGroupHelpTextArray (xstringsequence_ptr values)

Sets the popup help-text to be displayed for the group headers of the List whilst the pointer is over the component.

Parameters:

values

Returns:

xstring GetMostRecentItemName ()

Returns:: The item which was beneath the pointer the last time the pointer was over the component.

xstring GetPrompt ()

Returns:: The text to be displayed in the List when the component's contents are empty.

void SetPrompt (xrstring value)

Sets the text to be displayed in the List when the component's contents are empty.

Parameters:

value

Returns:

xstringsequence_ptr GetGroupTextArray ()

Returns:: The labels of the group headers of the List.

void SetGroupTextArray (xstringsequence_ptr values)

Sets the labels of the group headers of the List.

Parameters:

values

Returns:

xintsequence_ptr GetTabStopArray ()

Returns:: The character positions of the tab-stops of the List.

void SetTabStopArray (xintsequence_ptr values)

Sets the character positions of the tab-stops of the List.

Parameters:

values

Returns:

xstringsequence_ptr GetItemTextArray ()

Returns:: The labels of the items of the component.

void SetItemTextArray (xstringsequence_ptr values)

Sets the labels of the items of the component.

Parameters:

values

Returns:

xstring GetSetStateImage ()

Returns:: The check mark image to be displayed next to an item when the state of the item is True.

void SetSetStateImage (xrstring value)

Sets the check mark image to be displayed next to an item when the state of the item is True.

Parameters:

value

Returns:

uifcSelectionPolicy GetItemSelectionPolicy ()

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 SetItemSelectionPolicy (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:: Specifies the minimum width of a column in a wrapped list (in character widths). If set to 0 then the maximum item width will be used.

void SetDefaultColumnWidth (xint value)

Sets specifies the minimum width of a column in a wrapped list (in character widths). If set to 0 then the maximum item width will be used.

Parameters:

value

Returns:

xstring OnlyScrollItemNameIntoView ()

Returns:: The item of the List to which the List should scroll so that it can be viewed.

void ScrollItemNameIntoView (xrstring value)

Sets the item of the List to which the List should scroll so that it can be viewed.

Parameters:

value

Returns:

xbool DoesScrollOnKeyboardInput ()

Returns:: Flag indicating whether the List should automatically scroll to the first item whose label has the initial letter keyed by the user when the user presses a printable character key.

void SetScrollOnKeyboardInput (xbool flag)

Sets flag indicating whether the List should automatically scroll to the first item whose label has the initial letter keyed by the user when the user presses a printable character key.

Parameters:

flag

Returns:

xstringsequence_ptr GetGroupImageArray ()

Returns:: The images of the group headers of the List.
Each image may be a BIF (the .bif extension is optional) file or a JPG, PNG, PCX, GIF, BMP, ICO or CUR file.

void SetGroupImageArray (xstringsequence_ptr values)

Sets the images of the group headers of the List.
Each image may be a BIF (the .bif extension is optional) file or a JPG, PNG, PCX, GIF, BMP, ICO or CUR file.

Parameters:

values

Returns:

xbool HasBorder ()

Returns:: Flag indicating whether the List has a decorated shadow border.

void SetHasBorder (xbool flag)

Sets flag indicating whether the List has a decorated shadow border.

Parameters:

flag

Returns:

xint GetSelectedItemIndex ()

Returns:: The index of the selected item of the component. Can be used if no more than one item in the component may be selected at any time.

void SetSelectedItemIndex (xint value)

Sets the index of the selected item of the component. Can be used if no more than one item in the component may be selected at any time.

Parameters:

value

Returns:

xstring GetSelectedItemName ()

Returns:: The name of the selected item of the component. Can be used if no more than one item in the component may be selected at any time.

void SetSelectedItemName (xrstring value)

Sets the name of the selected item of the component. Can be used if no more than one item in the component may be selected at any time.

Parameters:

value

Returns:

void AddActionListener (uifcListListener_ptr listener)

Parameters:

listener

Returns:

void PushAction (uifcListAction action)

Parameters:

action

Returns:

void CreateTimer (uifcListTimer_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: