playbit API documentation

Radio Button Groups

PBRadioGroup

Opaque object handle:

This is a subclass of PBElement. You can safely cast from PBRadioGroup to PBElement. To cast from PBElement to PBRadioGroup, call PBRadioGroupCast; this performs a runtime assertion to check the cast is possible. This function is thread-safe.

This object maintains an internal reference count. When the reference count reaches zero, the object will be automatically deallocated. To increment the reference count, call PBElementRetain; to decrement the reference count, call PBElementRelease. These functions are thread-safe.

PBRadioButton

Opaque object handle:

This is a subclass of PBElement. You can safely cast from PBRadioButton to PBElement. To cast from PBElement to PBRadioButton, call PBRadioButtonCast; this performs a runtime assertion to check the cast is possible. This function is thread-safe.

This object maintains an internal reference count. When the reference count reaches zero, the object will be automatically deallocated. To increment the reference count, call PBElementRetain; to decrement the reference count, call PBElementRelease. These functions are thread-safe.

PBRadioGroupFlags

Enumeration/bitset of type uint32_t:

Constants

Or any of the values from PBElementFlags.

PBRadioButtonFlags

Enumeration/bitset of type uint32_t:

Constants

PBRadioButton_CHECKED

PBRadioButton_CHECKED = 1<<0

Or any of the values from PBElementFlags.

PBRadioButtonCreate

Function:

Syntax (C/C++)

PBRadioButtonPtr _Nullable PBRadioButtonCreate(PBRadioGroupRef parent, 
    PBRadioButtonFlags flags, ConstStr label, PBUserContext itemID);

Syntax (Python)

RadioButtonCreate(parent, flags, label, itemID) -> (radioButton)

Parameters and Return Values

[in] parent (referenced PBRadioGroup):

[in] flags (PBRadioButtonFlags):

[in] label (referenced string):

[in] itemID (PBUserContext):

[out] radioButton (nullable owned PBRadioButton):

PBRadioGroupCreate

Function:

Syntax (C/C++)

PBRadioGroupPtr _Nullable PBRadioGroupCreate(PBElementRef parent, 
    PBRadioGroupFlags flags);

Syntax (Python)

RadioGroupCreate(parent, flags) -> (radioGroup)

Parameters and Return Values

[in] parent (referenced PBElement):

[in] flags (PBRadioGroupFlags):

[out] radioGroup (nullable owned PBRadioGroup):

PBRadioGroupSetCheckedItem

Function:

Syntax (C/C++)

void PBRadioGroupSetCheckedItem(PBRadioGroupRef element, PBUserContext itemID, 
    bool sendValueChangedMessage);

Syntax (Python)

RadioGroupSetCheckedItem(element, itemID, sendValueChangedMessage)

Parameters and Return Values

[in] element (referenced PBRadioGroup):

[in] itemID (PBUserContext):

[in] sendValueChangedMessage (bool):

PBRadioGroupGetCheckedItem

Function:

Syntax (C/C++)

PBUserContext PBRadioGroupGetCheckedItem(PBRadioGroupRef element);

Syntax (Python)

RadioGroupGetCheckedItem(element) -> (itemID)

Parameters and Return Values

[in] element (referenced PBRadioGroup):

[out] itemID (PBUserContext):