Sophie

Sophie

distrib > PLD > ra > i686 > by-pkgid > 7d9d988b8daaf36219b4c06c923aefbc > files > 193

gtk+-devel-1.2.10-6.i686.rpm

<HTML
><HEAD
><TITLE
>GtkCheckMenuItem</TITLE
><META
NAME="GENERATOR"
CONTENT="Modular DocBook HTML Stylesheet Version 1.61
"><LINK
REL="HOME"
TITLE="GTK+ Reference Manual"
HREF="index.html"><LINK
REL="UP"
TITLE="GTK+ Widgets and Objects"
HREF="gtkobjects.html"><LINK
REL="PREVIOUS"
TITLE="GtkCheckButton"
HREF="gtkcheckbutton.html"><LINK
REL="NEXT"
TITLE="GtkCList"
HREF="gtkclist.html"></HEAD
><BODY
CLASS="REFENTRY"
BGCOLOR="#FFFFFF"
TEXT="#000000"
LINK="#0000FF"
VLINK="#840084"
ALINK="#0000FF"
><DIV
CLASS="NAVHEADER"
><TABLE
WIDTH="100%"
BORDER="0"
BGCOLOR="#000000"
CELLPADDING="1"
CELLSPACING="0"
><TR
><TH
COLSPAN="4"
ALIGN="center"
><FONT
COLOR="#FFFFFF"
SIZE="5"
>GTK+ Reference Manual</FONT
></TH
></TR
><TR
><TD
WIDTH="25%"
BGCOLOR="#C00000"
ALIGN="left"
><A
HREF="gtkcheckbutton.html"
><FONT
COLOR="#FFFFFF"
SIZE="3"
><B
>&#60;&#60;&#60; Previous Page</B
></FONT
></A
></TD
><TD
WIDTH="25%"
BGCOLOR="#0000C0"
ALIGN="center"
><FONT
COLOR="#FFFFFF"
SIZE="3"
><B
><A
HREF="index.html"
><FONT
COLOR="#FFFFFF"
SIZE="3"
><B
>Home</B
></FONT
></A
></B
></FONT
></TD
><TD
WIDTH="25%"
BGCOLOR="#00C000"
ALIGN="center"
><FONT
COLOR="#FFFFFF"
SIZE="3"
><B
><A
HREF="gtkobjects.html"
><FONT
COLOR="#FFFFFF"
SIZE="3"
><B
>Up</B
></FONT
></A
></B
></FONT
></TD
><TD
WIDTH="25%"
BGCOLOR="#C00000"
ALIGN="right"
><A
HREF="gtkclist.html"
><FONT
COLOR="#FFFFFF"
SIZE="3"
><B
>Next Page &#62;&#62;&#62;</B
></FONT
></A
></TD
></TR
></TABLE
></DIV
><H1
><A
NAME="GTKCHECKMENUITEM"
>GtkCheckMenuItem</A
></H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN15713"
></A
><H2
>Name</H2
>GtkCheckMenuItem&nbsp;--&nbsp;a menu item with a check box.</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN15716"
></A
><H2
>Synopsis</H2
><TABLE
BORDER="0"
BGCOLOR="#D6E8FF"
WIDTH="100%"
CELLPADDING="6"
><TR
><TD
><PRE
CLASS="SYNOPSIS"
>&#13;#include &lt;gtk/gtk.h&gt;


struct      <A
HREF="gtkcheckmenuitem.html#GTKCHECKMENUITEM-STRUCT"
>GtkCheckMenuItem</A
>;
<A
HREF="gtkwidget.html"
>GtkWidget</A
>*  <A
HREF="gtkcheckmenuitem.html#GTK-CHECK-MENU-ITEM-NEW"
>gtk_check_menu_item_new</A
>         (void);
<A
HREF="gtkwidget.html"
>GtkWidget</A
>*  <A
HREF="gtkcheckmenuitem.html#GTK-CHECK-MENU-ITEM-NEW-WITH-LABEL"
>gtk_check_menu_item_new_with_label</A
>
                                            (const <A
HREF=../glib/glib-basic-types.html#GCHAR
>gchar</A> *label);
#define     <A
HREF="gtkcheckmenuitem.html#GTK-CHECK-MENU-ITEM-SET-STATE"
>gtk_check_menu_item_set_state</A
>
void        <A
HREF="gtkcheckmenuitem.html#GTK-CHECK-MENU-ITEM-SET-ACTIVE"
>gtk_check_menu_item_set_active</A
>  (<A
HREF="gtkcheckmenuitem.html"
>GtkCheckMenuItem</A
> *check_menu_item,
                                             <A
HREF=../glib/glib-basic-types.html#GBOOLEAN
>gboolean</A> is_active);
void        <A
HREF="gtkcheckmenuitem.html#GTK-CHECK-MENU-ITEM-SET-SHOW-TOGGLE"
>gtk_check_menu_item_set_show_toggle</A
>
                                            (<A
HREF="gtkcheckmenuitem.html"
>GtkCheckMenuItem</A
> *menu_item,
                                             <A
HREF=../glib/glib-basic-types.html#GBOOLEAN
>gboolean</A> always);
void        <A
HREF="gtkcheckmenuitem.html#GTK-CHECK-MENU-ITEM-TOGGLED"
>gtk_check_menu_item_toggled</A
>     (<A
HREF="gtkcheckmenuitem.html"
>GtkCheckMenuItem</A
> *check_menu_item);&#13;</PRE
></TD
></TR
></TABLE
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN15734"
></A
><H2
>Object Hierarchy</H2
><TABLE
BORDER="0"
BGCOLOR="#D6E8FF"
WIDTH="100%"
CELLPADDING="6"
><TR
><TD
><PRE
CLASS="SYNOPSIS"
>&#13;  <A
HREF="gtkobject.html"
>GtkObject</A
>
   +----<A
