ShinobiEssentials Class Reference

Inherits from NSObject
Declared in ShinobiEssentials.h
Availability
Related samples

Overview

ShinobiEssentials is a global utility class for the ShinobiEssentials framework.

It allows you to do the following:

  • Get information on the version of the framework

  • For trial versions of ShinobiEssentials, it allows you to set the trial key. This enables you to use the framework for the duration of the trial period.

  • It defines a global theme. If a SEssentialsStyle object is not created with a specific instance of a theme, it uses the global theme. This allows us to define a common appearance for all controls within an application.

All controls by default use the global theme. To access this theme and set one of its values you would use the following code

SEssentialsTheme *globalTheme = [ ShinobiEssentials theme];

If you wish to change the current global theme then use

[ ShinobiEssentials setTheme:[ SEssentialsDarkTheme new]];

To change the primary tint color on all controls using the theme you would use the following code

globalTheme.primaryTintColor = [ UIColor redColor];

Once you’ve updated the theme, you should go through all your controls and call applyTheme on them, to configure them from the theme.

Properties

trialKey

The trial key for the trial version of the ShinobiEssentials framework. You will be emailed the trial key when you download the framework.

@property (class, nonatomic, strong) NSString *trialKey

Declared In

ShinobiEssentials.h

Class Methods

getInfo

Returns the version number of the framework, and the date on which it was built.

+ (NSString *)getInfo

Declared In

ShinobiEssentials.h

setLicenseKey:

Sets the trial license key for the trial version of the ShinobiEssentials framework. You will be emailed the trial license key when you download the framework.

+ (void)setLicenseKey:(NSString *)licenseKey

Discussion

Warning: DEPRECATED. You should use the ShinobiEssentials.trialKey property instead.

Declared In

ShinobiEssentials.h

setTheme:

Sets the global theme to the specified theme.

+ (void)setTheme:(SEssentialsTheme *)theme

Declared In

ShinobiEssentials.h

theme

The global theme, which is used by default when creating any new ShinobiEssentials controls. This defaults to SEssentialsIOS7Theme when the framework is run in iOS7, and SEssentialsDarkTheme for previous versions of iOS.

+ (SEssentialsTheme *)theme

Declared In

ShinobiEssentials.h

verifyLicenseKey

Verifies the trial license key. Each control in the framework does this when they are initialized.

+ (void)verifyLicenseKey

Discussion

Warning: DEPRECATED. You should use [ShinobiEssentials verifyTrialKey] instead.

Declared In

ShinobiEssentials.h

verifyTrialKey

Verifies the trial key. Each control in the framework does this when they are initialized.

+ (void)verifyTrialKey

Declared In

ShinobiEssentials.h