ICustomizedAnnotationObj Class Reference

Annotation object interface. More...

#include <customized_annotation.h>

Public Member Functions
virtual SDKError	SetEvent (ICustomizedAnnotationObjEvent *event_)=0
	Sets annotation object callback event handler.
virtual SDKError	CanClear (AnnotationClearType type)=0
	Determines if it is enabled to clear annotations by the specified way.
virtual SDKError	Clear (AnnotationClearType type)=0
	Clear the annotation with the specified type.
virtual SDKError	SetTool (AnnotationToolType type)=0
	Sets the tool to annotate.
virtual SDKError	SetColor (unsigned long color)=0
	Sets the color to annotate.
virtual SDKError	SetLineWidth (long lineWidth)=0
	Sets the value of line width of annotation tool.
virtual SDKError	GetCurColor (unsigned long &color)=0
	Gets the color of current annotation tool.
virtual SDKError	GetCurLineWidth (long &lineWidth)=0
	Gets the value of line width of the current annotation tool.
virtual SDKError	GetCurTool (AnnotationToolType &type)=0
	Gets the type of the current annotation tool.
virtual SDKError	Undo ()=0
	Undo the last annotation.
virtual SDKError	Redo ()=0
	Redo the annotation that was undone.
virtual SDKError	CanSaveSnapshot ()=0
	Determines if it is enabled to save the screenshot.
virtual SDKError	SaveSnapshot (const zchar_t *path, SDKAnnoSaveType nType)=0
	Save the screenshot in the specified path.
virtual SDKError	CanDoAnnotation (bool &bCan)=0
	Determines if can do annotate.
virtual bool	IsAnnotationDisable ()=0
	Determines whether current meeting supports annotation feature.
virtual SDKError	DisableViewerAnnotation (bool bDisable)=0
	Disallow/allow participants to annotate when viewing the sharing content.
virtual SDKError	CanDisableViewerAnnotation (bool &bCan)=0
	Determines if it is able to disallow viewer to annotate.
virtual bool	IsViewerAnnotationDisabled ()=0
	Determines if viewer's privilege of annotation is disabled.
virtual	~ICustomizedAnnotationObj ()

Detailed Description

Annotation object interface.

Definition at line 56 of file customized_annotation.h.

Constructor & Destructor Documentation

~ICustomizedAnnotationObj()

virtual ICustomizedAnnotationObj::~ICustomizedAnnotationObj ( )

inlinevirtual

Definition at line 181 of file customized_annotation.h.

{};

Member Function Documentation

CanClear()

virtual SDKError ICustomizedAnnotationObj::CanClear ( AnnotationClearType type )

pure virtual

Determines if it is enabled to clear annotations by the specified way.

Parameters

type	Specify the annotation clear type.

Returns

If the user owns the authority, the return value is SDKERR_SUCCESS. Otherwise not.

CanDisableViewerAnnotation()

virtual SDKError ICustomizedAnnotationObj::CanDisableViewerAnnotation ( bool & bCan )

pure virtual

Determines if it is able to disallow viewer to annotate.

Parameters

[out]

bCan

true indicates able, false not. It validates only when the return value is SDKERR_SUCCESS.

Returns

If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.

CanDoAnnotation()

virtual SDKError ICustomizedAnnotationObj::CanDoAnnotation ( bool & bCan )

pure virtual

Determines if can do annotate.

Parameters

[out]

bCan,true

indicates can do annotate, false can not.

Returns

If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.

CanSaveSnapshot()

virtual SDKError ICustomizedAnnotationObj::CanSaveSnapshot ( )

pure virtual

Determines if it is enabled to save the screenshot.

Returns

If the user owns the authority, the return value is SDKERR_SUCCESS. Otherwise not.

Clear()

virtual SDKError ICustomizedAnnotationObj::Clear ( AnnotationClearType type )

pure virtual

Clear the annotation with the specified type.

Parameters

type	Specify the type to clear annotation.

Returns

If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.

DisableViewerAnnotation()

virtual SDKError ICustomizedAnnotationObj::DisableViewerAnnotation ( bool bDisable )

pure virtual

Disallow/allow participants to annotate when viewing the sharing content.

Parameters

bDisable

true indicates disabled, false not.

Returns

If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.

GetCurColor()

virtual SDKError ICustomizedAnnotationObj::GetCurColor ( unsigned long & color )

pure virtual

Gets the color of current annotation tool.

Parameters

[out]

color

The color to annotate in RGB format.

Returns

If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.

GetCurLineWidth()

virtual SDKError ICustomizedAnnotationObj::GetCurLineWidth ( long & lineWidth )

pure virtual

Gets the value of line width of the current annotation tool.

Parameters

[out]

lineWidth

The width of the current annotation tool.

Returns

If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.

GetCurTool()

virtual SDKError ICustomizedAnnotationObj::GetCurTool ( AnnotationToolType & type )

pure virtual

Gets the type of the current annotation tool.

Parameters

type	Specify the type of the annotation tool.

Returns

If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.

IsAnnotationDisable()

virtual bool ICustomizedAnnotationObj::IsAnnotationDisable ( )

pure virtual

Determines whether current meeting supports annotation feature.

Returns

true not support, false support.

IsViewerAnnotationDisabled()

virtual bool ICustomizedAnnotationObj::IsViewerAnnotationDisabled ( )

pure virtual

Determines if viewer's privilege of annotation is disabled.

Returns

true if viewer's privilege of annotation is disabled. Otherwise, false.

Redo()

virtual SDKError ICustomizedAnnotationObj::Redo ( )

pure virtual

Redo the annotation that was undone.

Returns

If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.

SaveSnapshot()

virtual SDKError ICustomizedAnnotationObj::SaveSnapshot ( const zchar_t * path, SDKAnnoSaveType nType )

pure virtual

Save the screenshot in the specified path.

Parameters

path	Specify the path to store the screenshot. If the specified path is wrong, the SDKERR_INVALID_PARAMETER will be returned.

Returns

If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.

SetColor()

virtual SDKError ICustomizedAnnotationObj::SetColor ( unsigned long color )

pure virtual

Sets the color to annotate.

Parameters

color

Specify the color to annotate, in RGB format.

Returns

If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.

SetEvent()

virtual SDKError ICustomizedAnnotationObj::SetEvent ( ICustomizedAnnotationObjEvent * event_ )

pure virtual

Sets annotation object callback event handler.

Parameters

event_

A pointer to the ICustomizedAnnotationObjEvent that receives annotation object event.

Returns

If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.

SetLineWidth()

virtual SDKError ICustomizedAnnotationObj::SetLineWidth ( long lineWidth )

pure virtual

Sets the value of line width of annotation tool.

Parameters

lineWidth

The line width of annotation tool.

Returns

If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.

SetTool()

virtual SDKError ICustomizedAnnotationObj::SetTool ( AnnotationToolType type )

pure virtual

Sets the tool to annotate.

Parameters

type	Specify the type of the annotation tool.

Returns

If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.

Undo()

virtual SDKError ICustomizedAnnotationObj::Undo ( )

pure virtual

Undo the last annotation.

Returns

If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.