📄 gtktooltips.html
字号:
<HTML><HEAD><TITLE>GtkTooltips</TITLE><METANAME="GENERATOR"CONTENT="Modular DocBook HTML Stylesheet Version 1.61"><LINKREL="HOME"TITLE="GTK+ Reference Manual"HREF="index.html"><LINKREL="UP"TITLE="GTK+ Widgets and Objects"HREF="gtkobjects.html"><LINKREL="PREVIOUS"TITLE="GtkToolbar"HREF="gtktoolbar.html"><LINKREL="NEXT"TITLE="GtkTree"HREF="gtktree.html"></HEAD><BODYCLASS="REFENTRY"BGCOLOR="#FFFFFF"TEXT="#000000"LINK="#0000FF"VLINK="#840084"ALINK="#0000FF"><DIVCLASS="NAVHEADER"><TABLEWIDTH="100%"BORDER="0"BGCOLOR="#000000"CELLPADDING="1"CELLSPACING="0"><TR><THCOLSPAN="4"ALIGN="center"><FONTCOLOR="#FFFFFF"SIZE="5">GTK+ Reference Manual</FONT></TH></TR><TR><TDWIDTH="25%"BGCOLOR="#C00000"ALIGN="left"><AHREF="gtktoolbar.html"><FONTCOLOR="#FFFFFF"SIZE="3"><B><<< Previous Page</B></FONT></A></TD><TDWIDTH="25%"BGCOLOR="#0000C0"ALIGN="center"><FONTCOLOR="#FFFFFF"SIZE="3"><B><AHREF="index.html"><FONTCOLOR="#FFFFFF"SIZE="3"><B>Home</B></FONT></A></B></FONT></TD><TDWIDTH="25%"BGCOLOR="#00C000"ALIGN="center"><FONTCOLOR="#FFFFFF"SIZE="3"><B><AHREF="gtkobjects.html"><FONTCOLOR="#FFFFFF"SIZE="3"><B>Up</B></FONT></A></B></FONT></TD><TDWIDTH="25%"BGCOLOR="#C00000"ALIGN="right"><AHREF="gtktree.html"><FONTCOLOR="#FFFFFF"SIZE="3"><B>Next Page >>></B></FONT></A></TD></TR></TABLE></DIV><H1><ANAME="GTKTOOLTIPS">GtkTooltips</A></H1><DIVCLASS="REFNAMEDIV"><ANAME="AEN42578"></A><H2>Name</H2>GtkTooltips -- Add tips to your widgets.</DIV><DIVCLASS="REFSYNOPSISDIV"><ANAME="AEN42581"></A><H2>Synopsis</H2><TABLEBORDER="0"BGCOLOR="#D6E8FF"WIDTH="100%"CELLPADDING="6"><TR><TD><PRECLASS="SYNOPSIS"> #include <gtk/gtk.h>struct <AHREF="gtktooltips.html#GTKTOOLTIPS-STRUCT">GtkTooltips</A>;struct <AHREF="gtktooltips.html#GTKTOOLTIPSDATA">GtkTooltipsData</A>;<AHREF="gtktooltips.html">GtkTooltips</A>* <AHREF="gtktooltips.html#GTK-TOOLTIPS-NEW">gtk_tooltips_new</A> (void);void <AHREF="gtktooltips.html#GTK-TOOLTIPS-ENABLE">gtk_tooltips_enable</A> (<AHREF="gtktooltips.html">GtkTooltips</A> *tooltips);void <AHREF="gtktooltips.html#GTK-TOOLTIPS-DISABLE">gtk_tooltips_disable</A> (<AHREF="gtktooltips.html">GtkTooltips</A> *tooltips);void <AHREF="gtktooltips.html#GTK-TOOLTIPS-SET-DELAY">gtk_tooltips_set_delay</A> (<AHREF="gtktooltips.html">GtkTooltips</A> *tooltips, <AHREF=../glib/glib-basic-types.html#GUINT>guint</A> delay);void <AHREF="gtktooltips.html#GTK-TOOLTIPS-SET-TIP">gtk_tooltips_set_tip</A> (<AHREF="gtktooltips.html">GtkTooltips</A> *tooltips, <AHREF="gtkwidget.html">GtkWidget</A> *widget, const <AHREF=../glib/glib-basic-types.html#GCHAR>gchar</A> *tip_text, const <AHREF=../glib/glib-basic-types.html#GCHAR>gchar</A> *tip_private);void <AHREF="gtktooltips.html#GTK-TOOLTIPS-SET-COLORS">gtk_tooltips_set_colors</A> (<AHREF="gtktooltips.html">GtkTooltips</A> *tooltips, <AHREF=../gdk/gdk-colormaps-and-colors.html#GDKCOLOR>GdkColor</A> *background, <AHREF=../gdk/gdk-colormaps-and-colors.html#GDKCOLOR>GdkColor</A> *foreground);<AHREF="gtktooltips.html#GTKTOOLTIPSDATA">GtkTooltipsData</A>* <AHREF="gtktooltips.html#GTK-TOOLTIPS-DATA-GET">gtk_tooltips_data_get</A> (<AHREF="gtkwidget.html">GtkWidget</A> *widget);void <AHREF="gtktooltips.html#GTK-TOOLTIPS-FORCE-WINDOW">gtk_tooltips_force_window</A> (<AHREF="gtktooltips.html">GtkTooltips</A> *tooltips); </PRE></TD></TR></TABLE></DIV><DIVCLASS="REFSECT1"><ANAME="AEN42609"></A><H2>Object Hierarchy</H2><TABLEBORDER="0"BGCOLOR="#D6E8FF"WIDTH="100%"CELLPADDING="6"><TR><TD><PRECLASS="SYNOPSIS"> <AHREF="gtkobject.html">GtkObject</A> +----<AHREF="gtkdata.html">GtkData</A> +----GtkTooltips</PRE></TD></TR></TABLE></DIV><DIVCLASS="REFSECT1"><ANAME="AEN42614"></A><H2>Description</H2><P>Tooltips are the messages that appear next to a widget when the mouse pointer is held over it for a short amount of time. They are especially helpful for adding more verbose descriptions of things such as buttons in a toolbar.</P><P>An individual tooltip belongs to a group of tooltips. A group is created with a call to <AHREF="gtktooltips.html#GTK-TOOLTIPS-NEW">gtk_tooltips_new</A>(). Every tooltip in the group can then be turned off with a call to <AHREF="gtktooltips.html#GTK-TOOLTIPS-DISABLE">gtk_tooltips_disable</A>() and enabled with <AHREF="gtktooltips.html#GTK-TOOLTIPS-ENABLE">gtk_tooltips_enable</A>().</P><P>The length of time the user must keep the mouse over a widget before the tip is shown, can be altered with <AHREF="gtktooltips.html#GTK-TOOLTIPS-SET-DELAY">gtk_tooltips_set_delay</A>(). This is set on a 'per group of tooltips' basis.</P><P>To assign a tip to a particular <AHREF="gtkwidget.html">GtkWidget</A>, <AHREF="gtktooltips.html#GTK-TOOLTIPS-SET-TIP">gtk_tooltips_set_tip</A>() is used.</P><DIVCLASS="NOTE"><BLOCKQUOTECLASS="NOTE"><P><B>Note: </B>Tooltips can only be set on widgets which have their own X window.To check if a widget has its own window use 'GTK_WIDGET_NO_WINDOW (widget)'.To add a tooltip to a widget that doesn't have its own window, place thewidget inside a <AHREF="gtkeventbox.html">GtkEventBox</A> and add a tooltip to that instead.</P></BLOCKQUOTE></DIV><P>The default appearance of all tooltips in a program is determined by the current gtk theme that the user has selected.</P><P>Information about the tooltip (if any) associated with an arbitrary widget can be retrieved using <AHREF="gtktooltips.html#GTK-TOOLTIPS-DATA-GET">gtk_tooltips_data_get</A>().</P><P><DIVCLASS="EXAMPLE"><ANAME="AEN42633"></A><P><B>Example 1. Adding tooltips to buttons.</B></P><TABLEBORDER="0"BGCOLOR="#D8F8D8"WIDTH="100%"CELLPADDING="6"><TR><TD><PRECLASS="PROGRAMLISTING"> GtkWidget *load_button, *save_button, *hbox; GtkTooltips *button_bar_tips; button_bar_tips = <AHREF="gtktooltips.html#GTK-TOOLTIPS-NEW">gtk_tooltips_new</A>(); /* Create the buttons and pack them into a <AHREF="gtkhbox.html">GtkHBox</A> */ hbox = gtk_hbox_new(TRUE, 2); load_button = gtk_button_new_with_label("Load a file"); gtk_box_pack_start(GTK_BOX (hbox), load_button, TRUE, TRUE, 2); gtk_widget_show(load_button); save_button = gtk_button_new_with_label("Save a file"); gtk_box_pack_start(GTK_BOX (hbox), save_button, TRUE, TRUE, 2); gtk_widget_show(save_button); gtk_widget_show(hbox); /* Add the tips */ gtk_tooltips_set_tip(GTK_TOOLTIPS (button_bar_tips), load_button, "Load a new document into this window", "Requests the filename of a document. This will then be loaded into the current window, replacing the contents of whatever is already loaded."); gtk_tooltips_set_tip(GTK_TOOLTIPS (button_bar_tips), save_button, "Saves the current document to a file", "If you have saved the document previously, then the new version will be saved over the old one. Otherwise, you will be prompted for a filename."); </PRE></TD></TR></TABLE></DIV></P></DIV><DIVCLASS="REFSECT1"><ANAME="AEN42638"></A><H2>Details</H2><DIVCLASS="REFSECT2"><ANAME="AEN42640"></A><H3><ANAME="GTKTOOLTIPS-STRUCT"></A>struct GtkTooltips</H3><TABLEBORDER="0"BGCOLOR="#D6E8FF"WIDTH="100%"CELLPADDING="6"><TR><TD><PRECLASS="PROGRAMLISTING">struct GtkTooltips;</PRE></TD></TR></TABLE><P>Holds information about a group of tooltips. Fields should be changed using the functions provided, rather than directly accessing the struct's members.</P></DIV><HR><DIVCLASS="REFSECT2"><ANAME="AEN42645"></A><H3><ANAME="GTKTOOLTIPSDATA"></A>struct GtkTooltipsData</H3><TABLEBORDER="0"BGCOLOR="#D6E8FF"WIDTH="100%"CELLPADDING="6"><TR><TD><PRECLASS="PROGRAMLISTING">struct GtkTooltipsData{ GtkTooltips *tooltips; GtkWidget *widget; gchar *tip_text; gchar *tip_private; GdkFont *font; gint width; GList *row;};</PRE></TD></TR></TABLE><P><TTCLASS="STRUCTFIELD"><I>tooltips</I></TT> is the <AHREF="gtktooltips.html">GtkTooltips</A> group that this tooltip belongs to. <TTCLASS="STRUCTFIELD"><I>widget</I></TT> is the <AHREF="gtkwidget.html">GtkWidget</A> that this tooltip data is associated with. <TTCLASS="STRUCTFIELD"><I>tip_text</I></TT> is a string containing the tooltip message itself.</P><P><TTCLASS="STRUCTFIELD"><I>tip_private</I></TT> is a string that is not shown as the default tooltip. Instead, this message may be more informative and go towards forming a context-sensitive help system for your application. (FIXME: how to actually "switch on" private tips?)</P></DIV><HR><DIVCLASS="REFSECT2"><ANAME="AEN42657"></A><H3><ANAME="GTK-TOOLTIPS-NEW"></A>gtk_tooltips_new ()</H3><TABLEBORDER="0"BGCOLOR="#D6E8FF"WIDTH="100%"CELLPADDING="6"><TR><TD><PRECLASS="PROGRAMLISTING"><AHREF="gtktooltips.html">GtkTooltips</A>* gtk_tooltips_new (void);</PRE></TD></TR></TABLE><P>Creates an empty group of tooltips. This function initialises a <AHREF="gtktooltips.html">GtkTooltips</A> structure. Without at least one such structure, you can not add tips to your application.</P><DIVCLASS="INFORMALTABLE"><ANAME="AEN42664"></A><P></P><TABLEBORDER="0"WIDTH="100%"BGCOLOR="#FFD0D0"CELLSPACING="0"CELLPADDING="4"CLASS="CALSTABLE"><TBODY><TR><TDWIDTH="20%"ALIGN="RIGHT"VALIGN="TOP"><ICLASS="EMPHASIS">Returns</I> :</TD><TDWIDTH="80%"ALIGN="LEFT"VALIGN="TOP">a new <AHREF="gtktooltips.html">GtkTooltips</A> group for you to use. </TD></TR></TBODY></TABLE><P></P></DIV></DIV><HR><DIVCLASS="REFSECT2"><ANAME="AEN42674"></A><H3><ANAME="GTK-TOOLTIPS-ENABLE"></A>gtk_tooltips_enable ()</H3><TABLEBORDER="0"BGCOLOR="#D6E8FF"WIDTH="100%"CELLPADDING="6"><TR><TD><PRECLASS="PROGRAMLISTING">void gtk_tooltips_enable (<AHREF="gtktooltips.html">GtkTooltips</A> *tooltips);</PRE></TD></TR></TABLE><P>Allows the user to see your tooltips as they navigate your application.</P><DIVCLASS="INFORMALTABLE"><ANAME="AEN42680"></A><P></P><TABLEBORDER="0"WIDTH="100%"BGCOLOR="#FFD0D0"CELLSPACING="0"CELLPADDING="4"CLASS="CALSTABLE"><TBODY><TR><TDWIDTH="20%"ALIGN="RIGHT"VALIGN="TOP"><TTCLASS="PARAMETER"><I>tooltips</I></TT> :</TD><TDWIDTH="80%"ALIGN="LEFT"VALIGN="TOP">a <AHREF="gtktooltips.html">GtkTooltips</A>. </TD></TR></TBODY></TABLE><P></P></DIV></DIV><HR><DIVCLASS="REFSECT2"><ANAME="AEN42690"></A><H3><ANAME="GTK-TOOLTIPS-DISABLE"></A>gtk_tooltips_disable ()</H3><TABLEBORDER="0"BGCOLOR="#D6E8FF"WIDTH="100%"CELLPADDING="6"><TR><TD><PRECLASS="PROGRAMLISTING">void gtk_tooltips_disable (<AHREF="gtktooltips.html">GtkTooltips</A> *tooltips);</PRE></TD></TR></TABLE><P>Causes all tooltips in <TTCLASS="PARAMETER"><I>tooltips</I></TT> to become inactive. Any widgets that have tips associated with that group will no longer display their tips until they are enabled again with <AHREF="gtktooltips.html#GTK-TOOLTIPS-ENABLE">gtk_tooltips_enable</A>().</P><DIVCLASS="INFORMALTABLE"><ANAME="AEN42698"></A><P></P><TABLEBORDER="0"WIDTH="100%"BGCOLOR="#FFD0D0"CELLSPACING="0"CELLPADDING="4"CLASS="CALSTABLE"><TBODY
⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -