gtk-general.html

该压缩包包含了GTK+的大量API函数

NAME="AEN214"
></A
><H3
><A
NAME="GTK-INIT-CHECK"
></A
>gtk_init_check ()</H3
><TABLE
BORDER="0"
BGCOLOR="#D6E8FF"
WIDTH="100%"
CELLPADDING="6"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
><A
HREF=../glib/glib-basic-types.html#GBOOLEAN
>gboolean</A>    gtk_init_check                  (int *argc,
                                             char ***argv);</PRE
></TD
></TR
></TABLE
><P
>This function does the same work as <TT
CLASS="FUNCTION"
>gtk_init</TT
> with only 
a single change: It does not terminate the program if the GUI can't be 
initialized. Instead it returns <TT
CLASS="LITERAL"
>FALSE</TT
> on failure.</P
><P
>This way the application can fall back to some other means of communication 
with the user - for example a curses or command line interface.</P
><DIV
CLASS="INFORMALTABLE"
><A
NAME="AEN223"
></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
>argc</I
></TT
>&nbsp;:</TD
><TD
WIDTH="80%"
ALIGN="LEFT"
VALIGN="TOP"
>A reference to the <TT
CLASS="PARAMETER"
><I
>argc</I
></TT
> of the <TT
CLASS="FUNCTION"
>main</TT
> function.</TD
></TR
><TR
><TD
WIDTH="20%"
ALIGN="RIGHT"
VALIGN="TOP"
><TT
CLASS="PARAMETER"
><I
>argv</I
></TT
>&nbsp;:</TD
><TD
WIDTH="80%"
ALIGN="LEFT"
VALIGN="TOP"
>A reference to the <TT
CLASS="PARAMETER"
><I
>argv</I
></TT
> of the <TT
CLASS="FUNCTION"
>main</TT
> function.</TD
></TR
><TR
><TD
WIDTH="20%"
ALIGN="RIGHT"
VALIGN="TOP"
><I
CLASS="EMPHASIS"
>Returns</I
> :</TD
><TD
WIDTH="80%"
ALIGN="LEFT"
VALIGN="TOP"
><TT
CLASS="LITERAL"
>TRUE</TT
> if the GUI has been successful initialized, 
<TT
CLASS="LITERAL"
>FALSE</TT
> otherwise.
&#13;</TD
></TR
></TBODY
></TABLE
><P
></P
></DIV
></DIV
><HR><DIV
CLASS="REFSECT2"
><A
NAME="AEN246"
></A
><H3
><A
NAME="GTK-EXIT"
></A
>gtk_exit ()</H3
><TABLE
BORDER="0"
BGCOLOR="#D6E8FF"
WIDTH="100%"
CELLPADDING="6"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
>void        gtk_exit                        (<A
HREF=../glib/glib-basic-types.html#GINT
>gint</A> error_code);</PRE
></TD
></TR
></TABLE
><P
>Terminate the program and return the given exit code to the caller. 
This function will shut down the GUI and free all resources allocated 
for GTK.</P
><DIV
CLASS="INFORMALTABLE"
><A
NAME="AEN252"
></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
>error_code</I
></TT
>&nbsp;:</TD
><TD
WIDTH="80%"
ALIGN="LEFT"
VALIGN="TOP"
>Return value to pass to the caller. This is dependend on the
target system but at least on Unix systems <TT
CLASS="LITERAL"
>0</TT
> means 
success.
&#13;</TD
></TR
></TBODY
></TABLE
><P
></P
></DIV
></DIV
><HR><DIV
CLASS="REFSECT2"
><A
NAME="AEN262"
></A
><H3
><A
NAME="GTK-EVENTS-PENDING"
></A
>gtk_events_pending ()</H3
><TABLE
BORDER="0"
BGCOLOR="#D6E8FF"
WIDTH="100%"
CELLPADDING="6"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
><A
HREF=../glib/glib-basic-types.html#GINT
>gint</A>        gtk_events_pending              (void);</PRE
></TD
></TR
></TABLE
><P
>Check if any events are pending. This can be used to update the GUI 
and invoke timeouts etc. while doing some time intensive computation.</P
><DIV
CLASS="EXAMPLE"
><A
NAME="AEN268"
></A
><P
><B
>Example 2.  Updating the GUI during a long computation</B
></P
><TABLE
BORDER="0"
BGCOLOR="#D8F8D8"
WIDTH="100%"
CELLPADDING="6"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
>	/* computation going on */
...
        while (<A
HREF="gtk-general.html#GTK-EVENTS-PENDING"
>gtk_events_pending</A
>())
	  <A
HREF="gtk-general.html#GTK-MAIN-ITERATION"
>gtk_main_iteration</A
>();
...
	/* computation continued */</PRE
