1 /* ATK - Accessibility Toolkit
2 * Copyright 2001 Sun Microsystems Inc.
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Lesser General Public
6 * License as published by the Free Software Foundation; either
7 * version 2 of the License, or (at your option) any later version.
9 * This library is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Lesser General Public License for more details.
14 * You should have received a copy of the GNU Lesser General Public
15 * License along with this library; if not, write to the
16 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
17 * Boston, MA 02111-1307, USA.
20 #include "atkaction.h"
23 atk_action_get_type (void)
25 static GType type = 0;
30 sizeof (AtkActionIface),
32 (GBaseFinalizeFunc) NULL,
36 type = g_type_register_static (G_TYPE_INTERFACE, "AtkAction", &tinfo, 0);
43 * atk_action_do_action:
44 * @action: a #GObject instance that implements AtkActionIface
45 * @i: the action index corresponding to the action to be performed
47 * Perform the specified action on the object.
49 * Returns: %TRUE if success, %FALSE otherwise
53 atk_action_do_action (AtkAction *obj,
56 AtkActionIface *iface;
58 g_return_val_if_fail (ATK_IS_ACTION (obj), FALSE);
60 iface = ATK_ACTION_GET_IFACE (obj);
63 return (iface->do_action) (obj, i);
69 * atk_action_get_n_actions:
70 * @action: a #GObject instance that implements AtkActionIface
72 * Gets the number of accessible actions available on the object.
73 * If there are more than one, the first one is considered the
74 * "default" action of the object.
76 * Returns: a the number of actions, or 0 if @action does not
77 * implement this interface.
80 atk_action_get_n_actions (AtkAction *obj)
82 AtkActionIface *iface;
84 g_return_val_if_fail (ATK_IS_ACTION (obj), 0);
86 iface = ATK_ACTION_GET_IFACE (obj);
88 if (iface->get_n_actions)
89 return (iface->get_n_actions) (obj);
95 * atk_action_get_description:
96 * @action: a #GObject instance that implements AtkActionIface
97 * @i: the action index corresponding to the action to be performed
99 * Returns a description of the specified action of the object.
101 * Returns a description string, or %NULL
102 * if @action does not implement this interface.
104 G_CONST_RETURN gchar*
105 atk_action_get_description (AtkAction *obj,
108 AtkActionIface *iface;
110 g_return_val_if_fail (ATK_IS_ACTION (obj), NULL);
112 iface = ATK_ACTION_GET_IFACE (obj);
114 if (iface->get_description)
115 return (iface->get_description) (obj, i);
121 * atk_action_get_name:
122 * @action: a #GObject instance that implements AtkActionIface
123 * @i: the action index corresponding to the action to be performed
125 * Returns the name of the specified action of the object.
127 * Returns a name string, or %NULL
128 * if @action does not implement this interface.
130 G_CONST_RETURN gchar*
131 atk_action_get_name (AtkAction *obj,
134 AtkActionIface *iface;
136 g_return_val_if_fail (ATK_IS_ACTION (obj), NULL);
138 iface = ATK_ACTION_GET_IFACE (obj);
141 return (iface->get_name) (obj, i);
147 * atk_action_get_localized_name:
148 * @action: a #GObject instance that implements AtkActionIface
149 * @i: the action index corresponding to the action to be performed
151 * Returns the localized name of the specified action of the object.
153 * Returns a name string, or %NULL
154 * if @action does not implement this interface.
156 G_CONST_RETURN gchar*
157 atk_action_get_localized_name (AtkAction *obj,
160 AtkActionIface *iface;
162 g_return_val_if_fail (ATK_IS_ACTION (obj), NULL);
164 iface = ATK_ACTION_GET_IFACE (obj);
166 if (iface->get_localized_name)
167 return (iface->get_localized_name) (obj, i);
173 * atk_action_get_keybinding:
174 * @action: a #GObject instance that implements AtkActionIface
175 * @i: the action index corresponding to the action to be performed
177 * Returns a keybinding associated with this action, if one exists.
179 * Returns a string representing the keybinding, or %NULL
180 * if there is no keybinding for this action.
183 G_CONST_RETURN gchar*
184 atk_action_get_keybinding (AtkAction *obj,
187 AtkActionIface *iface;
189 g_return_val_if_fail (ATK_IS_ACTION (obj), NULL);
191 iface = ATK_ACTION_GET_IFACE (obj);
193 if (iface->get_keybinding)
194 return (iface->get_keybinding) (obj, i);
200 * atk_action_set_description:
201 * @action: a #GObject instance that implements AtkActionIface
202 * @i: the action index corresponding to the action to be performed
203 * @desc: the description to be assigned to this action
205 * Sets a description of the specified action of the object.
207 * Returns: a gboolean representing if the description was successfully set;
210 atk_action_set_description (AtkAction *obj,
214 AtkActionIface *iface;
216 g_return_val_if_fail (ATK_IS_ACTION (obj), FALSE);
218 iface = ATK_ACTION_GET_IFACE (obj);
220 if (iface->set_description)
221 return (iface->set_description) (obj, i, desc);