HREF="gtkwidget.html"
>GtkWidget</A
>
         +----<A
HREF="gtkcontainer.html"
>GtkContainer</A
>
               +----<A
HREF="gtkbin.html"
>GtkBin</A
>
                     +----<A
HREF="gtkitem.html"
>GtkItem</A
>
                           +----<A
HREF="gtkmenuitem.html"
>GtkMenuItem</A
>
                                 +----GtkCheckMenuItem</PRE
></TD
></TR
></TABLE
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN15743"
></A
><H2
>Signal Prototypes</H2
><TABLE
BORDER="0"
BGCOLOR="#D6E8FF"
WIDTH="100%"
CELLPADDING="6"
><TR
><TD
><PRE
CLASS="SYNOPSIS"
>&#13;&quot;<A
HREF="gtkcheckmenuitem.html#GTKCHECKMENUITEM-TOGGLED"
>toggled</A
>&quot;   void        user_function      (<A
HREF="gtkcheckmenuitem.html"
>GtkCheckMenuItem</A
> *checkmenuitem,
                                            <A
HREF=../glib/glib-basic-types.html#GPOINTER
>gpointer</A> user_data);</PRE
></TD
></TR
></TABLE
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN15749"
></A
><H2
>Description</H2
><P
>A <A
HREF="gtkcheckmenuitem.html"
>GtkCheckMenuItem</A
> is a menu item that maintains the state of a boolean 
value in addition to a <A
HREF="gtkmenuitem.html"
>GtkMenuItem</A
>'s usual role in activating application
code.</P
><P
>A check box indicating the state of the boolean value is displayed
at the left side of the <A
HREF="gtkmenuitem.html"
>GtkMenuItem</A
>.  Activating the <A
HREF="gtkmenuitem.html"
>GtkMenuItem</A
> 
toggles the value.</P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN15757"
></A
><H2
>Details</H2
><DIV
CLASS="REFSECT2"
><A
NAME="AEN15759"
></A
><H3
><A
NAME="GTKCHECKMENUITEM-STRUCT"
></A
>struct GtkCheckMenuItem</H3
><TABLE
BORDER="0"
BGCOLOR="#D6E8FF"
WIDTH="100%"
CELLPADDING="6"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
>struct GtkCheckMenuItem;</PRE
></TD
></TR
></TABLE
><P
>The <A
HREF="gtkcheckmenuitem.html#GTKCHECKMENUITEM-STRUCT"
>GtkCheckMenuItem</A
> struct contains the following fields.
(These fields should be considered read-only. They should never be set by
an application.)

