Mercurial > pidgin3 / file comparison

comparison: finch/gntblist.h

finch/gntblist.h

branch
soc.2013.gobjectification.plugins
changeset 37034
9d6765962b22
parent 37023
d9bcdc9a91e6
child 37035
e85ed7f4d6e3
equal deleted inserted replaced
37033:ce8b96a22ebe 37034:9d6765962b22
53 } FinchBlistManager; 53 } FinchBlistManager;
54 54
55 /** 55 /**
56 * Get the ui-functions. 56 * Get the ui-functions.
57 * 57 *
58 * @return The PurpleBlistUiOps structure populated with the appropriate functions. 58 * Returns: The PurpleBlistUiOps structure populated with the appropriate functions.
59 */ 59 */
60 PurpleBlistUiOps * finch_blist_get_ui_ops(void); 60 PurpleBlistUiOps * finch_blist_get_ui_ops(void);
61 61
62 /** 62 /**
63 * Perform necessary initializations. 63 * Perform necessary initializations.
75 void finch_blist_show(void); 75 void finch_blist_show(void);
76 76
77 /** 77 /**
78 * Get the position of the buddy list. 78 * Get the position of the buddy list.
79 * 79 *
80 * @param x The x-coordinate is set here if not @ NULL. 80 * @x: The x-coordinate is set here if not @ NULL.
81 * @param y The y-coordinate is set here if not @c NULL. 81 * @y: The y-coordinate is set here if not %NULL.
82 * 82 *
83 * @return Returns @c TRUE if the values were set, @c FALSE otherwise. 83 * Returns: Returns %TRUE if the values were set, %FALSE otherwise.
84 */ 84 */
85 gboolean finch_blist_get_position(int *x, int *y); 85 gboolean finch_blist_get_position(int *x, int *y);
86 86
87 /** 87 /**
88 * Set the position of the buddy list. 88 * Set the position of the buddy list.
89 * 89 *
90 * @param x The x-coordinate of the buddy list. 90 * @x: The x-coordinate of the buddy list.
91 * @param y The y-coordinate of the buddy list. 91 * @y: The y-coordinate of the buddy list.
92 */ 92 */
93 void finch_blist_set_position(int x, int y); 93 void finch_blist_set_position(int x, int y);
94 94
95 /** 95 /**
96 * Get the size of the buddy list. 96 * Get the size of the buddy list.
97 * 97 *
98 * @param width The width is set here if not @ NULL. 98 * @width: The width is set here if not @ NULL.
99 * @param height The height is set here if not @c NULL. 99 * @height: The height is set here if not %NULL.
100 * 100 *
101 * @return Returns @c TRUE if the values were set, @c FALSE otherwise. 101 * Returns: Returns %TRUE if the values were set, %FALSE otherwise.
102 */ 102 */
103 gboolean finch_blist_get_size(int *width, int *height); 103 gboolean finch_blist_get_size(int *width, int *height);
104 104
105 /** 105 /**
106 * Set the size of the buddy list. 106 * Set the size of the buddy list.
107 * 107 *
108 * @param width The width of the buddy list. 108 * @width: The width of the buddy list.
109 * @param height The height of the buddy list. 109 * @height: The height of the buddy list.
110 */ 110 */
111 void finch_blist_set_size(int width, int height); 111 void finch_blist_set_size(int width, int height);
112 112
113 /** 113 /**
114 * Get information about a user. Show immediate feedback. 114 * Get information about a user. Show immediate feedback.
115 * 115 *
116 * @param conn The connection to get information fro 116 * @conn: The connection to get information fro
117 * @param name The user to get information about. 117 * @name: The user to get information about.
118 * 118 *
119 * @return Returns the ui-handle for the userinfo notification. 119 * Returns: Returns the ui-handle for the userinfo notification.
120 */ 120 */
121 gpointer finch_retrieve_user_info(PurpleConnection *conn, const char *name); 121 gpointer finch_retrieve_user_info(PurpleConnection *conn, const char *name);
122 122
123 /** 123 /**
124 * Get the tree list of the buddy list. 124 * Get the tree list of the buddy list.
125 * @return The GntTree widget. 125 * Returns: The GntTree widget.
126 */ 126 */
127 GntTree * finch_blist_get_tree(void); 127 GntTree * finch_blist_get_tree(void);
128 128
129 /** 129 /**
130 * Add an alternate buddy list manager. 130 * Add an alternate buddy list manager.
131 * 131 *
132 * @param manager The alternate buddylist manager. 132 * @manager: The alternate buddylist manager.
133 */ 133 */
134 void finch_blist_install_manager(const FinchBlistManager *manager); 134 void finch_blist_install_manager(const FinchBlistManager *manager);
135 135
136 /** 136 /**
137 * Remove an alternate buddy list manager. 137 * Remove an alternate buddy list manager.
138 * 138 *
139 * @param manager The buddy list manager to remove. 139 * @manager: The buddy list manager to remove.
140 */ 140 */
141 void finch_blist_uninstall_manager(const FinchBlistManager *manager); 141 void finch_blist_uninstall_manager(const FinchBlistManager *manager);
142 142
143 /** 143 /**
144 * Find a buddy list manager. 144 * Find a buddy list manager.
145 * 145 *
146 * @param id The identifier for the desired buddy list manager. 146 * @id: The identifier for the desired buddy list manager.
147 * 147 *
148 * @return The manager with the requested identifier, if available. @c NULL otherwise. 148 * Returns: The manager with the requested identifier, if available. %NULL otherwise.
149 */ 149 */
150 FinchBlistManager * finch_blist_manager_find(const char *id); 150 FinchBlistManager * finch_blist_manager_find(const char *id);
151 151
152 /** 152 /**
153 * Request the active buddy list manager to add a node. 153 * Request the active buddy list manager to add a node.
154 * 154 *
155 * @param node The node to add 155 * @node: The node to add
156 */ 156 */
157 void finch_blist_manager_add_node(PurpleBlistNode *node); 157 void finch_blist_manager_add_node(PurpleBlistNode *node);
158 158
159 /*@}*/ 159 /*@}*/
160 160

Mercurial Repository: pidgin3

mercurial