PurpleConnectionUiOps Struct Reference

Connection UI operations. More...

#include <connection.h>


Data Fields

void(* connect_progress )(PurpleConnection *gc, const char *text, size_t step, size_t step_count)
 When an account is connecting, this operation is called to notify the UI of what is happening, as well as which step out of step_count has been reached (which might be displayed as a progress bar).
void(* connected )(PurpleConnection *gc)
 Called when a connection is established (just before the signed-on signal).
void(* disconnected )(PurpleConnection *gc)
 Called when a connection is ended (between the signing-off and signed-off signals).
void(* notice )(PurpleConnection *gc, const char *text)
 Used to display connection-specific notices.
void(* report_disconnect )(PurpleConnection *gc, const char *text)
 Called when an error causes a connection to be disconnected.
void(* network_connected )()
 Called when libpurple discovers that the computer's network connection is active.
void(* network_disconnected )()
 Called when libpurple discovers that the computer's network connection has gone away.
void(* _purple_reserved1 )(void)
void(* _purple_reserved2 )(void)
void(* _purple_reserved3 )(void)
void(* _purple_reserved4 )(void)


Detailed Description

Connection UI operations.

Used to notify the user of changes to connections, such as being disconnected, and to respond to the underlying network connection appearing and disappearing. UIs should call purple_connections_set_ui_ops() with an instance of this struct.

See also:
ui-ops


Field Documentation

void(* PurpleConnectionUiOps::network_connected)()
 

Called when libpurple discovers that the computer's network connection is active.

On Linux, this uses Network Manager if available; on Windows, it uses Win32's network change notification infrastructure.

void(* PurpleConnectionUiOps::notice)(PurpleConnection *gc, const char *text)
 

Used to display connection-specific notices.

(Pidgin's Gtk user interface implements this as a no-op; purple_connection_notice(), which uses this operation, is not used by any of the protocols shipped with libpurple.)

void(* PurpleConnectionUiOps::report_disconnect)(PurpleConnection *gc, const char *text)
 

Called when an error causes a connection to be disconnected.

Called before disconnected.

Parameters:
text a localized error message.


The documentation for this struct was generated from the following file: