NSObject(LOFixtureLibraryDelegate) Class Reference

Delegate interface to customise the behaviour of the LOFixtureLibrary. More...

#import <LOFixtureLibrary.h>

Public Member Functions

(void) - unableToParseFixtureXML:withError:inLibrary:

Called whenever a fixture definintion is corrupt and can not be parsed.

(BOOL) - loadFixture:withDuplicateFixture:inLibrary:

If a fixture is being loaded into the library with the same details (apart from the name, manufacturers name and comment) this function is called.

(BOOL) - shouldRenameFixture:inLibrary:

If a fixture is being loaded into the library with the same name and manufacturer as one that already exists and it is different, then there is the option to rename it so that it can be loaded.

(NSString *) - newNameForFixture:suggestedName:inLibrary:

Called if the fixture needs to be renamed.

Detailed Description

Delegate interface to customise the behaviour of the LOFixtureLibrary.

Member Function Documentation

- (BOOL) loadFixture:	(LOFixture *)	newFixture
withDuplicateFixture:	(LOFixture *)	existingFixture
inLibrary:	(LOFixtureLibrary *)	library

If a fixture is being loaded into the library with the same details (apart from the name, manufacturers name and comment) this function is called.

Returns:: YES to load the fixture anyway. Defaults to NO in the absense of this function

- (NSString *) newNameForFixture:	(LOFixture *)	newFixture
suggestedName:	(NSString *)	suggested
inLibrary:	(LOFixtureLibrary *)	library

Called if the fixture needs to be renamed.

If this function is not implemented the new name will be auto generated by the library. If nil is returned the fixture will not be added.

See also:: shouldRenameFixture:inLibrary

- (BOOL) shouldRenameFixture:	(LOFixture *)	newFixture
inLibrary:	(LOFixtureLibrary *)	library

If a fixture is being loaded into the library with the same name and manufacturer as one that already exists and it is different, then there is the option to rename it so that it can be loaded.

The default action in the event of this delegated method not being present is to not laod the fixture.

Returns:: YES to allow the file to be overwritten

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

LOFixtureLibrary.h