GraffitiListbox

Popular Searches gridgraffitigraffitistylegraffkanban
Table of Contents

Images #

About #

GraffitiListbox is a replacement for the standard Xojo listbox that uses GraffitiColors to properly draw list contents, supports cell border variants, cell alignments, advanced modern header with support for drop-down menus, and much more! Looks great on macOS, Windows, or Linux!

Enumerations #

Name Values
HoverEffects System
On
Off

Constants #

Name Type Value
This class exposes no constants.

Events #

Name Parameters Return Type Description
CellAction row as Integer None If a cell is editable, a CellAction event occurs when the user finishes editing a cell. Row and Column are zero-based.
Column as Integer
CellBackgroundPaint g as Graphics None Raised when a cell’s background is being drawn.
Row as Integer
Column as Integer
CellClick Row as Integer None Raised when the user clicks a cell.
Column as Integer
X as Integer
Y as Integer
CellGotFocus Row as Integer None The user has selected an editable cell of a ListBox. Row and Column are zero-based.
Column as Integer
CellKeyDown Row as Integer Boolean The user has pressed a key while a cell in the ListBox is being edited. Row and Column are zero-based.
Column as Integer
Key as String
CellLostFocus Row as Integer None An editable cell has lost focus.
Column as Integer
CellTextChange Row as Integer None The user has changed the text in an editable cell.
Column as Integer
Change None None The user has selected a row.
CollapseRow Row as Integer None The user has collapsed a hierarchical row.
ColumnResized column as Integer None Raised when a column resize operation has completed.
ColumnResizing column as Integer None Raised during a column resize operation.
DisclosureWidgetPaint g As Graphics None The hierarchical expand/collapse icon is being drawn.
row As Integer
ByRef x As Integer
ByRef y As Integer
ByRef width As Integer
ByRef height As Integer
DoubleClick None None The user has double-clicked a row or cell.
DragEnter obj as DragItem Boolean Fires when the passed DragItem enters the RectControl.
Action as Integer
DragExit obj as DragItem None Raised when the dragged item has left the display area.
Action as Integer
DragOver x as Integer Boolean Raised when a DragItem is being dragged inside the display.
y as Integer
obj as DragItem
Action as Integer
DragOverRow x As Integer None Raised when a DragItem is being dragged over rows.
y As Integer
obj As DragItem
action As Integer
ByRef row As Integer
ByRef parentRow As Integer
ByRef location As listbox.DropLocations
DragReorderRows newPosition as Integer Boolean Raised when a row has been dragged to a new position.
parentRow as Integer
DragRow Drag as DragItem Boolean Raised when a row drag operation has begun.
Row as Integer
DropObject Obj as DragItem None Raised when a DragItem has been dropped on the control.
Action as Integer
DropObjectOnRow x As Integer None Raised when a DragItem has been dropped on a row.
y As Integer
obj As DragItem
action As Integer
row As Integer
parentRow As Integer
location As listbox.DropLocations
EnableMenuItems None None The control has received the focus. Menu handlers are invoked if the control has the focus.
ExpandRow Row as Integer None Raised when the user has expanded a hierarchical row.
GotFocus None None Raised when the control has received focus.
HeaderBackgroundPaint g As Graphics Boolean A column header is being redrawn. Return True to override default drawing.
column as Integer
HeaderContentPaint g as Graphics Boolean A column header’s text is being redrawn. Return True to override default drawing.
column as Integer
HeaderMenuAction column as Integer None Raised when the user clicks a column header’s menu item.
parentMenu as MenuItem
hitItem as MenuItem
HeaderMouseEnter column as Integer None Raised when the user’s cursor enters a header’s area.
HeaderMouseExit column as Integer None Raised when the user’s cursor enter’s a header’s area.
HeaderPressed Column as Integer Boolean Raised when the user clicks a column header.
IsContextualClick as Boolean
KeyDown Key as String Boolean Raised when the control has focus and a keyboard key is pressed. Return True to cancel default behavior and raise KeyUp on release.
KeyUp Key as String Boolean Raised when the user releases a pressed key while the control has focus.
LostFocus None None Raised when the control has lost focus.
MouseDown x as Integer Boolean Raise when the user clicks the control. Return True to cancel default operation and raise MouseUp.
y as Integer
MouseDrag x as Integer None Raised when a drag operation is occurring.
y as Integer
MouseEnter None None Raised when the mouse enters the control’s area.
MouseExit None None Raised when the mouse exits the control’s area.
MouseMove X as Integer None Raised when the mouse is moved within the control’s area.
Y as Integer
MouseUp X as Integer None Raised when the pressed mouse button is released.
Y as Integer
MouseWheel X as Integer Boolean Raised when the user has used the mouse wheel. Return True to cancel scrolling.
Y as Integer
DeltaX as Integer
DeltaY as Integer
Open None None Raised when the control is created.
SortColumn Column as Integer Boolean Raised when the user has clicked a column header in an attempt to sort the row values. Return True to cancel sort operation.

