Inherits from GBParagraphItem : NSObject
Declared in GBParagraphLinkItem.h
GBParagraphLinkItem.m

Overview

Specifies a link paragraph item.

Link items wrap a cross reference link with all the data. There are several types of links:

  • Link to a URL: Points to a http, ftp or file objects. stringValue value represents the link value, while all other properties are nil. isLocal is NO.
  • Link to an object: Points to a known top-level object. stringValue value represents nicely formatted object's name and context points to the object instance while all other properties are nil and isLocal is either YES if the link's origin is the same object or NO if it's a link to another object.
  • Link to a local member: Points to another member of the same known top-level object. stringValue value represents nicely formatted link value, context points to the object instance and member to the object's member instance. isLocal value is YES.
  • Link to a member of another object: Points to a member of another object. Values representation is the same as in previous option, only isLocal value is NO in this case.

Tasks

Values

  • href The href value to which the link "points" to.
  • context The context to which the link's member points to or nil if this is a stringValue link.
  • member The member to which the link points to or nil if this is either a stringValue link or context link.
  • isLocal Specifies whether the link is local or not.

Other Methods

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

Instance Methods

isLinkItem

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

- (BOOL)isLinkItem

Declared In

GBParagraphLinkItem.m

Properties

context

The context to which the link's member points to or nil if this is a stringValue link.

@property (retain) id context

Discussion

The context to which the link's member points to or nil if this is a stringValue link.

The context can be either GBClassData, GBCategoryData or GBProtocolData if provided.

See Also

Declared In

GBParagraphLinkItem.h

href

The href value to which the link "points" to.

@property (retain) NSString *href

Discussion

The href value to which the link "points" to.

This can actually be used when generating output to get proper URL of the link item.

Declared In

GBParagraphLinkItem.h

isLocal

Specifies whether the link is local or not.

@property (assign) BOOL isLocal

Discussion

Specifies whether the link is local or not.

If a link is local, it points from within a context either to the context itself (i.e. member is nil) or to on eof the the same context s members. If the link points to another context or to one of other context s member, or this is a stringValue link, the value is NO.

See Also

Declared In

GBParagraphLinkItem.h

member

The member to which the link points to or nil if this is either a stringValue link or context link.

@property (retain) id member

Discussion

The member to which the link points to or nil if this is either a stringValue link or context link.

This is only used if the link points to a member within a context. If this is link to the context itself or to an stringValue, this value is nil. The member can only be a GBMethodData instance at this point.

See Also

Declared In

GBParagraphLinkItem.h