></TD
></TR
></TABLE
></DIV
><DIV
CLASS="INFORMALTABLE"
><A
NAME="AEN273"
></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"
><TT
CLASS="LITERAL"
>TRUE</TT
> if any events are pending, <TT
CLASS="LITERAL"
>FALSE</TT
> otherwise.
&#13;</TD
></TR
></TBODY
></TABLE
><P
></P
></DIV
></DIV
><HR><DIV
CLASS="REFSECT2"
><A
NAME="AEN284"
></A
><H3
><A
NAME="GTK-MAIN"
></A
>gtk_main ()</H3
><TABLE
BORDER="0"
BGCOLOR="#D6E8FF"
WIDTH="100%"
CELLPADDING="6"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
>void        gtk_main                        (void);</PRE
></TD
></TR
></TABLE
><P
>Runs the main loop until <A
HREF="gtk-general.html#GTK-MAIN-QUIT"
>gtk_main_quit</A
>() is called. You can nest calls to
gtk_main. In that case <A
HREF="gtk-general.html#GTK-MAIN-QUIT"
>gtk_main_quit</A
>() will make the innerst invocation
of the main loop return.</P
></DIV
><HR><DIV
CLASS="REFSECT2"
><A
NAME="AEN291"
></A
><H3
><A
NAME="GTK-MAIN-LEVEL"
></A
>gtk_main_level ()</H3
><TABLE
BORDER="0"
BGCOLOR="#D6E8FF"
WIDTH="100%"
CELLPADDING="6"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
><A
HREF=../glib/glib-basic-types.html#GUINT
>guint</A>       gtk_main_level                  (void);</PRE
></TD
></TR
></TABLE
><P
>Ask for the current nesting level of the main loop. This can be useful
when calling gtk_quit_add.</P
><DIV
CLASS="INFORMALTABLE"
><A
NAME="AEN297"
></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"
>the nesting level of the current invocation of the main loop.
&#13;</TD
></TR
></TBODY
></TABLE
><P
></P
></DIV
></DIV
><HR><DIV
CLASS="REFSECT2"
><A
NAME="AEN306"
></A
><H3
><A
NAME="GTK-MAIN-QUIT"
></A
>gtk_main_quit ()</H3
><TABLE
BORDER="0"
BGCOLOR="#D6E8FF"
WIDTH="100%"
CELLPADDING="6"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
>void        gtk_main_quit                   (void);</PRE
></TD
></TR
></TABLE
><P
>Makes the innermost invocation of the main loop return when it regains 
control.</P
></DIV
><HR><DIV
CLASS="REFSECT2"
><A
NAME="AEN311"
></A
><H3
><A
NAME="GTK-MAIN-ITERATION"
></A
>gtk_main_iteration ()</H3
><TABLE
BORDER="0"
BGCOLOR="#D6E8FF"
WIDTH="100%"
CELLPADDING="6"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
><A
HREF=../glib/glib-basic-types.html#GINT
>gint</A>        gtk_main_iteration              (void);</PRE
></TD
></TR
></TABLE
><P
>Runs a single iteration of the mainloop. If no events are waiting to be
processed GTK+ will block until the next event is noticed. If you don't
want to block look at gtk_main_iteration_do or check if any events are
pending with gtk_events_pending first.</P
><DIV
CLASS="INFORMALTABLE"
><A
NAME="AEN317"
></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"
><TT
CLASS="LITERAL"
>TRUE</TT
> if gtk_main_quit has been called for the innermost mainloop.
&#13;</TD
></TR
></TBODY
></TABLE
><P
></P
></DIV
></DIV
><HR><DIV
CLASS="REFSECT2"
><A
NAME="AEN327"
></A
><H3
><A
NAME="GTK-MAIN-ITERATION-DO"
></A
>gtk_main_iteration_do ()</H3
><TABLE
BORDER="0"
BGCOLOR="#D6E8FF"
WIDTH="100%"
CELLPADDING="6"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
><A
HREF=../glib/glib-basic-types.html#GINT
>gint</A>        gtk_main_iteration_do           (<A
HREF=../glib/glib-basic-types.html#GBOOLEAN
>gboolean</A> blocking);</PRE
></TD
></TR
></TABLE
><P
>Run a single iteration of the mainloop. If no events are available either
return or block dependend on the value of <TT
CLASS="PARAMETER"
><I
>blocking</I
></TT
>. </P
><DIV
CLASS="INFORMALTABLE"
><A
NAME="AEN335"
></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
>blocking</I
></TT
>&nbsp;:</TD
><TD
WIDTH="80%"
ALIGN="LEFT"
VALIGN="TOP"
><TT
CLASS="LITERAL"
>TRUE</TT
> if you want GTK+ to block if no events are pending.</TD
></TR
><TR
><TD
WIDTH="20%"
ALIGN="RIGHT"
VALIGN="TOP"
><I
CLASS="EMPHASIS"
>Returns</I
> :</TD
><TD
WIDTH="80%"
ALIGN="LEFT"
VALIGN="TOP"
><TT
CLASS="LITERAL"
>TRUE</TT
> if gtk_main_quit has been called for the innermost mainloop.
&#13;</TD
></TR
></TBODY
></TABLE
><P
></P
></DIV
></DIV
><HR><DIV
CLASS="REFSECT2"
><A
NAME="AEN350"
></A
><H3
><A
NAME="GTK-MAIN-DO-EVENT"
></A
>gtk_main_do_event ()</H3
><TABLE
BORDER="0"
BGCOLOR="#D6E8FF"
WIDTH="100%"
CELLPADDING="6"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
>void        gtk_main_do_event               (<A
HREF=../gdk/gdk-event-structures.html#GDKEVENT
>GdkEvent</A> *event);</PRE
></TD
></TR
></TABLE
><P
>Process a single GDK event. This is public only to allow filtering of events
between GDK and GTK. You will not usually need to call this function directly.</P
><P
>While you should not call this function directly, you might want to know
how exactly events are handled. So here is what this function does with 
the event:</P
><P
></P
><OL
TYPE="1"
><LI
><P
>  Compress enter/leave notify events. If the event passed build an 
  enter/leave pair together with the next event (peeked from Gdk)
  both events are thrown away. This is to avoid a backlog of (de-)highlighting
  widgets crossed by the pointer.</P
