pidgin  2.14.10
whiteboard.h File Reference

The PurpleWhiteboard core object. More...

#include "account.h"

Go to the source code of this file.

Data Structures

struct  _PurpleWhiteboard
 A PurpleWhiteboard. More...
 
struct  _PurpleWhiteboardUiOps
 The PurpleWhiteboard UI Operations. More...
 
struct  _PurpleWhiteboardPrplOps
 PurpleWhiteboard PRPL Operations. More...
 

Typedefs

typedef struct _PurpleWhiteboardPrplOps PurpleWhiteboardPrplOps
 Whiteboard PRPL Operations.
 
typedef struct _PurpleWhiteboard PurpleWhiteboard
 A PurpleWhiteboard.
 
typedef struct _PurpleWhiteboardUiOps PurpleWhiteboardUiOps
 The PurpleWhiteboard UI Operations.
 

Functions

PurpleWhiteboard API <br>
void purple_whiteboard_set_ui_ops (PurpleWhiteboardUiOps *ops)
 Sets the UI operations. More...
 
void purple_whiteboard_set_prpl_ops (PurpleWhiteboard *wb, PurpleWhiteboardPrplOps *ops)
 Sets the prpl operations for a whiteboard. More...
 
PurpleWhiteboardpurple_whiteboard_create (PurpleAccount *account, const char *who, int state)
 Creates a whiteboard. More...
 
void purple_whiteboard_destroy (PurpleWhiteboard *wb)
 Destroys a whiteboard. More...
 
void purple_whiteboard_start (PurpleWhiteboard *wb)
 Starts a whiteboard. More...
 
PurpleWhiteboardpurple_whiteboard_get_session (const PurpleAccount *account, const char *who)
 Finds a whiteboard from an account and user. More...
 
void purple_whiteboard_draw_list_destroy (GList *draw_list)
 Destorys a drawing list for a whiteboard. More...
 
gboolean purple_whiteboard_get_dimensions (const PurpleWhiteboard *wb, int *width, int *height)
 Gets the dimension of a whiteboard. More...
 
void purple_whiteboard_set_dimensions (PurpleWhiteboard *wb, int width, int height)
 Sets the dimensions for a whiteboard. More...
 
void purple_whiteboard_draw_point (PurpleWhiteboard *wb, int x, int y, int color, int size)
 Draws a point on a whiteboard. More...
 
void purple_whiteboard_send_draw_list (PurpleWhiteboard *wb, GList *list)
 Send a list of points to draw to the buddy. More...
 
void purple_whiteboard_draw_line (PurpleWhiteboard *wb, int x1, int y1, int x2, int y2, int color, int size)
 Draws a line on a whiteboard. More...
 
void purple_whiteboard_clear (PurpleWhiteboard *wb)
 Clears a whiteboard. More...
 
void purple_whiteboard_send_clear (PurpleWhiteboard *wb)
 Sends a request to the buddy to clear the whiteboard. More...
 
void purple_whiteboard_send_brush (PurpleWhiteboard *wb, int size, int color)
 Sends a request to change the size and color of the brush. More...
 
gboolean purple_whiteboard_get_brush (const PurpleWhiteboard *wb, int *size, int *color)
 Gets the size and color of the brush. More...
 
void purple_whiteboard_set_brush (PurpleWhiteboard *wb, int size, int color)
 Sets the size and color of the brush. More...
 

Detailed Description

The PurpleWhiteboard core object.

Definition in file whiteboard.h.

Function Documentation

◆ purple_whiteboard_clear()

void purple_whiteboard_clear ( PurpleWhiteboard wb)

Clears a whiteboard.

Parameters
wbThe whiteboard.

◆ purple_whiteboard_create()

PurpleWhiteboard* purple_whiteboard_create ( PurpleAccount account,
const char *  who,
int  state 
)

Creates a whiteboard.

Parameters
accountThe account.
whoWho you're drawing with.
stateThe state.
Returns
The new whiteboard

◆ purple_whiteboard_destroy()

void purple_whiteboard_destroy ( PurpleWhiteboard wb)

