SCKProject documentation

Authors

Generated by builder

Contents -

  1. Software documentation for the SCKFileBrowsingProjectContent class
  2. Software documentation for the SCKProject class
  3. Software documentation for the SCKSymbolBrowsingProjectContent class
  4. Software documentation for the SCKProjectContent protocol

Software documentation for the SCKFileBrowsingProjectContent class

SCKFileBrowsingProjectContent : NSObject

Declared in:
SCKProject.h
Conforms to:
SCKProjectContent

Content class to present the project files.

Software documentation for the SCKProject class

SCKProject : NSObject

Declared in:
SCKProject.h

SCKProject represents an IDE project that tracks several source files usually put together in a directory.

In addition, SCKProject provides access to the program components declared in the project files. See -classes , -functions and -globals .

Custom presentation in the IDE source list (or similar UI) are supported by setting a custom project content class, that implements the collection protocols on the behalf of SCKProject instance. The collection returned by -content depends on the class set with -setContentClass: .

Method summary

addFileURL: 

- (void) addFileURL: (NSURL*)aURL;

Adds the file that corresponds to the URL to the project.

When the URL is nil, raises a NSInvalidArgumentException.


initWithDirectoryURL: sourceCollection: 

- (id) initWithDirectoryURL: (NSURL*)aURL sourceCollection: (SCKSourceCollection*)aSourceCollection;
This is a designated initialiser for the class.

Initializes and returns a new project based on the directory URL (to resolve relative paths) and the provided source collection to retrieve the SCKFile objects.

A source collection can be shared between several projects (it caches SCKFile objects).

When aSourceCollection is nil, raises a NSInvalidArgumentException.


removeFileURL: 

- (void) removeFileURL: (NSURL*)aURL;

Removes the file that corresponds to the URL from the project.

When the URL is nil, raises a NSInvalidArgumentException.


Software documentation for the SCKSymbolBrowsingProjectContent class

SCKSymbolBrowsingProjectContent : NSObject

Declared in:
SCKProject.h
Conforms to:
SCKProjectContent

Content class to present the project program components grouped into classes, functions and globals.

Software documentation for the SCKProjectContent protocol

SCKProjectContent

Declared in:
SCKProject.h

Protocol to which SCKProject content class must conform to. See -[SCKProject setContentClass:].

Method summary

content 

- (id) content;
Description forthcoming.