AbiWord: <XAP_CocoaPlugin_Tool> Protocol Reference

A class which provides information about a specific tool. More...

#import <xap_CocoaPlugin.h>

Inheritance diagram for <XAP_CocoaPlugin_Tool>:

List of all members.

Public Member Functions
(NSString *)	- identifier
	Each tool, for a given provider, has a unique identifier.
(NSString *)	- description
	The description is the tooltip or menu item name for this tool.
(void)	- setProvider:
	When a tool is added to a tool provider, the provider sends a setProvider: message to the tool.
(id< NSObject, XAP_CocoaPlugin_ToolProvider >)	- provider
	The tool provider which owns the tool.
(id< NSObject, XAP_CocoaPlugin_ToolInstance >)	- tool
	Multiple toolbar buttons can be created for a particular tool.

Detailed Description

A class which provides information about a specific tool.

Any given tool may have any number of buttons (or menu items) in any number of toolbars; the XAP_CocoaPlugin_Tool object is used to create instances of these.

Member Function Documentation

- (NSString *) description

The description is the tooltip or menu item name for this tool.

Returns:: A description of this tool.

Reimplemented in AP_CocoaTool.

Referenced by XAP_CocoaToolProvider::toolDescription:.

- (NSString *) identifier

Each tool, for a given provider, has a unique identifier.

Returns:: The unique identifier for this tool.

Reimplemented in AP_CocoaTool.

Referenced by XAP_CocoaToolProvider::addTool:.

- (id <NSObject, XAP_CocoaPlugin_ToolProvider>) provider

The tool provider which owns the tool.

Returns:: The tool provider which owns the tool, or nil if none does.

Reimplemented in AP_CocoaTool.

- (void) setProvider: (id< NSObject, XAP_CocoaPlugin_ToolProvider >) provider

When a tool is added to a tool provider, the provider sends a setProvider: message to the tool.

Parameters:

provider

The tool provider which has assumed ownership of this tool, or nil if the provider has removed the tool from its list. (Internal use only.)

Referenced by XAP_CocoaToolProvider::addTool:.

- (id <NSObject, XAP_CocoaPlugin_ToolInstance>) tool

Multiple toolbar buttons can be created for a particular tool.

This method instantiates a new tool object which manages a toolbar button and, optionally, a menu item.

Returns:: A tool object which manages a toolbar button and, optionally, a menu item.

Reimplemented in AP_CocoaTool.

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

xap_CocoaPlugin.h