Methods #

Definition Parameters Return Type
AddRow Item() as String None
AddRow ParamArray Item as String None
Cell RowNumber as Integer String
ColumnNumber as Integer
Cell RowNumber as Integer None
ColumnNumber as Integer
assigns newValue as String
CellAlignment Row as Integer DesktopListBox.Alignments
Column as Integer
CellAlignment Row as Integer None
Column as Integer
assigns newValue as DesktopListBox.Alignments
CellAlignmentOffset Row as Integer Integer
Column as Integer
CellAlignmentOffset Row as Integer None
Column as Integer
assigns newValue as Integer
CellBackgroundColor RowNumber as Integer Color
ColumnNumber as Integer
CellBackgroundColor RowNumber as Integer None
ColumnNumber as Integer
assigns Value as Color
CellBold row as Integer Boolean
column as Integer
CellBold row as Integer None
column as Integer
assigns newValue as Boolean
CellBorderBottom Row as Integer Integer
Column as Integer
CellBorderBottom Row as Integer None
Column as Integer
assigns newValue as Integer
CellBorderColor RowNumber as Integer Color
ColumnNumber as Integer
CellBorderColor RowNumber as Integer None
ColumnNumber as Integer
assigns Value as Color
CellBorderLeft Row as Integer Integer
Column as Integer
CellBorderLeft Row as Integer None
Column as Integer
assigns newValue as Integer
CellBorderRight Row as Integer Integer
Column as Integer
CellBorderRight Row as Integer None
Column as Integer
assigns newValue as Integer
CellBorderTop row as Integer Integer
column as integer
CellBorderTop row as Integer None
column as integer
assigns newValue as Integer
CellCheck Row as Integer Boolean
Column as Integer
CellCheck Row as Integer None
Column as Integer
assigns newValue as Boolean
CellHelpTag RowNumber as Integer String
ColumnNumber as Integer
CellHelpTag RowNumber as Integer
ColumnNumber as Integer
assigns newValue as String
CellItalic row as Integer Boolean
column as Integer
CellItalic row as Integer None
column as Integer
assigns newValue as Boolean
CellState row as Integer Checkbox.CheckedStates
column as Integer
CellState row as Integer None
column as Integer
assigns newValue as CheckBox.CheckedStates
CellTag Row as Integer Variant
Column as Integer
CellTag Row as Integer None
Column as Integer
assigns newValue as Variant
CellTextColor RowNumber as Integer Color
ColumnNumber as Integer
CellTextColor RowNumber as Integer None
ColumnNumber as Integer
assigns Value as Color
CellType Row as Integer DesktopListBox.CellTypes
Column as Integer
CellType Row as Integer None
Column as Integer
assigns newValue as DesktopListBox.CellTypes
CellUnderline row as Integer Boolean
column as Integer
CellUnderline row as Integer None
column as Integer
assigns newValue as Boolean
Column ColumnNumber as Integer ListColumn
Column ColumnNumber as Integer None
assigns newListColumn as ListColumn :::
ColumnAlignment ColumnNumber as Integer Integer
ColumnAlignment ColumnNumber as Integer None
assigns newValue as Integer
ColumnAlignmentOffset ColumnNumber as Integer Integer
ColumnAlignmentOffset ColumnNumber as Integer
assigns newValue as Integer
ColumnCount None Integer
ColumnCount assigns newValue as Integer None
ColumnSortable index as Integer Boolean
ColumnSortable index as Integer
assigns newValue as Boolean
ColumnSortDirection columnNumber as Integer DesktopListBox.SortDirections
ColumnSortDirection columnNumber as Integer None
assigns newValue as DesktopListBox.SortDirections
ColumnTag Column as Integer Variant
ColumnTag Column as Integer None
assigns newValue as Variant :::
ColumnType columnNumber as Integer Integer
ColumnType columnNumber as Integer
assigns newValue as Integer
Expanded row as Integer Boolean
Expanded row as Integer None
assigns newValue as Boolean
HeaderAlignmentAt index as Integer DesktopListbox.Alignments
HeaderAlignmentAt index as Integer None
assigns value as DesktopListbox.Alignments
HeaderBackgroundColorAt index as Integer None
Assigns value as Color
HeaderBackgroundColorAt index as Integer Color
HeaderBackgroundColorSetAt index as Integer Boolean
HeaderBackgroundColorHoverAt index as Integer None
Assigns value as Color
HeaderBackgroundColorHoverAt index as Integer Color
HeaderBackgroundColorHoverSetAt index as Integer Boolean
HeaderBoldAt index as Integer None
Assigns value as Boolean
HeaderBoldAt index as Integer Boolean
HeaderItalicAt index as Integer None
Assigns value as Boolean
HeaderItalicAt index as Integer Boolean
HeaderTextColorAt index as Integer None
Assigns value as Color
HeaderTextColorAt index as Integer Color
HeaderTextColorSetAt index as Integer Boolean
HeaderTextColorHoverAt index as Integer None
Assigns value as Color
HeaderTextColorHoverAt index as Integer Color
HeaderTextColorHoverSetAt index as Integer Boolean
HeaderUnderlineAt index as Integer None
Assigns value as Boolean
HeaderUnderlineAt index as Itneger Boolean
HeaderMenu index as Integer MenuItem
HeaderMenu index as Integer None
assigns menuVal as MenuItem
HeaderType Column as Integer Listbox.HeaderTypes
HeaderType Column as Integer None
assigns newValue as Listbox.HeaderTypes
Heading index as Integer String
Heading index as Integer None
assigns newValue as String
List Index as Integer String
List Index as Integer None
assigns newValue as String
RowPicture RowNumber as Integer Picture
RowPicture RowNumber as Integer None
assigns newValue as Picture
RowTag row as Integer Variant
RowTag row as Integer None
assigns newValue as Variant
Selected Row as Integer Boolean
Selected Row as Integer None
Assigns newValue as Boolean
Text None String
Text assigns value as String None
AcceptFileDrop FileType as String None
AcceptPictureDrop None None
AcceptRawDataDrop Type as String None
AcceptTextDrop None None
AddFolder text as String None
CellBounds Row as Integer Rect
Column as Integer
CellClearBackgroundColor RowNumber as Integer None
ColumnNumber as Integer
CellClearTextColor RowNumber as Integer None
ColumnNumber as Integer
CellHasBackgroundColor RowNumber as Integer Boolean
ColumnNumber as Integer
CellHasTextColor RowNumber as Integer Boolean
ColumnNumber as Integer
ColumnFromXY X as Integer Integer
Y as Integer
ColumnIsHovered index as Integer Boolean
DeleteAllRows None None
EditCell row as Integer None
column as Integer
InsertFolder RowNumber as Integer None
Item as String
Indent as Integer = 0
InsertRow RowNumber as Integer None
Item as String
Indent as Integer = 0
InvalidateCell row as Integer None
column as Integer
LockUpdate Assigns newValue as Boolean None
PressHeader v as Integer None
RemoveRow RowNumber as Integer None
RowDepth row as Integer Integer
RowFromXY X as Integer Integer
Y as Integer
RowIsFolder row as Integer Boolean
SetFocus None None
Sort None None

