diff --git a/docs/reference/gtk/tmpl/.gitignore b/docs/reference/gtk/tmpl/.gitignore index 3679f03047..c00125deae 100644 --- a/docs/reference/gtk/tmpl/.gitignore +++ b/docs/reference/gtk/tmpl/.gitignore @@ -20,6 +20,7 @@ gtkcellrenderertext.sgml gtkcellrenderertoggle.sgml gtkcellview.sgml gtkcheckbutton.sgml +gtkcheckmenuitem.sgml gtkcolorbutton.sgml gtkcolorsel.sgml gtkcombobox.sgml diff --git a/docs/reference/gtk/tmpl/gtkcheckmenuitem.sgml b/docs/reference/gtk/tmpl/gtkcheckmenuitem.sgml deleted file mode 100644 index 5c93084197..0000000000 --- a/docs/reference/gtk/tmpl/gtkcheckmenuitem.sgml +++ /dev/null @@ -1,158 +0,0 @@ - -GtkCheckMenuItem - - -A menu item with a check box - - - -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. - - - -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. - - - - - - - - - - - - - - - -The #GtkCheckMenuItem-struct struct contains only private fields that -should not be directly accessed. - - - - - -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. - - -@checkmenuitem: the object which received the signal. - - - - - - - - - - - - - - - - - - - - - - - -Creates a new #GtkCheckMenuItem. - - -@void: -@Returns: a new #GtkCheckMenuItem. - - - - -Creates a new #GtkCheckMenuItem with a label. - - -@label: the string to use for the label. -@Returns: a new #GtkCheckMenuItem. - - - - - - - -@label: -@Returns: - - - - - - - -@check_menu_item: -@Returns: - - - - -Sets the active state of the menu item's check box. - - -@check_menu_item: a #GtkCheckMenuItem. -@is_active: boolean value indicating whether the check box is active. - - - - -Emits the GtkCheckMenuItem::toggled signal. - - -@check_menu_item: a #GtkCheckMenuItem. - - - - - - - -@check_menu_item: -@Returns: - - - - - - - -@check_menu_item: -@setting: - - - - - - - -@check_menu_item: -@draw_as_radio: - - - - - - - -@check_menu_item: -@Returns: - - diff --git a/gtk/gtkcheckmenuitem.c b/gtk/gtkcheckmenuitem.c index 8385ff56c2..614e15d95b 100644 --- a/gtk/gtkcheckmenuitem.c +++ b/gtk/gtkcheckmenuitem.c @@ -34,6 +34,22 @@ #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 @@ -142,6 +158,15 @@ gtk_check_menu_item_class_init (GtkCheckMenuItemClass *klass) 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), @@ -212,12 +237,27 @@ gtk_check_menu_item_sync_action_properties (GtkActivatable *activatable, 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) { @@ -246,6 +286,13 @@ gtk_check_menu_item_new_with_mnemonic (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) @@ -296,6 +343,12 @@ gtk_check_menu_item_toggle_size_request (GtkMenuItem *menu_item, *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) {