Class Fox::FXListBox
In: rdoc-sources/FXListBox.rb
lib/fox12/iterators.rb
Parent: FXPacker

List Box

Events

The following messages are sent by FXListBox to its target:

SEL_COMMAND:sent when a new list item is clicked; the message data is the index of the selected item.
SEL_CHANGED:sent when a new list item is clicked; the message data is the index of the selected item.

List Box styles

LISTBOX_NORMAL:Normal style

Message identifiers

ID_LIST ID_FIELD

Methods

appendItem   clearItems   each   findItem   getItemData   getItemIcon   getItemText   insertItem   itemCurrent?   moveItem   new   paneShown?   prependItem   removeItem   retrieveItem   setItem   setItemData   setItemIcon   setItemText   sortItems  

Included Modules

Enumerable

External Aliases

<< -> appendItem

Attributes

backColor  [R]  Background color [FXColor]
currentItem  [RW]  Current item’s index, or -1 if no current item [Integer]
font  [RW]  Text font [FXFont]
helpText  [RW]  Status line help text [String]
numItems  [R]  Number of items in the list [Integer]
numVisible  [RW]  Number of visible items [Integer]
selBackColor  [RW]  Background color for selected items [FXColor]
selTextColor  [RW]  Text color for selected items [FXColor]
textColor  [RW]  Text color [FXColor]
tipText  [RW]  Tool tip message [String]

Public Class methods

Public Instance methods

appendItem(text, icon=nil, ptr=nil)

Add an item to the end of the list.

clearItems()

Remove all items from the list

each() {|getItemText(i), getItemIcon(i), getItemData(i)| ...}

Calls block once for each item in the list, passing the item’s text, icon and user data as parameters.

findItem(text, start=-1, flags=SEARCH_FORWARD|SEARCH_WRAP)

Search items for item by name, starting from start item; the flags argument controls the search direction, and case sensitivity.

getItemData(index)

Return user data object for specified item. Raises IndexError if index is out of bounds.

getItemIcon(index)

Return icon for specified item. Raises IndexError if index is out of bounds.

getItemText(index)

Return text for specified item. Raises IndexError if index is out of bounds.

insertItem(index, text, icon=nil, ptr=nil)

Insert a new item at index. Raises IndexError if index is out of bounds.

itemCurrent?(index)

Return true if index is the index of the current item. Raises IndexError if index is out of bounds.

moveItem(newIndex, oldIndex)

Move item from oldIndex to newIndex and return the new index of the item. Raises IndexError if either oldIndex or newIndex is out of bounds.

paneShown?()

Return true if the pane is shown.

prependItem(text, icon=nil, ptr=nil)

Prepend an item to the list

removeItem(index)

Remove this item from the list. Raises IndexError if index is out of bounds.

retrieveItem(index)

Return the text of the item at the given index. Raises IndexError if index is out of bounds.

setItem(index, text, icon=nil, ptr=nil)

Replace the item at index with a new item with the specified text, icon and data. Raises IndexError if index is out of bounds.

setItemData(index, ptr)

Set user data object for specified item to ptr. Raises IndexError if index is out of bounds.

setItemIcon(index, icon)

Set icon for specified item to icon. Raises IndexError if index is out of bounds.

setItemText(index, text)

Set text for specified item to text. Raises IndexError if index is out of bounds.

sortItems()

Sort items using current sort function

[Validate]