Properties #

Name Type
ActiveCell DesktopTextControl
AlternateRowColors Boolean
AutoHideScrollBars Boolean
Bold Boolean
BoldHeader Boolean
Border Boolean
ColumnCount Integer
ColumnsResizable Boolean
ColumnWidths String
DefaultRowHeight Integer
EnableDrag Boolean
EnableDragReorder Boolean
GridLines DesktopListBox.GridLineStyles
HasHeading Boolean
HeaderChange Boolean
HeadingIndex Integer
Hierarchical Boolean
HoverEffect HoverEffects
InitialValue String
IsHorizontalScrollVisible Boolean
IsVerticalScrollVisible Boolean
Italic Boolean
ItalicHeader Boolean
LastIndex Integer
ListCount Integer
ListIndex Integer
ListIndexHover Integer
RequiresSelection Boolean
RowHeight Integer
ScrollbarHorizontal Boolean
ScrollbarVertical Boolean
ScrollPosition Integer
ScrollPositionX Integer
SelCount Integer
SelectionType DesktopListBox.RowSelectionTypes
ShowDropIndicator Boolean
SortedColumn Integer
TabStop Boolean
TextFont String
TextFontHeader String
TextSize Integer
TextSizeHeader Integer
TextUnit REALbasic.FontUnits
TextUnitHeader REALbasic.FontUnits
Underline Boolean
UnderlineHeader Boolean

Examples #

This class currently has no examples.

Notes #

This class currently has no notes.