Package apple.carplay.protocol

Interface CPBarButtonProviding

All Known Implementing Classes:

CPContactTemplate, CPGridTemplate, CPInformationTemplate, CPListTemplate, CPMapTemplate, CPPointOfInterestTemplate

public interface CPBarButtonProviding

API-Since: 12.0

Method Summary

Modifier and Type	Method	Description
@Nullable CPBarButton	backButton()
@NotNull NSArray<? extends CPBarButton>	leadingNavigationBarButtons()	An array of bar buttons to be displayed on the leading side of the navigation bar.
void	setBackButton(@Nullable CPBarButton value)
void	setLeadingNavigationBarButtons(@NotNull NSArray<? extends CPBarButton> value)	An array of bar buttons to be displayed on the leading side of the navigation bar.
void	setTrailingNavigationBarButtons(@NotNull NSArray<? extends CPBarButton> value)	An array of bar buttons to be displayed on the trailing side of the navigation bar.
@NotNull NSArray<? extends CPBarButton>	trailingNavigationBarButtons()	An array of bar buttons to be displayed on the trailing side of the navigation bar.

Method Detail

backButton

@Nullable
@Nullable CPBarButton backButton()

leadingNavigationBarButtons

@NotNull
@NotNull NSArray<? extends CPBarButton> leadingNavigationBarButtons()

An array of bar buttons to be displayed on the leading side of the navigation bar. [@note] The navigation bar may display a maximum of 2 buttons in the leading space. Setting more than 2 buttons to this property will only display the first 2 buttons.

setBackButton

void setBackButton(@Nullable
                   @Nullable CPBarButton value)

setLeadingNavigationBarButtons

void setLeadingNavigationBarButtons(@NotNull
                                    @NotNull NSArray<? extends CPBarButton> value)

An array of bar buttons to be displayed on the leading side of the navigation bar. [@note] The navigation bar may display a maximum of 2 buttons in the leading space. Setting more than 2 buttons to this property will only display the first 2 buttons.

setTrailingNavigationBarButtons

void setTrailingNavigationBarButtons(@NotNull
                                     @NotNull NSArray<? extends CPBarButton> value)

An array of bar buttons to be displayed on the trailing side of the navigation bar. [@note] The navigation bar may display a maximum of 2 buttons in the trailing space. Setting more than 2 buttons to this property will only display the first 2 buttons.

trailingNavigationBarButtons

@NotNull
@NotNull NSArray<? extends CPBarButton> trailingNavigationBarButtons()

An array of bar buttons to be displayed on the trailing side of the navigation bar. [@note] The navigation bar may display a maximum of 2 buttons in the trailing space. Setting more than 2 buttons to this property will only display the first 2 buttons.