+++ /dev/null
-<!-- ##### SECTION Title ##### -->
-GtkCheckMenuItem
-
-<!-- ##### SECTION Short_Description ##### -->
-A menu item with a check box
-
-<!-- ##### SECTION Long_Description ##### -->
-<para>
-A #GtkCheckMenuItem is a menu item that maintains the state of a boolean
-value in addition to a #GtkMenuItem's usual role in activating application
-code.
-</para>
-
-<para>
-A check box indicating the state of the boolean value is displayed
-at the left side of the #GtkMenuItem. Activating the #GtkMenuItem
-toggles the value.
-</para>
-
-<!-- ##### SECTION See_Also ##### -->
-<para>
-
-</para>
-
-<!-- ##### SECTION Stability_Level ##### -->
-
-
-<!-- ##### SECTION Image ##### -->
-
-
-<!-- ##### STRUCT GtkCheckMenuItem ##### -->
-<para>
-The #GtkCheckMenuItem-struct struct contains only private fields that
-should not be directly accessed.
-</para>
-
-
-<!-- ##### SIGNAL GtkCheckMenuItem::toggled ##### -->
-<para>
-This signal is emitted when the state of the check box is changed.
-</para>
-
-<para>
-A signal handler can use gtk_check_menu_item_get_active()
-to discover the new state.
-</para>
-
-@checkmenuitem: the object which received the signal.
-
-<!-- ##### ARG GtkCheckMenuItem:active ##### -->
-<para>
-
-</para>
-
-<!-- ##### ARG GtkCheckMenuItem:draw-as-radio ##### -->
-<para>
-
-</para>
-
-<!-- ##### ARG GtkCheckMenuItem:inconsistent ##### -->
-<para>
-
-</para>
-
-<!-- ##### ARG GtkCheckMenuItem:indicator-size ##### -->
-<para>
-
-</para>
-
-<!-- ##### FUNCTION gtk_check_menu_item_new ##### -->
-<para>
-Creates a new #GtkCheckMenuItem.
-</para>
-
-@void:
-@Returns: a new #GtkCheckMenuItem.
-
-
-<!-- ##### FUNCTION gtk_check_menu_item_new_with_label ##### -->
-<para>
-Creates a new #GtkCheckMenuItem with a label.
-</para>
-
-@label: the string to use for the label.
-@Returns: a new #GtkCheckMenuItem.
-
-
-<!-- ##### FUNCTION gtk_check_menu_item_new_with_mnemonic ##### -->
-<para>
-
-</para>
-
-@label:
-@Returns:
-
-
-<!-- ##### FUNCTION gtk_check_menu_item_get_active ##### -->
-<para>
-
-</para>
-
-@check_menu_item:
-@Returns:
-
-
-<!-- ##### FUNCTION gtk_check_menu_item_set_active ##### -->
-<para>
-Sets the active state of the menu item's check box.
-</para>
-
-@check_menu_item: a #GtkCheckMenuItem.
-@is_active: boolean value indicating whether the check box is active.
-
-
-<!-- ##### FUNCTION gtk_check_menu_item_toggled ##### -->
-<para>
-Emits the GtkCheckMenuItem::toggled signal.
-</para>
-
-@check_menu_item: a #GtkCheckMenuItem.
-
-
-<!-- ##### FUNCTION gtk_check_menu_item_get_inconsistent ##### -->
-<para>
-
-</para>
-
-@check_menu_item:
-@Returns:
-
-
-<!-- ##### FUNCTION gtk_check_menu_item_set_inconsistent ##### -->
-<para>
-
-</para>
-
-@check_menu_item:
-@setting:
-
-
-<!-- ##### FUNCTION gtk_check_menu_item_set_draw_as_radio ##### -->
-<para>
-
-</para>
-
-@check_menu_item:
-@draw_as_radio:
-
-
-<!-- ##### FUNCTION gtk_check_menu_item_get_draw_as_radio ##### -->
-<para>
-
-</para>
-
-@check_menu_item:
-@Returns:
-
-
#include "gtkprivate.h"
#include "gtkintl.h"
+
+/**
+ * SECTION:gtkcheckmenuitem
+ * @Short_description: A menu item with a check box
+ * @Title: GtkCheckMenuItem
+ *
+ * A #GtkCheckMenuItem is a menu item that maintains the state of a boolean
+ * value in addition to a #GtkMenuItem usual role in activating application
+ * code.
+ *
+ * A check box indicating the state of the boolean value is displayed
+ * at the left side of the #GtkMenuItem. Activating the #GtkMenuItem
+ * toggles the value.
+ */
+
+
#define INDICATOR_SIZE 16
struct _GtkCheckMenuItemPrivate
klass->toggled = NULL;
klass->draw_indicator = gtk_real_check_menu_item_draw_indicator;
+ /**
+ * GtkCheckMenuItem::toggled:
+ * @checkmenuitem: the object which received the signal.
+ *
+ * This signal is emitted when the state of the check box is changed.
+ *
+ * A signal handler can use gtk_check_menu_item_get_active()
+ * to discover the new state.
+ */
check_menu_item_signals[TOGGLED] =
g_signal_new (I_("toggled"),
G_OBJECT_CLASS_TYPE (gobject_class),
gtk_toggle_action_get_draw_as_radio (GTK_TOGGLE_ACTION (action)));
}
+/**
+ * gtk_check_menu_item_new:
+ *
+ * Creates a new #GtkCheckMenuItem.
+ *
+ * Returns: a new #GtkCheckMenuItem.
+ */
GtkWidget*
gtk_check_menu_item_new (void)
{
return g_object_new (GTK_TYPE_CHECK_MENU_ITEM, NULL);
}
+/**
+ * gtk_check_menu_item_new_with_label:
+ * @label: the string to use for the label.
+ *
+ * Creates a new #GtkCheckMenuItem with a label.
+ *
+ * Returns: a new #GtkCheckMenuItem.
+ */
GtkWidget*
gtk_check_menu_item_new_with_label (const gchar *label)
{
NULL);
}
+/**
+ * gtk_check_menu_item_set_active:
+ * @check_menu_item: a #GtkCheckMenuItem.
+ * @is_active: boolean value indicating whether the check box is active.
+ *
+ * Sets the active state of the menu item's check box.
+ */
void
gtk_check_menu_item_set_active (GtkCheckMenuItem *check_menu_item,
gboolean is_active)
*requisition = indicator_size + toggle_spacing;
}
+/**
+ * gtk_check_menu_item_toggled:
+ * @check_menu_item: a #GtkCheckMenuItem.
+ *
+ * Emits the #GtkCheckMenuItem::toggled signal.
+ */
void
gtk_check_menu_item_toggled (GtkCheckMenuItem *check_menu_item)
{