ZoomSDKCustomizedAnnotation Class Reference

Inheritance diagram for ZoomSDKCustomizedAnnotation:

Instance Methods
(ZoomSDKError)	- canClear:
	Query if it is able to clear annotations. More...
(ZoomSDKError)	- clear:
	Clear annotations. More...
(ZoomSDKError)	- setTool:
	Set annotation tools. More...
(ZoomSDKError)	- getCurrentTool:
	Get the current annotation tool type. More...
(ZoomSDKError)	- setColor:
	Set the colors of annotation tools. More...
(ZoomSDKError)	- getCurrentColor:
	Get the color of the current annotation tools. More...
(ZoomSDKError)	- setLineWidth:
	Set the line width of annotation tools. More...
(ZoomSDKError)	- getCurrentLineWidth:
	Get the line width of the current annotation tool. More...
(ZoomSDKError)	- undo
	Undo the last annotation. More...
(ZoomSDKError)	- redo
	Redo the annotation having been deleted. More...
(ZoomSDKError)	- canSaveSnapshot
	Determine if it is enabled to save the snapshot. More...
(ZoomSDKError)	- saveSnapshot:
	Save the snapshot in the specified path. More...
(ZoomSDKError)	- saveSnapshot:snapshotSaveType:
	Save the snapshot in the specified path. More...

Protected Attributes
ZoomSDKShareElement *	_shareElement
id< ZoomSDKCustomizedAnnotationDelegate >	_delegate

Properties
id< ZoomSDKCustomizedAnnotationDelegate >	delegate

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, the return value is ZoomSDKError_Success. Otherwise failed.

canSaveSnapshot

- (ZoomSDKError) canSaveSnapshot

Determine if it is enabled to save the snapshot.

Returns

If the function succeeds, the return value is ZoomSDKError_Success. Otherwise failed.

clear:

- (ZoomSDKError) clear:

(AnnotationClearType)

clearType

Clear annotations.

Parameters

clearType

Specify the way to clear annotations.

Returns

If the function succeeds, the return value is ZoomSDKError_Success. Otherwise failed.

getCurrentColor:

- (ZoomSDKError) getCurrentColor:

(Color *)

color

Get the color of the current annotation tools.

Parameters

color

The pointer to the object of color.

Returns

If the function succeeds, the return value is ZoomSDKError_Success. Otherwise failed.

getCurrentLineWidth:

- (ZoomSDKError) getCurrentLineWidth:

(long *)

lineWidth

Get the line width of the current annotation tool.

Parameters

lineWidth

The pointer to the object of long.

Returns

If the function succeeds, the return value is ZoomSDKError_Success. Otherwise failed.

getCurrentTool:

- (ZoomSDKError) getCurrentTool:

(AnnotationToolType *)

toolType

Get the current annotation tool type.

Parameters

toolType

The type of annotation tools.

Returns

If the function succeeds, the return value is ZoomSDKError_Success. Otherwise failed.

redo

- (ZoomSDKError) redo

Redo the annotation having been deleted.

Returns

If the function succeeds, the return value is ZoomSDKError_Success. Otherwise failed.

saveSnapshot:

- (ZoomSDKError) saveSnapshot:		(4.)	1
		(5.0)	NS_DEPRECATED_MAC

Save the snapshot in the specified path.

Parameters

snapShotName

Name of the snapshot.

Returns

If the function succeeds, the return value is ZoomSDKError_Success. Otherwise failed.

saveSnapshot:snapshotSaveType:

- (ZoomSDKError) saveSnapshot:		(NSString *)	snapShotName
snapshotSaveType:		(5.2)	NS_AVAILABLE_MAC

Save the snapshot in the specified path.

Parameters

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

Returns

If the function succeeds, the return value is ZoomSDKError_Success. Otherwise failed.

setColor:

- (ZoomSDKError) setColor:

(Color)

color

Set the colors of annotation tools.

Parameters

color

The structural object of Color.

Returns

If the function succeeds, the return value is ZoomSDKError_Success. Otherwise failed.

setLineWidth:

- (ZoomSDKError) setLineWidth:

(long)

lineWidth

Set the line width of annotation tools.

Parameters

lineWidth

Specify the line width to annotate.

Returns

If the function succeeds, the return value is ZoomSDKError_Success. Otherwise failed.

setTool:

- (ZoomSDKError) setTool:

(AnnotationToolType)

toolType

Set annotation tools.

Parameters

toolType

Specify the tool type to clear annotations.

Returns

If the function succeeds, the return value is ZoomSDKError_Success. Otherwise failed.

undo

- (ZoomSDKError) undo

Undo the last annotation.

Returns

If the function succeeds, the return value is ZoomSDKError_Success. Otherwise failed.

---

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

• ZoomSDKCustomizedAnnotationCtr.h