JRAD at 12:07, 21 November 2007

2007-11-21T12:07:13Z

New page

__NOEDITSECTION__
== Class Tree ==
* [[:UIObject]]
** [[:UIObject_Drawable]]
*** [[:UIWindow]]
**** [[:UIList]]

== Overview ==
The list window type can be used if you want display a list in the GUI. It is the most complex window type in the GUI system. Some of the features of the list type are column headers, drawing of text or materials in headers and items, saving additional data in items, column sorting, variable row height, filling from enumerators, mouse and key events on header columns and items.

This class may be used in the GUIs. It will inherit all properties, flags, functions and events from [[UIWindow]].

Window type:
type list;

'''Example:'''
windowDef vPlayerList {
type list;
properties {
float fontSize = 48;
// Truncate player name to the item rectangle
float flags = immediate( flags ) | WF_TRUNCATE_TEXT;
rect rect = 24, 50, 590, 350;
color backColor = 0,0,0,0;
}
events {
onCreate {
insertColumn( gui.blankWStr, 0, 0 ); // Class icon column.
insertColumn( gui.blankWStr, 590, 1 ) // Player name column;
}
}
timeLine {
onTime 250 {
// Have the gamecode update the list of players in the vehicle every 250 milliseconds.
fillFromEnumerator( "vehiclePlayerList" );
resetTime( 0 );
}
}
}

== Properties ==
{{:UIList Properties}}

== Flags ==
{{:UIList Flags}}

== Functions ==
=== General Functions ===
[[UIList:insertItem|insertItem]] Insert list item. Calls onItemAdded event.
[[UIList:insertBlankItems|insertBlankItems]] Insert multiple blank items.
[[UIList:setItemText|setItemText]] Set item text.
[[UIList:setItemTextFlags|setItemTextFlags]] Set item text flags.
[[UIList:setItemForeColor|setItemForeColor]] Set item forecolor.
[[UIList:setItemBackColor|setItemBackColor]] Set item backcolor.
[[UIList:setItemMaterialSize|setItemMaterialSize]] Set iteam material size.
[[UIList:setItemIcon|setItemIcon]] Set icon for item.
[[UIList:transitionItemVec4|transitionItemVec4]] Transition a property for an item.
[[UIList:getItemTransitionVec4Result|getItemTransitionVec4Result]] Get the items immediate transition value.
[[UIList:transitionColumnVec4|transitionColumnVec4]] Transition a property for a column.
[[UIList:getColumnTransitionVec4Result|getColumnTransitionVec4Result]] Get the columns immediate transition value.
[[UIList:clearTransitions|clearTransitions]] Clear transitions for an item.
[[UIList:setColumnText|setColumnText]] Set column header text.
[[UIList:setColumnWidth|setColumnWidth]] Set column width.
[[UIList:setColumnTextFlags|setColumnTextFlags]] Set column header text flags.
[[UIList:deleteItem|deleteItem]] Delete an item from the list. Calls onItemRemoved event.
[[UIList:insertColumn|insertColumn]] Insert a column.
[[UIList:deleteColumn|deleteColumn]] Delete a column. NOT IMPLEMENTED.
[[UIList:clearItems|clearItems]] Delete all items.
[[UIList:clearColumns|clearColumns]] Delete all columns.
[[UIList:getItemText|getItemText]] Get item text. Returns header text if row is -1.
[[UIList:getItemRect|getItemRect]] Get item rectangle.
[[UIList:fillFromEnumerator|fillFromEnumerator]] Fill list using the specified enumerator.
[[UIList:sort|sort]] Explicitly sort list.
[[UIList:getItemAtPoint|getItemAtPoint]] Get item at position. Often used to get the list item under the cursor.
[[UIList:findItem|findItem]] Finds first item in column which matches the search text.
[[UIList:findItemDataInt|findItemDataInt]] Find the item with the item data.
[[UIList:setItemDataInt|setItemDataInt]] Set item data.
[[UIList:getItemDataInt|getItemDataInt]] Get item data.
[[UIList:storeVisualState|storeVisualState]] Store the visual state, in essence the scroll amount.
[[UIList:restoreVisualState|restoreVisualState]] Restore the visual state. Makes the layout dirty.
[[UIList:drawItemMaterial|drawItemMaterial]] Draw a material in the given item.
[[UIList:sizeLastColumn|sizeLastColumn]] Stretch the last column to fill any leftover space, minus the amount passed in.
[[UIList:setItemFlags|setItemFlags]] Set item flags.
[[UIList:setColumnFlags|setColumnFlags]] Set column header flags.
[[UIList:ensureItemIsVisible|ensureItemIsVisible]] Potentially scroll the list to make sure the item is visible.
[[UIList:fillFromFile|fillFromFile]] Fill list from file. Supports UTF8 encoding.

== Events ==
[[UIList:onSelectItem|onSelectItem]] Called when a list item is selected.
[[UIList:onItemAdded|onItemAdded]] Called when an item is inserted into the list.
[[UIList:onItemRemoved|onItemRemoved]] Called when an item is deleted from the list.
[[UIList:onDrawSelectedBackground|onDrawSelectedBackground]] If this event is valid in the GUI it will be called instead of onDrawItemBackGround for the currently selected item.
[[UIList:onDrawItemBackGround|onDrawItemBackGround]] Called when drawing an item background.
[[UIList:onDrawItem|onDrawItem]] Called when drawing an item.
[[UIList:onDrawColumn|onDrawColumn]] Called when drawing a column.
[[UIList:onEnterColumnHeader|onEnterColumnHeader]] Called when the mouse enters a column header.
[[UIList:onExitColumnHeader|onExitColumnHeader]] Called when the mouse exits a column header.
[[UIList:onClickColumnHeader|onClickColumnHeader]] Called when there's a mouse click on the column header.
[[UIList:onEnterItem|onEnterItem]] Called when the mouse enters the list item.
[[UIList:onExitItem|onExitItem]] Called when the mouse exits the list item.

[[Category:GUIs]]

UIList - Revision history

JRAD at 12:07, 21 November 2007