A class which has a toolbar button and, optionally, a menu item associated with a specific tool. More...
#import <xap_CocoaPlugin.h>
Public Member Functions | |
| (id< NSObject, XAP_CocoaPlugin_Tool >) | - tool |
| Information about what this tool actually is, rather than what it looks like, can be obtained from the tool which created this instance. | |
| (NSView *) | - toolbarButton |
| The XAP_CocoaPlugin_ToolInstance object manages a button and, optionally, a menu item. | |
| (NSMenuItem *) | - toolbarMenuItem |
| The XAP_CocoaPlugin_ToolInstance object may manage a menu item for use in case the button disappears off the end of the toolbar. | |
| (NSString *) | - configWidth |
| The XAP_CocoaPlugin_ToolInstance manages a set of configuration strings. | |
| (NSString *) | - configHeight |
| The XAP_CocoaPlugin_ToolInstance manages a set of configuration strings. | |
| (NSString *) | - configImage |
| The XAP_CocoaPlugin_ToolInstance manages a set of configuration strings. | |
| (NSString *) | - configAltImage |
| The XAP_CocoaPlugin_ToolInstance manages a set of configuration strings. | |
| (void) | - setConfigWidth: |
| The XAP_CocoaPlugin_ToolInstance manages a set of configuration strings. | |
| (void) | - setConfigHeight: |
| The XAP_CocoaPlugin_ToolInstance manages a set of configuration strings. | |
| (void) | - setConfigImage: |
| The XAP_CocoaPlugin_ToolInstance manages a set of configuration strings. | |
| (void) | - setConfigAltImage: |
| The XAP_CocoaPlugin_ToolInstance manages a set of configuration strings. | |
Detailed Description
A class which has a toolbar button and, optionally, a menu item associated with a specific tool.
The class also manages size and image information which can be saved to and loaded from a configuration file, if desired.
Member Function Documentation
| - (NSString *) configAltImage |
The XAP_CocoaPlugin_ToolInstance manages a set of configuration strings.
- Returns:
- The string describing the alternative image used by the button, if any image is used at all. Should be "auto" if it is the same as the default setting.
Reimplemented in AP_CocoaToolInstance_StandardButton.
| - (NSString *) configHeight |
The XAP_CocoaPlugin_ToolInstance manages a set of configuration strings.
- Returns:
- The string describing the height of the button - should be "auto" if it is the same as the default setting.
Reimplemented in AP_CocoaToolInstance_StandardButton.
| - (NSString *) configImage |
The XAP_CocoaPlugin_ToolInstance manages a set of configuration strings.
- Returns:
- The string describing the image used by the button, if any image is used at all. Should be "auto" if it is the same as the default setting.
Reimplemented in AP_CocoaToolInstance_StandardButton.
| - (NSString *) configWidth |
The XAP_CocoaPlugin_ToolInstance manages a set of configuration strings.
- Returns:
- The string describing the width of the button - should be "auto" if it is the same as the default setting.
Reimplemented in AP_CocoaToolInstance_StandardButton.
| - (void) setConfigAltImage: | (NSString *) | altImage |
The XAP_CocoaPlugin_ToolInstance manages a set of configuration strings.
- Parameters:
-
altImage The alternative image setting (i.e., filename) which has been read from a configuration file.
Reimplemented in AP_CocoaToolInstance_StandardButton.
| - (void) setConfigHeight: | (NSString *) | height |
The XAP_CocoaPlugin_ToolInstance manages a set of configuration strings.
- Parameters:
-
height The height setting which has been read from a configuration file.
Reimplemented in AP_CocoaToolInstance_StandardButton.
| - (void) setConfigImage: | (NSString *) | image |
The XAP_CocoaPlugin_ToolInstance manages a set of configuration strings.
- Parameters:
-
image The image setting (i.e., filename) which has been read from a configuration file.
Reimplemented in AP_CocoaToolInstance_StandardButton.
| - (void) setConfigWidth: | (NSString *) | width |
The XAP_CocoaPlugin_ToolInstance manages a set of configuration strings.
- Parameters:
-
width The width setting which has been read from a configuration file.
Reimplemented in AP_CocoaToolInstance_StandardButton.
| - (id <NSObject, XAP_CocoaPlugin_Tool>) tool |
Information about what this tool actually is, rather than what it looks like, can be obtained from the tool which created this instance.
- Returns:
- The tool associated with this object.
Reimplemented in AP_CocoaToolInstance_StandardButton.
| - (NSView *) toolbarButton |
The XAP_CocoaPlugin_ToolInstance object manages a button and, optionally, a menu item.
- Returns:
- The button managed by this object.
Reimplemented in AP_CocoaToolInstance_StandardButton.
| - (NSMenuItem *) toolbarMenuItem |
The XAP_CocoaPlugin_ToolInstance object may manage a menu item for use in case the button disappears off the end of the toolbar.
- Returns:
- The menu item managed by this object, or nil if there is no menu item.
Reimplemented in AP_CocoaToolInstance_StandardButton.
The documentation for this protocol was generated from the following file:
Generated on Sun Feb 14 2021 for AbiWord by
1.7.1