Destroys a whiteboard.

Parameters
wbThe whiteboard.

◆ purple_whiteboard_draw_line()

void purple_whiteboard_draw_line ( PurpleWhiteboard wb,
int  x1,
int  y1,
int  x2,
int  y2,
int  color,
int  size 
)

Draws a line on a whiteboard.

Parameters
wbThe whiteboard.
x1The top-left x coordinate.
y1The top-left y coordinate.
x2The bottom-right x coordinate.
y2The bottom-right y coordinate.
colorThe color to use.
sizeThe brush size.

◆ purple_whiteboard_draw_list_destroy()

void purple_whiteboard_draw_list_destroy ( GList *  draw_list)

Destorys a drawing list for a whiteboard.

Parameters
draw_listThe drawing list.

◆ purple_whiteboard_draw_point()

void purple_whiteboard_draw_point ( PurpleWhiteboard wb,
int  x,
int  y,
int  color,
int  size 
)

Draws a point on a whiteboard.

Parameters
wbThe whiteboard.
xThe x coordinate.
yThe y coordinate.
colorThe color to use.
sizeThe brush size.

◆ purple_whiteboard_get_brush()

gboolean purple_whiteboard_get_brush ( const PurpleWhiteboard wb,
int *  size,
int *  color 
)

Gets the size and color of the brush.

Parameters
wbThe whiteboard
sizeThe size of the brush
colorThe color of the brush
Returns
TRUE if the size and color were set.

◆ purple_whiteboard_get_dimensions()

gboolean purple_whiteboard_get_dimensions ( const PurpleWhiteboard wb,
int *  width,
int *  height 
)

Gets the dimension of a whiteboard.

Parameters
wbThe whiteboard.
widthThe width to be set.
heightThe height to be set.
Returns
TRUE if the values of width and height were set.

◆ purple_whiteboard_get_session()

PurpleWhiteboard* purple_whiteboard_get_session ( const PurpleAccount account,
const char *  who 
)

Finds a whiteboard from an account and user.

Parameters
accountThe account.
whoThe user.
Returns
The whiteboard if found, otherwise NULL.

◆ purple_whiteboard_send_brush()

void purple_whiteboard_send_brush ( PurpleWhiteboard wb,
int  size,
int  color 
)

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

Parameters
wbThe whiteboard
sizeThe size of the brush
colorThe color of the brush

◆ purple_whiteboard_send_clear()

void purple_whiteboard_send_clear ( PurpleWhiteboard wb)

Sends a request to the buddy to clear the whiteboard.

Parameters
wbThe whiteboard

◆ purple_whiteboard_send_draw_list()

void purple_whiteboard_send_draw_list ( PurpleWhiteboard wb,
GList *  list 
)

Send a list of points to draw to the buddy.

Parameters
wbThe whiteboard
listA GList of points

◆ purple_whiteboard_set_brush()

void purple_whiteboard_set_brush ( PurpleWhiteboard wb,
int  size,
int  color 
)

Sets the size and color of the brush.

Parameters
wbThe whiteboard
sizeThe size of the brush
colorThe color of the brush

◆ purple_whiteboard_set_dimensions()

void purple_whiteboard_set_dimensions ( PurpleWhiteboard wb,
int  width,
int  height 
)

Sets the dimensions for a whiteboard.

Parameters
wbThe whiteboard.
widthThe width.
heightThe height.

◆ purple_whiteboard_set_prpl_ops()

void purple_whiteboard_set_prpl_ops ( PurpleWhiteboard wb,
PurpleWhiteboardPrplOps ops 
)

Sets the prpl operations for a whiteboard.

Parameters
wbThe whiteboard for which to set the prpl operations
opsThe prpl operations to set

◆ purple_whiteboard_set_ui_ops()

void purple_whiteboard_set_ui_ops ( PurpleWhiteboardUiOps ops)

Sets the UI operations.

Parameters
opsThe UI operations to set

◆ purple_whiteboard_start()

void purple_whiteboard_start ( PurpleWhiteboard wb)

Starts a whiteboard.

Parameters
wbThe whiteboard.