Widget::GetFirstSprocket

Defined in: C4Widgets.h

Returns the first sprocket for a widget.

Prototype

Sprocket *GetFirstSprocket(void) const;

Description

The GetFirstSprocket function returns the first sprocket attached to a widget. The entire list of sprockets can be iterated by calling the ListElement::GetNextListElement function on the returned object. If a widget has no sprockets, then the GetFirstSprocket returns nullptr.