diff options
| author | Diego Escalante Urrelo <diegoe@igalia.com> | 2012-01-23 23:04:48 +0800 |
|---|---|---|
| committer | Diego Escalante Urrelo <diegoe@igalia.com> | 2012-01-24 00:22:08 +0800 |
| commit | 0257e7153ecbe593a0b13cca3ec90f9db03705e7 (patch) | |
| tree | 6bb32b14e34068132ca035bcb3037d9a698042af | |
| parent | 0caf6e516601a5167b4e3f18593dcb75d85b8452 (diff) | |
| download | gsoc2013-epiphany-0257e7153ecbe593a0b13cca3ec90f9db03705e7.tar gsoc2013-epiphany-0257e7153ecbe593a0b13cca3ec90f9db03705e7.tar.gz gsoc2013-epiphany-0257e7153ecbe593a0b13cca3ec90f9db03705e7.tar.bz2 gsoc2013-epiphany-0257e7153ecbe593a0b13cca3ec90f9db03705e7.tar.lz gsoc2013-epiphany-0257e7153ecbe593a0b13cca3ec90f9db03705e7.tar.xz gsoc2013-epiphany-0257e7153ecbe593a0b13cca3ec90f9db03705e7.tar.zst gsoc2013-epiphany-0257e7153ecbe593a0b13cca3ec90f9db03705e7.zip | |
ephy-action-helper: document flags API
https://bugzilla.gnome.org/show_bug.cgi?id=668510
| -rw-r--r-- | src/ephy-action-helper.c | 14 |
1 files changed, 14 insertions, 0 deletions
diff --git a/src/ephy-action-helper.c b/src/ephy-action-helper.c index ba48eb9cb..4dbcdce1d 100644 --- a/src/ephy-action-helper.c +++ b/src/ephy-action-helper.c @@ -23,6 +23,20 @@ #define SENSITIVITY_KEY "EphyAction::Sensitivity" +/** + * ephy_action_change_sensitivity_flags: + * @action: a #GtkAction object + * @flags: arbitrary combination of bit flags, defined by the user + * @set: %TRUE if @flags should be added to @action + * + * This helper function provides an extra layer on top of #GtkAction to + * manage its sensitivity. It uses bit @flags defined by the user, like + * in ephy-window.c, SENS_FLAG_*. + * + * Effectively, the @action won't be sensitive until it has no flags + * set. This means you can stack @flags for different events or + * conditions at the same time. + */ void ephy_action_change_sensitivity_flags (GtkAction *action, guint flags, |