* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
- * License along with this library; if not, write to the
- * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
- * Boston, MA 02111-1307, USA.
+ * License along with this library. If not, see <http://www.gnu.org/licenses/>.
*/
/*
#include "gtkactivatable.h"
#include "gtkprivate.h"
#include "gtkintl.h"
+#include "a11y/gtkradiomenuitemaccessible.h"
+
+/**
+ * SECTION:gtkradiomenuitem
+ * @Short_description: A choice from multiple check menu items
+ * @Title: GtkRadioMenuItem
+ * @See_also: #GtkMenuItem, #GtkCheckMenuItem
+ *
+ * A radio menu item is a check menu item that belongs to a group. At each
+ * instant exactly one of the radio menu items from a group is selected.
+ *
+ * The group list does not need to be freed, as each #GtkRadioMenuItem will
+ * remove itself and its list item when it is destroyed.
+ *
+ * The correct way to create a group of radio menu items is approximatively
+ * this:
+ *
+ * <example>
+ * <title>How to create a group of radio menu items.</title>
+ * <programlisting>
+ * GSList *group = NULL;
+ * GtkWidget *item;
+ * gint i;
+ *
+ * for (i = 0; i < 5; i++)
+ * {
+ * item = gtk_radio_menu_item_new_with_label (group, "This is an example");
+ * group = gtk_radio_menu_item_get_group (GTK_RADIO_MENU_ITEM (item));
+ * if (i == 1)
+ * gtk_check_menu_item_set_active (GTK_CHECK_MENU_ITEM (item), TRUE);
+ * }
+ * </programlisting>
+ * </example>
+ */
struct _GtkRadioMenuItemPrivate
G_DEFINE_TYPE (GtkRadioMenuItem, gtk_radio_menu_item, GTK_TYPE_CHECK_MENU_ITEM)
+/**
+ * gtk_radio_menu_item_new:
+ * @group: (element-type GtkRadioMenuItem): the group to which the
+ * radio menu item is to be attached
+ *
+ * Creates a new #GtkRadioMenuItem.
+ *
+ * Returns: a new #GtkRadioMenuItem
+ */
GtkWidget*
gtk_radio_menu_item_new (GSList *group)
{
GSList *slist;
case PROP_GROUP:
- if (G_VALUE_HOLDS_OBJECT (value))
- slist = gtk_radio_menu_item_get_group ((GtkRadioMenuItem*) g_value_get_object (value));
- else
- slist = NULL;
+ slist = g_value_get_object (value);
+ if (slist)
+ slist = gtk_radio_menu_item_get_group ((GtkRadioMenuItem*) g_value_get_object (value));
gtk_radio_menu_item_set_group (radio_menu_item, slist);
break;
default:
}
}
+/**
+ * gtk_radio_menu_item_set_group:
+ * @radio_menu_item: a #GtkRadioMenuItem.
+ * @group: (element-type GtkRadioMenuItem): the new group.
+ *
+ * Sets the group of a radio menu item, or changes it.
+ */
void
gtk_radio_menu_item_set_group (GtkRadioMenuItem *radio_menu_item,
GSList *group)
gtk_radio_menu_item_new_with_label (GSList *group,
const gchar *label)
{
- GtkWidget *radio_menu_item;
- GtkWidget *accel_label;
-
- radio_menu_item = gtk_radio_menu_item_new (group);
- accel_label = gtk_accel_label_new (label);
- gtk_misc_set_alignment (GTK_MISC (accel_label), 0.0, 0.5);
- gtk_container_add (GTK_CONTAINER (radio_menu_item), accel_label);
- gtk_accel_label_set_accel_widget (GTK_ACCEL_LABEL (accel_label), radio_menu_item);
- gtk_widget_show (accel_label);
-
- return radio_menu_item;
+ return g_object_new (GTK_TYPE_RADIO_MENU_ITEM,
+ "group", (group) ? group->data : NULL,
+ "label", label,
+ NULL);
}
/**
* gtk_radio_menu_item_new_with_mnemonic:
- * @group: group the radio menu item is inside
+ * @group: (element-type GtkRadioMenuItem): group the radio menu item is inside
* @label: the text of the button, with an underscore in front of the
* mnemonic character
- * @returns: a new #GtkRadioMenuItem
*
* Creates a new #GtkRadioMenuItem containing a label. The label
* will be created using gtk_label_new_with_mnemonic(), so underscores
* in @label indicate the mnemonic for the menu item.
- **/
+ *
+ * Returns: a new #GtkRadioMenuItem
+ */
GtkWidget*
gtk_radio_menu_item_new_with_mnemonic (GSList *group,
const gchar *label)
{
- GtkWidget *radio_menu_item;
- GtkWidget *accel_label;
-
- radio_menu_item = gtk_radio_menu_item_new (group);
- accel_label = g_object_new (GTK_TYPE_ACCEL_LABEL, NULL);
- gtk_label_set_text_with_mnemonic (GTK_LABEL (accel_label), label);
- gtk_misc_set_alignment (GTK_MISC (accel_label), 0.0, 0.5);
-
- gtk_container_add (GTK_CONTAINER (radio_menu_item), accel_label);
- gtk_accel_label_set_accel_widget (GTK_ACCEL_LABEL (accel_label), radio_menu_item);
- gtk_widget_show (accel_label);
-
- return radio_menu_item;
+ return g_object_new (GTK_TYPE_RADIO_MENU_ITEM,
+ "group", (group) ? group->data : NULL,
+ "label", label,
+ "use-underline", TRUE,
+ NULL);
}
/**
- * gtk_radio_menu_item_new_from_widget:
+ * gtk_radio_menu_item_new_from_widget: (constructor)
* @group: An existing #GtkRadioMenuItem
*
* Creates a new #GtkRadioMenuItem adding it to the same group as @group.
*
- * Return value: (transfer full): The new #GtkRadioMenuItem
+ * Return value: (transfer none): The new #GtkRadioMenuItem
*
* Since: 2.4
**/
}
/**
- * gtk_radio_menu_item_new_with_mnemonic_from_widget:
+ * gtk_radio_menu_item_new_with_mnemonic_from_widget: (constructor)
* @group: An existing #GtkRadioMenuItem
* @label: the text of the button, with an underscore in front of the
* mnemonic character
*
* The new #GtkRadioMenuItem is added to the same group as @group.
*
- * Return value: (transfer full): The new #GtkRadioMenuItem
+ * Return value: (transfer none): The new #GtkRadioMenuItem
*
* Since: 2.4
**/
}
/**
- * gtk_radio_menu_item_new_with_label_from_widget:
+ * gtk_radio_menu_item_new_with_label_from_widget: (constructor)
* @group: an existing #GtkRadioMenuItem
* @label: the text for the label
*
* Creates a new GtkRadioMenuItem whose child is a simple GtkLabel.
* The new #GtkRadioMenuItem is added to the same group as @group.
*
- * Return value: (transfer full): The new #GtkRadioMenuItem
+ * Return value: (transfer none): The new #GtkRadioMenuItem
*
* Since: 2.4
**/
* Returns the group to which the radio menu item belongs, as a #GList of
* #GtkRadioMenuItem. The list belongs to GTK+ and should not be freed.
*
- * Returns: (transfer none): the group of @radio_menu_item
+ * Returns: (element-type GtkRadioMenuItem) (transfer none): the group
+ * of @radio_menu_item
*/
GSList*
gtk_radio_menu_item_get_group (GtkRadioMenuItem *radio_menu_item)
return radio_menu_item->priv->group;
}
-
static void
gtk_radio_menu_item_class_init (GtkRadioMenuItemClass *klass)
{
- GObjectClass *gobject_class;
+ GObjectClass *gobject_class;
GtkWidgetClass *widget_class;
GtkMenuItemClass *menu_item_class;
widget_class->destroy = gtk_radio_menu_item_destroy;
+ gtk_widget_class_set_accessible_type (widget_class, GTK_TYPE_RADIO_MENU_ITEM_ACCESSIBLE);
+
menu_item_class->activate = gtk_radio_menu_item_activate;
/**