📄 gtktooltip.html
字号:
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"><html><head><meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"><title>GtkTooltip</title><meta name="generator" content="DocBook XSL Stylesheets V1.73.2"><link rel="start" href="index.html" title="GTK+ Reference Manual"><link rel="up" href="MiscObjects.html" title="Miscellaneous"><link rel="prev" href="GtkSizeGroup.html" title="GtkSizeGroup"><link rel="next" href="GtkViewport.html" title="GtkViewport"><meta name="generator" content="GTK-Doc V1.9 (XML mode)"><link rel="stylesheet" href="style.css" type="text/css"><link rel="part" href="gtk.html" title="Part I. GTK+ Overview"><link rel="part" href="gtkbase.html" title="Part II. GTK+ Core Reference"><link rel="part" href="gtkobjects.html" title="Part III. GTK+ Widgets and Objects"><link rel="chapter" href="ch01.html" title="Object Hierarchy"><link rel="chapter" href="ch02.html" title="Widget Gallery"><link rel="chapter" href="WindowWidgets.html" title="Windows"><link rel="chapter" href="DisplayWidgets.html" title="Display Widgets"><link rel="chapter" href="ButtonWidgets.html" title="Buttons and Toggles"><link rel="chapter" href="NumericEntry.html" title="Numeric/Text Data Entry"><link rel="chapter" href="TextWidgetObjects.html" title="Multiline Text Editor"><link rel="chapter" href="TreeWidgetObjects.html" title="Tree, List and Icon Grid Widgets"><link rel="chapter" href="MenusAndCombos.html" title="Menus, Combo Box, Toolbar"><link rel="chapter" href="Actions.html" title="Action-based menus and toolbars"><link rel="chapter" href="SelectorWidgets.html" title="Selectors (File/Font/Color/Input Devices)"><link rel="chapter" href="LayoutContainers.html" title="Layout Containers"><link rel="chapter" href="Ornaments.html" title="Ornaments"><link rel="chapter" href="ScrollingWidgets.html" title="Scrolling"><link rel="chapter" href="Printing.html" title="Printing"><link rel="chapter" href="MiscObjects.html" title="Miscellaneous"><link rel="chapter" href="AbstractObjects.html" title="Abstract Base Classes"><link rel="chapter" href="PlugSocket.html" title="Cross-process Embedding"><link rel="chapter" href="SpecialObjects.html" title="Special-purpose features"><link rel="chapter" href="RecentDocuments.html" title="Recently Used Documents"><link rel="chapter" href="Builder.html" title="Interface builder"><link rel="chapter" href="DeprecatedObjects.html" title="Deprecated"><link rel="part" href="migrating.html" title="Part IV. Migrating from Previous Versions of GTK+"><link rel="chapter" href="gtk-migrating-checklist.html" title="Migration Checklist"><link rel="chapter" href="gtk-migrating-GtkFileChooser.html" title="Migrating from GtkFileSelection to GtkFileChooser"><link rel="chapter" href="gtk-migrating-GtkAction.html" title="Migrating from old menu and toolbar systems to GtkAction"><link rel="chapter" href="gtk-migrating-GtkComboBox.html" title="Migrating from GtkOptionMenu and GtkCombo to GtkComboBox and GtkComboBoxEntry"><link rel="chapter" href="gtk-migrating-GtkIconView.html" title="Migrating from GnomeIconList to GtkIconView"><link rel="chapter" href="gtk-migrating-GtkAboutDialog.html" title="Migrating from GnomeAbout to GtkAboutDialog"><link rel="chapter" href="gtk-migrating-GtkColorButton.html" title="Migrating from GnomeColorPicker to GtkColorButton"><link rel="chapter" href="gtk-migrating-GtkAssistant.html" title="Migrating from GnomeDruid to GtkAssistant"><link rel="chapter" href="gtk-migrating-GtkRecentChooser.html" title="Migrating from EggRecent to GtkRecentChooser"><link rel="chapter" href="gtk-migrating-GtkLinkButton.html" title="Migrating from GnomeHRef to GtkLinkButton"><link rel="chapter" href="gtk-migrating-GtkBuilder.html" title="Migrating from libglade to GtkBuilder"><link rel="chapter" href="gtk-migrating-tooltips.html" title="Migrating from GtkTooltips to GtkTooltip"><link rel="part" href="pt05.html" title="Part V. GTK+ Tools"><link rel="glossary" href="glossary.html" title="Glossary"><link rel="index" href="ix01.html" title="Index"><link rel="index" href="ix02.html" title="Index of deprecated symbols"><link rel="index" href="ix03.html" title="Index of new symbols in 2.2"><link rel="index" href="ix04.html" title="Index of new symbols in 2.4"><link rel="index" href="ix05.html" title="Index of new symbols in 2.6"><link rel="index" href="ix06.html" title="Index of new symbols in 2.8"><link rel="index" href="ix07.html" title="Index of new symbols in 2.10"><link rel="index" href="ix08.html" title="Index of new symbols in 2.12"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle"><td><a accesskey="p" href="GtkSizeGroup.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td><td><a accesskey="u" href="MiscObjects.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td><td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td><th width="100%" align="center">GTK+ Reference Manual</th><td><a accesskey="n" href="GtkViewport.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td></tr><tr><td colspan="5" class="shortcuts"><nobr><a href="#id4231113" class="shortcut">Top</a>  |  <a href="#id4231374" class="shortcut">Description</a>  |  <a href="#id4231350" class="shortcut">Object Hierarchy</a></nobr></td></tr></table><div class="refentry" lang="en"><a name="GtkTooltip"></a><div class="titlepage"></div><div class="refnamediv"><table width="100%"><tr><td valign="top"><h2><a name="id4231113"></a><span class="refentrytitle">GtkTooltip</span></h2><p>GtkTooltip — Add tips to your widgets</p></td><td valign="top" align="right"></td></tr></table></div><div class="refsynopsisdiv"><h2>Synopsis</h2><pre class="synopsis">#include <gtk/gtk.h> <a class="link" href="GtkTooltip.html#GtkTooltip-struct">GtkTooltip</a>;void <a class="link" href="GtkTooltip.html#gtk-tooltip-set-markup">gtk_tooltip_set_markup</a> (<a class="link" href="GtkTooltip.html" title="GtkTooltip">GtkTooltip</a> *tooltip, const <ahref="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar">gchar</a> *markup);void <a class="link" href="GtkTooltip.html#gtk-tooltip-set-text">gtk_tooltip_set_text</a> (<a class="link" href="GtkTooltip.html" title="GtkTooltip">GtkTooltip</a> *tooltip, const <ahref="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar">gchar</a> *text);void <a class="link" href="GtkTooltip.html#gtk-tooltip-set-icon">gtk_tooltip_set_icon</a> (<a class="link" href="GtkTooltip.html" title="GtkTooltip">GtkTooltip</a> *tooltip, <ahref="/usr/share/gtk-doc/html/gdk-pixbuf/gdk-pixbuf-gdk-pixbuf.html#GdkPixbuf">GdkPixbuf</a> *pixbuf);void <a class="link" href="GtkTooltip.html#gtk-tooltip-set-icon-from-stock">gtk_tooltip_set_icon_from_stock</a> (<a class="link" href="GtkTooltip.html" title="GtkTooltip">GtkTooltip</a> *tooltip, const <ahref="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar">gchar</a> *stock_id, <a class="link" href="gtk-Themeable-Stock-Images.html#GtkIconSize">GtkIconSize</a> size);void <a class="link" href="GtkTooltip.html#gtk-tooltip-set-custom">gtk_tooltip_set_custom</a> (<a class="link" href="GtkTooltip.html" title="GtkTooltip">GtkTooltip</a> *tooltip, <a class="link" href="GtkWidget.html" title="GtkWidget">GtkWidget</a> *custom_widget);void <a class="link" href="GtkTooltip.html#gtk-tooltip-trigger-tooltip-query">gtk_tooltip_trigger_tooltip_query</a> (<ahref="/usr/share/gtk-doc/html/gdk/GdkDisplay.html">GdkDisplay</a> *display);void <a class="link" href="GtkTooltip.html#gtk-tooltip-set-tip-area">gtk_tooltip_set_tip_area</a> (<a class="link" href="GtkTooltip.html" title="GtkTooltip">GtkTooltip</a> *tooltip, <ahref="/usr/share/gtk-doc/html/gdk/gdk-Points-Rectangles-and-Regions.html#GdkRectangle">GdkRectangle</a> *rect);</pre></div><div class="refsect1" lang="en"><a name="id4231350"></a><h2>Object Hierarchy</h2><pre class="synopsis"> <ahref="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a> +----GtkTooltip</pre></div><div class="refsect1" lang="en"><a name="id4231374"></a><h2>Description</h2><p><a class="link" href="GtkTooltip.html" title="GtkTooltip"><span class="type">GtkTooltip</span></a> belongs to the new tooltips API that wasintroduced in GTK+ 2.12 and which deprecates the old<a class="link" href="GtkTooltips.html" title="GtkTooltips"><span class="type">GtkTooltips</span></a> API. </p><p>Basic tooltips can be realized simply by using <a class="link" href="GtkWidget.html#gtk-widget-set-tooltip-text"><code class="function">gtk_widget_set_tooltip_text()</code></a>or <a class="link" href="GtkWidget.html#gtk-widget-set-tooltip-markup"><code class="function">gtk_widget_set_tooltip_markup()</code></a> without any explicit tooltip object. </p><p>When you need a tooltip with a little more fancy contents, likeadding an image, or you want the tooltip to have different contentsper GtkTreeView row or cell, you will have to do a little more work:</p><div class="itemizedlist"><ul type="disc"><li><p>Set the <a class="link" href="GtkWidget.html#GtkWidget--has-tooltip"><span class="type">"has-tooltip"</span></a> property to <ahref="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>, this willmake GTK+ monitor the widget for motion and related eventswhich are needed to determine when and where to show a tooltip.</p></li><li><p>Connect to the <a class="link" href="GtkWidget.html#GtkWidget-query-tooltip"><span class="type">"query-tooltip"</span></a> signal. This signalwill be emitted when a tooltip is supposed to be shown. Oneof the arguments passed to the signal handler is a <a class="link" href="GtkTooltip.html" title="GtkTooltip"><span class="type">GtkTooltip</span></a>object. This is the object that we are about to display as a tooltip, and can be manipulated in your callback using functionslike <a class="link" href="GtkTooltip.html#gtk-tooltip-set-icon"><code class="function">gtk_tooltip_set_icon()</code></a>. There are functions for settingthe tooltip's markup, setting an image from a stock icon, oreven putting in a custom widget.</p></li><li><p>Return <ahref="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> from your query-tooltip handler. This causesthe tooltip to be show. If you return <ahref="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>, it will not be shown. </p></li></ul></div><p></p><p>In the probably rare case where you want to have even more controlover the tooltip that is about to be shown, you can set your own<a class="link" href="GtkWindow.html" title="GtkWindow"><span class="type">GtkWindow</span></a> which will be used as tooltip window. This works asfollows:</p><div class="itemizedlist"><ul type="disc"><li><p>Set <a class="link" href="GtkWidget.html#GtkWidget--has-tooltip"><span class="type">"has-tooltip"</span></a> and connect to <a class="link" href="GtkWidget.html#GtkWidget-query-tooltip"><span class="type">"query-tooltip"</span></a> as before.</p></li><li><p>Use <a class="link" href="GtkWidget.html#gtk-widget-set-tooltip-window"><code class="function">gtk_widget_set_tooltip_window()</code></a> to set a <a class="link" href="GtkWindow.html" title="GtkWindow"><span class="type">GtkWindow</span></a> createdby you as tooltip window.</p></li><li><p>In the ::query-tooltip callback you can access your windowusing <a class="link" href="GtkWidget.html#gtk-widget-get-tooltip-window"><code class="function">gtk_widget_get_tooltip_window()</code></a> and manipulate as youwish. The semantics of the return value are exactly as before,return <ahref="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> to show the window, <ahref="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> to not show it.</p></li></ul></div><p></p></div><div class="refsect1" lang="en"><a name="id4231643"></a><h2>Details</h2><div class="refsect2" lang="en"><a name="id4231653"></a><h3><a name="GtkTooltip-struct"></a>GtkTooltip</h3><a class="indexterm" name="id4231666"></a><pre class="programlisting">typedef struct _GtkTooltip GtkTooltip;</pre><p></p></div><hr><div class="refsect2" lang="en"><a name="id4231681"></a><h3><a name="gtk-tooltip-set-markup"></a>gtk_tooltip_set_markup ()</h3><a class="indexterm" name="id4231697"></a><pre class="programlisting">void gtk_tooltip_set_markup (<a class="link" href="GtkTooltip.html" title="GtkTooltip">GtkTooltip</a> *tooltip, const <ahref="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar">gchar</a> *markup);</pre><p>Sets the text of the tooltip to be <em class="parameter"><code>markup</code></em>, which is marked upwith the <ahref="/usr/share/gtk-doc/html/pango/PangoMarkupFormat.html">Pango text markup language</a>.If <em class="parameter"><code>markup</code></em> is <ahref="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a>, the label will be hidden.</p><p></p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><p><span class="term"><em class="parameter"><code>tooltip</code></em> :</span></p></td><td> a <a class="link" href="GtkTooltip.html" title="GtkTooltip"><span class="type">GtkTooltip</span></a>⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -