RBToolbarButtonItemSchema Class Reference

Inherits from NSObject
Declared in RBToolbarButtonItemSchema.h

Overview

The schema of a toolbar button.

Other Methods

  identifier

The unique identifier of the toolbar button. Identifier is also used as theme identifier within the toolbar theme.

@property (nonatomic, readonly, nonnull) NSString *identifier

Declared In

RBToolbarButtonItemSchema.h

  themeOverrides

Theme values to apply after any other prior theming has been applied.

@property (nonatomic, readonly, nullable) NSDictionary<NSString*id> *themeOverrides

Declared In

RBToolbarButtonItemSchema.h

  disabled

Whether or not the button should be disabled.

@property (nonatomic, readonly) BOOL disabled

Declared In

RBToolbarButtonItemSchema.h

  shouldLoadButtonImageFromUrl

Whether or not the button image should be loaded from the url.

@property (nonatomic, readonly) BOOL shouldLoadButtonImageFromUrl

Declared In

RBToolbarButtonItemSchema.h

  buttonImageUrl

The NSURL of the button image to use.

@property (nonatomic, readonly, nullable) NSURL *buttonImageUrl

Declared In

RBToolbarButtonItemSchema.h

  title

The title for the button that will be created from this schema.

@property (nonatomic, readonly, nullable) NSString *title

Declared In

RBToolbarButtonItemSchema.h

  image

The image for the button that will be created from this schema.

@property (nonatomic, readonly, nullable) UIImage *image

Declared In

RBToolbarButtonItemSchema.h

– initWithIdentifier:title:image:disabled:themeOverrides:

Initializes a new toolbar button schema.

- (nonnull instancetype)initWithIdentifier:(nonnull NSString *)identifier title:(nullable NSString *)title image:(nullable UIImage *)image disabled:(BOOL)disabled themeOverrides:(nullable NSDictionary<NSString*,id> *)themeOverrides

Parameters

identifier

The unique identifier of the button.

title

The title of the button.

image

The image of the button.

disabled

Whether or not the button should be disabled.

themeOverrides

Theme values to apply after any other prior theming has been applied.

Return Value

The initialized toolbar button schema.

Declared In

RBToolbarButtonItemSchema.h

– initWithIdentifier:title:disabled:themeOverrides:withButtonImageAtUrl:

Initializes a new toolbar button schema.

- (nonnull instancetype)initWithIdentifier:(nonnull NSString *)identifier title:(nullable NSString *)title disabled:(BOOL)disabled themeOverrides:(nullable NSDictionary<NSString*,id> *)themeOverrides withButtonImageAtUrl:(nonnull NSURL *)buttonImageUrl

Parameters

identifier

The unique identifier of the button.

title

The title of the button.

disabled

Whether or not the button should be disabled.

themeOverrides

Theme values to apply after any other prior theming has been applied.

buttonImageUrl

An NSURL to an image to use as the button image.

Return Value

The initialized toolbar button schema.

Declared In

RBToolbarButtonItemSchema.h

FlexiSchema Methods

  flexiRowSchema

The required schema for an RBLayoutFlexiPositioner object to display this row element of the toolbar schema.

@property (nonatomic, readonly, nonnull) RBLayoutFlexiPositionerRowSchema *flexiRowSchema

Declared In

RBToolbarSchema+FlexiSchema.h

  flexiCellSchema

The required schema for an RBLayoutFlexiPositioner object to display this cell element of the toolbar schema.

@property (nonatomic, readonly, nonnull) RBLayoutFlexiPositionerCellSchema *flexiCellSchema

Declared In

RBToolbarSchema+FlexiSchema.h