Inherits from NSObject
Declared in GBParagraphItem.h
GBParagraphItem.m

Overview

Defines the base functionality for all paragraph items.

Tasks

Initialization & disposal

Values

Debugging aids

Output generator helpers

  •   isTextItem Returns YES if this item is text. This is only used to simplify output generation! property
  •   isOrderedListItem Returns YES if this is ordered list item. This is only used to simplify output generation! property
  •   isUnorderedListItem Returns YES if this is unordered list item. This is only used to simplify output generation! property
  •   isWarningSpecialItem Returns YES if this is warning special item. This is only used to simplify output generation! property
  •   isBugSpecialItem Returns YES if this is bug special item. This is only used to simplify output generation! property
  •   isExampleSpecialItem Returns YES if this is example special item. This is only used to simplify output generation! property
  •   isBoldDecoratorItem Returns YES if this is bold decorator item. This is only used to simplify output generation! property
  •   isItalicsDecoratorItem Returns YES if this is italics decorator item. This is only used to simplify output generation! property
  •   isCodeDecoratorItem Returns YES if this is code decorator item. This is only used to simplify output generation! property
  •   isLinkItem Returns YES if this is link item. This is only used to simplify output generation! property

Properties

descriptionStringValue

String value as used in debug description.

@property (readonly) NSString *descriptionStringValue

Discussion

By default this returns string value trimmed to a predefined maximum length, but subclasses can override to provide their specific implementation. This is only used for debugging purposes and should not be used for any output generation! See description method implementation for details.

Sending this message is equivalent to sending descriptionForStringValue: to receiver and passing it stringValue as the parameter.

Declared In

GBParagraphItem.h

isBoldDecoratorItem

Returns YES if this is bold decorator item. This is only used to simplify output generation!

@property (readonly) BOOL isBoldDecoratorItem

Declared In

GBParagraphItem.h

isBugSpecialItem

Returns YES if this is bug special item. This is only used to simplify output generation!

@property (readonly) BOOL isBugSpecialItem

Declared In

GBParagraphItem.h

isCodeDecoratorItem

Returns YES if this is code decorator item. This is only used to simplify output generation!

@property (readonly) BOOL isCodeDecoratorItem

Declared In

GBParagraphItem.h

isExampleSpecialItem

Returns YES if this is example special item. This is only used to simplify output generation!

@property (readonly) BOOL isExampleSpecialItem

Declared In

GBParagraphItem.h

isItalicsDecoratorItem

Returns YES if this is italics decorator item. This is only used to simplify output generation!

@property (readonly) BOOL isItalicsDecoratorItem

Declared In

GBParagraphItem.h

isLinkItem

Returns YES if this is link item. This is only used to simplify output generation!

@property (readonly) BOOL isLinkItem

Declared In

GBParagraphItem.h

isOrderedListItem

Returns YES if this is ordered list item. This is only used to simplify output generation!

@property (readonly) BOOL isOrderedListItem

Declared In

GBParagraphItem.h

isTextItem

Returns YES if this item is text. This is only used to simplify output generation!

@property (readonly) BOOL isTextItem

Declared In

GBParagraphItem.h

isUnorderedListItem

Returns YES if this is unordered list item. This is only used to simplify output generation!

@property (readonly) BOOL isUnorderedListItem

Declared In

GBParagraphItem.h

isWarningSpecialItem

Returns YES if this is warning special item. This is only used to simplify output generation!

@property (readonly) BOOL isWarningSpecialItem

Declared In

GBParagraphItem.h

stringValue

Item's string value.

@property (copy) NSString *stringValue

Discussion

String value is used for output generation in case of leaf items. For container items, string value should not be used for output generation unless specified otherwise!

Declared In

GBParagraphItem.h

Class Methods

paragraphItem

Returns new autoreleased instance.

+ (id)paragraphItem

Declared In

GBParagraphItem.h

paragraphItemWithStringValue:

Returns new autoreleased instance with stringValue set to the given text.

+ (id)paragraphItemWithStringValue:(NSString *)value

Parameters

value
The string value of the item.

Return Value

Returns initialized value.

Discussion

This is equivalent to the following code:

GBParagraphItem *item = [GBParagraphItem paragraphItem];
item.stringValue = value;

Declared In

GBParagraphItem.h