gtkactionable.c 8.47 KB
Newer Older
1 2 3
/*
 * Copyright © 2012 Canonical Limited
 *
Javier Jardón's avatar
Javier Jardón committed
4
 * This library is free software: you can redistribute it and/or modify
5 6 7 8 9 10 11 12 13 14
 * it under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2 of the
 * licence or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
Javier Jardón's avatar
Javier Jardón committed
15
 * License along with this library. If not, see <http://www.gnu.org/licenses/>.
16 17 18 19 20 21 22 23 24 25 26
 *
 * Authors: Ryan Lortie <desrt@desrt.ca>
 */

#include "config.h"

#include "gtkactionable.h"

#include "gtkwidget.h"
#include "gtkintl.h"

Ryan Lortie's avatar
Ryan Lortie committed
27 28 29
/**
 * SECTION:gtkactionable
 * @title: GtkActionable
Matthias Clasen's avatar
Matthias Clasen committed
30 31
 * @short_description: An interface for widgets that can be associated
 *     with actions
Ryan Lortie's avatar
Ryan Lortie committed
32 33 34 35
 *
 * This interface provides a convenient way of associating widgets with
 * actions on a #GtkApplicationWindow or #GtkApplication.
 *
Matthias Clasen's avatar
Matthias Clasen committed
36 37 38
 * It primarily consists of two properties: #GtkActionable:action-name
 * and #GtkActionable:action-target. There are also some convenience APIs
 * for setting these properties.
Ryan Lortie's avatar
Ryan Lortie committed
39
 *
40 41
 * The action will be looked up in action groups that are found among
 * the widgets ancestors. Most commonly, these will be the actions with
42
 * the “win.” or “app.” prefix that are associated with the #GtkApplicationWindow
43
 * or #GtkApplication, but other action groups that are added with
44
 * gtk_widget_insert_action_group() will be consulted as well.
Ryan Lortie's avatar
Ryan Lortie committed
45 46 47 48 49 50 51 52 53 54 55 56
 *
 * Since: 3.4
 **/

/**
 * GtkActionable:
 *
 * An opaque pointer type.
 **/

/**
 * GtkActionableInterface:
57 58 59 60
 * @get_action_name: virtual function for gtk_actionable_get_action_name()
 * @set_action_name: virtual function for gtk_actionable_set_action_name()
 * @get_action_target_value: virtual function for gtk_actionable_get_action_target_value()
 * @set_action_target_value: virtual function for gtk_actionable_set_action_target_value()
Ryan Lortie's avatar
Ryan Lortie committed
61 62 63 64
 *
 * The interface vtable for #GtkActionable.
 **/

65 66 67 68 69 70
G_DEFINE_INTERFACE (GtkActionable, gtk_actionable, GTK_TYPE_WIDGET)

