Class

PurpleWhiteboard

Description [src]

class Purple.Whiteboard : GObject.Object {
  parent_instance: GObject
}

A abstract whiteboard object.

Ancestors

Constructors

purple_whiteboard_new

Creates a new whiteboard.

Functions

purple_whiteboard_draw_list_destroy

Destroys a drawing list for a whiteboard.

purple_whiteboard_set_ui_ops

Sets the UI operations.

Instance methods

purple_whiteboard_clear

Clears the contents of whiteboard.

purple_whiteboard_draw_line

Draws a line on whiteboard with the given parameters.

purple_whiteboard_draw_point

Draws a point on whiteboard with the given parameters.

purple_whiteboard_equal

Checks the id’s for whiteboard1 and whiteboard2 and return whether or not they are equal.

Available since: 3.0.0

purple_whiteboard_get_account

Gets the PurpleAccount that whiteboard is tied to.

purple_whiteboard_get_brush

Gets the size and color of the brush.

purple_whiteboard_get_dimensions

Gets the dimension of a whiteboard.

purple_whiteboard_get_draw_list

Gets the drawing list.

purple_whiteboard_get_id

Gets the id of whiteboard.

Available since: 3.0.0

purple_whiteboard_get_protocol_data

Gets the protocol data for a whiteboard.

purple_whiteboard_get_state

Gets the state of whiteboard.

purple_whiteboard_send_brush

Sends a request to change the size and color of the brush.

purple_whiteboard_send_clear

Sends a request to the buddy to clear whiteboard.

purple_whiteboard_send_draw_list

Send a list of points to draw.

purple_whiteboard_set_brush

Sets the size and color of the brush.

purple_whiteboard_set_dimensions

Sets the dimensions for whiteboard.

purple_whiteboard_set_draw_list

Sets the drawing list.

purple_whiteboard_set_protocol_data

Sets the protocol data for whiteboard.

purple_whiteboard_set_protocol_ops

Sets the protocol operations for whiteboard.

purple_whiteboard_set_state

Set the state of whiteboard to state.

purple_whiteboard_start

Puts whiteboard into the started state if it wasn’t already.

purple_whiteboard_ui_ops_clear

Clears all the contents of whiteboard.

purple_whiteboard_ui_ops_create

Creates a user interface for whiteboard.

purple_whiteboard_ui_ops_destroy

Destroys the user interface for whiteboard.

purple_whiteboard_ui_ops_draw_line

Draws a line on whiteboard.

purple_whiteboard_ui_ops_draw_point

Draws a point on whiteboard.

purple_whiteboard_ui_ops_set_brush

Sets the size and color of the active brush for whiteboard.

purple_whiteboard_ui_ops_set_dimensions

Sets the user interface dimensions for whiteboard.

Methods inherited from GObject (43)

Please see GObject for a full list of methods.

Properties

Purple.Whiteboard:account
No description available.
Purple.Whiteboard:draw-list
No description available.
Purple.Whiteboard:id
No description available.
Purple.Whiteboard:state
No description available.

Signals

Signals inherited from GObject (1)
GObject.Object::notify

The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.

Class structure

struct PurpleWhiteboardClass {
  /* no available fields */
}

The class methods for a PurpleWhiteboard.

Right now this is empty but it will be filled out with the function from PurpleWhiteboardOps in a future review request.