Functions

vnc_status_t vnc_AnnotationManager_setCallback(vnc_AnnotationManager *annotationManager, const vnc_AnnotationManager_Callback *callback, void *userData)¶

Sets annotation-related callbacks.

Return

vnc_success or vnc_failure, in which case call vnc_getLastError() to get the error code.

Since

1.4

Parameters

• annotationManager -

  Belonging to either a Viewer or a Server.

• callback -

  The new annotation callback.

Return Value

• InvalidArgument -

  callback is invalid.

vnc_status_t vnc_AnnotationManager_clear(vnc_AnnotationManager *annotationManager, vnc_bool_t fade, vnc_Connection *connection)¶

Clears particular annotations.

For a Viewer, this is all its annotations. For a Server, you can choose to clear its annotations, or those of a particular Viewer.

Return

vnc_success or vnc_failure, in which case call vnc_getLastError() to get the error code.

Since

1.4

Parameters

• annotationManager -

  Belonging to either a Viewer or a Server.

• fade -

  vnc_true to fade annotations gradually, or vnc_false to clear immediately without fading.

• connection -

  For a Server, the Viewer whose annotations to clear, or NULL to clear Server annotations. For a Viewer, this must be NULL.

Return Value

• InvalidArgument -

  annotationManager is invalid or connection is invalid.

void vnc_AnnotationManager_clearAll(vnc_AnnotationManager *annotationManager, vnc_bool_t fade)¶

Clears all annotations.

For a Server, clears all annotations, including its own. For a Viewer, this is the same as vnc_AnnotationManager_clear.

Since

1.4

Parameters

• annotationManager -

  Belonging to either a Viewer or a Server.

• fade -

  vnc_true to fade annotations gradually, or vnc_false to clear immediately without fading.

vnc_bool_t vnc_AnnotationManager_isAvailable(vnc_AnnotationManager *annotationManager)¶

Queries whether it is possible to annotate.

Note that a Server cannot annotate until app initialization is complete. A Viewer cannot annotate if it is not connected to a Server, if it has not been granted annotation permissions, or if the Server does not support annotations (perhaps because that Server was not created using the VNC SDK).

See

vnc_AnnotationManager_Callback::availabilityChanged

Return

vnc_true if it is possible to annotate, otherwise vnc_false.

Since

1.4

Parameters

• annotationManager -

  Belonging to either a Viewer or a Server.

vnc_uint32_t vnc_AnnotationManager_getPenColor(vnc_AnnotationManager *annotationManager)¶

Gets the current pen color.

Return

A 32-bit integer in the form AARRGGBB.

Since

1.4

Parameters

• annotationManager -

  Belonging to either a Viewer or a Server.

void vnc_AnnotationManager_setPenColor(vnc_AnnotationManager *annotationManager, vnc_uint32_t color)¶

Sets the pen color, determining the color of the annotation line.

Since

1.4

Parameters

• annotationManager -

  Belonging to either a Viewer or a Server.

• color -

  A 32-bit integer in the form AARRGGBB.

vnc_uint31_t vnc_AnnotationManager_getPenSize(vnc_AnnotationManager *annotationManager)¶

Gets the current pen size.

Defaults to 10 device independent pixels (DIP).

Return

A number of DIP.

Since

1.4

Parameters

• annotationManager -

  Belonging to either a Viewer or a Server.

void vnc_AnnotationManager_setPenSize(vnc_AnnotationManager *annotationManager, vnc_uint31_t size)¶

Sets the pen size, determining the width of the annotation line.

Since

1.4

Parameters

• annotationManager -

  Belonging to either a Viewer or a Server.

• size -

  A number of DIP.

int vnc_AnnotationManager_getPersistDuration(vnc_AnnotationManager *annotationManager)¶

Gets how long annotations persist as a solid color for.

Defaults to 10000 milliseconds.

Return

A number of milliseconds. A value of 0 means annotations start fading immediately. A value of -1 or lower means annotations persist indefinitely unless explicitly or automatically cleared (see the detailed description summary for when this might happen).

Since

1.4

Parameters

• annotationManager -

  Belonging to either a Viewer or a Server.

void vnc_AnnotationManager_setPersistDuration(vnc_AnnotationManager *annotationManager, int durationMs)¶

Sets how long annotations persist as a solid color for.

Since

1.4

Parameters

• annotationManager -

  Belonging to either a Viewer or a Server.

• durationMs -

  A number of milliseconds. Specify 0 to start fading immedaitely. Specify -1 or lower to persist annotations indefinitely unless explicitly or automatically cleared (see the detailed description for when this might happen).

int vnc_AnnotationManager_getFadeDuration(vnc_AnnotationManager *annotationManager)¶

Gets how long annotations take to fade.

Defaults to 2000 milliseconds.

Return

A number of milliseconds. A value of 0 means annotations do not fade but rather disappear immediately after vnc_AnnotationManager_getPersistDuration.

Since

1.4

Parameters

• annotationManager -

  Belonging to either a Viewer or a Server.

void vnc_AnnotationManager_setFadeDuration(vnc_AnnotationManager *annotationManager, int durationMs)¶

Sets how long annotations take to fade.

Since

1.4

Parameters

• annotationManager -

  Belonging to either a Viewer or a Server.

• durationMs -

  A number of milliseconds. Specify 0 to clear annotations immediately after vnc_AnnotationManager_getPersistDuration.

vnc_status_t vnc_AnnotationManager_movePenTo(vnc_AnnotationManager *annotationManager, int x, int y, vnc_bool_t penDown)¶

Draws a line on the Server screen from the current position to a new position.

When you obtain a vnc_AnnotationManager, its co-ordinate system is set to 0,0. This means that before you annotate for the first time, call this method with penDown set to vnc_false to move the pen from 0,0 to the current position without drawing a line. You can then call this method again with penDown set to vnc_true to actually draw from the current position to a new position. Call this method with penDown set to vnc_false to stop drawing.

A vnc_AnnotationManager subsequently remembers its current position, so you only need manoevre from 0,0 once. It is only reset to 0,0 if you obtain a new vnc_AnnotationManager, or if the Server screen resolution changes.

Return

vnc_success or vnc_failure, in which case call vnc_getLastError() to get the error code.

See

vnc_AnnotationManager_isAvailable

Since

1.4

Parameters

• annotationManager -

  Belonging to either a Viewer or a Server.

• x -

  New X co-ordinate.

• y -

  New Y co-ordinate.

• penDown -

  vnc_true to draw a line from the current position to the new position, or vnc_false to move the pen without drawing.

Return Value

• InvalidArgument -

  annotationManager is invalid.

• NotSupported -

  An attempt was made to annotate with the pen down while annotations were not available.