GBParagraphSpecialItem Class Reference

Inherits from GBParagraphItem : NSObject
Declared in GBParagraphSpecialItem.h<br />GBParagraphSpecialItem.m

Overview

Handles special paragraph items such as warnings and bugs.

Special items are containers for GBCommentParagraph which are formatted differently to catch user's attention. There can be several types of special items, to determine the type, use the value of specialItemType property.

Tasks

Initialization & disposal

Values

Other Methods

Class Methods

specialItemWithType:

Returns new autoreleased GBParagraphSpecialItem instance of te given type.

+ (id)specialItemWithType:(GBSpecialItemType)type

Parameters

type
The type of the special item.

Return Value

Returns initialized instance.

Discussion

Returns new autoreleased GBParagraphSpecialItem instance of te given type.

Sending this message to the class is equivalent of: 

 GBParagraphSpecialItem *item = [[[GBParagraphSpecialItem alloc] init] autorelease];
item.specialItemType = type;

See Also

Declared In

GBParagraphSpecialItem.h
GBParagraphSpecialItem.m

specialItemWithType:stringValue:

Returns new autoreleased GBParagraphSpecialItem instance of te given type.

+ (id)specialItemWithType:(GBSpecialItemType)type stringValue:(NSString *)value

Parameters

type
The type of the special item.
value
The desired string value.

Return Value

Returns initialized instance.

Discussion

Returns new autoreleased GBParagraphSpecialItem instance of te given type.

Sending this message to the class is equivalent of: 

 GBParagraphSpecialItem *item = [[[GBParagraphSpecialItem alloc] init] autorelease];
item.specialItemType = type;
item.stringValue = value;

See Also

Declared In

GBParagraphSpecialItem.h
GBParagraphSpecialItem.m

Instance Methods

description

descriptionStringValue

isBugSpecialItem

isExampleSpecialItem

isWarningSpecialItem

registerParagraph:

Registers the given paragraph.

- (void)registerParagraph:(GBCommentParagraph *)paragraph

Parameters

paragraph
GBCommentParagraph to register.

Discussion

Registers the given paragraph.

Exceptions

NSException
Thrown if the given item is nil .

Declared In

GBParagraphSpecialItem.h
GBParagraphSpecialItem.m

Properties

specialItemDescription

The description of the special item in the form of GBCommentParagraph .

@property (readonly) GBCommentParagraph *specialItemDescription

Discussion

The description of the special item in the form of GBCommentParagraph .

Declared In

GBParagraphSpecialItem.h

specialItemType

The type of the special item.

@property (assign) GBSpecialItemType specialItemType

Discussion

The type of the special item.

Declared In

GBParagraphSpecialItem.h