forked from AuroraMiddleware/gtk
159 lines
2.8 KiB
Plaintext
159 lines
2.8 KiB
Plaintext
<!-- ##### 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:
|
|
|
|
|