Widget::GetNextWidgetWithSameKey

Defined in: C4Widgets.h

Returns the next widget having the same key.

Prototype

Widget *GetNextWidgetWithSameKey(void) const;

Description

The GetNextWidgetWithSameKey function returns a pointer to the next widget having the same key as the widget for which this function is called. If there are no more widgets having the same key, then the return value is nullptr. This function is typically called iteratively after a call to the RootWidget::FindWidget function to get the first widget having a particular key.

If the widget for which the GetNextWidgetWithSameKey function is called has the empty string for its key, then the return value is always nullptr, not the next widget having the empty string for its key.