* a unique name which needs to be specified upon creation.
*
* Return value: new binding set
- **/
+ */
GtkBindingSet*
gtk_binding_set_new (const gchar *set_name)
{
* demand by this function.
*
* Return value: the binding set corresponding to @object_class
- **/
+ */
GtkBindingSet*
gtk_binding_set_by_class (gpointer object_class)
{
* a class used in gtk_binding_set_by_class().
*
* Return value: %NULL or the specified binding set
- **/
+ */
GtkBindingSet*
gtk_binding_set_find (const gchar *set_name)
{
/**
* gtk_binding_set_activate:
- * @binding_set: @binding_set to activate
+ * @binding_set: a #GtkBindingSet set to activate
* @keyval: key value of the binding
* @modifiers: key modifier of the binding
* @object: object to activate when binding found
* @binding_set and activate the binding on @object.
*
* Return value: %TRUE if a binding was found and activated
- **/
+ */
gboolean
gtk_binding_set_activate (GtkBindingSet *binding_set,
guint keyval,
entry = binding_entry_new (binding_set, keyval, modifiers);
}
+/**
+ * gtk_binding_entry_add:
+ * @binding_set: #a GtkBindingSet to clear an entry of
+ * @keyval: key value of binding to clear
+ * @modifiers: key modifier of binding to clear
+ *
+ * Adds a binding entry.
+ *
+ * Deprecated: 2.12: Use gtk_binding_entry_add_signal() instead.
+ */
+
/**
* gtk_binding_entry_clear:
- * @binding_set: @binding_set to clear an entry of
+ * @binding_set: binding set to clear an entry of
* @keyval: key value of binding to clear
* @modifiers: key modifier of binding to clear
*
- * Use of this function is deprecated.
- **/
+ * Clears a binding entry.
+ *
+ * Deprecated: 2.12: Use gtk_binding_entry_remove() instead.
+ */
void
gtk_binding_entry_clear (GtkBindingSet *binding_set,
guint keyval,
/**
* gtk_binding_entry_skip:
- * @binding_set: @binding_set to skip an entry of
+ * @binding_set: a #GtkBindingSet to skip an entry of
* @keyval: key value of binding to skip
* @modifiers: key modifier of binding to skip
*
- * Since: 2.12
- *
* Install a binding on @binding_set which causes key lookups
* to be aborted, to prevent bindings from lower priority sets
* to be activated.
- **/
+ *
+ * Since: 2.12
+ */
void
gtk_binding_entry_skip (GtkBindingSet *binding_set,
guint keyval,
/**
* gtk_binding_entry_remove:
- * @binding_set: @binding_set to remove an entry of
+ * @binding_set: a #GtkBindingSet to remove an entry of
* @keyval: key value of binding to remove
* @modifiers: key modifier of binding to remove
*
* Remove a binding previously installed via
* gtk_binding_entry_add_signal() on @binding_set.
- **/
+ */
void
gtk_binding_entry_remove (GtkBindingSet *binding_set,
guint keyval,
/**
* gtk_binding_entry_add_signall:
- * @binding_set: binding set to add a signal to
+ * @binding_set: a #GtkBindingSet to add a signal to
* @keyval: key value
* @modifiers: key modifier
* @signal_name: signal name to be bound
* @binding_args: list of #GtkBindingArg signal arguments
*
- * Deprecated.
- **/
+ * Override or install a new key binding for @keyval with @modifiers on
+ * @binding_set.
+ */
void
gtk_binding_entry_add_signall (GtkBindingSet *binding_set,
guint keyval,
/**
* gtk_binding_entry_add_signal:
- * @binding_set: @binding_set to install an entry for
+ * @binding_set: a #GtkBindingSet to install an entry for
* @keyval: key value of binding to install
* @modifiers: key modifier of binding to install
* @signal_name: signal to execute upon activation
* @Varargs: arguments to @signal_name
*
* Override or install a new key binding for @keyval with @modifiers on
- * @binding_set. When the binding is activated, @signal_name will be
+ * @binding_set. When the binding is activated, @signal_name will be
* emitted on the target widget, with @n_args @Varargs used as
* arguments.
- **/
+ */
void
gtk_binding_entry_add_signal (GtkBindingSet *binding_set,
guint keyval,
/**
* gtk_binding_set_add_path:
- * @binding_set: binding set to add a path to
+ * @binding_set: a #GtkBindingSet to add a path to
* @path_type: path type the pattern applies to
* @path_pattern: the actual match pattern
* @priority: binding priority
*
* This function is used internally by the GtkRC parsing mechanism to
* assign match patterns to #GtkBindingSet structures.
- **/
+ */
void
gtk_binding_set_add_path (GtkBindingSet *binding_set,
GtkPathType path_type,
* binding on @object.
*
* Return value: %TRUE if a binding was found and activated
- **/
+ */
gboolean
-gtk_bindings_activate (GtkObject *object,
- guint keyval,
- GdkModifierType modifiers)
+gtk_bindings_activate (GtkObject *object,
+ guint keyval,
+ GdkModifierType modifiers)
{
GSList *entries = NULL;
GdkDisplay *display;
* @event, and if one was found, activate it.
*
* Return value: %TRUE if a matching key binding was found
- **/
+ */
gboolean
-gtk_bindings_activate_event (GtkObject *object,
- GdkEventKey *event)
+gtk_bindings_activate_event (GtkObject *object,
+ GdkEventKey *event)
{
GSList *entries = NULL;
GdkDisplay *display;
* gtk_binding_parse_binding:
* @scanner: GtkRC scanner
*
- * Deprecated as public API, used only internally.
+ * Parse a binding entry from a gtkrc file.
*
* Return value: expected token upon errors, %G_TOKEN_NONE on success.
- **/
+ *
+ * Deprecated: 2.12: There should be no need to call this function outside GTK+.
+ */
guint
gtk_binding_parse_binding (GScanner *scanner)
{
/**
* _gtk_binding_reset_parsed:
*
- * Removing all binding sets that were added by
- * gtk_binding_parse_binding()
- **/
+ * Remove all binding sets that were added by gtk_binding_parse_binding().
+ */
void
_gtk_binding_reset_parsed (void)
{
projects / ~andy / gtk / blobdiff