Objective-C API Library Reference  4.3.0-42-g45f162a
 All Classes Functions Typedefs Properties Pages
Public Functions | Properties | List of all members
PWAcetateToolset Class Reference

The PWAcetateToolset class models a set of tools used for acetate markup. All methods on this class are meant to be called on the UI thread.

An acetate toolset aggregates a collection of acetate tools with a collection of views that will use those tools. The toolset is designed to only dispatch view actions to a single active view. For more information on the acetate functionality, see PWAcetateToolDelegate.

Public Functions

(void) - activateTool:
 
(PWView *) - activeView
 
(void) - deactivateTool:
 
(id< PWAcetateToolDelegate >) - defaultTool
 
(void) - registerTool:
 
(void) - unregisterTool:
 

Properties

NSArray * activatedTools
 
PWViewactiveView
 
PWEventPublisher * activeViewChanged
 
NSArray * deactivatedTools
 
id< PWAcetateToolDelegatedefaultTool
 
PWEventPublisher * defaultToolChanged
 
NSTimeInterval pendingMarkupDelayMillis
 
PWEventPublisher * toolActivated
 
PWEventPublisher * toolActivating
 
PWEventPublisher * toolDeactivated
 
PWEventPublisher * toolRegistered
 
NSArray * tools
 
PWEventPublisher * toolUnregistered
 

Methods Descriptions

- (void) activateTool: (id< PWAcetateToolDelegate >)  tool

Activates the specified tool.

- (PWView *) activeView

Sets the view to which the toolset will apply.

- (void) deactivateTool: (id< PWAcetateToolDelegate >)  tool

Deactivates the specified tool.

- (id<PWAcetateToolDelegate>) defaultTool

Sets the tool to be used as the default.

- (void) registerTool: (id< PWAcetateToolDelegate >)  tool

Registers the tool with the toolset.

- (void) unregisterTool: (id< PWAcetateToolDelegate >)  tool

Unregisters the tool from the toolset.

Properties Descriptions

- (NSArray*) activatedTools
readnonatomicunsafe_unretained

A list of tools currently activated in the toolset.

- (PWView*) activeView
readwritenonatomicstrong

The active view for the toolset.

- (PWEventPublisher*) activeViewChanged
readnonatomicstrong

The event that gets dispatched before a new view becomes the active view for this toolset, but after the previous active view has been deactivated.

- (NSArray*) deactivatedTools
readnonatomicunsafe_unretained

A list of tools currently deactivated from the toolset.

- (id<PWAcetateToolDelegate>) defaultTool
readwritenonatomicunsafe_unretained

The tool currently set as the default.

- (PWEventPublisher*) defaultToolChanged
readnonatomicstrong

The event that gets dispatched when the default tool in the toolset is changed.

- (NSTimeInterval) pendingMarkupDelayMillis
readwritenonatomicassign

The interval in milliseconds when the pending markup updates should be checked.

- (PWEventPublisher*) toolActivated
readnonatomicstrong

The event that gets dispatched when a tool is has been activated.

- (PWEventPublisher*) toolActivating
readnonatomicstrong

The event that gets dispatched when a tool is activating.

- (PWEventPublisher*) toolDeactivated
readnonatomicstrong

The event that gets dispatched when a tool has been deactivated.

- (PWEventPublisher*) toolRegistered
readnonatomicstrong

The event that gets dispatched when a tool is registered with this toolset.

- (NSArray*) tools
readnonatomicunsafe_unretained

The list of tools in the toolset.

- (PWEventPublisher*) toolUnregistered
readnonatomicstrong

The event that gets dispatched when a tool is unregistered from this toolset.