Class

PurpleWhiteboard

unstable since: 3.0

Description [src]

class Purple.Whiteboard : GObject.Object
{
  /* No available fields */
}

A abstract whiteboard object.

Available since: 3.0

Ancestors

GObject

Functions

purple_whiteboard_draw_list_destroy

Destroys a drawing list for a whiteboard.

since: 2.0

purple_whiteboard_set_ui_ops

Sets the UI operations.

since: 2.0

Instance methods

purple_whiteboard_clear

Clears the contents of whiteboard.

since: 2.0

purple_whiteboard_draw_line

Draws a line on whiteboard with the given parameters.

since: 2.0

purple_whiteboard_draw_point

Draws a point on whiteboard with the given parameters.

since: 2.0

purple_whiteboard_equal

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

unstable since: 3.0

purple_whiteboard_get_account

Gets the PurpleAccount that whiteboard is tied to.

unstable since: 3.0

purple_whiteboard_get_brush

Gets the size and color of the brush.

since: 2.0

purple_whiteboard_get_dimensions

Gets the dimension of a whiteboard.

since: 2.0

purple_whiteboard_get_draw_list

Gets the drawing list.

unstable since: 3.0

purple_whiteboard_get_id

Gets the id of whiteboard.

unstable since: 3.0

purple_whiteboard_get_state

Gets the state of whiteboard.

unstable since: 3.0

purple_whiteboard_send_draw_list

Send a list of points to draw.

since: 2.0

purple_whiteboard_set_brush

Sets the size and color of the brush.

since: 2.0

purple_whiteboard_set_dimensions

Sets the dimensions for whiteboard.

since: 2.0

purple_whiteboard_set_draw_list

Sets the drawing list.

unstable since: 3.0

purple_whiteboard_set_state

Set the state of whiteboard to state.

unstable since: 3.0

purple_whiteboard_start

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

since: 2.0

purple_whiteboard_ui_ops_clear

Clears all the contents of whiteboard.

unstable since: 3.0

purple_whiteboard_ui_ops_create

Creates a user interface for whiteboard.

unstable since: 3.0

purple_whiteboard_ui_ops_destroy

Destroys the user interface for whiteboard.

unstable since: 3.0

purple_whiteboard_ui_ops_draw_line

Draws a line on whiteboard.

unstable since: 3.0

purple_whiteboard_ui_ops_draw_point

Draws a point on whiteboard.

unstable since: 3.0

purple_whiteboard_ui_ops_set_brush

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

unstable since: 3.0

purple_whiteboard_ui_ops_set_dimensions

Sets the user interface dimensions for whiteboard.

unstable since: 3.0

Methods inherited from GObject (43)

Please see GObject for a full list of methods.

Properties

Purple.Whiteboard:account

The account this whiteboard belongs to.

unstable since: 3.0

Purple.Whiteboard:draw-list

The list of draw actions for the whiteboard.

unstable since: 3.0

Purple.Whiteboard:id

The unique identifier of the whiteboard.

unstable since: 3.0

Purple.Whiteboard:state

The state of the whiteboard.

unstable since: 3.0

Signals

Signals inherited from GObject (1)

GObject::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 {
  void (* start) (
    PurpleWhiteboard* whiteboard
  );
  void (* end) (
    PurpleWhiteboard* whiteboard
  );
  gboolean (* get_dimensions) (
    PurpleWhiteboard* whiteboard,
    int* width,
    int* height
  );
  void (* set_dimensions) (
    PurpleWhiteboard* whiteboard,
    int width,
    int height
  );
  void (* get_brush) (
    PurpleWhiteboard* whiteboard,
    int* size,
    int* color
  );
  void (* set_brush) (
    PurpleWhiteboard* whiteboard,
    int size,
    int color
  );
  void (* send_draw_list) (
    PurpleWhiteboard* whiteboard,
    GList* list
  );
  void (* draw_point) (
    PurpleWhiteboard* whiteboard,
    int x,
    int y,
    int size,
    int color
  );
  void (* draw_line) (
    PurpleWhiteboard* whiteboard,
    int x1,
    int y1,
    int x2,
    int y2,
    int size,
    int color
  );
  void (* clear) (
    PurpleWhiteboard* whiteboard
  );
  
}

No description available.

Class members

start: void (* start) ( PurpleWhiteboard* whiteboard ): No description available.
end: void (* end) ( PurpleWhiteboard* whiteboard ): No description available.
get_dimensions: gboolean (* get_dimensions) ( PurpleWhiteboard* whiteboard, int* width, int* height ): No description available.
set_dimensions: void (* set_dimensions) ( PurpleWhiteboard* whiteboard, int width, int height ): No description available.
get_brush: void (* get_brush) ( PurpleWhiteboard* whiteboard, int* size, int* color ): No description available.
set_brush: void (* set_brush) ( PurpleWhiteboard* whiteboard, int size, int color ): No description available.
send_draw_list: void (* send_draw_list) ( PurpleWhiteboard* whiteboard, GList* list ): No description available.
draw_point: void (* draw_point) ( PurpleWhiteboard* whiteboard, int x, int y, int size, int color ): No description available.
draw_line: void (* draw_line) ( PurpleWhiteboard* whiteboard, int x1, int y1, int x2, int y2, int size, int color ): No description available.
clear: void (* clear) ( PurpleWhiteboard* whiteboard ): No description available.