Public Member Functions

<XAP_CocoaPlugin_ToolProvider> Protocol Reference

A class which provides a set of available tools which can be used to create a toolbar. More...

#import <xap_CocoaPlugin.h>

Inheritance diagram for <XAP_CocoaPlugin_ToolProvider>:
XAP_CocoaToolProvider

List of all members.

Public Member Functions

(NSString *) - name
 Get the name of the provider.
(id< NSObject,
XAP_CocoaPlugin_Tool >) 
- toolWithIdentifier:
 Get the tool with the specified identifier.
(NSArray *) - toolIdentifiers
 Get the identifiers of the tools provided.
(NSString *) - toolDescription:
 See whether the provider provides a specific tool, and get the description (tooltip).

Detailed Description

A class which provides a set of available tools which can be used to create a toolbar.


Member Function Documentation

- (NSString *) name  

Get the name of the provider.

Returns:
The name identifying the provider.

Reimplemented in XAP_CocoaToolProvider.

- (NSString *) toolDescription: (NSString *)  identifier  

See whether the provider provides a specific tool, and get the description (tooltip).

Parameters:
identifier The internal identifier of the desired tool.
Returns:
The description (the tooltip) of the tool if the identifier is recognized, otherwise nil.

Reimplemented in XAP_CocoaToolProvider.

- (NSArray *) toolIdentifiers  

Get the identifiers of the tools provided.

Returns:
The identifiers of the tools provided.

Reimplemented in XAP_CocoaToolProvider.

- (id <NSObject, XAP_CocoaPlugin_Tool>) toolWithIdentifier: (NSString *)  identifier  

Get the tool with the specified identifier.

Parameters:
identifier The identifier of the tool which is desired.
Returns:
The specified tool, or nil if the identifier is not matched.

Reimplemented in XAP_CocoaToolProvider.


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