Mercurial > pidgin3 / file comparison

comparison: libpurple/accounts.h

libpurple/accounts.h

branch
soc.2013.gobjectification.plugins
changeset 37017
8e2b68c79fa1
parent 36896
3865997e388b
child 37021
04c99b24db84
equal deleted inserted replaced
37016:48f85579cc4c 37017:8e2b68c79fa1
60 60
61 /** Prompt for authorization when someone adds this account to their buddy 61 /** Prompt for authorization when someone adds this account to their buddy
62 * list. To authorize them to see this account's presence, call \a 62 * list. To authorize them to see this account's presence, call \a
63 * authorize_cb (\a message, \a user_data); otherwise call 63 * authorize_cb (\a message, \a user_data); otherwise call
64 * \a deny_cb (\a message, \a user_data); 64 * \a deny_cb (\a message, \a user_data);
65 * @return a UI-specific handle, as passed to #close_account_request. 65 * Returns: a UI-specific handle, as passed to #close_account_request.
66 */ 66 */
67 void *(*request_authorize)(PurpleAccount *account, 67 void *(*request_authorize)(PurpleAccount *account,
68 const char *remote_user, 68 const char *remote_user,
69 const char *id, 69 const char *id,
70 const char *alias, 70 const char *alias,
99 /*@{*/ 99 /*@{*/
100 100
101 /** 101 /**
102 * Adds an account to the list of accounts. 102 * Adds an account to the list of accounts.
103 * 103 *
104 * @param account The account. 104 * @account: The account.
105 */ 105 */
106 void purple_accounts_add(PurpleAccount *account); 106 void purple_accounts_add(PurpleAccount *account);
107 107
108 /** 108 /**
109 * Removes an account from the list of accounts. 109 * Removes an account from the list of accounts.
110 * 110 *
111 * @param account The account. 111 * @account: The account.
112 */ 112 */
113 void purple_accounts_remove(PurpleAccount *account); 113 void purple_accounts_remove(PurpleAccount *account);
114 114
115 /** 115 /**
116 * Deletes an account. 116 * Deletes an account.
117 * 117 *
118 * This will remove any buddies from the buddy list that belong to this 118 * This will remove any buddies from the buddy list that belong to this
119 * account, buddy pounces that belong to this account, and will also 119 * account, buddy pounces that belong to this account, and will also
120 * destroy @a account. 120 * destroy @a account.
121 * 121 *
122 * @param account The account. 122 * @account: The account.
123 */ 123 */
124 void purple_accounts_delete(PurpleAccount *account); 124 void purple_accounts_delete(PurpleAccount *account);
125 125
126 /** 126 /**
127 * Reorders an account. 127 * Reorders an account.
128 * 128 *
129 * @param account The account to reorder. 129 * @account: The account to reorder.
130 * @param new_index The new index for the account. 130 * @new_index: The new index for the account.
131 */ 131 */
132 void purple_accounts_reorder(PurpleAccount *account, guint new_index); 132 void purple_accounts_reorder(PurpleAccount *account, guint new_index);
133 133
134 /** 134 /**
135 * Returns a list of all accounts. 135 * Returns a list of all accounts.
136 * 136 *
137 * @constreturn A list of all accounts. 137 * Returns: (TODO const): A list of all accounts.
138 */ 138 */
139 GList *purple_accounts_get_all(void); 139 GList *purple_accounts_get_all(void);
140 140
141 /** 141 /**
142 * Returns a list of all enabled accounts 142 * Returns a list of all enabled accounts
143 * 143 *
144 * @return A list of all enabled accounts. The list is owned 144 * Returns: A list of all enabled accounts. The list is owned
145 * by the caller, and must be g_list_free()d to avoid 145 * by the caller, and must be g_list_free()d to avoid
146 * leaking the nodes. 146 * leaking the nodes.
147 */ 147 */
148 GList *purple_accounts_get_all_active(void); 148 GList *purple_accounts_get_all_active(void);
149 149
150 /** 150 /**
151 * Finds an account with the specified name and protocol id. 151 * Finds an account with the specified name and protocol id.
152 * 152 *
153 * @param name The account username. 153 * @name: The account username.
154 * @param protocol The account protocol ID. 154 * @protocol: The account protocol ID.
155 * 155 *
156 * @return The account, if found, or @c FALSE otherwise. 156 * Returns: The account, if found, or @c FALSE otherwise.
157 */ 157 */
158 PurpleAccount *purple_accounts_find(const char *name, const char *protocol); 158 PurpleAccount *purple_accounts_find(const char *name, const char *protocol);
159 159
160 /** 160 /**
161 * This is called by the core after all subsystems and what 161 * This is called by the core after all subsystems and what
176 /**************************************************************************/ 176 /**************************************************************************/
177 /*@{*/ 177 /*@{*/
178 /** 178 /**
179 * Sets the UI operations structure to be used for accounts. 179 * Sets the UI operations structure to be used for accounts.
180 * 180 *
181 * @param ops The UI operations structure. 181 * @ops: The UI operations structure.
182 */ 182 */
183 void purple_accounts_set_ui_ops(PurpleAccountUiOps *ops); 183 void purple_accounts_set_ui_ops(PurpleAccountUiOps *ops);
184 184
185 /** 185 /**
186 * Returns the UI operations structure used for accounts. 186 * Returns the UI operations structure used for accounts.
187 * 187 *
188 * @return The UI operations structure in use. 188 * Returns: The UI operations structure in use.
189 */ 189 */
190 PurpleAccountUiOps *purple_accounts_get_ui_ops(void); 190 PurpleAccountUiOps *purple_accounts_get_ui_ops(void);
191 191
192 /*@}*/ 192 /*@}*/
193 193
198 /*@{*/ 198 /*@{*/
199 199
200 /** 200 /**
201 * Returns the accounts subsystem handle. 201 * Returns the accounts subsystem handle.
202 * 202 *
203 * @return The accounts subsystem handle. 203 * Returns: The accounts subsystem handle.
204 */ 204 */
205 void *purple_accounts_get_handle(void); 205 void *purple_accounts_get_handle(void);
206 206
207 /** 207 /**
208 * Initializes the accounts subsystem. 208 * Initializes the accounts subsystem.

Mercurial Repository: pidgin3

mercurial