Mercurial > pidgin
comparison finch/libgnt/gntbindable.h @ 20306:665d6d7eea83
applied changes from 88f296b3653b5a7578a7581c1582d37390c9d212
through 4bbc209c8076ef89135700af844ec6bb04602c0a
author | Luke Schierer <lschiere@pidgin.im> |
---|---|
date | Fri, 19 Oct 2007 17:06:53 +0000 |
parents | 44b4e8bd759b |
children | 8d73d519155a ae330012956f |
comparison
equal
deleted
inserted
replaced
20305:636e6a3a5b67 | 20306:665d6d7eea83 |
---|---|
103 }; | 103 }; |
104 | 104 |
105 /*GntBindableAction *gnt_bindable_action_parse(const char *name);*/ | 105 /*GntBindableAction *gnt_bindable_action_parse(const char *name);*/ |
106 | 106 |
107 /** | 107 /** |
108 * | 108 * Free a bindable action. |
109 * @param action | 109 * |
110 * @param action The bindable action. | |
110 */ | 111 */ |
111 void gnt_bindable_action_free(GntBindableAction *action); | 112 void gnt_bindable_action_free(GntBindableAction *action); |
112 | 113 |
113 /** | 114 /** |
114 * | 115 * Free a GntBindableActionParam. |
115 * @param param | 116 * |
117 * @param param The GntBindableActionParam to free. | |
116 */ | 118 */ |
117 void gnt_bindable_action_param_free(GntBindableActionParam *param); | 119 void gnt_bindable_action_param_free(GntBindableActionParam *param); |
118 | 120 |
119 /** | 121 /** |
120 * | 122 * Register a bindable action for a class. |
121 * @param klass | 123 * |
122 * @param name | 124 * @param klass The class the binding is for. |
123 * @param callback | 125 * @param name The name of the binding. |
124 * @param trigger | 126 * @param callback The callback for the binding. |
127 * @param trigger The default trigger for the binding, or @c NULL, followed by a NULL-terminated | |
128 * list of default parameters. | |
125 */ | 129 */ |
126 void gnt_bindable_class_register_action(GntBindableClass *klass, const char *name, GntBindableActionCallback callback, const char *trigger, ...); | 130 void gnt_bindable_class_register_action(GntBindableClass *klass, const char *name, GntBindableActionCallback callback, const char *trigger, ...); |
127 | 131 |
128 /** | 132 /** |
129 * | 133 * Register a key-binding to an existing action. |
130 * @param klass | 134 * |
131 * @param name | 135 * @param klass The class the binding is for. |
132 * @param trigger | 136 * @param name The name of the binding. |
137 * @param trigger A new trigger for the binding, followed by a @c NULL-terminated list of parameters for the callback. | |
133 */ | 138 */ |
134 void gnt_bindable_register_binding(GntBindableClass *klass, const char *name, const char *trigger, ...); | 139 void gnt_bindable_register_binding(GntBindableClass *klass, const char *name, const char *trigger, ...); |
135 | 140 |
136 /** | 141 /** |
137 * | 142 * Perform an action from a keybinding. |
138 * @param bindable | |
139 * @param keys | |
140 * | 143 * |
141 * @return | 144 * @param bindable The bindable object. |
145 * @param keys The key to trigger the action. | |
146 * | |
147 * @return @c TRUE if the action was performed successfully, @c FALSE otherwise. | |
142 */ | 148 */ |
143 gboolean gnt_bindable_perform_action_key(GntBindable *bindable, const char *keys); | 149 gboolean gnt_bindable_perform_action_key(GntBindable *bindable, const char *keys); |
144 | 150 |
145 /** | 151 /** |
146 * | 152 * Perform an action on a bindable object. |
147 * @param bindable | |
148 * @param name | |
149 * | 153 * |
150 * @return | 154 * @param bindable The bindable object. |
155 * @param name The action to perform, followed by a @c NULL-terminated list of parameters. | |
156 * | |
157 * @return @c TRUE if the action was performed successfully, @c FALSE otherwise. | |
151 */ | 158 */ |
152 gboolean gnt_bindable_perform_action_named(GntBindable *bindable, const char *name, ...); | 159 gboolean gnt_bindable_perform_action_named(GntBindable *bindable, const char *name, ...); |
153 | 160 |
154 /** | 161 /** |
155 * Returns a GntTree populated with "key" -> "binding" for the widget. | 162 * Returns a GntTree populated with "key" -> "binding" for the widget. |
156 */ | 163 * |
157 /** | 164 * @param widget The object to list the bindings for. |
158 * | 165 * |
159 * @param widget | 166 * @return The GntTree. |
160 * | 167 */ |
161 * @return | |
162 */ | |
163 GntBindable * gnt_bindable_bindings_view(GntBindable *bind); | 168 GntBindable * gnt_bindable_bindings_view(GntBindable *bind); |
164 | 169 |
165 /** | 170 /** |
166 * | 171 * Builds a window that list the key bindings for a GntBindable object. |
167 * Builds a window that list the key bindings for a GntBindable object. From this window a user can select a listing to rebind a new key for the given action. | 172 * From this window a user can select a listing to rebind a new key for the given action. |
168 * | |
169 */ | |
170 /** | |
171 * | 173 * |
172 * @param bindable | 174 * @param bindable The object to list the bindings for. |
173 * | 175 * |
174 * @return | 176 * @return @c TRUE |
175 */ | 177 */ |
176 | 178 |
177 gboolean gnt_bindable_build_help_window(GntBindable *bindable); | 179 gboolean gnt_bindable_build_help_window(GntBindable *bindable); |
178 | 180 |
179 G_END_DECLS | 181 G_END_DECLS |