Class

PurpleUi

unstable since: 3.0

Description [src]

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

An abstract class representing a user interface. All user interfaces must create a subclass of this and pass it to purple_core_init().

Available since: 3.0

Ancestors

GObject

Instance methods

purple_ui_get_client_type

Gets the client type from ui.

unstable since: 3.0

purple_ui_get_conversation_manager

Gets the default conversation manager manage from ui.

unstable since: 3.0

purple_ui_get_history_adapter

Gets the history adapter that the user interface wants to use.

unstable since: 3.0

purple_ui_get_id

Gets the id for the user interface.

unstable since: 3.0

purple_ui_get_name

Gets the name of ui. This should be translated.

unstable since: 3.0

purple_ui_get_presence_manager

Gets the PurplePresenceManager that the user interface wants to use.

unstable since: 3.0

purple_ui_get_settings_backend

Get the GSettingsBackend that ui is using for its settings.

unstable since: 3.0

purple_ui_get_support_website

Gets the support website from ui.

unstable since: 3.0

purple_ui_get_version

Gets the version of ui.

unstable since: 3.0

purple_ui_get_website

Gets the website from ui.

unstable since: 3.0

purple_ui_open_uri

Attempts to open uri and calls callback with the result.

unstable since: 3.0

purple_ui_open_uri_finish

Finishes a previous call to purple_ui_open_uri() and gets the result.

unstable since: 3.0

purple_ui_prefs_init

Tells ui that it should be initializing its preferences.

unstable since: 3.0

purple_ui_start

Tells ui that libpurple is done initializing and that ui should continue its initialization.

unstable since: 3.0

purple_ui_stop

Tells ui that libpurple is done shutting down.

unstable since: 3.0

Methods inherited from GObject (43)

Please see GObject for a full list of methods.

Properties

Purple.Ui:client-type

The client type of the user interface. Common values include bot, console, mobile, pc, web, etc.

unstable since: 3.0

Purple.Ui:id

The identifier of the user interface. This is used in places where a constant string is need to represent the user interface.

unstable since: 3.0

Purple.Ui:name

The name of the user interface. This is used in places where it will be displayed to users, so it should be translated.

unstable since: 3.0

Purple.Ui:support-website

The support website of the user interface. This should link to a page that specifically directs users how to get support for your user interface.

unstable since: 3.0

Purple.Ui:version

The version number of the user interface.

unstable since: 3.0

Purple.Ui:website

The website of the user interface. This should be the main website.

unstable since: 3.0

Signals

Purple.Ui::started

Emitted if purple_ui_start() completed successfully.

unstable since: 3.0

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 PurpleUiClass {
  void (* prefs_init) (
    PurpleUi* ui
  );
  gboolean (* start) (
    PurpleUi* ui,
    GError** error
  );
  void (* stop) (
    PurpleUi* ui
  );
  PurpleConversationManager* (* get_conversation_manager) (
    PurpleUi* ui
  );
  PurpleHistoryAdapter* (* get_history_adapter) (
    PurpleUi* ui
  );
  PurplePresenceManager* (* get_presence_manager) (
    PurpleUi* ui
  );
  gpointer (* get_settings_backend) (
    PurpleUi* ui
  );
  void (* open_uri) (
    PurpleUi* ui,
    const char* uri,
    GCancellable* cancellable,
    GAsyncReadyCallback callback,
    gpointer data
  );
  gboolean (* open_uri_finish) (
    PurpleUi* ui,
    GAsyncResult* result,
    GError** error
  );
  
}

The base class for all user interfaces which is used to identify themselves to libpurple when calling purple_core_init().

Class members

prefs_init: void (* prefs_init) ( PurpleUi* ui ): This function is called to initialize the ui’s preferences. This is slowly being phased out for get_settings_backend, but is still required.
start: gboolean (* start) ( PurpleUi* ui, GError** error ): Called when libpurple is done with its initialization when the user interface should start telling libpurple about the rest of the user interface’s interfaces.
stop: void (* stop) ( PurpleUi* ui ): Called after most of libpurple has been uninitialized.
get_conversation_manager: PurpleConversationManager* (* get_conversation_manager) ( PurpleUi* ui ): No description available.
get_history_adapter: PurpleHistoryAdapter* (* get_history_adapter) ( PurpleUi* ui ): No description available.
get_presence_manager: PurplePresenceManager* (* get_presence_manager) ( PurpleUi* ui ): No description available.
get_settings_backend: gpointer (* get_settings_backend) ( PurpleUi* ui ): Called to get the GSettingsBackend that the UI is using.
open_uri: void (* open_uri) ( PurpleUi* ui, const char* uri, GCancellable* cancellable, GAsyncReadyCallback callback, gpointer data ): No description available.
open_uri_finish: gboolean (* open_uri_finish) ( PurpleUi* ui, GAsyncResult* result, GError** error ): No description available.

Description [src]

Ancestors

Instance methods

Methods inherited from GObject (43)

Properties

Signals

Signals inherited from GObject (1)

Class structure

Class members

Virtual methods