GTLCommonSettingsCellConfiguration Class Reference

Configuration API to configure Launcher Common settings section table view cells styles. More...

#import <BlackBerryDynamics/GD/GTLCommonSettingsCellConfiguration.h>

Description

Configure the style of the common or default options shown in the settings menu. This includes the menu items to 'Change Password, 'Upload Logs' and to configure the size of the launcher icon.

A host application can configure styles for common settings section by creating instance of this class and returning it in `GTLauncherViewControllerDelegate commonSettingsCellConfigurationForType:launcherViewController:`of the GTLauncherViewControllerDelegate method:

- (GTLCommonSettingsCellConfiguration *)commonSettingsCellConfigurationForType:(GTLCommonSettingsCellType)cellType
                                                        launcherViewController:(GTLauncherViewController *)controller {
      GTLCommonSettingsCellConfiguration *style = [GTLCommonSettingsCellConfiguration defaultConfigurationForType:cellType];
 
      // Do updates
      
      return style;
  }

Class Methods
(GTLCommonSettingsCellConfiguration *)	+ defaultConfigurationForType:
	Provides ability to get the default style for provided table view cell type. More...

Protected Types
enum	GTLCommonSettingsCellType {   GTLCommonSettingsCellTypeChangePassword = 1,   GTLCommonSettingsCellTypeLauncher,   GTLCommonSettingsCellTypeUploadLogs }
	The type of common settings cell used by common settings section. More...

Properties
UIColor *	backgroundColor
	Cell background color. Default is `nil`: system default color will be used. More...
UIColor *	textColor
	Setting name text color. Default is black. More...
UIFont *	textFont
	Setting name text font. Default is ``UIFontTextStyleBody`` font. More...
UIImage *	icon
	Icon to be displayed to the left of setting name text, by default it is `nil`, no icon will be displayed. More...
UIColor *	iconTintColor
	Tint color for icon, by default it is `nil`, no tint will be applied. Has no effect when `icon` is `nil`. More...
UITableViewCellAccessoryType	accessoryType
	Table view cell accessory type to be displayed on the right, by default is ``UITableViewCellAccessoryNone``. More...
CGFloat	leftMarginDelta
	Content left margin delta. This might be needed to align custom table view cells with Common settings table view cells. By default is `0`. More...
UIView *	accessoryView
	Table view cell accessory view, by default is nil. More...

Member Enumeration Documentation

GTLCommonSettingsCellType

- (enum) GTLCommonSettingsCellType

protected

Enumerator
GTLCommonSettingsCellTypeChangePassword	Cell type that represents 'Change Password' item.
GTLCommonSettingsCellTypeLauncher	Cell type that represents 'Launcher' item.
GTLCommonSettingsCellTypeUploadLogs	Cell type that represents 'Upload Logs' item.

Method Documentation

defaultConfigurationForType:

+ (GTLCommonSettingsCellConfiguration *) defaultConfigurationForType:

(GTLCommonSettingsCellType)

type

This method provides ability to get the default style for provided table view cell type. Useful in the case a style update is needed only to the font or color for a particular table view cell type.

Parameters

type	GTLCommonSettingsCellType type of cell.

Returns

GTLCommonSettingsCellConfiguration default style for provided table view cell type.

Property Documentation

backgroundColor

- (UIColor*) backgroundColor

readwritenonatomicstrong

textColor

- (UIColor*) textColor

readwritenonatomicstrong

textFont

- (UIFont*) textFont

readwritenonatomicstrong

icon

- (UIImage*) icon

readwritenonatomicstrong

iconTintColor

- (UIColor*) iconTintColor

readwritenonatomicstrong

accessoryType

- (UITableViewCellAccessoryType) accessoryType

readwritenonatomicassign

leftMarginDelta

- (CGFloat) leftMarginDelta

readwritenonatomicassign

accessoryView

- (UIView*) accessoryView

readwritenonatomicstrong

---

The documentation for this class was generated from the following file:

• GTLCommonSettingsCellConfiguration.h