<DIV
CLASS="INFORMALTABLE"
><A
NAME="AEN15765"
></A
><P
></P
><TABLE
BORDER="0"
WIDTH="100%"
BGCOLOR="#FFF0D0"
CELLSPACING="0"
CELLPADDING="4"
CLASS="CALSTABLE"
><TBODY
><TR
><TD
WIDTH="20%"
ALIGN="LEFT"
VALIGN="TOP"
><A
HREF=../glib/glib-basic-types.html#GUINT
>guint</A> active;</TD
><TD
WIDTH="80%"
ALIGN="LEFT"
VALIGN="TOP"
>TRUE if the check box is active.</TD
></TR
></TBODY
></TABLE
><P
></P
></DIV
></P
></DIV
><HR><DIV
CLASS="REFSECT2"
><A
NAME="AEN15774"
></A
><H3
><A
NAME="GTK-CHECK-MENU-ITEM-NEW"
></A
>gtk_check_menu_item_new ()</H3
><TABLE
BORDER="0"
BGCOLOR="#D6E8FF"
WIDTH="100%"
CELLPADDING="6"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
><A
HREF="gtkwidget.html"
>GtkWidget</A
>*  gtk_check_menu_item_new         (void);</PRE
></TD
></TR
></TABLE
><P
>Creates a new <A
HREF="gtkcheckmenuitem.html"
>GtkCheckMenuItem</A
>.</P
><DIV
CLASS="INFORMALTABLE"
><A
NAME="AEN15781"
></A
><P
></P
><TABLE
BORDER="0"
WIDTH="100%"
BGCOLOR="#FFD0D0"
CELLSPACING="0"
CELLPADDING="4"
CLASS="CALSTABLE"
><TBODY
><TR
><TD
WIDTH="20%"
ALIGN="RIGHT"
VALIGN="TOP"
><I
CLASS="EMPHASIS"
>Returns</I
> :</TD
><TD
WIDTH="80%"
ALIGN="LEFT"
VALIGN="TOP"
>a new <A
HREF="gtkcheckmenuitem.html"
>GtkCheckMenuItem</A
>.
&#13;</TD
></TR
></TBODY
></TABLE
><P
></P
></DIV
></DIV
><HR><DIV
CLASS="REFSECT2"
><A
NAME="AEN15791"
></A
><H3
><A
NAME="GTK-CHECK-MENU-ITEM-NEW-WITH-LABEL"
></A
>gtk_check_menu_item_new_with_label ()</H3
><TABLE
BORDER="0"
BGCOLOR="#D6E8FF"
WIDTH="100%"
CELLPADDING="6"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
><A
HREF="gtkwidget.html"
>GtkWidget</A
>*  gtk_check_menu_item_new_with_label
                                            (const <A
HREF=../glib/glib-basic-types.html#GCHAR
>gchar</A> *label);</PRE
></TD
></TR
></TABLE
><P
>Creates a new <A
HREF="gtkcheckmenuitem.html"
>GtkCheckMenuItem</A
> with a label.</P
><DIV
CLASS="INFORMALTABLE"
><A
NAME="AEN15799"
></A
><P
></P
><TABLE
BORDER="0"
WIDTH="100%"
BGCOLOR="#FFD0D0"
CELLSPACING="0"
CELLPADDING="4"
CLASS="CALSTABLE"
><TBODY
><TR
><TD
WIDTH="20%"
ALIGN="RIGHT"
VALIGN="TOP"
><TT
CLASS="PARAMETER"
><I
>label</I
></TT
>&nbsp;:</TD
><TD
WIDTH="80%"
ALIGN="LEFT"
VALIGN="TOP"
>the string to use for the label.</TD
></TR
><TR
><TD
WIDTH="20%"
ALIGN="RIGHT"
VALIGN="TOP"
><I
CLASS="EMPHASIS"
>Returns</I
> :</TD
><TD
WIDTH="80%"
ALIGN="LEFT"
VALIGN="TOP"
>a new <A
HREF="gtkcheckmenuitem.html"
>GtkCheckMenuItem</A
>.
&#13;</TD
></TR
></TBODY
></TABLE
><P
></P
></DIV
></DIV
><HR><DIV
CLASS="REFSECT2"
><A
NAME="AEN15813"
></A
><H3
><A
NAME="GTK-CHECK-MENU-ITEM-SET-STATE"
></A
>gtk_check_menu_item_set_state</H3
><TABLE
BORDER="0"
BGCOLOR="#D6E8FF"
WIDTH="100%"
CELLPADDING="6"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
>#define	gtk_check_menu_item_set_state		gtk_check_menu_item_set_active</PRE
></TD
></TR
></TABLE
><P
>This macro is provided to preserve compatibility with older code.
New code should use <A
HREF="gtkcheckmenuitem.html#GTK-CHECK-MENU-ITEM-SET-ACTIVE"
>gtk_check_menu_item_set_active</A
>() function instead.</P
></DIV
><HR><DIV
CLASS="REFSECT2"
><A
NAME="AEN15819"
></A
><H3
><A
NAME="GTK-CHECK-MENU-ITEM-SET-ACTIVE"
></A
>gtk_check_menu_item_set_active ()</H3
><TABLE
BORDER="0"
BGCOLOR="#D6E8FF"
WIDTH="100%"
CELLPADDING="6"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
>void        gtk_check_menu_item_set_active  (<A
HREF="gtkcheckmenuitem.html"
>GtkCheckMenuItem</A
> *check_menu_item,
                                             <A
HREF=../glib/glib-basic-types.html#GBOOLEAN
>gboolean</A> is_active);</PRE
></TD
></TR
></TABLE
><P
>Sets the active state of the menu item's check box.</P
><DIV
CLASS="INFORMALTABLE"
><A
NAME="AEN15826"
></A
><P
></P
><TABLE
BORDER="0"
WIDTH="100%"
BGCOLOR="#FFD0D0"
CELLSPACING="0"
CELLPADDING="4"
CLASS="CALSTABLE"
><TBODY
><TR
><TD
WIDTH="20%"
ALIGN="RIGHT"
VALIGN="TOP"
><TT
CLASS="PARAMETER"
><I
>check_menu_item</I
></TT
>&nbsp;:</TD
><TD
WIDTH="80%"
ALIGN="LEFT"
VALIGN="TOP"
>a <A
HREF="gtkcheckmenuitem.html"
>GtkCheckMenuItem</A
>.</TD
></TR
><TR
><TD
WIDTH="20%"
ALIGN="RIGHT"
VALIGN="TOP"
><TT
CLASS="PARAMETER"
><I
>is_active</I
></TT
>&nbsp;:</TD
><TD
WIDTH="80%"
ALIGN="LEFT"
VALIGN="TOP"
>boolean value indicating whether the check box is active.
&#13;</TD
></TR
></TBODY
></TABLE
><P
></P
></DIV
></DIV
><HR><DIV
CLASS="REFSECT2"
><A
NAME="AEN15840"
></A
><H3
><A
NAME="GTK-CHECK-MENU-ITEM-SET-SHOW-TOGGLE"
></A
>gtk_check_menu_item_set_show_toggle ()</H3
><TABLE
BORDER="0"
BGCOLOR="#D6E8FF"
WIDTH="100%"
CELLPADDING="6"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
>void        gtk_check_menu_item_set_show_toggle
                                            (<A
HREF="gtkcheckmenuitem.html"
>GtkCheckMenuItem</A
> *menu_item,
                                             <A
HREF=../glib/glib-basic-types.html#GBOOLEAN
>gboolean</A> always);</PRE
></TD
></TR
></TABLE
><P
>Controls whether the check box is shown at all times.
Normally the check box is shown only when it is active or while the 
menu item is selected.</P
><DIV
CLASS="INFORMALTABLE"
><A
NAME="AEN15847"
></A
><P
></P
><TABLE
BORDER="0"
WIDTH="100%"
BGCOLOR="#FFD0D0"
CELLSPACING="0"
CELLPADDING="4"
CLASS="CALSTABLE"
><TBODY
><TR
><TD
WIDTH="20%"
ALIGN="RIGHT"
VALIGN="TOP"
><TT
CLASS="PARAMETER"
><I
>menu_item</I
></TT
>&nbsp;:</TD
><TD
WIDTH="80%"
ALIGN="LEFT"
VALIGN="TOP"
>a <A
HREF="gtkcheckmenuitem.html"
>GtkCheckMenuItem</A
>.</TD
></TR
><TR
><TD
WIDTH="20%"
ALIGN="RIGHT"
VALIGN="TOP"
><TT
CLASS="PARAMETER"
><I
>always</I
></TT
>&nbsp;:</TD
><TD
WIDTH="80%"
ALIGN="LEFT"
VALIGN="TOP"
>boolean value indicating whether to always show the check box.
&#13;</TD
></TR
></TBODY
></TABLE
><P
></P
></DIV
></DIV
><HR><DIV
CLASS="REFSECT2"
><A
NAME="AEN15861"
></A
><H3
><A
NAME="GTK-CHECK-MENU-ITEM-TOGGLED"
></A
>gtk_check_menu_item_toggled ()</H3
><TABLE
BORDER="0"
BGCOLOR="#D6E8FF"
WIDTH="100%"
CELLPADDING="6"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
>void        gtk_check_menu_item_toggled     (<A
HREF="gtkcheckmenuitem.html"
>GtkCheckMenuItem</A
> *check_menu_item);</PRE
></TD
></TR
></TABLE
><P
>Emits the GtkCheckMenuItem::toggled signal.</P
><DIV
CLASS="INFORMALTABLE"
><A
NAME="AEN15867"
></A
><P
></P
><TABLE
BORDER="0"
WIDTH="100%"
BGCOLOR="#FFD0D0"
CELLSPACING="0"
CELLPADDING="4"
CLASS="CALSTABLE"
><TBODY
><TR
><TD
WIDTH="20%"
ALIGN="RIGHT"
VALIGN="TOP"
><TT
CLASS="PARAMETER"
><I
>check_menu_item</I
></TT
>&nbsp;:</TD
><TD
WIDTH="80%"
ALIGN="LEFT"
VALIGN="TOP"
>a <A
HREF="gtkcheckmenuitem.html"
>GtkCheckMenuItem</A
>.
&#13;</TD
></TR
></TBODY
></TABLE
><P
></P
></DIV
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN15877"
></A
><H2
>Signals</H2
><DIV
CLASS="REFSECT2"
><A
NAME="AEN15879"
></A
><H3
><A
NAME="GTKCHECKMENUITEM-TOGGLED"
></A
>The &quot;toggled&quot; signal</H3
><TABLE
BORDER="0"
BGCOLOR="#D6E8FF"
WIDTH="100%"
CELLPADDING="6"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
>void        user_function                  (<A
HREF="gtkcheckmenuitem.html"
>GtkCheckMenuItem</A
> *checkmenuitem,
                                            <A
HREF=../glib/glib-basic-types.html#GPOINTER
>gpointer</A> user_data);</PRE
></TD
></TR
></TABLE
><P
>This signal is emitted when the state of the check box is changed.</P
><P
>A signal handler can examine the <TT
CLASS="STRUCTFIELD"
><I
>active</I
></TT
> 
field of the <A
HREF="gtkcheckmenuitem.html#GTKCHECKMENUITEM-STRUCT"
>GtkCheckMenuItem</A
> struct to discover the new state.</P
><DIV
CLASS="INFORMALTABLE"
><A
NAME="AEN15889"
></A
><P
></P
><TABLE
BORDER="0"
WIDTH="100%"
BGCOLOR="#FFD0D0"
CELLSPACING="0"
CELLPADDING="4"
CLASS="CALSTABLE"
><TBODY
><TR
><TD
WIDTH="20%"
ALIGN="RIGHT"
VALIGN="TOP"
><TT
CLASS="PARAMETER"
><I
>checkmenuitem</I
></TT
>&nbsp;:</TD
><TD
WIDTH="80%"
ALIGN="LEFT"
VALIGN="TOP"
>the object which received the signal.&#13;</TD
></TR
><TR
><TD
WIDTH="20%"
ALIGN="RIGHT"
VALIGN="TOP"
><TT
CLASS="PARAMETER"
><I
>user_data</I
></TT
>&nbsp;:</TD
><TD
WIDTH="80%"
ALIGN="LEFT"
VALIGN="TOP"
>user data set when the signal handler was connected.</TD
></TR
></TBODY
></TABLE
><P
></P
></DIV
></DIV
></DIV
><DIV
CLASS="NAVFOOTER"
><BR
CLEAR="all"><BR><TABLE
WIDTH="100%"
BORDER="0"
BGCOLOR="#000000"
CELLPADDING="1"
CELLSPACING="0"
><TR
><TD
WIDTH="25%"
BGCOLOR="#C00000"
ALIGN="left"
><A
HREF="gtkcheckbutton.html"
><FONT
COLOR="#FFFFFF"
SIZE="3"
><B
>&#60;&#60;&#60; Previous Page</B
></FONT
></A
></TD
><TD
WIDTH="25%"
BGCOLOR="#0000C0"
ALIGN="center"
><FONT
COLOR="#FFFFFF"
SIZE="3"
><B
><A
HREF="index.html"
><FONT
COLOR="#FFFFFF"
SIZE="3"
><B
>Home</B
></FONT
></A
></B
></FONT
></TD
><TD
WIDTH="25%"
BGCOLOR="#00C000"
ALIGN="center"
><FONT
COLOR="#FFFFFF"
SIZE="3"
><B
><A
HREF="gtkobjects.html"
><FONT
COLOR="#FFFFFF"
SIZE="3"
><B
>Up</B
></FONT
></A
></B
></FONT
></TD
><TD
WIDTH="25%"
BGCOLOR="#C00000"
ALIGN="right"
><A
HREF="gtkclist.html"
><FONT
COLOR="#FFFFFF"
SIZE="3"
><B
>Next Page &#62;&#62;&#62;</B
></FONT
></A
></TD
></TR
><TR
><TD
COLSPAN="2"
ALIGN="left"
><FONT
COLOR="#FFFFFF"
SIZE="3"
><B
>GtkCheckButton</B
></FONT
></TD
><TD
COLSPAN="2"
ALIGN="right"
><FONT
COLOR="#FFFFFF"
SIZE="3"
><B
>GtkCList</B
></FONT
></TD
></TR
></TABLE
></DIV
></BODY
></HTML
>