></LI
><LI
><P
>  Find the widget which got the event. If the widget can't be determined 
  the event is thrown away unless it belongs to a INCR transaction. In that
  case it is passed to gtk_selection_incr_event.</P
></LI
><LI
><P
>  Then the event is passed on a stack so you can query the currently handled
  event with gtk_get_current_event. </P
></LI
><LI
><P
>  The event is sent to a widget. If a grab is active all events for 
  widgets that are not in the contained in the grab widget are sent to the 
  latter with a few exceptions: 

  <P
></P
><UL
><LI
><P
>    Deletion and destruction events are still sent to the event widget for
    obvious reasons.
  </P
></LI
><LI
><P
>    Events which directly relate to the visual representation of the event
    widget.
  </P
></LI
><LI
><P
>    Leave events are delivered to the event widget if there was an enter 
    event delivered to it before without the paired leave event.
  </P
></LI
><LI
><P
>    Drag events are not redirected because it is unclear what the semantics
    of that would be.
  </P
></LI
></UL
>

  Another point of interest might be that all keypresses are first passed
  through the key snooper functions if there are any. Read the description
  of <A
HREF="gtk-general.html#GTK-KEY-SNOOPER-INSTALL"
>gtk_key_snooper_install</A
>() if you need this feature.</P
></LI
><LI
><P
>  After finishing the delivery the event is popped from the event stack.</P
></LI
></OL
><DIV
CLASS="INFORMALTABLE"
><A
NAME="AEN378"
></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
>event</I
></TT
>&nbsp;:</TD
><TD
WIDTH="80%"
ALIGN="LEFT"
VALIGN="TOP"
>An event to process (normally) passed by Gdk.
&#13;</TD
></TR
></TBODY
></TABLE
><P
></P
></DIV
></DIV
><HR><DIV
CLASS="REFSECT2"
><A
NAME="AEN387"
></A
><H3
><A
NAME="GTKMODULEINITFUNC"
></A
>GtkModuleInitFunc ()</H3
><TABLE
BORDER="0"
BGCOLOR="#D6E8FF"
WIDTH="100%"
CELLPADDING="6"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
>void        (*GtkModuleInitFunc)            (<A
HREF=../glib/glib-basic-types.html#GINT
>gint</A> *argc,
                                             <A
HREF=../glib/glib-basic-types.html#GCHAR
>gchar</A> ***argv);</PRE
></TD
></TR
></TABLE
><P
>Each GTK+ module must have a function gtk_module_init with this prototype.
This function is called after loading the module with the argc and argv 
cleaned from any arguments that GTK+ handles itself.</P
><DIV
CLASS="INFORMALTABLE"
><A
NAME="AEN394"
></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
>argc</I
></TT
>&nbsp;:</TD
><TD
WIDTH="80%"
ALIGN="LEFT"
VALIGN="TOP"
>Pointer to the number of arguments remaining after gtk_init.</TD
></TR
><TR
><TD
WIDTH="20%"
ALIGN="RIGHT"
VALIGN="TOP"
><TT
CLASS="PARAMETER"
><I
>argv</I
></TT
>&nbsp;:</TD
><TD
WIDTH="80%"
ALIGN="LEFT"
VALIGN="TOP"
>Points to the argument vector. 
&#13;</TD
></TR
></TBODY
></TABLE
><P
></P
></DIV
></DIV
><HR><DIV
CLASS="REFSECT2"
><A
NAME="AEN407"
></A
><H3
><A
NAME="GTK-TRUE"
></A
>gtk_true ()</H3
><TABLE
BORDER="0"
BGCOLOR="#D6E8FF"
WIDTH="100%"
CELLPADDING="6"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"