comparison: libpurple/core.h
libpurple/core.h
- branch
- soc.2013.gobjectification.plugins
- changeset 37017
- 8e2b68c79fa1
- parent 35024
- eb3afb7643ce
- child 37021
- 04c99b24db84
equal
deleted
inserted
replaced
| 37016:48f85579cc4c | 37017:8e2b68c79fa1 |
|---|---|
| 85 /** | 85 /** |
| 86 * Initializes the core of purple. | 86 * Initializes the core of purple. |
| 87 * | 87 * |
| 88 * This will setup preferences for all the core subsystems. | 88 * This will setup preferences for all the core subsystems. |
| 89 * | 89 * |
| 90 * @param ui The ID of the UI using the core. This should be a | 90 * @ui: The ID of the UI using the core. This should be a |
| 91 * unique ID, registered with the purple team. | 91 * unique ID, registered with the purple team. |
| 92 * | 92 * |
| 93 * @return @c TRUE if successful, or @c FALSE otherwise. | 93 * Returns: @c TRUE if successful, or @c FALSE otherwise. |
| 94 */ | 94 */ |
| 95 gboolean purple_core_init(const char *ui); | 95 gboolean purple_core_init(const char *ui); |
| 96 | 96 |
| 97 /** | 97 /** |
| 98 * Quits the core of purple, which, depending on the UI, may quit the | 98 * Quits the core of purple, which, depending on the UI, may quit the |
| 122 gboolean purple_core_quit_cb(gpointer unused); | 122 gboolean purple_core_quit_cb(gpointer unused); |
| 123 | 123 |
| 124 /** | 124 /** |
| 125 * Returns the version of the core library. | 125 * Returns the version of the core library. |
| 126 * | 126 * |
| 127 * @return The version of the core library. | 127 * Returns: The version of the core library. |
| 128 */ | 128 */ |
| 129 const char *purple_core_get_version(void); | 129 const char *purple_core_get_version(void); |
| 130 | 130 |
| 131 /** | 131 /** |
| 132 * Returns the ID of the UI that is using the core, as passed to | 132 * Returns the ID of the UI that is using the core, as passed to |
| 133 * purple_core_init(). | 133 * purple_core_init(). |
| 134 * | 134 * |
| 135 * @return The ID of the UI that is currently using the core. | 135 * Returns: The ID of the UI that is currently using the core. |
| 136 */ | 136 */ |
| 137 const char *purple_core_get_ui(void); | 137 const char *purple_core_get_ui(void); |
| 138 | 138 |
| 139 /** | 139 /** |
| 140 * Returns a handle to the purple core. | 140 * Returns a handle to the purple core. |
| 144 PurpleCore *purple_get_core(void); | 144 PurpleCore *purple_get_core(void); |
| 145 | 145 |
| 146 /** | 146 /** |
| 147 * Sets the UI ops for the core. | 147 * Sets the UI ops for the core. |
| 148 * | 148 * |
| 149 * @param ops A UI ops structure for the core. | 149 * @ops: A UI ops structure for the core. |
| 150 */ | 150 */ |
| 151 void purple_core_set_ui_ops(PurpleCoreUiOps *ops); | 151 void purple_core_set_ui_ops(PurpleCoreUiOps *ops); |
| 152 | 152 |
| 153 /** | 153 /** |
| 154 * Returns the UI ops for the core. | 154 * Returns the UI ops for the core. |
| 155 * | 155 * |
| 156 * @return The core's UI ops structure. | 156 * Returns: The core's UI ops structure. |
| 157 */ | 157 */ |
| 158 PurpleCoreUiOps *purple_core_get_ui_ops(void); | 158 PurpleCoreUiOps *purple_core_get_ui_ops(void); |
| 159 | 159 |
| 160 /** | 160 /** |
| 161 * Ensures that only one instance is running. If libpurple is built with D-Bus | 161 * Ensures that only one instance is running. If libpurple is built with D-Bus |
| 162 * support, this checks if another process owns the libpurple bus name and if | 162 * support, this checks if another process owns the libpurple bus name and if |
| 163 * so whether that process is using the same configuration directory as this | 163 * so whether that process is using the same configuration directory as this |
| 164 * process. | 164 * process. |
| 165 * | 165 * |
| 166 * @return @c TRUE if this is the first instance of libpurple running; | 166 * Returns: @c TRUE if this is the first instance of libpurple running; |
| 167 * @c FALSE if there is another instance running. | 167 * @c FALSE if there is another instance running. |
| 168 */ | 168 */ |
| 169 gboolean purple_core_ensure_single_instance(void); | 169 gboolean purple_core_ensure_single_instance(void); |
| 170 | 170 |
| 171 /** | 171 /** |
| 191 * 'handheld', 'web', and 'bot'. These values are compared | 191 * 'handheld', 'web', and 'bot'. These values are compared |
| 192 * programmatically and should not be localized.</dd> | 192 * programmatically and should not be localized.</dd> |
| 193 * | 193 * |
| 194 * </dl> | 194 * </dl> |
| 195 * | 195 * |
| 196 * @return A GHashTable with strings for keys and values. This | 196 * Returns: A GHashTable with strings for keys and values. This |
| 197 * hash table must not be freed and should not be modified. | 197 * hash table must not be freed and should not be modified. |
| 198 * | 198 * |
| 199 */ | 199 */ |
| 200 GHashTable* purple_core_get_ui_info(void); | 200 GHashTable* purple_core_get_ui_info(void); |
| 201 | 201 |
