Treehopper C# API
LedDisplayCollection Class Reference

Efficiently update multiple LED display widgets simultaneously. More...

Inheritance diagram for LedDisplayCollection:
IFlushable

Public Member Functions

async Task FlushAsync (bool force=false)
 Flush every display in this collection to the LED drivers More...
 

Protected Member Functions

override void InsertItem (int index, LedDisplay item)
 Insert a new LED display widget More...
 
override void SetItem (int index, LedDisplay item)
 Set the LED display widget at the given index More...
 
override void RemoveItem (int index)
 Remove the LED display widget at the given index More...
 
override void ClearItems ()
 Remove all LED display widgets from this collection More...
 

Properties

bool AutoFlush [get, set]
 Gets / sets whether the drivers should be auto-flushed or not. More...
 
IFlushable Parent [get, set]
 The parent of this Flushable interface. More...
 

Detailed Description

Efficiently update multiple LED display widgets simultaneously.

Member Function Documentation

◆ FlushAsync()

async Task FlushAsync ( bool  force = false)

Flush every display in this collection to the LED drivers

Parameters
forceWhether to force an update, even if the driver doesn't appear to have a different state
Returns

Implements IFlushable.

◆ InsertItem()

override void InsertItem ( int  index,
LedDisplay  item 
)
protected

Insert a new LED display widget

Parameters
indexThe index to insert the item at
itemThe LED display widget to insert

◆ SetItem()

override void SetItem ( int  index,
LedDisplay  item 
)
protected

Set the LED display widget at the given index

Parameters
indexThe index to set
itemThe item to set

◆ RemoveItem()

override void RemoveItem ( int  index)
protected

Remove the LED display widget at the given index

Parameters
indexThe index of the item to remove

◆ ClearItems()

override void ClearItems ( )
protected

Remove all LED display widgets from this collection

Property Documentation

◆ AutoFlush

bool AutoFlush
getset

Gets / sets whether the drivers should be auto-flushed or not.

◆ Parent

IFlushable Parent
getset

The parent of this Flushable interface.

This property is unused.


The documentation for this class was generated from the following file: