ZoomSDKCustomizedAnnotation Class Reference

Provides interfaces to operate customized annotations on shared content. More...

#include <ZoomSDKCustomizedAnnotationCtr.h>

Inherits NSObject.

Instance Methods
(ZoomSDKError)	- canClear:
	Query if it is able to clear annotations.
(ZoomSDKError)	- clear:
	Clears annotations.
(ZoomSDKError)	- setTool:
	Sets annotation tool type.
(ZoomSDKError)	- getCurrentTool:
	Gets the current annotation tool type.
(ZoomSDKError)	- setColor:
	Sets the colors of annotation tools.
(ZoomSDKError)	- getCurrentColor:
	Gets the current's color annotation tools.
(ZoomSDKError)	- setLineWidth:
	Sets the line width of annotation tools.
(ZoomSDKError)	- getCurrentLineWidth:
	Gets the current's line width annotation tool.
(ZoomSDKError)	- undo
	Undo the last annotation.
(ZoomSDKError)	- redo
	Redo the annotation having been deleted.
(ZoomSDKError)	- canSaveSnapshot
	Determines if it is enabled to save the snapshot.
(ZoomSDKError)	- saveSnapshot:snapshotSaveType:
	Saves the snapshot in the specified path.

Protected Attributes
ZoomSDKShareElement *	_shareElement
id< ZoomSDKCustomizedAnnotationDelegate >	_delegate

Properties
id< ZoomSDKCustomizedAnnotationDelegate >	delegate
	Delegate to receive annotation events.

Detailed Description

Provides interfaces to operate customized annotations on shared content.

Definition at line 47 of file ZoomSDKCustomizedAnnotationCtr.h.

Method Documentation

canClear:

- (ZoomSDKError) canClear:

(AnnotationClearType)

clearType

Query if it is able to clear annotations.

Parameters

clearType

Specify the ways to clear annotations.

Returns

If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

canSaveSnapshot

- (ZoomSDKError) canSaveSnapshot

Determines if it is enabled to save the snapshot.

Returns

If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

clear:

- (ZoomSDKError) clear:

(AnnotationClearType)

clearType

Clears annotations.

Parameters

clearType

Specify the way to clear annotations.

Returns

If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

getCurrentColor:

- (ZoomSDKError) getCurrentColor:

(Color *)

color

Gets the current's color annotation tools.

Parameters

color

The pointer to the object of color.

Returns

If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

getCurrentLineWidth:

- (ZoomSDKError) getCurrentLineWidth:

(long *)

lineWidth

Gets the current's line width annotation tool.

Parameters

lineWidth

The pointer to the object of long.

Returns

If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

getCurrentTool:

- (ZoomSDKError) getCurrentTool:

(AnnotationToolType *)

toolType

Gets the current annotation tool type.

Parameters

toolType

The type of annotation tools.

Returns

If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

redo

- (ZoomSDKError) redo

Redo the annotation having been deleted.

Returns

If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

saveSnapshot:snapshotSaveType:

- (ZoomSDKError) saveSnapshot:		(NSString *)	snapShotName
snapshotSaveType:		(ZoomSDKAnnotationSavedType)	savedType

Saves the snapshot in the specified path.

Parameters

snapShotName	Name of the snapshot.
savedType	Sets the type of file to save the screenshot (PNG or PDF).

Returns

If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

setColor:

- (ZoomSDKError) setColor:

(Color)

color

Sets the colors of annotation tools.

Parameters

color

The structural object of Color.

Returns

If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

setLineWidth:

- (ZoomSDKError) setLineWidth:

(long)

lineWidth

Sets the line width of annotation tools.

Parameters

lineWidth

Specify the line width to annotate.

Returns

If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

setTool:

- (ZoomSDKError) setTool:

(AnnotationToolType)

toolType

Sets annotation tool type.

Parameters

toolType

The specify annotation tool type.

Returns

If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

Warning

The tool type AnnotationToolType_Picker and AnnotationToolType_SpotLight are not support for viewer.

undo

- (ZoomSDKError) undo

Undo the last annotation.

Returns

If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

Field Documentation

_delegate

- (id<ZoomSDKCustomizedAnnotationDelegate>) _delegate

protected

Definition at line 50 of file ZoomSDKCustomizedAnnotationCtr.h.

_shareElement

- (ZoomSDKShareElement*) _shareElement

protected

Definition at line 49 of file ZoomSDKCustomizedAnnotationCtr.h.

Property Documentation

delegate

- (id<ZoomSDKCustomizedAnnotationDelegate>) delegate

readwritenonatomicassign

Delegate to receive annotation events.

Definition at line 55 of file ZoomSDKCustomizedAnnotationCtr.h.