libpurple/blistnode.h

branch
soc.2013.gobjectification.plugins
changeset 37075
cf3f735b09b7
parent 37069
22bf5ea00006
parent 35472
474e26199560
child 37088
4d5ad6b1878e
equal deleted inserted replaced
37074:1e7b4b3741a0 37075:cf3f735b09b7
128 }; 128 };
129 129
130 G_BEGIN_DECLS 130 G_BEGIN_DECLS
131 131
132 /**************************************************************************/ 132 /**************************************************************************/
133 /** @name Buddy list node API */ 133 /* Buddy list node API */
134 /**************************************************************************/ 134 /**************************************************************************/
135 /*@{*/ 135 /*@{*/
136 136
137 /** 137 /**
138 * purple_blist_node_get_type: 138 * purple_blist_node_get_type:
147 * @offline: Whether to include nodes for offline accounts 147 * @offline: Whether to include nodes for offline accounts
148 * 148 *
149 * Returns the next node of a given node. This function is to be used to iterate 149 * Returns the next node of a given node. This function is to be used to iterate
150 * over the tree returned by purple_blist_get_buddy_list. 150 * over the tree returned by purple_blist_get_buddy_list.
151 * 151 *
152 * See purple_blist_node_get_parent(), purple_blist_node_get_first_child(),
153 * purple_blist_node_get_sibling_next(), purple_blist_node_get_sibling_prev().
154 *
152 * Returns: The next node 155 * Returns: The next node
153 *
154 * @see purple_blist_node_get_parent
155 * @see purple_blist_node_get_first_child
156 * @see purple_blist_node_get_sibling_next
157 * @see purple_blist_node_get_sibling_prev
158 */ 156 */
159 PurpleBlistNode *purple_blist_node_next(PurpleBlistNode *node, gboolean offline); 157 PurpleBlistNode *purple_blist_node_next(PurpleBlistNode *node, gboolean offline);
160 158
161 /** 159 /**
162 * purple_blist_node_get_parent: 160 * purple_blist_node_get_parent:
163 * @node: A node. 161 * @node: A node.
164 * 162 *
165 * Returns the parent node of a given node. 163 * Returns the parent node of a given node.
166 * 164 *
165 * See purple_blist_node_get_first_child(), purple_blist_node_get_sibling_next(),
166 * purple_blist_node_get_sibling_prev(), purple_blist_node_next().
167 *
167 * Returns: The parent node. 168 * Returns: The parent node.
168 *
169 * @see purple_blist_node_get_first_child
170 * @see purple_blist_node_get_sibling_next
171 * @see purple_blist_node_get_sibling_prev
172 * @see purple_blist_node_next
173 */ 169 */
174 PurpleBlistNode *purple_blist_node_get_parent(PurpleBlistNode *node); 170 PurpleBlistNode *purple_blist_node_get_parent(PurpleBlistNode *node);
175 171
176 /** 172 /**
177 * purple_blist_node_get_first_child: 173 * purple_blist_node_get_first_child:
178 * @node: A node. 174 * @node: A node.
179 * 175 *
180 * Returns the the first child node of a given node. 176 * Returns the the first child node of a given node.
181 * 177 *
178 * See purple_blist_node_get_parent(), purple_blist_node_get_sibling_next(),
179 * purple_blist_node_get_sibling_prev(), purple_blist_node_next().
180 *
182 * Returns: The child node. 181 * Returns: The child node.
183 *
184 * @see purple_blist_node_get_parent
185 * @see purple_blist_node_get_sibling_next
186 * @see purple_blist_node_get_sibling_prev
187 * @see purple_blist_node_next
188 */ 182 */
189 PurpleBlistNode *purple_blist_node_get_first_child(PurpleBlistNode *node); 183 PurpleBlistNode *purple_blist_node_get_first_child(PurpleBlistNode *node);
190 184
191 /** 185 /**
192 * purple_blist_node_get_sibling_next: 186 * purple_blist_node_get_sibling_next:
193 * @node: A node. 187 * @node: A node.
194 * 188 *
195 * Returns the sibling node of a given node. 189 * Returns the sibling node of a given node.
196 * 190 *
191 * See purple_blist_node_get_parent(), purple_blist_node_get_first_child(),
192 * purple_blist_node_get_sibling_prev(), purple_blist_node_next().
193 *
197 * Returns: The sibling node. 194 * Returns: The sibling node.
198 *
199 * @see purple_blist_node_get_parent
200 * @see purple_blist_node_get_first_child
201 * @see purple_blist_node_get_sibling_prev
202 * @see purple_blist_node_next
203 */ 195 */
204 PurpleBlistNode *purple_blist_node_get_sibling_next(PurpleBlistNode *node); 196 PurpleBlistNode *purple_blist_node_get_sibling_next(PurpleBlistNode *node);
205 197
206 /** 198 /**
207 * purple_blist_node_get_sibling_prev: 199 * purple_blist_node_get_sibling_prev:
208 * @node: A node. 200 * @node: A node.
209 * 201 *
210 * Returns the previous sibling node of a given node. 202 * Returns the previous sibling node of a given node.
211 * 203 *
204 * See purple_blist_node_get_parent(), purple_blist_node_get_first_child(),
205 * purple_blist_node_get_sibling_next(), purple_blist_node_next().
206 *
212 * Returns: The sibling node. 207 * Returns: The sibling node.
213 *
214 * @see purple_blist_node_get_parent
215 * @see purple_blist_node_get_first_child
216 * @see purple_blist_node_get_sibling_next
217 * @see purple_blist_node_next
218 */ 208 */
219 PurpleBlistNode *purple_blist_node_get_sibling_prev(PurpleBlistNode *node); 209 PurpleBlistNode *purple_blist_node_get_sibling_prev(PurpleBlistNode *node);
220 210
221 /** 211 /**
222 * purple_blist_node_get_ui_data: 212 * purple_blist_node_get_ui_data:
365 GList *purple_blist_node_get_extended_menu(PurpleBlistNode *n); 355 GList *purple_blist_node_get_extended_menu(PurpleBlistNode *n);
366 356
367 /*@}*/ 357 /*@}*/
368 358
369 /**************************************************************************/ 359 /**************************************************************************/
370 /** @name Counting node API */ 360 /* Counting node API */
371 /**************************************************************************/ 361 /**************************************************************************/
372 /*@{*/ 362 /*@{*/
373 363
374 /** 364 /**
375 * purple_counting_node_get_type: 365 * purple_counting_node_get_type:

mercurial