Class

PurpleUi

Description [src]

abstract class Purple.Ui : GObject.Object {
  parent_instance: GObject
}

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.0

Ancestors

Instance methods

purple_ui_get_client_type

Gets the client type from ui.

Available since: 3.0.0

purple_ui_get_id

Gets the id for the user interface.

Available since: 3.0.0

purple_ui_get_name

Gets the name of ui. This should be translated.

Available since: 3.0.0

purple_ui_get_settings_backend

Get the GSettingsBackend that ui is using for its settings.

Available since: 3.0.0

purple_ui_get_support_website

Gets the support website from ui.

Available since: 3.0.0

purple_ui_get_version

Gets the version of ui.

Available since: 3.0.0

purple_ui_get_website

Gets the website from ui.

Available since: 3.0.0

purple_ui_prefs_init

Tells ui that it should be initializing its preferences.

Available since: 3.0.0

purple_ui_start

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

Available since: 3.0.0

purple_ui_stop

Tells ui that libpurple is done shutting down.

Available since: 3.0.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.

Available since: 3.0.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.

Available since: 3.0.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.

Available since: 3.0.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.

Available since: 3.0.0

Purple.Ui:version

The version number of the user interface.

Available since: 3.0.0

Purple.Ui:website

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

Available since: 3.0.0

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 PurpleUiClass {
  void (* prefs_init) (
    PurpleUi* ui
  );
  gboolean (* start) (
    PurpleUi* ui,
    GError** error
  );
  void (* stop) (
    PurpleUi* ui
  );
  gpointer (* get_settings_backend) (
    PurpleUi* ui
  );
  
}
Class members
prefs_init
void (* prefs_init) (
    PurpleUi* ui
  )
  No description available.
start
gboolean (* start) (
    PurpleUi* ui,
    GError** error
  )
  No description available.
stop
void (* stop) (
    PurpleUi* ui
  )
  No description available.
get_settings_backend
gpointer (* get_settings_backend) (
    PurpleUi* ui
  )
  No description available.

Virtual methods

Purple.UiClass.get_settings_backend

Get the GSettingsBackend that ui is using for its settings.

Available since: 3.0.0

Purple.UiClass.prefs_init

Tells ui that it should be initializing its preferences.

Available since: 3.0.0

Purple.UiClass.start

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

Available since: 3.0.0

Purple.UiClass.stop

Tells ui that libpurple is done shutting down.

Available since: 3.0.0