X-Git-Url: http://git.ithinksw.org/MenuTunes.git/blobdiff_plain/144f2a34f982b5e54907225977b6770646e94f4d..b28cde9af5f0de2466cb62fa8e43c60fc58bf948:/ITMTRemote.h diff --git a/ITMTRemote.h b/ITMTRemote.h index 3527c85..a24e654 100755 --- a/ITMTRemote.h +++ b/ITMTRemote.h @@ -32,37 +32,54 @@ * @abstract Declares what a MenuTunes Remote must be able to do. * @discussion A MenuTunes Remote must be able to return and change state information. */ - @protocol ITMTRemote -/*! @method remote: - * @abstract Return an autoreleased instance of the remote. + + +/*! @method remote + * @abstract Returns an autoreleased instance of the remote. * @discussion Should be very quick and compact. - * EXAMPLE: - * + (id)remote - * { - * return [[[MyRemote alloc] init] autorelease]; - * } - * @result The instance. + * EXAMPLE: + * + (id)remote + * { + * return [[[MyRemote alloc] init] autorelease]; + * } + * @result The instance. */ + (id)remote; +/*! @method title: + * @abstract Returns an autoreleased instance of the remote. + * @result An NSString containing the title. + */ - (NSString *)title; -// Return the title of the remote. -- (NSString *)description; -// Return a short description of the remote. +/*! @method description: + * @abstract Returns a description of the remote. + * @result An NSString containing the description. + */ +- (NSString *)information; +/*! @method icon: + * @abstract Returns a icon for the remote. + * @result An NSImage containing the icon. + */ - (NSImage *)icon; -// Return a 16x16 icon representation for the remote. +/*! @method begin: + * @abstract Sent when the plugin should begin operation. + * @result A result code signifying success. + */ - (BOOL)begin; -// Sent to the plugin when it should begin operation. +/*! @method halt: + * @abstract Sent when the plugin should cease operation. + * @result A result code signifying success. + */ - (BOOL)halt; -// Sent to the plugin when it should cease operation. - (NSArray *)sources; - (int)currentSourceIndex; +- (NSString *)sourceTypeOfCurrentPlaylist; - (NSArray *)playlistsForCurrentSource; - (int)currentPlaylistIndex;