static void
gtk_actionable_default_init (GtkActionableInterface *iface)
{
  g_object_interface_install_property (iface,
71
    g_param_spec_string ("action-name", P_("Action name"),
72 73 74 75
                         P_("The name of the associated action, like 'app.quit'"),
                         NULL, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));

  g_object_interface_install_property (iface,
76
    g_param_spec_variant ("action-target", P_("Action target value"),
77 78 79 80
                          P_("The parameter for action invocations"),
                          G_VARIANT_TYPE_ANY, NULL, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
}

Ryan Lortie's avatar
Ryan Lortie committed
81 82 83 84 85 86 87 88
/**
 * gtk_actionable_get_action_name:
 * @actionable: a #GtkActionable widget
 *
 * Gets the action name for @actionable.
 *
 * See gtk_actionable_set_action_name() for more information.
 *
89
 * Returns: (nullable): the action name, or %NULL if none is set
Ryan Lortie's avatar
Ryan Lortie committed
90 91 92
 *
 * Since: 3.4
 **/
93 94 95 96 97 98 99 100 101
const gchar *
gtk_actionable_get_action_name (GtkActionable *actionable)
{
  g_return_val_if_fail (GTK_IS_ACTIONABLE (actionable), NULL);

  return GTK_ACTIONABLE_GET_IFACE (actionable)
    ->get_action_name (actionable);
}

Ryan Lortie's avatar
Ryan Lortie committed
102 103 104
/**
 * gtk_actionable_set_action_name:
 * @actionable: a #GtkActionable widget
105
 * @action_name: (nullable): an action name, or %NULL
Ryan Lortie's avatar
Ryan Lortie committed
106 107 108 109 110 111 112 113
 *
 * Specifies the name of the action with which this widget should be
 * associated.  If @action_name is %NULL then the widget will be
 * unassociated from any previous action.
 *
 * Usually this function is used when the widget is located (or will be
 * located) within the hierarchy of a #GtkApplicationWindow.
 *
114
 * Names are of the form “win.save” or “app.quit” for actions on the
Ryan Lortie's avatar
Ryan Lortie committed
115 116 117 118 119 120
 * containing #GtkApplicationWindow or its associated #GtkApplication,
 * respectively.  This is the same form used for actions in the #GMenu
 * associated with the window.
 *
 * Since: 3.4
 **/
121 122 123 124 125 126 127 128 129 130
void
gtk_actionable_set_action_name (GtkActionable *actionable,
                                const gchar   *action_name)
{
  g_return_if_fail (GTK_IS_ACTIONABLE (actionable));

  GTK_ACTIONABLE_GET_IFACE (actionable)
    ->set_action_name (actionable, action_name);
}

Ryan Lortie's avatar
Ryan Lortie committed
131 132 133 134
/**
 * gtk_actionable_get_action_target_value:
 * @actionable: a #GtkActionable widget
 *
Murray Cumming's avatar
Murray Cumming committed
135
 * Gets the current target value of @actionable.
Ryan Lortie's avatar
Ryan Lortie committed
136
 *
137
 * See gtk_actionable_set_action_target_value() for more information.
Ryan Lortie's avatar
Ryan Lortie committed
138 139 140 141 142
 *
 * Returns: (transfer none): the current target value
 *
 * Since: 3.4
 **/
143 144 145 146 147 148 149 150 151
GVariant *
gtk_actionable_get_action_target_value (GtkActionable *actionable)
{
  g_return_val_if_fail (GTK_IS_ACTIONABLE (actionable), NULL);

  return GTK_ACTIONABLE_GET_IFACE (actionable)
    ->get_action_target_value (actionable);
}

Ryan Lortie's avatar
Ryan Lortie committed
152 153 154 155 156 157 158 159 160 161 162
/**
 * gtk_actionable_set_action_target_value:
 * @actionable: a #GtkActionable widget
 * @target_value: a #GVariant to set as the target value, or %NULL
 *
 * Sets the target value of an actionable widget.
 *
 * If @target_value is %NULL then the target value is unset.
 *
 * The target value has two purposes.  First, it is used as the
 * parameter to activation of the action associated with the
Matthias Clasen's avatar
Matthias Clasen committed
163
 * #GtkActionable widget. Second, it is used to determine if the widget
164
 * should be rendered as “active” — the widget is active if the state
Ryan Lortie's avatar
Ryan Lortie committed
165 166 167
 * is equal to the given target.
 *
 * Consider the example of associating a set of buttons with a #GAction
168
 * with string state in a typical “radio button” situation.  Each button
Ryan Lortie's avatar
Ryan Lortie committed
169 170 171
 * will be associated with the same action, but with a different target
 * value for that action.  Clicking on a particular button will activate
 * the action with the target of that button, which will typically cause
172
 * the action’s state to change to that value.  Since the action’s state
Ryan Lortie's avatar
Ryan Lortie committed
173 174 175 176 177 178
 * is now equal to the target value of the button, the button will now
 * be rendered as active (and the other buttons, with different targets,
 * rendered inactive).
 *
 * Since: 3.4
 **/
179 180 181 182 183 184 185 186 187 188
void
gtk_actionable_set_action_target_value (GtkActionable *actionable,
                                        GVariant      *target_value)
{
  g_return_if_fail (GTK_IS_ACTIONABLE (actionable));

  GTK_ACTIONABLE_GET_IFACE (actionable)
    ->set_action_target_value (actionable, target_value);
}

Ryan Lortie's avatar
Ryan Lortie committed
189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206
/**
 * gtk_actionable_set_action_target:
 * @actionable: a #GtkActionable widget
 * @format_string: a GVariant format string
 * @...: arguments appropriate for @format_string
 *
 * Sets the target of an actionable widget.
 *
 * This is a convenience function that calls g_variant_new() for
 * @format_string and uses the result to call
 * gtk_actionable_set_action_target_value().
 *
 * If you are setting a string-valued target and want to set the action
 * name at the same time, you can use
 * gtk_actionable_set_detailed_action_name ().
 *
 * Since: 3.4
 **/
207 208 209 210 211 212 213 214 215 216 217 218
void
gtk_actionable_set_action_target (GtkActionable *actionable,
                                  const gchar   *format_string,
                                  ...)
{
  va_list ap;

  va_start (ap, format_string);
  gtk_actionable_set_action_target_value (actionable, g_variant_new_va (format_string, NULL, &ap));
  va_end (ap);
}

Ryan Lortie's avatar
Ryan Lortie committed
219 220 221 222 223 224 225 226
/**
 * gtk_actionable_set_detailed_action_name:
 * @actionable: a #GtkActionable widget
 * @detailed_action_name: the detailed action name
 *
 * Sets the action-name and associated string target value of an
 * actionable widget.
 *
227 228
 * @detailed_action_name is a string in the format accepted by
 * g_action_parse_detailed_name().
Ryan Lortie's avatar
Ryan Lortie committed
229
 *
230 231 232 233 234
 * (Note that prior to version 3.22.25,
 * this function is only usable for actions with a simple "s" target, and
 * @detailed_action_name must be of the form `"action::target"` where
 * `action` is the action name and `target` is the string to use
 * as the target.)
Ryan Lortie's avatar
Ryan Lortie committed
235 236 237
 *
 * Since: 3.4
 **/
238 239 240 241
void
gtk_actionable_set_detailed_action_name (GtkActionable *actionable,
                                         const gchar   *detailed_action_name)
{
242 243 244
  GError *error = NULL;
  GVariant *target;
  gchar *name;
245 246 247 248 249 250 251 252

  if (detailed_action_name == NULL)
    {
      gtk_actionable_set_action_name (actionable, NULL);
      gtk_actionable_set_action_target_value (actionable, NULL);
      return;
    }

253 254 255 256 257 258 259 260 261
  if (!g_action_parse_detailed_name (detailed_action_name, &name, &target, &error))
    g_error ("gtk_actionable_set_detailed_action_name: %s", error->message);

  gtk_actionable_set_action_name (actionable, name);
  gtk_actionable_set_action_target_value (actionable, target);

  if (target)
    g_variant_unref (target);
  g_free (name);
262
}
263