2395 lines
125 KiB
HTML
2395 lines
125 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
||
<html>
|
||
<head>
|
||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||
<title>GtkStatusIcon: GTK+ 3 Reference Manual</title>
|
||
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
|
||
<link rel="home" href="index.html" title="GTK+ 3 Reference Manual">
|
||
<link rel="up" href="DeprecatedObjects.html" title="Deprecated">
|
||
<link rel="prev" href="GtkArrow.html" title="GtkArrow">
|
||
<link rel="next" href="GtkThemingEngine.html" title="GtkThemingEngine">
|
||
<meta name="generator" content="GTK-Doc V1.33.1 (XML mode)">
|
||
<link rel="stylesheet" href="style.css" type="text/css">
|
||
</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="5"><tr valign="middle">
|
||
<td width="100%" align="left" class="shortcuts">
|
||
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span>
|
||
<a href="#GtkStatusIcon.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
|
||
<a href="#GtkStatusIcon.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties"> <span class="dim">|</span>
|
||
<a href="#GtkStatusIcon.properties" class="shortcut">Properties</a></span><span id="nav_signals"> <span class="dim">|</span>
|
||
<a href="#GtkStatusIcon.signals" class="shortcut">Signals</a></span>
|
||
</td>
|
||
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
|
||
<td><a accesskey="u" href="DeprecatedObjects.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
|
||
<td><a accesskey="p" href="GtkArrow.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
|
||
<td><a accesskey="n" href="GtkThemingEngine.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
|
||
</tr></table>
|
||
<div class="refentry">
|
||
<a name="GtkStatusIcon"></a><div class="titlepage"></div>
|
||
<div class="refnamediv"><table width="100%"><tr>
|
||
<td valign="top">
|
||
<h2><span class="refentrytitle"><a name="GtkStatusIcon.top_of_page"></a>GtkStatusIcon</span></h2>
|
||
<p>GtkStatusIcon — Display an icon in the system tray</p>
|
||
</td>
|
||
<td class="gallery_image" valign="top" align="right"></td>
|
||
</tr></table></div>
|
||
<div class="refsect1">
|
||
<a name="GtkStatusIcon.functions"></a><h2>Functions</h2>
|
||
<div class="informaltable"><table class="informaltable" width="100%" border="0">
|
||
<colgroup>
|
||
<col width="150px" class="functions_proto_type">
|
||
<col class="functions_proto_name">
|
||
</colgroup>
|
||
<tbody>
|
||
<tr>
|
||
<td class="function_type">
|
||
<a class="link" href="GtkStatusIcon.html" title="GtkStatusIcon"><span class="returnvalue">GtkStatusIcon</span></a> *
|
||
</td>
|
||
<td class="function_name">
|
||
<a class="link" href="GtkStatusIcon.html#gtk-status-icon-new" title="gtk_status_icon_new ()">gtk_status_icon_new</a> <span class="c_punctuation">()</span>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="function_type">
|
||
<a class="link" href="GtkStatusIcon.html" title="GtkStatusIcon"><span class="returnvalue">GtkStatusIcon</span></a> *
|
||
</td>
|
||
<td class="function_name">
|
||
<a class="link" href="GtkStatusIcon.html#gtk-status-icon-new-from-pixbuf" title="gtk_status_icon_new_from_pixbuf ()">gtk_status_icon_new_from_pixbuf</a> <span class="c_punctuation">()</span>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="function_type">
|
||
<a class="link" href="GtkStatusIcon.html" title="GtkStatusIcon"><span class="returnvalue">GtkStatusIcon</span></a> *
|
||
</td>
|
||
<td class="function_name">
|
||
<a class="link" href="GtkStatusIcon.html#gtk-status-icon-new-from-file" title="gtk_status_icon_new_from_file ()">gtk_status_icon_new_from_file</a> <span class="c_punctuation">()</span>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="function_type">
|
||
<a class="link" href="GtkStatusIcon.html" title="GtkStatusIcon"><span class="returnvalue">GtkStatusIcon</span></a> *
|
||
</td>
|
||
<td class="function_name">
|
||
<a class="link" href="GtkStatusIcon.html#gtk-status-icon-new-from-stock" title="gtk_status_icon_new_from_stock ()">gtk_status_icon_new_from_stock</a> <span class="c_punctuation">()</span>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="function_type">
|
||
<a class="link" href="GtkStatusIcon.html" title="GtkStatusIcon"><span class="returnvalue">GtkStatusIcon</span></a> *
|
||
</td>
|
||
<td class="function_name">
|
||
<a class="link" href="GtkStatusIcon.html#gtk-status-icon-new-from-icon-name" title="gtk_status_icon_new_from_icon_name ()">gtk_status_icon_new_from_icon_name</a> <span class="c_punctuation">()</span>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="function_type">
|
||
<a class="link" href="GtkStatusIcon.html" title="GtkStatusIcon"><span class="returnvalue">GtkStatusIcon</span></a> *
|
||
</td>
|
||
<td class="function_name">
|
||
<a class="link" href="GtkStatusIcon.html#gtk-status-icon-new-from-gicon" title="gtk_status_icon_new_from_gicon ()">gtk_status_icon_new_from_gicon</a> <span class="c_punctuation">()</span>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="function_type">
|
||
<span class="returnvalue">void</span>
|
||
</td>
|
||
<td class="function_name">
|
||
<a class="link" href="GtkStatusIcon.html#gtk-status-icon-set-from-pixbuf" title="gtk_status_icon_set_from_pixbuf ()">gtk_status_icon_set_from_pixbuf</a> <span class="c_punctuation">()</span>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="function_type">
|
||
<span class="returnvalue">void</span>
|
||
</td>
|
||
<td class="function_name">
|
||
<a class="link" href="GtkStatusIcon.html#gtk-status-icon-set-from-file" title="gtk_status_icon_set_from_file ()">gtk_status_icon_set_from_file</a> <span class="c_punctuation">()</span>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="function_type">
|
||
<span class="returnvalue">void</span>
|
||
</td>
|
||
<td class="function_name">
|
||
<a class="link" href="GtkStatusIcon.html#gtk-status-icon-set-from-stock" title="gtk_status_icon_set_from_stock ()">gtk_status_icon_set_from_stock</a> <span class="c_punctuation">()</span>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="function_type">
|
||
<span class="returnvalue">void</span>
|
||
</td>
|
||
<td class="function_name">
|
||
<a class="link" href="GtkStatusIcon.html#gtk-status-icon-set-from-icon-name" title="gtk_status_icon_set_from_icon_name ()">gtk_status_icon_set_from_icon_name</a> <span class="c_punctuation">()</span>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="function_type">
|
||
<span class="returnvalue">void</span>
|
||
</td>
|
||
<td class="function_name">
|
||
<a class="link" href="GtkStatusIcon.html#gtk-status-icon-set-from-gicon" title="gtk_status_icon_set_from_gicon ()">gtk_status_icon_set_from_gicon</a> <span class="c_punctuation">()</span>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="function_type">
|
||
<a class="link" href="GtkImage.html#GtkImageType" title="enum GtkImageType"><span class="returnvalue">GtkImageType</span></a>
|
||
</td>
|
||
<td class="function_name">
|
||
<a class="link" href="GtkStatusIcon.html#gtk-status-icon-get-storage-type" title="gtk_status_icon_get_storage_type ()">gtk_status_icon_get_storage_type</a> <span class="c_punctuation">()</span>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="function_type">
|
||
<span class="returnvalue">GdkPixbuf</span> *
|
||
</td>
|
||
<td class="function_name">
|
||
<a class="link" href="GtkStatusIcon.html#gtk-status-icon-get-pixbuf" title="gtk_status_icon_get_pixbuf ()">gtk_status_icon_get_pixbuf</a> <span class="c_punctuation">()</span>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="function_type">const <span class="returnvalue">gchar</span> *
|
||
</td>
|
||
<td class="function_name">
|
||
<a class="link" href="GtkStatusIcon.html#gtk-status-icon-get-stock" title="gtk_status_icon_get_stock ()">gtk_status_icon_get_stock</a> <span class="c_punctuation">()</span>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="function_type">const <span class="returnvalue">gchar</span> *
|
||
</td>
|
||
<td class="function_name">
|
||
<a class="link" href="GtkStatusIcon.html#gtk-status-icon-get-icon-name" title="gtk_status_icon_get_icon_name ()">gtk_status_icon_get_icon_name</a> <span class="c_punctuation">()</span>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="function_type">
|
||
<span class="returnvalue">GIcon</span> *
|
||
</td>
|
||
<td class="function_name">
|
||
<a class="link" href="GtkStatusIcon.html#gtk-status-icon-get-gicon" title="gtk_status_icon_get_gicon ()">gtk_status_icon_get_gicon</a> <span class="c_punctuation">()</span>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="function_type">
|
||
<span class="returnvalue">gint</span>
|
||
</td>
|
||
<td class="function_name">
|
||
<a class="link" href="GtkStatusIcon.html#gtk-status-icon-get-size" title="gtk_status_icon_get_size ()">gtk_status_icon_get_size</a> <span class="c_punctuation">()</span>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="function_type">
|
||
<span class="returnvalue">void</span>
|
||
</td>
|
||
<td class="function_name">
|
||
<a class="link" href="GtkStatusIcon.html#gtk-status-icon-set-screen" title="gtk_status_icon_set_screen ()">gtk_status_icon_set_screen</a> <span class="c_punctuation">()</span>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="function_type">
|
||
<span class="returnvalue">GdkScreen</span> *
|
||
</td>
|
||
<td class="function_name">
|
||
<a class="link" href="GtkStatusIcon.html#gtk-status-icon-get-screen" title="gtk_status_icon_get_screen ()">gtk_status_icon_get_screen</a> <span class="c_punctuation">()</span>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="function_type">
|
||
<span class="returnvalue">void</span>
|
||
</td>
|
||
<td class="function_name">
|
||
<a class="link" href="GtkStatusIcon.html#gtk-status-icon-set-tooltip-text" title="gtk_status_icon_set_tooltip_text ()">gtk_status_icon_set_tooltip_text</a> <span class="c_punctuation">()</span>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="function_type">
|
||
<span class="returnvalue">gchar</span> *
|
||
</td>
|
||
<td class="function_name">
|
||
<a class="link" href="GtkStatusIcon.html#gtk-status-icon-get-tooltip-text" title="gtk_status_icon_get_tooltip_text ()">gtk_status_icon_get_tooltip_text</a> <span class="c_punctuation">()</span>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="function_type">
|
||
<span class="returnvalue">void</span>
|
||
</td>
|
||
<td class="function_name">
|
||
<a class="link" href="GtkStatusIcon.html#gtk-status-icon-set-tooltip-markup" title="gtk_status_icon_set_tooltip_markup ()">gtk_status_icon_set_tooltip_markup</a> <span class="c_punctuation">()</span>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="function_type">
|
||
<span class="returnvalue">gchar</span> *
|
||
</td>
|
||
<td class="function_name">
|
||
<a class="link" href="GtkStatusIcon.html#gtk-status-icon-get-tooltip-markup" title="gtk_status_icon_get_tooltip_markup ()">gtk_status_icon_get_tooltip_markup</a> <span class="c_punctuation">()</span>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="function_type">
|
||
<span class="returnvalue">void</span>
|
||
</td>
|
||
<td class="function_name">
|
||
<a class="link" href="GtkStatusIcon.html#gtk-status-icon-set-has-tooltip" title="gtk_status_icon_set_has_tooltip ()">gtk_status_icon_set_has_tooltip</a> <span class="c_punctuation">()</span>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="function_type">
|
||
<span class="returnvalue">gboolean</span>
|
||
</td>
|
||
<td class="function_name">
|
||
<a class="link" href="GtkStatusIcon.html#gtk-status-icon-get-has-tooltip" title="gtk_status_icon_get_has_tooltip ()">gtk_status_icon_get_has_tooltip</a> <span class="c_punctuation">()</span>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="function_type">
|
||
<span class="returnvalue">void</span>
|
||
</td>
|
||
<td class="function_name">
|
||
<a class="link" href="GtkStatusIcon.html#gtk-status-icon-set-title" title="gtk_status_icon_set_title ()">gtk_status_icon_set_title</a> <span class="c_punctuation">()</span>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="function_type">const <span class="returnvalue">gchar</span> *
|
||
</td>
|
||
<td class="function_name">
|
||
<a class="link" href="GtkStatusIcon.html#gtk-status-icon-get-title" title="gtk_status_icon_get_title ()">gtk_status_icon_get_title</a> <span class="c_punctuation">()</span>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="function_type">
|
||
<span class="returnvalue">void</span>
|
||
</td>
|
||
<td class="function_name">
|
||
<a class="link" href="GtkStatusIcon.html#gtk-status-icon-set-name" title="gtk_status_icon_set_name ()">gtk_status_icon_set_name</a> <span class="c_punctuation">()</span>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="function_type">
|
||
<span class="returnvalue">void</span>
|
||
</td>
|
||
<td class="function_name">
|
||
<a class="link" href="GtkStatusIcon.html#gtk-status-icon-set-visible" title="gtk_status_icon_set_visible ()">gtk_status_icon_set_visible</a> <span class="c_punctuation">()</span>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="function_type">
|
||
<span class="returnvalue">gboolean</span>
|
||
</td>
|
||
<td class="function_name">
|
||
<a class="link" href="GtkStatusIcon.html#gtk-status-icon-get-visible" title="gtk_status_icon_get_visible ()">gtk_status_icon_get_visible</a> <span class="c_punctuation">()</span>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="function_type">
|
||
<span class="returnvalue">gboolean</span>
|
||
</td>
|
||
<td class="function_name">
|
||
<a class="link" href="GtkStatusIcon.html#gtk-status-icon-is-embedded" title="gtk_status_icon_is_embedded ()">gtk_status_icon_is_embedded</a> <span class="c_punctuation">()</span>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="function_type">
|
||
<span class="returnvalue">void</span>
|
||
</td>
|
||
<td class="function_name">
|
||
<a class="link" href="GtkStatusIcon.html#gtk-status-icon-position-menu" title="gtk_status_icon_position_menu ()">gtk_status_icon_position_menu</a> <span class="c_punctuation">()</span>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="function_type">
|
||
<span class="returnvalue">gboolean</span>
|
||
</td>
|
||
<td class="function_name">
|
||
<a class="link" href="GtkStatusIcon.html#gtk-status-icon-get-geometry" title="gtk_status_icon_get_geometry ()">gtk_status_icon_get_geometry</a> <span class="c_punctuation">()</span>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="function_type">
|
||
<span class="returnvalue">guint32</span>
|
||
</td>
|
||
<td class="function_name">
|
||
<a class="link" href="GtkStatusIcon.html#gtk-status-icon-get-x11-window-id" title="gtk_status_icon_get_x11_window_id ()">gtk_status_icon_get_x11_window_id</a> <span class="c_punctuation">()</span>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
</div>
|
||
<div class="refsect1">
|
||
<a name="GtkStatusIcon.properties"></a><h2>Properties</h2>
|
||
<div class="informaltable"><table class="informaltable" border="0">
|
||
<colgroup>
|
||
<col width="150px" class="properties_type">
|
||
<col width="300px" class="properties_name">
|
||
<col width="200px" class="properties_flags">
|
||
</colgroup>
|
||
<tbody>
|
||
<tr>
|
||
<td class="property_type"><span class="type">gboolean</span></td>
|
||
<td class="property_name"><a class="link" href="GtkStatusIcon.html#GtkStatusIcon--embedded" title="The “embedded” property">embedded</a></td>
|
||
<td class="property_flags">Read</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="property_type">
|
||
<span class="type">char</span> *</td>
|
||
<td class="property_name"><a class="link" href="GtkStatusIcon.html#GtkStatusIcon--file" title="The “file” property">file</a></td>
|
||
<td class="property_flags">Write</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="property_type">
|
||
<span class="type">GIcon</span> *</td>
|
||
<td class="property_name"><a class="link" href="GtkStatusIcon.html#GtkStatusIcon--gicon" title="The “gicon” property">gicon</a></td>
|
||
<td class="property_flags">Read / Write</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="property_type"><span class="type">gboolean</span></td>
|
||
<td class="property_name"><a class="link" href="GtkStatusIcon.html#GtkStatusIcon--has-tooltip" title="The “has-tooltip” property">has-tooltip</a></td>
|
||
<td class="property_flags">Read / Write</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="property_type">
|
||
<span class="type">char</span> *</td>
|
||
<td class="property_name"><a class="link" href="GtkStatusIcon.html#GtkStatusIcon--icon-name" title="The “icon-name” property">icon-name</a></td>
|
||
<td class="property_flags">Read / Write</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="property_type"><a class="link" href="gtk3-Standard-Enumerations.html#GtkOrientation" title="enum GtkOrientation"><span class="type">GtkOrientation</span></a></td>
|
||
<td class="property_name"><a class="link" href="GtkStatusIcon.html#GtkStatusIcon--orientation" title="The “orientation” property">orientation</a></td>
|
||
<td class="property_flags">Read</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="property_type">
|
||
<span class="type">GdkPixbuf</span> *</td>
|
||
<td class="property_name"><a class="link" href="GtkStatusIcon.html#GtkStatusIcon--pixbuf" title="The “pixbuf” property">pixbuf</a></td>
|
||
<td class="property_flags">Read / Write</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="property_type">
|
||
<span class="type">GdkScreen</span> *</td>
|
||
<td class="property_name"><a class="link" href="GtkStatusIcon.html#GtkStatusIcon--screen" title="The “screen” property">screen</a></td>
|
||
<td class="property_flags">Read / Write</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="property_type"><span class="type">int</span></td>
|
||
<td class="property_name"><a class="link" href="GtkStatusIcon.html#GtkStatusIcon--size" title="The “size” property">size</a></td>
|
||
<td class="property_flags">Read</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="property_type">
|
||
<span class="type">char</span> *</td>
|
||
<td class="property_name"><a class="link" href="GtkStatusIcon.html#GtkStatusIcon--stock" title="The “stock” property">stock</a></td>
|
||
<td class="property_flags">Read / Write</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="property_type"><a class="link" href="GtkImage.html#GtkImageType" title="enum GtkImageType"><span class="type">GtkImageType</span></a></td>
|
||
<td class="property_name"><a class="link" href="GtkStatusIcon.html#GtkStatusIcon--storage-type" title="The “storage-type” property">storage-type</a></td>
|
||
<td class="property_flags">Read</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="property_type">
|
||
<span class="type">char</span> *</td>
|
||
<td class="property_name"><a class="link" href="GtkStatusIcon.html#GtkStatusIcon--title" title="The “title” property">title</a></td>
|
||
<td class="property_flags">Read / Write</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="property_type">
|
||
<span class="type">char</span> *</td>
|
||
<td class="property_name"><a class="link" href="GtkStatusIcon.html#GtkStatusIcon--tooltip-markup" title="The “tooltip-markup” property">tooltip-markup</a></td>
|
||
<td class="property_flags">Read / Write</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="property_type">
|
||
<span class="type">char</span> *</td>
|
||
<td class="property_name"><a class="link" href="GtkStatusIcon.html#GtkStatusIcon--tooltip-text" title="The “tooltip-text” property">tooltip-text</a></td>
|
||
<td class="property_flags">Read / Write</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="property_type"><span class="type">gboolean</span></td>
|
||
<td class="property_name"><a class="link" href="GtkStatusIcon.html#GtkStatusIcon--visible" title="The “visible” property">visible</a></td>
|
||
<td class="property_flags">Read / Write</td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
</div>
|
||
<div class="refsect1">
|
||
<a name="GtkStatusIcon.signals"></a><h2>Signals</h2>
|
||
<div class="informaltable"><table class="informaltable" border="0">
|
||
<colgroup>
|
||
<col width="150px" class="signal_proto_type">
|
||
<col width="300px" class="signal_proto_name">
|
||
<col width="200px" class="signal_proto_flags">
|
||
</colgroup>
|
||
<tbody>
|
||
<tr>
|
||
<td class="signal_type"><span class="returnvalue">void</span></td>
|
||
<td class="signal_name"><a class="link" href="GtkStatusIcon.html#GtkStatusIcon-activate" title="The “activate” signal">activate</a></td>
|
||
<td class="signal_flags">Action</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="signal_type"><span class="returnvalue">gboolean</span></td>
|
||
<td class="signal_name"><a class="link" href="GtkStatusIcon.html#GtkStatusIcon-button-press-event" title="The “button-press-event” signal">button-press-event</a></td>
|
||
<td class="signal_flags">Run Last</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="signal_type"><span class="returnvalue">gboolean</span></td>
|
||
<td class="signal_name"><a class="link" href="GtkStatusIcon.html#GtkStatusIcon-button-release-event" title="The “button-release-event” signal">button-release-event</a></td>
|
||
<td class="signal_flags">Run Last</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="signal_type"><span class="returnvalue">void</span></td>
|
||
<td class="signal_name"><a class="link" href="GtkStatusIcon.html#GtkStatusIcon-popup-menu" title="The “popup-menu” signal">popup-menu</a></td>
|
||
<td class="signal_flags">Action</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="signal_type"><span class="returnvalue">gboolean</span></td>
|
||
<td class="signal_name"><a class="link" href="GtkStatusIcon.html#GtkStatusIcon-query-tooltip" title="The “query-tooltip” signal">query-tooltip</a></td>
|
||
<td class="signal_flags">Run Last</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="signal_type"><span class="returnvalue">gboolean</span></td>
|
||
<td class="signal_name"><a class="link" href="GtkStatusIcon.html#GtkStatusIcon-scroll-event" title="The “scroll-event” signal">scroll-event</a></td>
|
||
<td class="signal_flags">Run Last</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="signal_type"><span class="returnvalue">gboolean</span></td>
|
||
<td class="signal_name"><a class="link" href="GtkStatusIcon.html#GtkStatusIcon-size-changed" title="The “size-changed” signal">size-changed</a></td>
|
||
<td class="signal_flags">Run Last</td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
</div>
|
||
<div class="refsect1">
|
||
<a name="GtkStatusIcon.other"></a><h2>Types and Values</h2>
|
||
<div class="informaltable"><table class="informaltable" width="100%" border="0">
|
||
<colgroup>
|
||
<col width="150px" class="other_proto_type">
|
||
<col class="other_proto_name">
|
||
</colgroup>
|
||
<tbody><tr>
|
||
<td class="datatype_keyword">struct</td>
|
||
<td class="function_name"><a class="link" href="GtkStatusIcon.html#GtkStatusIcon-struct" title="struct GtkStatusIcon">GtkStatusIcon</a></td>
|
||
</tr></tbody>
|
||
</table></div>
|
||
</div>
|
||
<div class="refsect1">
|
||
<a name="GtkStatusIcon.object-hierarchy"></a><h2>Object Hierarchy</h2>
|
||
<pre class="screen"> GObject
|
||
<span class="lineart">╰──</span> GtkStatusIcon
|
||
</pre>
|
||
</div>
|
||
<div class="refsect1">
|
||
<a name="GtkStatusIcon.includes"></a><h2>Includes</h2>
|
||
<pre class="synopsis">#include <gtk/gtk.h>
|
||
</pre>
|
||
</div>
|
||
<div class="refsect1">
|
||
<a name="GtkStatusIcon.description"></a><h2>Description</h2>
|
||
<p>The “system tray” or notification area is normally used for transient icons
|
||
that indicate some special state. For example, a system tray icon might
|
||
appear to tell the user that they have new mail, or have an incoming instant
|
||
message, or something along those lines. The basic idea is that creating an
|
||
icon in the notification area is less annoying than popping up a dialog.</p>
|
||
<p>A <a class="link" href="GtkStatusIcon.html" title="GtkStatusIcon"><span class="type">GtkStatusIcon</span></a> object can be used to display an icon in a “system tray”.
|
||
The icon can have a tooltip, and the user can interact with it by
|
||
activating it or popping up a context menu.</p>
|
||
<p>It is very important to notice that status icons depend on the existence
|
||
of a notification area being available to the user; you should not use status
|
||
icons as the only way to convey critical information regarding your application,
|
||
as the notification area may not exist on the user's environment, or may have
|
||
been removed. You should always check that a status icon has been embedded into
|
||
a notification area by using <a class="link" href="GtkStatusIcon.html#gtk-status-icon-is-embedded" title="gtk_status_icon_is_embedded ()"><code class="function">gtk_status_icon_is_embedded()</code></a>, and gracefully
|
||
recover if the function returns <code class="literal">FALSE</code>.</p>
|
||
<p>On X11, the implementation follows the
|
||
<a class="ulink" href="http://www.freedesktop.org/wiki/Specifications/systemtray-spec" target="_top">FreeDesktop System Tray Specification</a>.
|
||
Implementations of the “tray” side of this specification can
|
||
be found e.g. in the GNOME 2 and KDE panel applications.</p>
|
||
<p>Note that a GtkStatusIcon is not a widget, but just a <span class="type">GObject</span>. Making it a
|
||
widget would be impractical, since the system tray on Windows doesn’t allow
|
||
to embed arbitrary widgets.</p>
|
||
<p>GtkStatusIcon has been deprecated in 3.14. You should consider using
|
||
notifications or more modern platform-specific APIs instead. GLib provides
|
||
the <span class="type">GNotification</span> API which works well with <a class="link" href="GtkApplication.html" title="GtkApplication"><span class="type">GtkApplication</span></a> on multiple
|
||
platforms and environments, and should be the preferred mechanism to notify
|
||
the users of transient status updates. See this <a class="ulink" href="https://wiki.gnome.org/HowDoI/GNotification" target="_top">HowDoI</a>
|
||
for code examples.</p>
|
||
</div>
|
||
<div class="refsect1">
|
||
<a name="GtkStatusIcon.functions_details"></a><h2>Functions</h2>
|
||
<div class="refsect2">
|
||
<a name="gtk-status-icon-new"></a><h3>gtk_status_icon_new ()</h3>
|
||
<pre class="programlisting"><a class="link" href="GtkStatusIcon.html" title="GtkStatusIcon"><span class="returnvalue">GtkStatusIcon</span></a> *
|
||
gtk_status_icon_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
|
||
<div class="warning">
|
||
<p><code class="literal">gtk_status_icon_new</code> has been deprecated since version 3.14 and should not be used in newly-written code.</p>
|
||
<p>Use <span class="type">GNotification</span> and <a class="link" href="GtkApplication.html" title="GtkApplication"><span class="type">GtkApplication</span></a> to
|
||
provide status notifications</p>
|
||
</div>
|
||
<p>Creates an empty status icon object.</p>
|
||
<div class="refsect3">
|
||
<a name="gtk-status-icon-new.returns"></a><h4>Returns</h4>
|
||
<p> a new <a class="link" href="GtkStatusIcon.html" title="GtkStatusIcon"><span class="type">GtkStatusIcon</span></a></p>
|
||
</div>
|
||
<p class="since">Since: 2.10</p>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="gtk-status-icon-new-from-pixbuf"></a><h3>gtk_status_icon_new_from_pixbuf ()</h3>
|
||
<pre class="programlisting"><a class="link" href="GtkStatusIcon.html" title="GtkStatusIcon"><span class="returnvalue">GtkStatusIcon</span></a> *
|
||
gtk_status_icon_new_from_pixbuf (<em class="parameter"><code><span class="type">GdkPixbuf</span> *pixbuf</code></em>);</pre>
|
||
<div class="warning">
|
||
<p><code class="literal">gtk_status_icon_new_from_pixbuf</code> has been deprecated since version 3.14 and should not be used in newly-written code.</p>
|
||
<p>Use <span class="type">GNotification</span> and <a class="link" href="GtkApplication.html" title="GtkApplication"><span class="type">GtkApplication</span></a> to
|
||
provide status notifications</p>
|
||
</div>
|
||
<p>Creates a status icon displaying <em class="parameter"><code>pixbuf</code></em>
|
||
. </p>
|
||
<p>The image will be scaled down to fit in the available
|
||
space in the notification area, if necessary.</p>
|
||
<div class="refsect3">
|
||
<a name="gtk-status-icon-new-from-pixbuf.parameters"></a><h4>Parameters</h4>
|
||
<div class="informaltable"><table class="informaltable" width="100%" border="0">
|
||
<colgroup>
|
||
<col width="150px" class="parameters_name">
|
||
<col class="parameters_description">
|
||
<col width="200px" class="parameters_annotations">
|
||
</colgroup>
|
||
<tbody><tr>
|
||
<td class="parameter_name"><p>pixbuf</p></td>
|
||
<td class="parameter_description"><p>a <span class="type">GdkPixbuf</span></p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr></tbody>
|
||
</table></div>
|
||
</div>
|
||
<div class="refsect3">
|
||
<a name="gtk-status-icon-new-from-pixbuf.returns"></a><h4>Returns</h4>
|
||
<p> a new <a class="link" href="GtkStatusIcon.html" title="GtkStatusIcon"><span class="type">GtkStatusIcon</span></a></p>
|
||
</div>
|
||
<p class="since">Since: 2.10</p>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="gtk-status-icon-new-from-file"></a><h3>gtk_status_icon_new_from_file ()</h3>
|
||
<pre class="programlisting"><a class="link" href="GtkStatusIcon.html" title="GtkStatusIcon"><span class="returnvalue">GtkStatusIcon</span></a> *
|
||
gtk_status_icon_new_from_file (<em class="parameter"><code>const <span class="type">gchar</span> *filename</code></em>);</pre>
|
||
<div class="warning">
|
||
<p><code class="literal">gtk_status_icon_new_from_file</code> has been deprecated since version 3.14 and should not be used in newly-written code.</p>
|
||
<p>Use <span class="type">GNotification</span> and <a class="link" href="GtkApplication.html" title="GtkApplication"><span class="type">GtkApplication</span></a> to
|
||
provide status notifications</p>
|
||
</div>
|
||
<p>Creates a status icon displaying the file <em class="parameter"><code>filename</code></em>
|
||
. </p>
|
||
<p>The image will be scaled down to fit in the available
|
||
space in the notification area, if necessary.</p>
|
||
<div class="refsect3">
|
||
<a name="gtk-status-icon-new-from-file.parameters"></a><h4>Parameters</h4>
|
||
<div class="informaltable"><table class="informaltable" width="100%" border="0">
|
||
<colgroup>
|
||
<col width="150px" class="parameters_name">
|
||
<col class="parameters_description">
|
||
<col width="200px" class="parameters_annotations">
|
||
</colgroup>
|
||
<tbody><tr>
|
||
<td class="parameter_name"><p>filename</p></td>
|
||
<td class="parameter_description"><p>a filename. </p></td>
|
||
<td class="parameter_annotations"><span class="annotation">[<acronym title="Override the parsed C type with given type."><span class="acronym">type</span></acronym> filename]</span></td>
|
||
</tr></tbody>
|
||
</table></div>
|
||
</div>
|
||
<div class="refsect3">
|
||
<a name="gtk-status-icon-new-from-file.returns"></a><h4>Returns</h4>
|
||
<p> a new <a class="link" href="GtkStatusIcon.html" title="GtkStatusIcon"><span class="type">GtkStatusIcon</span></a></p>
|
||
</div>
|
||
<p class="since">Since: 2.10</p>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="gtk-status-icon-new-from-stock"></a><h3>gtk_status_icon_new_from_stock ()</h3>
|
||
<pre class="programlisting"><a class="link" href="GtkStatusIcon.html" title="GtkStatusIcon"><span class="returnvalue">GtkStatusIcon</span></a> *
|
||
gtk_status_icon_new_from_stock (<em class="parameter"><code>const <span class="type">gchar</span> *stock_id</code></em>);</pre>
|
||
<div class="warning">
|
||
<p><code class="literal">gtk_status_icon_new_from_stock</code> has been deprecated since version 3.14 and should not be used in newly-written code.</p>
|
||
<p>Use <span class="type">GNotification</span> and <a class="link" href="GtkApplication.html" title="GtkApplication"><span class="type">GtkApplication</span></a> to
|
||
provide status notifications</p>
|
||
</div>
|
||
<p>Creates a status icon displaying a stock icon. Sample stock icon
|
||
names are <a class="link" href="gtk3-Stock-Items.html#GTK-STOCK-OPEN:CAPS" title="GTK_STOCK_OPEN"><span class="type">GTK_STOCK_OPEN</span></a>, <a class="link" href="gtk3-Stock-Items.html#GTK-STOCK-QUIT:CAPS" title="GTK_STOCK_QUIT"><span class="type">GTK_STOCK_QUIT</span></a>. You can register your
|
||
own stock icon names, see <a class="link" href="gtk3-Themeable-Stock-Images.html#gtk-icon-factory-add-default" title="gtk_icon_factory_add_default ()"><code class="function">gtk_icon_factory_add_default()</code></a> and
|
||
<a class="link" href="gtk3-Themeable-Stock-Images.html#gtk-icon-factory-add" title="gtk_icon_factory_add ()"><code class="function">gtk_icon_factory_add()</code></a>.</p>
|
||
<div class="refsect3">
|
||
<a name="gtk-status-icon-new-from-stock.parameters"></a><h4>Parameters</h4>
|
||
<div class="informaltable"><table class="informaltable" width="100%" border="0">
|
||
<colgroup>
|
||
<col width="150px" class="parameters_name">
|
||
<col class="parameters_description">
|
||
<col width="200px" class="parameters_annotations">
|
||
</colgroup>
|
||
<tbody><tr>
|
||
<td class="parameter_name"><p>stock_id</p></td>
|
||
<td class="parameter_description"><p>a stock icon id</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr></tbody>
|
||
</table></div>
|
||
</div>
|
||
<div class="refsect3">
|
||
<a name="gtk-status-icon-new-from-stock.returns"></a><h4>Returns</h4>
|
||
<p> a new <a class="link" href="GtkStatusIcon.html" title="GtkStatusIcon"><span class="type">GtkStatusIcon</span></a></p>
|
||
</div>
|
||
<p class="since">Since: 2.10</p>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="gtk-status-icon-new-from-icon-name"></a><h3>gtk_status_icon_new_from_icon_name ()</h3>
|
||
<pre class="programlisting"><a class="link" href="GtkStatusIcon.html" title="GtkStatusIcon"><span class="returnvalue">GtkStatusIcon</span></a> *
|
||
gtk_status_icon_new_from_icon_name (<em class="parameter"><code>const <span class="type">gchar</span> *icon_name</code></em>);</pre>
|
||
<div class="warning">
|
||
<p><code class="literal">gtk_status_icon_new_from_icon_name</code> has been deprecated since version 3.14 and should not be used in newly-written code.</p>
|
||
<p>Use <span class="type">GNotification</span> and <a class="link" href="GtkApplication.html" title="GtkApplication"><span class="type">GtkApplication</span></a> to
|
||
provide status notifications</p>
|
||
</div>
|
||
<p>Creates a status icon displaying an icon from the current icon theme.
|
||
If the current icon theme is changed, the icon will be updated
|
||
appropriately.</p>
|
||
<div class="refsect3">
|
||
<a name="gtk-status-icon-new-from-icon-name.parameters"></a><h4>Parameters</h4>
|
||
<div class="informaltable"><table class="informaltable" width="100%" border="0">
|
||
<colgroup>
|
||
<col width="150px" class="parameters_name">
|
||
<col class="parameters_description">
|
||
<col width="200px" class="parameters_annotations">
|
||
</colgroup>
|
||
<tbody><tr>
|
||
<td class="parameter_name"><p>icon_name</p></td>
|
||
<td class="parameter_description"><p>an icon name</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr></tbody>
|
||
</table></div>
|
||
</div>
|
||
<div class="refsect3">
|
||
<a name="gtk-status-icon-new-from-icon-name.returns"></a><h4>Returns</h4>
|
||
<p> a new <a class="link" href="GtkStatusIcon.html" title="GtkStatusIcon"><span class="type">GtkStatusIcon</span></a></p>
|
||
</div>
|
||
<p class="since">Since: 2.10</p>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="gtk-status-icon-new-from-gicon"></a><h3>gtk_status_icon_new_from_gicon ()</h3>
|
||
<pre class="programlisting"><a class="link" href="GtkStatusIcon.html" title="GtkStatusIcon"><span class="returnvalue">GtkStatusIcon</span></a> *
|
||
gtk_status_icon_new_from_gicon (<em class="parameter"><code><span class="type">GIcon</span> *icon</code></em>);</pre>
|
||
<div class="warning">
|
||
<p><code class="literal">gtk_status_icon_new_from_gicon</code> has been deprecated since version 3.14 and should not be used in newly-written code.</p>
|
||
<p>Use <span class="type">GNotification</span> and <a class="link" href="GtkApplication.html" title="GtkApplication"><span class="type">GtkApplication</span></a> to
|
||
provide status notifications</p>
|
||
</div>
|
||
<p>Creates a status icon displaying a <span class="type">GIcon</span>. If the icon is a
|
||
themed icon, it will be updated when the theme changes.</p>
|
||
<div class="refsect3">
|
||
<a name="gtk-status-icon-new-from-gicon.parameters"></a><h4>Parameters</h4>
|
||
<div class="informaltable"><table class="informaltable" width="100%" border="0">
|
||
<colgroup>
|
||
<col width="150px" class="parameters_name">
|
||
<col class="parameters_description">
|
||
<col width="200px" class="parameters_annotations">
|
||
</colgroup>
|
||
<tbody><tr>
|
||
<td class="parameter_name"><p>icon</p></td>
|
||
<td class="parameter_description"><p>a <span class="type">GIcon</span></p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr></tbody>
|
||
</table></div>
|
||
</div>
|
||
<div class="refsect3">
|
||
<a name="gtk-status-icon-new-from-gicon.returns"></a><h4>Returns</h4>
|
||
<p> a new <a class="link" href="GtkStatusIcon.html" title="GtkStatusIcon"><span class="type">GtkStatusIcon</span></a></p>
|
||
</div>
|
||
<p class="since">Since: 2.14</p>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="gtk-status-icon-set-from-pixbuf"></a><h3>gtk_status_icon_set_from_pixbuf ()</h3>
|
||
<pre class="programlisting"><span class="returnvalue">void</span>
|
||
gtk_status_icon_set_from_pixbuf (<em class="parameter"><code><a class="link" href="GtkStatusIcon.html" title="GtkStatusIcon"><span class="type">GtkStatusIcon</span></a> *status_icon</code></em>,
|
||
<em class="parameter"><code><span class="type">GdkPixbuf</span> *pixbuf</code></em>);</pre>
|
||
<div class="warning">
|
||
<p><code class="literal">gtk_status_icon_set_from_pixbuf</code> has been deprecated since version 3.14 and should not be used in newly-written code.</p>
|
||
<p>Use <span class="type">GNotification</span> and <a class="link" href="GtkApplication.html" title="GtkApplication"><span class="type">GtkApplication</span></a> to
|
||
provide status notifications; you can use <code class="function">g_notification_set_icon()</code>
|
||
to associate a <span class="type">GIcon</span> with a notification</p>
|
||
</div>
|
||
<p>Makes <em class="parameter"><code>status_icon</code></em>
|
||
display <em class="parameter"><code>pixbuf</code></em>
|
||
.
|
||
See <a class="link" href="GtkStatusIcon.html#gtk-status-icon-new-from-pixbuf" title="gtk_status_icon_new_from_pixbuf ()"><code class="function">gtk_status_icon_new_from_pixbuf()</code></a> for details.</p>
|
||
<div class="refsect3">
|
||
<a name="gtk-status-icon-set-from-pixbuf.parameters"></a><h4>Parameters</h4>
|
||
<div class="informaltable"><table class="informaltable" width="100%" border="0">
|
||
<colgroup>
|
||
<col width="150px" class="parameters_name">
|
||
<col class="parameters_description">
|
||
<col width="200px" class="parameters_annotations">
|
||
</colgroup>
|
||
<tbody>
|
||
<tr>
|
||
<td class="parameter_name"><p>status_icon</p></td>
|
||
<td class="parameter_description"><p>a <a class="link" href="GtkStatusIcon.html" title="GtkStatusIcon"><span class="type">GtkStatusIcon</span></a></p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>pixbuf</p></td>
|
||
<td class="parameter_description"><p>a <span class="type">GdkPixbuf</span> or <code class="literal">NULL</code>. </p></td>
|
||
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
</div>
|
||
<p class="since">Since: 2.10</p>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="gtk-status-icon-set-from-file"></a><h3>gtk_status_icon_set_from_file ()</h3>
|
||
<pre class="programlisting"><span class="returnvalue">void</span>
|
||
gtk_status_icon_set_from_file (<em class="parameter"><code><a class="link" href="GtkStatusIcon.html" title="GtkStatusIcon"><span class="type">GtkStatusIcon</span></a> *status_icon</code></em>,
|
||
<em class="parameter"><code>const <span class="type">gchar</span> *filename</code></em>);</pre>
|
||
<div class="warning">
|
||
<p><code class="literal">gtk_status_icon_set_from_file</code> has been deprecated since version 3.14 and should not be used in newly-written code.</p>
|
||
<p>Use <span class="type">GNotification</span> and <a class="link" href="GtkApplication.html" title="GtkApplication"><span class="type">GtkApplication</span></a> to
|
||
provide status notifications; you can use <code class="function">g_notification_set_icon()</code>
|
||
to associate a <span class="type">GIcon</span> with a notification</p>
|
||
</div>
|
||
<p>Makes <em class="parameter"><code>status_icon</code></em>
|
||
display the file <em class="parameter"><code>filename</code></em>
|
||
.
|
||
See <a class="link" href="GtkStatusIcon.html#gtk-status-icon-new-from-file" title="gtk_status_icon_new_from_file ()"><code class="function">gtk_status_icon_new_from_file()</code></a> for details.</p>
|
||
<div class="refsect3">
|
||
<a name="gtk-status-icon-set-from-file.parameters"></a><h4>Parameters</h4>
|
||
<div class="informaltable"><table class="informaltable" width="100%" border="0">
|
||
<colgroup>
|
||
<col width="150px" class="parameters_name">
|
||
<col class="parameters_description">
|
||
<col width="200px" class="parameters_annotations">
|
||
</colgroup>
|
||
<tbody>
|
||
<tr>
|
||
<td class="parameter_name"><p>status_icon</p></td>
|
||
<td class="parameter_description"><p>a <a class="link" href="GtkStatusIcon.html" title="GtkStatusIcon"><span class="type">GtkStatusIcon</span></a></p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>filename</p></td>
|
||
<td class="parameter_description"><p>a filename. </p></td>
|
||
<td class="parameter_annotations"><span class="annotation">[<acronym title="Override the parsed C type with given type."><span class="acronym">type</span></acronym> filename]</span></td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
</div>
|
||
<p class="since">Since: 2.10</p>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="gtk-status-icon-set-from-stock"></a><h3>gtk_status_icon_set_from_stock ()</h3>
|
||
<pre class="programlisting"><span class="returnvalue">void</span>
|
||
gtk_status_icon_set_from_stock (<em class="parameter"><code><a class="link" href="GtkStatusIcon.html" title="GtkStatusIcon"><span class="type">GtkStatusIcon</span></a> *status_icon</code></em>,
|
||
<em class="parameter"><code>const <span class="type">gchar</span> *stock_id</code></em>);</pre>
|
||
<div class="warning">
|
||
<p><code class="literal">gtk_status_icon_set_from_stock</code> has been deprecated since version 3.10 and should not be used in newly-written code.</p>
|
||
<p>Use <a class="link" href="GtkStatusIcon.html#gtk-status-icon-set-from-icon-name" title="gtk_status_icon_set_from_icon_name ()"><code class="function">gtk_status_icon_set_from_icon_name()</code></a> instead.</p>
|
||
</div>
|
||
<p>Makes <em class="parameter"><code>status_icon</code></em>
|
||
display the stock icon with the id <em class="parameter"><code>stock_id</code></em>
|
||
.
|
||
See <a class="link" href="GtkStatusIcon.html#gtk-status-icon-new-from-stock" title="gtk_status_icon_new_from_stock ()"><code class="function">gtk_status_icon_new_from_stock()</code></a> for details.</p>
|
||
<div class="refsect3">
|
||
<a name="gtk-status-icon-set-from-stock.parameters"></a><h4>Parameters</h4>
|
||
<div class="informaltable"><table class="informaltable" width="100%" border="0">
|
||
<colgroup>
|
||
<col width="150px" class="parameters_name">
|
||
<col class="parameters_description">
|
||
<col width="200px" class="parameters_annotations">
|
||
</colgroup>
|
||
<tbody>
|
||
<tr>
|
||
<td class="parameter_name"><p>status_icon</p></td>
|
||
<td class="parameter_description"><p>a <a class="link" href="GtkStatusIcon.html" title="GtkStatusIcon"><span class="type">GtkStatusIcon</span></a></p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>stock_id</p></td>
|
||
<td class="parameter_description"><p>a stock icon id</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
</div>
|
||
<p class="since">Since: 2.10</p>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="gtk-status-icon-set-from-icon-name"></a><h3>gtk_status_icon_set_from_icon_name ()</h3>
|
||
<pre class="programlisting"><span class="returnvalue">void</span>
|
||
gtk_status_icon_set_from_icon_name (<em class="parameter"><code><a class="link" href="GtkStatusIcon.html" title="GtkStatusIcon"><span class="type">GtkStatusIcon</span></a> *status_icon</code></em>,
|
||
<em class="parameter"><code>const <span class="type">gchar</span> *icon_name</code></em>);</pre>
|
||
<div class="warning">
|
||
<p><code class="literal">gtk_status_icon_set_from_icon_name</code> has been deprecated since version 3.14 and should not be used in newly-written code.</p>
|
||
<p>Use <span class="type">GNotification</span> and <a class="link" href="GtkApplication.html" title="GtkApplication"><span class="type">GtkApplication</span></a> to
|
||
provide status notifications; you can use <code class="function">g_notification_set_icon()</code>
|
||
to associate a <span class="type">GIcon</span> with a notification</p>
|
||
</div>
|
||
<p>Makes <em class="parameter"><code>status_icon</code></em>
|
||
display the icon named <em class="parameter"><code>icon_name</code></em>
|
||
from the
|
||
current icon theme.
|
||
See <a class="link" href="GtkStatusIcon.html#gtk-status-icon-new-from-icon-name" title="gtk_status_icon_new_from_icon_name ()"><code class="function">gtk_status_icon_new_from_icon_name()</code></a> for details.</p>
|
||
<div class="refsect3">
|
||
<a name="gtk-status-icon-set-from-icon-name.parameters"></a><h4>Parameters</h4>
|
||
<div class="informaltable"><table class="informaltable" width="100%" border="0">
|
||
<colgroup>
|
||
<col width="150px" class="parameters_name">
|
||
<col class="parameters_description">
|
||
<col width="200px" class="parameters_annotations">
|
||
</colgroup>
|
||
<tbody>
|
||
<tr>
|
||
<td class="parameter_name"><p>status_icon</p></td>
|
||
<td class="parameter_description"><p>a <a class="link" href="GtkStatusIcon.html" title="GtkStatusIcon"><span class="type">GtkStatusIcon</span></a></p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>icon_name</p></td>
|
||
<td class="parameter_description"><p>an icon name</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
</div>
|
||
<p class="since">Since: 2.10</p>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="gtk-status-icon-set-from-gicon"></a><h3>gtk_status_icon_set_from_gicon ()</h3>
|
||
<pre class="programlisting"><span class="returnvalue">void</span>
|
||
gtk_status_icon_set_from_gicon (<em class="parameter"><code><a class="link" href="GtkStatusIcon.html" title="GtkStatusIcon"><span class="type">GtkStatusIcon</span></a> *status_icon</code></em>,
|
||
<em class="parameter"><code><span class="type">GIcon</span> *icon</code></em>);</pre>
|
||
<div class="warning">
|
||
<p><code class="literal">gtk_status_icon_set_from_gicon</code> has been deprecated since version 3.14 and should not be used in newly-written code.</p>
|
||
<p>Use <span class="type">GNotification</span> and <a class="link" href="GtkApplication.html" title="GtkApplication"><span class="type">GtkApplication</span></a> to
|
||
provide status notifications; you can use <code class="function">g_notification_set_icon()</code>
|
||
to associate a <span class="type">GIcon</span> with a notification</p>
|
||
</div>
|
||
<p>Makes <em class="parameter"><code>status_icon</code></em>
|
||
display the <span class="type">GIcon</span>.
|
||
See <a class="link" href="GtkStatusIcon.html#gtk-status-icon-new-from-gicon" title="gtk_status_icon_new_from_gicon ()"><code class="function">gtk_status_icon_new_from_gicon()</code></a> for details.</p>
|
||
<div class="refsect3">
|
||
<a name="gtk-status-icon-set-from-gicon.parameters"></a><h4>Parameters</h4>
|
||
<div class="informaltable"><table class="informaltable" width="100%" border="0">
|
||
<colgroup>
|
||
<col width="150px" class="parameters_name">
|
||
<col class="parameters_description">
|
||
<col width="200px" class="parameters_annotations">
|
||
</colgroup>
|
||
<tbody>
|
||
<tr>
|
||
<td class="parameter_name"><p>status_icon</p></td>
|
||
<td class="parameter_description"><p>a <a class="link" href="GtkStatusIcon.html" title="GtkStatusIcon"><span class="type">GtkStatusIcon</span></a></p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>icon</p></td>
|
||
<td class="parameter_description"><p>a GIcon</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
</div>
|
||
<p class="since">Since: 2.14</p>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="gtk-status-icon-get-storage-type"></a><h3>gtk_status_icon_get_storage_type ()</h3>
|
||
<pre class="programlisting"><a class="link" href="GtkImage.html#GtkImageType" title="enum GtkImageType"><span class="returnvalue">GtkImageType</span></a>
|
||
gtk_status_icon_get_storage_type (<em class="parameter"><code><a class="link" href="GtkStatusIcon.html" title="GtkStatusIcon"><span class="type">GtkStatusIcon</span></a> *status_icon</code></em>);</pre>
|
||
<div class="warning">
|
||
<p><code class="literal">gtk_status_icon_get_storage_type</code> has been deprecated since version 3.14 and should not be used in newly-written code.</p>
|
||
<p>Use <span class="type">GNotification</span> and <a class="link" href="GtkApplication.html" title="GtkApplication"><span class="type">GtkApplication</span></a> to
|
||
provide status notifications; there is no direct replacement
|
||
for this function, and <span class="type">GNotification</span> only supports <span class="type">GIcon</span>
|
||
instances</p>
|
||
</div>
|
||
<p>Gets the type of representation being used by the <a class="link" href="GtkStatusIcon.html" title="GtkStatusIcon"><span class="type">GtkStatusIcon</span></a>
|
||
to store image data. If the <a class="link" href="GtkStatusIcon.html" title="GtkStatusIcon"><span class="type">GtkStatusIcon</span></a> has no image data,
|
||
the return value will be <a class="link" href="GtkImage.html#GTK-IMAGE-EMPTY:CAPS"><code class="literal">GTK_IMAGE_EMPTY</code></a>.</p>
|
||
<div class="refsect3">
|
||
<a name="gtk-status-icon-get-storage-type.parameters"></a><h4>Parameters</h4>
|
||
<div class="informaltable"><table class="informaltable" width="100%" border="0">
|
||
<colgroup>
|
||
<col width="150px" class="parameters_name">
|
||
<col class="parameters_description">
|
||
<col width="200px" class="parameters_annotations">
|
||
</colgroup>
|
||
<tbody><tr>
|
||
<td class="parameter_name"><p>status_icon</p></td>
|
||
<td class="parameter_description"><p>a <a class="link" href="GtkStatusIcon.html" title="GtkStatusIcon"><span class="type">GtkStatusIcon</span></a></p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr></tbody>
|
||
</table></div>
|
||
</div>
|
||
<div class="refsect3">
|
||
<a name="gtk-status-icon-get-storage-type.returns"></a><h4>Returns</h4>
|
||
<p> the image representation being used</p>
|
||
</div>
|
||
<p class="since">Since: 2.10</p>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="gtk-status-icon-get-pixbuf"></a><h3>gtk_status_icon_get_pixbuf ()</h3>
|
||
<pre class="programlisting"><span class="returnvalue">GdkPixbuf</span> *
|
||
gtk_status_icon_get_pixbuf (<em class="parameter"><code><a class="link" href="GtkStatusIcon.html" title="GtkStatusIcon"><span class="type">GtkStatusIcon</span></a> *status_icon</code></em>);</pre>
|
||
<div class="warning">
|
||
<p><code class="literal">gtk_status_icon_get_pixbuf</code> has been deprecated since version 3.14 and should not be used in newly-written code.</p>
|
||
<p>Use <span class="type">GNotification</span> and <a class="link" href="GtkApplication.html" title="GtkApplication"><span class="type">GtkApplication</span></a> to
|
||
provide status notifications; there is no direct replacement
|
||
for this function</p>
|
||
</div>
|
||
<p>Gets the <span class="type">GdkPixbuf</span> being displayed by the <a class="link" href="GtkStatusIcon.html" title="GtkStatusIcon"><span class="type">GtkStatusIcon</span></a>.
|
||
The storage type of the status icon must be <a class="link" href="GtkImage.html#GTK-IMAGE-EMPTY:CAPS"><code class="literal">GTK_IMAGE_EMPTY</code></a> or
|
||
<a class="link" href="GtkImage.html#GTK-IMAGE-PIXBUF:CAPS"><code class="literal">GTK_IMAGE_PIXBUF</code></a> (see <a class="link" href="GtkStatusIcon.html#gtk-status-icon-get-storage-type" title="gtk_status_icon_get_storage_type ()"><code class="function">gtk_status_icon_get_storage_type()</code></a>).
|
||
The caller of this function does not own a reference to the
|
||
returned pixbuf.</p>
|
||
<div class="refsect3">
|
||
<a name="gtk-status-icon-get-pixbuf.parameters"></a><h4>Parameters</h4>
|
||
<div class="informaltable"><table class="informaltable" width="100%" border="0">
|
||
<colgroup>
|
||
<col width="150px" class="parameters_name">
|
||
<col class="parameters_description">
|
||
<col width="200px" class="parameters_annotations">
|
||
</colgroup>
|
||
<tbody><tr>
|
||
<td class="parameter_name"><p>status_icon</p></td>
|
||
<td class="parameter_description"><p>a <a class="link" href="GtkStatusIcon.html" title="GtkStatusIcon"><span class="type">GtkStatusIcon</span></a></p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr></tbody>
|
||
</table></div>
|
||
</div>
|
||
<div class="refsect3">
|
||
<a name="gtk-status-icon-get-pixbuf.returns"></a><h4>Returns</h4>
|
||
<p>the displayed pixbuf,
|
||
or <code class="literal">NULL</code> if the image is empty. </p>
|
||
<p><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>][<acronym title="The data is owned by the callee, which is responsible of freeing it."><span class="acronym">transfer none</span></acronym>]</span></p>
|
||
</div>
|
||
<p class="since">Since: 2.10</p>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="gtk-status-icon-get-stock"></a><h3>gtk_status_icon_get_stock ()</h3>
|
||
<pre class="programlisting">const <span class="returnvalue">gchar</span> *
|
||
gtk_status_icon_get_stock (<em class="parameter"><code><a class="link" href="GtkStatusIcon.html" title="GtkStatusIcon"><span class="type">GtkStatusIcon</span></a> *status_icon</code></em>);</pre>
|
||
<div class="warning">
|
||
<p><code class="literal">gtk_status_icon_get_stock</code> has been deprecated since version 3.10 and should not be used in newly-written code.</p>
|
||
<p>Use <a class="link" href="GtkStatusIcon.html#gtk-status-icon-get-icon-name" title="gtk_status_icon_get_icon_name ()"><code class="function">gtk_status_icon_get_icon_name()</code></a> instead.</p>
|
||
</div>
|
||
<p>Gets the id of the stock icon being displayed by the <a class="link" href="GtkStatusIcon.html" title="GtkStatusIcon"><span class="type">GtkStatusIcon</span></a>.
|
||
The storage type of the status icon must be <a class="link" href="GtkImage.html#GTK-IMAGE-EMPTY:CAPS"><code class="literal">GTK_IMAGE_EMPTY</code></a> or
|
||
<a class="link" href="GtkImage.html#GTK-IMAGE-STOCK:CAPS"><code class="literal">GTK_IMAGE_STOCK</code></a> (see <a class="link" href="GtkStatusIcon.html#gtk-status-icon-get-storage-type" title="gtk_status_icon_get_storage_type ()"><code class="function">gtk_status_icon_get_storage_type()</code></a>).
|
||
The returned string is owned by the <a class="link" href="GtkStatusIcon.html" title="GtkStatusIcon"><span class="type">GtkStatusIcon</span></a> and should not
|
||
be freed or modified.</p>
|
||
<div class="refsect3">
|
||
<a name="gtk-status-icon-get-stock.parameters"></a><h4>Parameters</h4>
|
||
<div class="informaltable"><table class="informaltable" width="100%" border="0">
|
||
<colgroup>
|
||
<col width="150px" class="parameters_name">
|
||
<col class="parameters_description">
|
||
<col width="200px" class="parameters_annotations">
|
||
</colgroup>
|
||
<tbody><tr>
|
||
<td class="parameter_name"><p>status_icon</p></td>
|
||
<td class="parameter_description"><p>a <a class="link" href="GtkStatusIcon.html" title="GtkStatusIcon"><span class="type">GtkStatusIcon</span></a></p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr></tbody>
|
||
</table></div>
|
||
</div>
|
||
<div class="refsect3">
|
||
<a name="gtk-status-icon-get-stock.returns"></a><h4>Returns</h4>
|
||
<p>stock id of the displayed stock icon,
|
||
or <code class="literal">NULL</code> if the image is empty. </p>
|
||
<p><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></p>
|
||
</div>
|
||
<p class="since">Since: 2.10</p>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="gtk-status-icon-get-icon-name"></a><h3>gtk_status_icon_get_icon_name ()</h3>
|
||
<pre class="programlisting">const <span class="returnvalue">gchar</span> *
|
||
gtk_status_icon_get_icon_name (<em class="parameter"><code><a class="link" href="GtkStatusIcon.html" title="GtkStatusIcon"><span class="type">GtkStatusIcon</span></a> *status_icon</code></em>);</pre>
|
||
<div class="warning">
|
||
<p><code class="literal">gtk_status_icon_get_icon_name</code> has been deprecated since version 3.14 and should not be used in newly-written code.</p>
|
||
<p>Use <span class="type">GNotification</span> and <a class="link" href="GtkApplication.html" title="GtkApplication"><span class="type">GtkApplication</span></a> to
|
||
provide status notifications; there is no direct replacement
|
||
for this function</p>
|
||
</div>
|
||
<p>Gets the name of the icon being displayed by the <a class="link" href="GtkStatusIcon.html" title="GtkStatusIcon"><span class="type">GtkStatusIcon</span></a>.
|
||
The storage type of the status icon must be <a class="link" href="GtkImage.html#GTK-IMAGE-EMPTY:CAPS"><code class="literal">GTK_IMAGE_EMPTY</code></a> or
|
||
<a class="link" href="GtkImage.html#GTK-IMAGE-ICON-NAME:CAPS"><code class="literal">GTK_IMAGE_ICON_NAME</code></a> (see <a class="link" href="GtkStatusIcon.html#gtk-status-icon-get-storage-type" title="gtk_status_icon_get_storage_type ()"><code class="function">gtk_status_icon_get_storage_type()</code></a>).
|
||
The returned string is owned by the <a class="link" href="GtkStatusIcon.html" title="GtkStatusIcon"><span class="type">GtkStatusIcon</span></a> and should not
|
||
be freed or modified.</p>
|
||
<div class="refsect3">
|
||
<a name="gtk-status-icon-get-icon-name.parameters"></a><h4>Parameters</h4>
|
||
<div class="informaltable"><table class="informaltable" width="100%" border="0">
|
||
<colgroup>
|
||
<col width="150px" class="parameters_name">
|
||
<col class="parameters_description">
|
||
<col width="200px" class="parameters_annotations">
|
||
</colgroup>
|
||
<tbody><tr>
|
||
<td class="parameter_name"><p>status_icon</p></td>
|
||
<td class="parameter_description"><p>a <a class="link" href="GtkStatusIcon.html" title="GtkStatusIcon"><span class="type">GtkStatusIcon</span></a></p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr></tbody>
|
||
</table></div>
|
||
</div>
|
||
<div class="refsect3">
|
||
<a name="gtk-status-icon-get-icon-name.returns"></a><h4>Returns</h4>
|
||
<p>name of the displayed icon, or <code class="literal">NULL</code> if the image is empty. </p>
|
||
<p><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></p>
|
||
</div>
|
||
<p class="since">Since: 2.10</p>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="gtk-status-icon-get-gicon"></a><h3>gtk_status_icon_get_gicon ()</h3>
|
||
<pre class="programlisting"><span class="returnvalue">GIcon</span> *
|
||
gtk_status_icon_get_gicon (<em class="parameter"><code><a class="link" href="GtkStatusIcon.html" title="GtkStatusIcon"><span class="type">GtkStatusIcon</span></a> *status_icon</code></em>);</pre>
|
||
<div class="warning">
|
||
<p><code class="literal">gtk_status_icon_get_gicon</code> has been deprecated since version 3.14 and should not be used in newly-written code.</p>
|
||
<p>Use <span class="type">GNotification</span> and <a class="link" href="GtkApplication.html" title="GtkApplication"><span class="type">GtkApplication</span></a> to
|
||
provide status notifications; there is no direct replacement
|
||
for this function</p>
|
||
</div>
|
||
<p>Retrieves the <span class="type">GIcon</span> being displayed by the <a class="link" href="GtkStatusIcon.html" title="GtkStatusIcon"><span class="type">GtkStatusIcon</span></a>.
|
||
The storage type of the status icon must be <a class="link" href="GtkImage.html#GTK-IMAGE-EMPTY:CAPS"><code class="literal">GTK_IMAGE_EMPTY</code></a> or
|
||
<a class="link" href="GtkImage.html#GTK-IMAGE-GICON:CAPS"><code class="literal">GTK_IMAGE_GICON</code></a> (see <a class="link" href="GtkStatusIcon.html#gtk-status-icon-get-storage-type" title="gtk_status_icon_get_storage_type ()"><code class="function">gtk_status_icon_get_storage_type()</code></a>).
|
||
The caller of this function does not own a reference to the
|
||
returned <span class="type">GIcon</span>.</p>
|
||
<p>If this function fails, <em class="parameter"><code>icon</code></em>
|
||
is left unchanged;</p>
|
||
<div class="refsect3">
|
||
<a name="gtk-status-icon-get-gicon.parameters"></a><h4>Parameters</h4>
|
||
<div class="informaltable"><table class="informaltable" width="100%" border="0">
|
||
<colgroup>
|
||
<col width="150px" class="parameters_name">
|
||
<col class="parameters_description">
|
||
<col width="200px" class="parameters_annotations">
|
||
</colgroup>
|
||
<tbody><tr>
|
||
<td class="parameter_name"><p>status_icon</p></td>
|
||
<td class="parameter_description"><p>a <a class="link" href="GtkStatusIcon.html" title="GtkStatusIcon"><span class="type">GtkStatusIcon</span></a></p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr></tbody>
|
||
</table></div>
|
||
</div>
|
||
<div class="refsect3">
|
||
<a name="gtk-status-icon-get-gicon.returns"></a><h4>Returns</h4>
|
||
<p>the displayed icon, or <code class="literal">NULL</code> if the image is empty. </p>
|
||
<p><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>][<acronym title="The data is owned by the callee, which is responsible of freeing it."><span class="acronym">transfer none</span></acronym>]</span></p>
|
||
</div>
|
||
<p class="since">Since: 2.14</p>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="gtk-status-icon-get-size"></a><h3>gtk_status_icon_get_size ()</h3>
|
||
<pre class="programlisting"><span class="returnvalue">gint</span>
|
||
gtk_status_icon_get_size (<em class="parameter"><code><a class="link" href="GtkStatusIcon.html" title="GtkStatusIcon"><span class="type">GtkStatusIcon</span></a> *status_icon</code></em>);</pre>
|
||
<div class="warning">
|
||
<p><code class="literal">gtk_status_icon_get_size</code> has been deprecated since version 3.14 and should not be used in newly-written code.</p>
|
||
<p>Use <span class="type">GNotification</span> and <a class="link" href="GtkApplication.html" title="GtkApplication"><span class="type">GtkApplication</span></a> to
|
||
provide status notifications; there is no direct replacement
|
||
for this function, as the representation of a notification
|
||
is left to the platform</p>
|
||
</div>
|
||
<p>Gets the size in pixels that is available for the image.
|
||
Stock icons and named icons adapt their size automatically
|
||
if the size of the notification area changes. For other
|
||
storage types, the size-changed signal can be used to
|
||
react to size changes.</p>
|
||
<p>Note that the returned size is only meaningful while the
|
||
status icon is embedded (see <a class="link" href="GtkStatusIcon.html#gtk-status-icon-is-embedded" title="gtk_status_icon_is_embedded ()"><code class="function">gtk_status_icon_is_embedded()</code></a>).</p>
|
||
<div class="refsect3">
|
||
<a name="gtk-status-icon-get-size.parameters"></a><h4>Parameters</h4>
|
||
<div class="informaltable"><table class="informaltable" width="100%" border="0">
|
||
<colgroup>
|
||
<col width="150px" class="parameters_name">
|
||
<col class="parameters_description">
|
||
<col width="200px" class="parameters_annotations">
|
||
</colgroup>
|
||
<tbody><tr>
|
||
<td class="parameter_name"><p>status_icon</p></td>
|
||
<td class="parameter_description"><p>a <a class="link" href="GtkStatusIcon.html" title="GtkStatusIcon"><span class="type">GtkStatusIcon</span></a></p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr></tbody>
|
||
</table></div>
|
||
</div>
|
||
<div class="refsect3">
|
||
<a name="gtk-status-icon-get-size.returns"></a><h4>Returns</h4>
|
||
<p> the size that is available for the image</p>
|
||
</div>
|
||
<p class="since">Since: 2.10</p>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="gtk-status-icon-set-screen"></a><h3>gtk_status_icon_set_screen ()</h3>
|
||
<pre class="programlisting"><span class="returnvalue">void</span>
|
||
gtk_status_icon_set_screen (<em class="parameter"><code><a class="link" href="GtkStatusIcon.html" title="GtkStatusIcon"><span class="type">GtkStatusIcon</span></a> *status_icon</code></em>,
|
||
<em class="parameter"><code><span class="type">GdkScreen</span> *screen</code></em>);</pre>
|
||
<div class="warning">
|
||
<p><code class="literal">gtk_status_icon_set_screen</code> has been deprecated since version 3.14 and should not be used in newly-written code.</p>
|
||
<p>Use <span class="type">GNotification</span> and <a class="link" href="GtkApplication.html" title="GtkApplication"><span class="type">GtkApplication</span></a> to
|
||
provide status notifications; there is no direct replacement
|
||
for this function, as GTK typically only has one <span class="type">GdkScreen</span>
|
||
and notifications are managed by the platform</p>
|
||
</div>
|
||
<p>Sets the <span class="type">GdkScreen</span> where <em class="parameter"><code>status_icon</code></em>
|
||
is displayed; if
|
||
the icon is already mapped, it will be unmapped, and
|
||
then remapped on the new screen.</p>
|
||
<div class="refsect3">
|
||
<a name="gtk-status-icon-set-screen.parameters"></a><h4>Parameters</h4>
|
||
<div class="informaltable"><table class="informaltable" width="100%" border="0">
|
||
<colgroup>
|
||
<col width="150px" class="parameters_name">
|
||
<col class="parameters_description">
|
||
<col width="200px" class="parameters_annotations">
|
||
</colgroup>
|
||
<tbody>
|
||
<tr>
|
||
<td class="parameter_name"><p>status_icon</p></td>
|
||
<td class="parameter_description"><p>a <a class="link" href="GtkStatusIcon.html" title="GtkStatusIcon"><span class="type">GtkStatusIcon</span></a></p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>screen</p></td>
|
||
<td class="parameter_description"><p>a <span class="type">GdkScreen</span></p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
</div>
|
||
<p class="since">Since: 2.12</p>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="gtk-status-icon-get-screen"></a><h3>gtk_status_icon_get_screen ()</h3>
|
||
<pre class="programlisting"><span class="returnvalue">GdkScreen</span> *
|
||
gtk_status_icon_get_screen (<em class="parameter"><code><a class="link" href="GtkStatusIcon.html" title="GtkStatusIcon"><span class="type">GtkStatusIcon</span></a> *status_icon</code></em>);</pre>
|
||
<div class="warning">
|
||
<p><code class="literal">gtk_status_icon_get_screen</code> has been deprecated since version 3.14 and should not be used in newly-written code.</p>
|
||
<p>Use <span class="type">GNotification</span> and <a class="link" href="GtkApplication.html" title="GtkApplication"><span class="type">GtkApplication</span></a> to
|
||
provide status notifications; there is no direct replacement
|
||
for this function, as notifications are managed by the platform</p>
|
||
</div>
|
||
<p>Returns the <span class="type">GdkScreen</span> associated with <em class="parameter"><code>status_icon</code></em>
|
||
.</p>
|
||
<div class="refsect3">
|
||
<a name="gtk-status-icon-get-screen.parameters"></a><h4>Parameters</h4>
|
||
<div class="informaltable"><table class="informaltable" width="100%" border="0">
|
||
<colgroup>
|
||
<col width="150px" class="parameters_name">
|
||
<col class="parameters_description">
|
||
<col width="200px" class="parameters_annotations">
|
||
</colgroup>
|
||
<tbody><tr>
|
||
<td class="parameter_name"><p>status_icon</p></td>
|
||
<td class="parameter_description"><p>a <a class="link" href="GtkStatusIcon.html" title="GtkStatusIcon"><span class="type">GtkStatusIcon</span></a></p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr></tbody>
|
||
</table></div>
|
||
</div>
|
||
<div class="refsect3">
|
||
<a name="gtk-status-icon-get-screen.returns"></a><h4>Returns</h4>
|
||
<p>a <span class="type">GdkScreen</span>. </p>
|
||
<p><span class="annotation">[<acronym title="The data is owned by the callee, which is responsible of freeing it."><span class="acronym">transfer none</span></acronym>]</span></p>
|
||
</div>
|
||
<p class="since">Since: 2.12</p>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="gtk-status-icon-set-tooltip-text"></a><h3>gtk_status_icon_set_tooltip_text ()</h3>
|
||
<pre class="programlisting"><span class="returnvalue">void</span>
|
||
gtk_status_icon_set_tooltip_text (<em class="parameter"><code><a class="link" href="GtkStatusIcon.html" title="GtkStatusIcon"><span class="type">GtkStatusIcon</span></a> *status_icon</code></em>,
|
||
<em class="parameter"><code>const <span class="type">gchar</span> *text</code></em>);</pre>
|
||
<div class="warning">
|
||
<p><code class="literal">gtk_status_icon_set_tooltip_text</code> has been deprecated since version 3.14 and should not be used in newly-written code.</p>
|
||
<p>Use <span class="type">GNotification</span> and <a class="link" href="GtkApplication.html" title="GtkApplication"><span class="type">GtkApplication</span></a> to
|
||
provide status notifications; there is no direct replacement
|
||
for this function</p>
|
||
</div>
|
||
<p>Sets <em class="parameter"><code>text</code></em>
|
||
as the contents of the tooltip.</p>
|
||
<p>This function will take care of setting <a class="link" href="GtkStatusIcon.html#GtkStatusIcon--has-tooltip" title="The “has-tooltip” property"><span class="type">“has-tooltip”</span></a> to
|
||
<code class="literal">TRUE</code> and of the default handler for the <a class="link" href="GtkStatusIcon.html#GtkStatusIcon-query-tooltip" title="The “query-tooltip” signal"><span class="type">“query-tooltip”</span></a>
|
||
signal.</p>
|
||
<p>See also the <a class="link" href="GtkStatusIcon.html#GtkStatusIcon--tooltip-text" title="The “tooltip-text” property"><span class="type">“tooltip-text”</span></a> property and
|
||
<a class="link" href="GtkTooltip.html#gtk-tooltip-set-text" title="gtk_tooltip_set_text ()"><code class="function">gtk_tooltip_set_text()</code></a>.</p>
|
||
<div class="refsect3">
|
||
<a name="gtk-status-icon-set-tooltip-text.parameters"></a><h4>Parameters</h4>
|
||
<div class="informaltable"><table class="informaltable" width="100%" border="0">
|
||
<colgroup>
|
||
<col width="150px" class="parameters_name">
|
||
<col class="parameters_description">
|
||
<col width="200px" class="parameters_annotations">
|
||
</colgroup>
|
||
<tbody>
|
||
<tr>
|
||
<td class="parameter_name"><p>status_icon</p></td>
|
||
<td class="parameter_description"><p>a <a class="link" href="GtkStatusIcon.html" title="GtkStatusIcon"><span class="type">GtkStatusIcon</span></a></p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>text</p></td>
|
||
<td class="parameter_description"><p>the contents of the tooltip for <em class="parameter"><code>status_icon</code></em>
|
||
</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
</div>
|
||
<p class="since">Since: 2.16</p>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="gtk-status-icon-get-tooltip-text"></a><h3>gtk_status_icon_get_tooltip_text ()</h3>
|
||
<pre class="programlisting"><span class="returnvalue">gchar</span> *
|
||
gtk_status_icon_get_tooltip_text (<em class="parameter"><code><a class="link" href="GtkStatusIcon.html" title="GtkStatusIcon"><span class="type">GtkStatusIcon</span></a> *status_icon</code></em>);</pre>
|
||
<div class="warning">
|
||
<p><code class="literal">gtk_status_icon_get_tooltip_text</code> has been deprecated since version 3.14 and should not be used in newly-written code.</p>
|
||
<p>Use <span class="type">GNotification</span> and <a class="link" href="GtkApplication.html" title="GtkApplication"><span class="type">GtkApplication</span></a> to
|
||
provide status notifications; there is no direct replacement
|
||
for this function</p>
|
||
</div>
|
||
<p>Gets the contents of the tooltip for <em class="parameter"><code>status_icon</code></em>
|
||
.</p>
|
||
<div class="refsect3">
|
||
<a name="gtk-status-icon-get-tooltip-text.parameters"></a><h4>Parameters</h4>
|
||
<div class="informaltable"><table class="informaltable" width="100%" border="0">
|
||
<colgroup>
|
||
<col width="150px" class="parameters_name">
|
||
<col class="parameters_description">
|
||
<col width="200px" class="parameters_annotations">
|
||
</colgroup>
|
||
<tbody><tr>
|
||
<td class="parameter_name"><p>status_icon</p></td>
|
||
<td class="parameter_description"><p>a <a class="link" href="GtkStatusIcon.html" title="GtkStatusIcon"><span class="type">GtkStatusIcon</span></a></p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr></tbody>
|
||
</table></div>
|
||
</div>
|
||
<div class="refsect3">
|
||
<a name="gtk-status-icon-get-tooltip-text.returns"></a><h4>Returns</h4>
|
||
<p>the tooltip text, or <code class="literal">NULL</code>. You should free the
|
||
returned string with <code class="function">g_free()</code> when done. </p>
|
||
<p><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></p>
|
||
</div>
|
||
<p class="since">Since: 2.16</p>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="gtk-status-icon-set-tooltip-markup"></a><h3>gtk_status_icon_set_tooltip_markup ()</h3>
|
||
<pre class="programlisting"><span class="returnvalue">void</span>
|
||
gtk_status_icon_set_tooltip_markup (<em class="parameter"><code><a class="link" href="GtkStatusIcon.html" title="GtkStatusIcon"><span class="type">GtkStatusIcon</span></a> *status_icon</code></em>,
|
||
<em class="parameter"><code>const <span class="type">gchar</span> *markup</code></em>);</pre>
|
||
<div class="warning">
|
||
<p><code class="literal">gtk_status_icon_set_tooltip_markup</code> has been deprecated since version 3.14 and should not be used in newly-written code.</p>
|
||
<p>Use <span class="type">GNotification</span> and <a class="link" href="GtkApplication.html" title="GtkApplication"><span class="type">GtkApplication</span></a> to
|
||
provide status notifications; there is no direct replacement
|
||
for this function</p>
|
||
</div>
|
||
<p>Sets <em class="parameter"><code>markup</code></em>
|
||
as the contents of the tooltip, which is marked up with
|
||
the Pango text markup language.</p>
|
||
<p>This function will take care of setting <a class="link" href="GtkStatusIcon.html#GtkStatusIcon--has-tooltip" title="The “has-tooltip” property"><span class="type">“has-tooltip”</span></a> to <code class="literal">TRUE</code>
|
||
and of the default handler for the <a class="link" href="GtkStatusIcon.html#GtkStatusIcon-query-tooltip" title="The “query-tooltip” signal"><span class="type">“query-tooltip”</span></a> signal.</p>
|
||
<p>See also the <a class="link" href="GtkStatusIcon.html#GtkStatusIcon--tooltip-markup" title="The “tooltip-markup” property"><span class="type">“tooltip-markup”</span></a> property and
|
||
<a class="link" href="GtkTooltip.html#gtk-tooltip-set-markup" title="gtk_tooltip_set_markup ()"><code class="function">gtk_tooltip_set_markup()</code></a>.</p>
|
||
<div class="refsect3">
|
||
<a name="gtk-status-icon-set-tooltip-markup.parameters"></a><h4>Parameters</h4>
|
||
<div class="informaltable"><table class="informaltable" width="100%" border="0">
|
||
<colgroup>
|
||
<col width="150px" class="parameters_name">
|
||
<col class="parameters_description">
|
||
<col width="200px" class="parameters_annotations">
|
||
</colgroup>
|
||
<tbody>
|
||
<tr>
|
||
<td class="parameter_name"><p>status_icon</p></td>
|
||
<td class="parameter_description"><p>a <a class="link" href="GtkStatusIcon.html" title="GtkStatusIcon"><span class="type">GtkStatusIcon</span></a></p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>markup</p></td>
|
||
<td class="parameter_description"><p>the contents of the tooltip for <em class="parameter"><code>status_icon</code></em>
|
||
, or <code class="literal">NULL</code>. </p></td>
|
||
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
</div>
|
||
<p class="since">Since: 2.16</p>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="gtk-status-icon-get-tooltip-markup"></a><h3>gtk_status_icon_get_tooltip_markup ()</h3>
|
||
<pre class="programlisting"><span class="returnvalue">gchar</span> *
|
||
gtk_status_icon_get_tooltip_markup (<em class="parameter"><code><a class="link" href="GtkStatusIcon.html" title="GtkStatusIcon"><span class="type">GtkStatusIcon</span></a> *status_icon</code></em>);</pre>
|
||
<div class="warning">
|
||
<p><code class="literal">gtk_status_icon_get_tooltip_markup</code> has been deprecated since version 3.14 and should not be used in newly-written code.</p>
|
||
<p>Use <span class="type">GNotification</span> and <a class="link" href="GtkApplication.html" title="GtkApplication"><span class="type">GtkApplication</span></a> to
|
||
provide status notifications; there is no direct replacement
|
||
for this function</p>
|
||
</div>
|
||
<p>Gets the contents of the tooltip for <em class="parameter"><code>status_icon</code></em>
|
||
.</p>
|
||
<div class="refsect3">
|
||
<a name="gtk-status-icon-get-tooltip-markup.parameters"></a><h4>Parameters</h4>
|
||
<div class="informaltable"><table class="informaltable" width="100%" border="0">
|
||
<colgroup>
|
||
<col width="150px" class="parameters_name">
|
||
<col class="parameters_description">
|
||
<col width="200px" class="parameters_annotations">
|
||
</colgroup>
|
||
<tbody><tr>
|
||
<td class="parameter_name"><p>status_icon</p></td>
|
||
<td class="parameter_description"><p>a <a class="link" href="GtkStatusIcon.html" title="GtkStatusIcon"><span class="type">GtkStatusIcon</span></a></p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr></tbody>
|
||
</table></div>
|
||
</div>
|
||
<div class="refsect3">
|
||
<a name="gtk-status-icon-get-tooltip-markup.returns"></a><h4>Returns</h4>
|
||
<p>the tooltip text, or <code class="literal">NULL</code>. You should free the
|
||
returned string with <code class="function">g_free()</code> when done. </p>
|
||
<p><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></p>
|
||
</div>
|
||
<p class="since">Since: 2.16</p>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="gtk-status-icon-set-has-tooltip"></a><h3>gtk_status_icon_set_has_tooltip ()</h3>
|
||
<pre class="programlisting"><span class="returnvalue">void</span>
|
||
gtk_status_icon_set_has_tooltip (<em class="parameter"><code><a class="link" href="GtkStatusIcon.html" title="GtkStatusIcon"><span class="type">GtkStatusIcon</span></a> *status_icon</code></em>,
|
||
<em class="parameter"><code><span class="type">gboolean</span> has_tooltip</code></em>);</pre>
|
||
<div class="warning">
|
||
<p><code class="literal">gtk_status_icon_set_has_tooltip</code> has been deprecated since version 3.14 and should not be used in newly-written code.</p>
|
||
<p>Use <span class="type">GNotification</span> and <a class="link" href="GtkApplication.html" title="GtkApplication"><span class="type">GtkApplication</span></a> to
|
||
provide status notifications; there is no direct replacement
|
||
for this function, but notifications can display an arbitrary
|
||
amount of text using <code class="function">g_notification_set_body()</code></p>
|
||
</div>
|
||
<p>Sets the has-tooltip property on <em class="parameter"><code>status_icon</code></em>
|
||
to <em class="parameter"><code>has_tooltip</code></em>
|
||
.
|
||
See <a class="link" href="GtkStatusIcon.html#GtkStatusIcon--has-tooltip" title="The “has-tooltip” property"><span class="type">“has-tooltip”</span></a> for more information.</p>
|
||
<div class="refsect3">
|
||
<a name="gtk-status-icon-set-has-tooltip.parameters"></a><h4>Parameters</h4>
|
||
<div class="informaltable"><table class="informaltable" width="100%" border="0">
|
||
<colgroup>
|
||
<col width="150px" class="parameters_name">
|
||
<col class="parameters_description">
|
||
<col width="200px" class="parameters_annotations">
|
||
</colgroup>
|
||
<tbody>
|
||
<tr>
|
||
<td class="parameter_name"><p>status_icon</p></td>
|
||
<td class="parameter_description"><p>a <a class="link" href="GtkStatusIcon.html" title="GtkStatusIcon"><span class="type">GtkStatusIcon</span></a></p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>has_tooltip</p></td>
|
||
<td class="parameter_description"><p>whether or not <em class="parameter"><code>status_icon</code></em>
|
||
has a tooltip</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
</div>
|
||
<p class="since">Since: 2.16</p>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="gtk-status-icon-get-has-tooltip"></a><h3>gtk_status_icon_get_has_tooltip ()</h3>
|
||
<pre class="programlisting"><span class="returnvalue">gboolean</span>
|
||
gtk_status_icon_get_has_tooltip (<em class="parameter"><code><a class="link" href="GtkStatusIcon.html" title="GtkStatusIcon"><span class="type">GtkStatusIcon</span></a> *status_icon</code></em>);</pre>
|
||
<div class="warning">
|
||
<p><code class="literal">gtk_status_icon_get_has_tooltip</code> has been deprecated since version 3.14 and should not be used in newly-written code.</p>
|
||
<p>Use <span class="type">GNotification</span> and <a class="link" href="GtkApplication.html" title="GtkApplication"><span class="type">GtkApplication</span></a> to
|
||
provide status notifications; there is no direct replacement
|
||
for this function</p>
|
||
</div>
|
||
<p>Returns the current value of the has-tooltip property.
|
||
See <a class="link" href="GtkStatusIcon.html#GtkStatusIcon--has-tooltip" title="The “has-tooltip” property"><span class="type">“has-tooltip”</span></a> for more information.</p>
|
||
<div class="refsect3">
|
||
<a name="gtk-status-icon-get-has-tooltip.parameters"></a><h4>Parameters</h4>
|
||
<div class="informaltable"><table class="informaltable" width="100%" border="0">
|
||
<colgroup>
|
||
<col width="150px" class="parameters_name">
|
||
<col class="parameters_description">
|
||
<col width="200px" class="parameters_annotations">
|
||
</colgroup>
|
||
<tbody><tr>
|
||
<td class="parameter_name"><p>status_icon</p></td>
|
||
<td class="parameter_description"><p>a <a class="link" href="GtkStatusIcon.html" title="GtkStatusIcon"><span class="type">GtkStatusIcon</span></a></p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr></tbody>
|
||
</table></div>
|
||
</div>
|
||
<div class="refsect3">
|
||
<a name="gtk-status-icon-get-has-tooltip.returns"></a><h4>Returns</h4>
|
||
<p> current value of has-tooltip on <em class="parameter"><code>status_icon</code></em>
|
||
.</p>
|
||
</div>
|
||
<p class="since">Since: 2.16</p>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="gtk-status-icon-set-title"></a><h3>gtk_status_icon_set_title ()</h3>
|
||
<pre class="programlisting"><span class="returnvalue">void</span>
|
||
gtk_status_icon_set_title (<em class="parameter"><code><a class="link" href="GtkStatusIcon.html" title="GtkStatusIcon"><span class="type">GtkStatusIcon</span></a> *status_icon</code></em>,
|
||
<em class="parameter"><code>const <span class="type">gchar</span> *title</code></em>);</pre>
|
||
<div class="warning">
|
||
<p><code class="literal">gtk_status_icon_set_title</code> has been deprecated since version 3.14 and should not be used in newly-written code.</p>
|
||
<p>Use <span class="type">GNotification</span> and <a class="link" href="GtkApplication.html" title="GtkApplication"><span class="type">GtkApplication</span></a> to
|
||
provide status notifications; you should use <code class="function">g_notification_set_title()</code>
|
||
and <code class="function">g_notification_set_body()</code> to present text inside your notification</p>
|
||
</div>
|
||
<p>Sets the title of this tray icon.
|
||
This should be a short, human-readable, localized string
|
||
describing the tray icon. It may be used by tools like screen
|
||
readers to render the tray icon.</p>
|
||
<div class="refsect3">
|
||
<a name="gtk-status-icon-set-title.parameters"></a><h4>Parameters</h4>
|
||
<div class="informaltable"><table class="informaltable" width="100%" border="0">
|
||
<colgroup>
|
||
<col width="150px" class="parameters_name">
|
||
<col class="parameters_description">
|
||
<col width="200px" class="parameters_annotations">
|
||
</colgroup>
|
||
<tbody>
|
||
<tr>
|
||
<td class="parameter_name"><p>status_icon</p></td>
|
||
<td class="parameter_description"><p>a <a class="link" href="GtkStatusIcon.html" title="GtkStatusIcon"><span class="type">GtkStatusIcon</span></a></p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>title</p></td>
|
||
<td class="parameter_description"><p>the title </p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
</div>
|
||
<p class="since">Since: 2.18</p>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="gtk-status-icon-get-title"></a><h3>gtk_status_icon_get_title ()</h3>
|
||
<pre class="programlisting">const <span class="returnvalue">gchar</span> *
|
||
gtk_status_icon_get_title (<em class="parameter"><code><a class="link" href="GtkStatusIcon.html" title="GtkStatusIcon"><span class="type">GtkStatusIcon</span></a> *status_icon</code></em>);</pre>
|
||
<div class="warning">
|
||
<p><code class="literal">gtk_status_icon_get_title</code> has been deprecated since version 3.14 and should not be used in newly-written code.</p>
|
||
<p>Use <span class="type">GNotification</span> and <a class="link" href="GtkApplication.html" title="GtkApplication"><span class="type">GtkApplication</span></a> to
|
||
provide status notifications; there is no direct replacement
|
||
for this function</p>
|
||
</div>
|
||
<p>Gets the title of this tray icon. See <a class="link" href="GtkStatusIcon.html#gtk-status-icon-set-title" title="gtk_status_icon_set_title ()"><code class="function">gtk_status_icon_set_title()</code></a>.</p>
|
||
<div class="refsect3">
|
||
<a name="gtk-status-icon-get-title.parameters"></a><h4>Parameters</h4>
|
||
<div class="informaltable"><table class="informaltable" width="100%" border="0">
|
||
<colgroup>
|
||
<col width="150px" class="parameters_name">
|
||
<col class="parameters_description">
|
||
<col width="200px" class="parameters_annotations">
|
||
</colgroup>
|
||
<tbody><tr>
|
||
<td class="parameter_name"><p>status_icon</p></td>
|
||
<td class="parameter_description"><p>a <a class="link" href="GtkStatusIcon.html" title="GtkStatusIcon"><span class="type">GtkStatusIcon</span></a></p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr></tbody>
|
||
</table></div>
|
||
</div>
|
||
<div class="refsect3">
|
||
<a name="gtk-status-icon-get-title.returns"></a><h4>Returns</h4>
|
||
<p> the title of the status icon</p>
|
||
</div>
|
||
<p class="since">Since: 2.18</p>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="gtk-status-icon-set-name"></a><h3>gtk_status_icon_set_name ()</h3>
|
||
<pre class="programlisting"><span class="returnvalue">void</span>
|
||
gtk_status_icon_set_name (<em class="parameter"><code><a class="link" href="GtkStatusIcon.html" title="GtkStatusIcon"><span class="type">GtkStatusIcon</span></a> *status_icon</code></em>,
|
||
<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>);</pre>
|
||
<div class="warning">
|
||
<p><code class="literal">gtk_status_icon_set_name</code> has been deprecated since version 3.14 and should not be used in newly-written code.</p>
|
||
<p>Use <span class="type">GNotification</span> and <a class="link" href="GtkApplication.html" title="GtkApplication"><span class="type">GtkApplication</span></a> to
|
||
provide status notifications; there is no direct replacement
|
||
for this function, as notifications are associated with a
|
||
unique application identifier by <span class="type">GApplication</span></p>
|
||
</div>
|
||
<p>Sets the name of this tray icon.
|
||
This should be a string identifying this icon. It is may be
|
||
used for sorting the icons in the tray and will not be shown to
|
||
the user.</p>
|
||
<div class="refsect3">
|
||
<a name="gtk-status-icon-set-name.parameters"></a><h4>Parameters</h4>
|
||
<div class="informaltable"><table class="informaltable" width="100%" border="0">
|
||
<colgroup>
|
||
<col width="150px" class="parameters_name">
|
||
<col class="parameters_description">
|
||
<col width="200px" class="parameters_annotations">
|
||
</colgroup>
|
||
<tbody>
|
||
<tr>
|
||
<td class="parameter_name"><p>status_icon</p></td>
|
||
<td class="parameter_description"><p>a <a class="link" href="GtkStatusIcon.html" title="GtkStatusIcon"><span class="type">GtkStatusIcon</span></a></p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>name</p></td>
|
||
<td class="parameter_description"><p>the name</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
</div>
|
||
<p class="since">Since: 2.20</p>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="gtk-status-icon-set-visible"></a><h3>gtk_status_icon_set_visible ()</h3>
|
||
<pre class="programlisting"><span class="returnvalue">void</span>
|
||
gtk_status_icon_set_visible (<em class="parameter"><code><a class="link" href="GtkStatusIcon.html" title="GtkStatusIcon"><span class="type">GtkStatusIcon</span></a> *status_icon</code></em>,
|
||
<em class="parameter"><code><span class="type">gboolean</span> visible</code></em>);</pre>
|
||
<div class="warning">
|
||
<p><code class="literal">gtk_status_icon_set_visible</code> has been deprecated since version 3.14 and should not be used in newly-written code.</p>
|
||
<p>Use <span class="type">GNotification</span> and <a class="link" href="GtkApplication.html" title="GtkApplication"><span class="type">GtkApplication</span></a> to
|
||
provide status notifications; there is no direct replacement
|
||
for this function, as notifications are managed by the platform</p>
|
||
</div>
|
||
<p>Shows or hides a status icon.</p>
|
||
<div class="refsect3">
|
||
<a name="gtk-status-icon-set-visible.parameters"></a><h4>Parameters</h4>
|
||
<div class="informaltable"><table class="informaltable" width="100%" border="0">
|
||
<colgroup>
|
||
<col width="150px" class="parameters_name">
|
||
<col class="parameters_description">
|
||
<col width="200px" class="parameters_annotations">
|
||
</colgroup>
|
||
<tbody>
|
||
<tr>
|
||
<td class="parameter_name"><p>status_icon</p></td>
|
||
<td class="parameter_description"><p>a <a class="link" href="GtkStatusIcon.html" title="GtkStatusIcon"><span class="type">GtkStatusIcon</span></a></p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>visible</p></td>
|
||
<td class="parameter_description"><p><code class="literal">TRUE</code> to show the status icon, <code class="literal">FALSE</code> to hide it</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
</div>
|
||
<p class="since">Since: 2.10</p>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="gtk-status-icon-get-visible"></a><h3>gtk_status_icon_get_visible ()</h3>
|
||
<pre class="programlisting"><span class="returnvalue">gboolean</span>
|
||
gtk_status_icon_get_visible (<em class="parameter"><code><a class="link" href="GtkStatusIcon.html" title="GtkStatusIcon"><span class="type">GtkStatusIcon</span></a> *status_icon</code></em>);</pre>
|
||
<div class="warning">
|
||
<p><code class="literal">gtk_status_icon_get_visible</code> has been deprecated since version 3.14 and should not be used in newly-written code.</p>
|
||
<p>Use <span class="type">GNotification</span> and <a class="link" href="GtkApplication.html" title="GtkApplication"><span class="type">GtkApplication</span></a> to
|
||
provide status notifications; there is no direct replacement
|
||
for this function</p>
|
||
</div>
|
||
<p>Returns whether the status icon is visible or not.
|
||
Note that being visible does not guarantee that
|
||
the user can actually see the icon, see also
|
||
<a class="link" href="GtkStatusIcon.html#gtk-status-icon-is-embedded" title="gtk_status_icon_is_embedded ()"><code class="function">gtk_status_icon_is_embedded()</code></a>.</p>
|
||
<div class="refsect3">
|
||
<a name="gtk-status-icon-get-visible.parameters"></a><h4>Parameters</h4>
|
||
<div class="informaltable"><table class="informaltable" width="100%" border="0">
|
||
<colgroup>
|
||
<col width="150px" class="parameters_name">
|
||
<col class="parameters_description">
|
||
<col width="200px" class="parameters_annotations">
|
||
</colgroup>
|
||
<tbody><tr>
|
||
<td class="parameter_name"><p>status_icon</p></td>
|
||
<td class="parameter_description"><p>a <a class="link" href="GtkStatusIcon.html" title="GtkStatusIcon"><span class="type">GtkStatusIcon</span></a></p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr></tbody>
|
||
</table></div>
|
||
</div>
|
||
<div class="refsect3">
|
||
<a name="gtk-status-icon-get-visible.returns"></a><h4>Returns</h4>
|
||
<p> <code class="literal">TRUE</code> if the status icon is visible</p>
|
||
</div>
|
||
<p class="since">Since: 2.10</p>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="gtk-status-icon-is-embedded"></a><h3>gtk_status_icon_is_embedded ()</h3>
|
||
<pre class="programlisting"><span class="returnvalue">gboolean</span>
|
||
gtk_status_icon_is_embedded (<em class="parameter"><code><a class="link" href="GtkStatusIcon.html" title="GtkStatusIcon"><span class="type">GtkStatusIcon</span></a> *status_icon</code></em>);</pre>
|
||
<div class="warning">
|
||
<p><code class="literal">gtk_status_icon_is_embedded</code> has been deprecated since version 3.14 and should not be used in newly-written code.</p>
|
||
<p>Use <span class="type">GNotification</span> and <a class="link" href="GtkApplication.html" title="GtkApplication"><span class="type">GtkApplication</span></a> to
|
||
provide status notifications; there is no direct replacement
|
||
for this function</p>
|
||
</div>
|
||
<p>Returns whether the status icon is embedded in a notification
|
||
area.</p>
|
||
<div class="refsect3">
|
||
<a name="gtk-status-icon-is-embedded.parameters"></a><h4>Parameters</h4>
|
||
<div class="informaltable"><table class="informaltable" width="100%" border="0">
|
||
<colgroup>
|
||
<col width="150px" class="parameters_name">
|
||
<col class="parameters_description">
|
||
<col width="200px" class="parameters_annotations">
|
||
</colgroup>
|
||
<tbody><tr>
|
||
<td class="parameter_name"><p>status_icon</p></td>
|
||
<td class="parameter_description"><p>a <a class="link" href="GtkStatusIcon.html" title="GtkStatusIcon"><span class="type">GtkStatusIcon</span></a></p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr></tbody>
|
||
</table></div>
|
||
</div>
|
||
<div class="refsect3">
|
||
<a name="gtk-status-icon-is-embedded.returns"></a><h4>Returns</h4>
|
||
<p> <code class="literal">TRUE</code> if the status icon is embedded in
|
||
a notification area.</p>
|
||
</div>
|
||
<p class="since">Since: 2.10</p>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="gtk-status-icon-position-menu"></a><h3>gtk_status_icon_position_menu ()</h3>
|
||
<pre class="programlisting"><span class="returnvalue">void</span>
|
||
gtk_status_icon_position_menu (<em class="parameter"><code><a class="link" href="GtkMenu.html" title="GtkMenu"><span class="type">GtkMenu</span></a> *menu</code></em>,
|
||
<em class="parameter"><code><span class="type">gint</span> *x</code></em>,
|
||
<em class="parameter"><code><span class="type">gint</span> *y</code></em>,
|
||
<em class="parameter"><code><span class="type">gboolean</span> *push_in</code></em>,
|
||
<em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);</pre>
|
||
<div class="warning">
|
||
<p><code class="literal">gtk_status_icon_position_menu</code> has been deprecated since version 3.14 and should not be used in newly-written code.</p>
|
||
<p>Use <span class="type">GNotification</span> and <a class="link" href="GtkApplication.html" title="GtkApplication"><span class="type">GtkApplication</span></a> to
|
||
provide status notifications; notifications do not have menus,
|
||
but can have buttons, and actions associated with each button</p>
|
||
</div>
|
||
<p>Menu positioning function to use with <a class="link" href="GtkMenu.html#gtk-menu-popup" title="gtk_menu_popup ()"><code class="function">gtk_menu_popup()</code></a>
|
||
to position <em class="parameter"><code>menu</code></em>
|
||
aligned to the status icon <em class="parameter"><code>user_data</code></em>
|
||
.</p>
|
||
<div class="refsect3">
|
||
<a name="gtk-status-icon-position-menu.parameters"></a><h4>Parameters</h4>
|
||
<div class="informaltable"><table class="informaltable" width="100%" border="0">
|
||
<colgroup>
|
||
<col width="150px" class="parameters_name">
|
||
<col class="parameters_description">
|
||
<col width="200px" class="parameters_annotations">
|
||
</colgroup>
|
||
<tbody>
|
||
<tr>
|
||
<td class="parameter_name"><p>menu</p></td>
|
||
<td class="parameter_description"><p>the <a class="link" href="GtkMenu.html" title="GtkMenu"><span class="type">GtkMenu</span></a></p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>x</p></td>
|
||
<td class="parameter_description"><p>return location for the x position. </p></td>
|
||
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for input and for returning results. Default is transfer full."><span class="acronym">inout</span></acronym>]</span></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>y</p></td>
|
||
<td class="parameter_description"><p>return location for the y position. </p></td>
|
||
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for input and for returning results. Default is transfer full."><span class="acronym">inout</span></acronym>]</span></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>push_in</p></td>
|
||
<td class="parameter_description"><p>whether the first menu item should be offset
|
||
(pushed in) to be aligned with the menu popup position
|
||
(only useful for GtkOptionMenu). </p></td>
|
||
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>user_data</p></td>
|
||
<td class="parameter_description"><p>the status icon to position the menu on. </p></td>
|
||
<td class="parameter_annotations"><span class="annotation">[<acronym title="Override the parsed C type with given type."><span class="acronym">type</span></acronym> GtkStatusIcon]</span></td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
</div>
|
||
<p class="since">Since: 2.10</p>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="gtk-status-icon-get-geometry"></a><h3>gtk_status_icon_get_geometry ()</h3>
|
||
<pre class="programlisting"><span class="returnvalue">gboolean</span>
|
||
gtk_status_icon_get_geometry (<em class="parameter"><code><a class="link" href="GtkStatusIcon.html" title="GtkStatusIcon"><span class="type">GtkStatusIcon</span></a> *status_icon</code></em>,
|
||
<em class="parameter"><code><span class="type">GdkScreen</span> **screen</code></em>,
|
||
<em class="parameter"><code><span class="type">GdkRectangle</span> *area</code></em>,
|
||
<em class="parameter"><code><a class="link" href="gtk3-Standard-Enumerations.html#GtkOrientation" title="enum GtkOrientation"><span class="type">GtkOrientation</span></a> *orientation</code></em>);</pre>
|
||
<div class="warning">
|
||
<p><code class="literal">gtk_status_icon_get_geometry</code> has been deprecated since version 3.14 and should not be used in newly-written code.</p>
|
||
<p>Use <span class="type">GNotification</span> and <a class="link" href="GtkApplication.html" title="GtkApplication"><span class="type">GtkApplication</span></a> to
|
||
provide status notifications; there is no direct replacement
|
||
for this function, as the platform is responsible for the
|
||
presentation of notifications</p>
|
||
</div>
|
||
<p>Obtains information about the location of the status icon
|
||
on screen. This information can be used to e.g. position
|
||
popups like notification bubbles. </p>
|
||
<p>See <a class="link" href="GtkStatusIcon.html#gtk-status-icon-position-menu" title="gtk_status_icon_position_menu ()"><code class="function">gtk_status_icon_position_menu()</code></a> for a more convenient
|
||
alternative for positioning menus.</p>
|
||
<p>Note that some platforms do not allow GTK+ to provide
|
||
this information, and even on platforms that do allow it,
|
||
the information is not reliable unless the status icon
|
||
is embedded in a notification area, see
|
||
<a class="link" href="GtkStatusIcon.html#gtk-status-icon-is-embedded" title="gtk_status_icon_is_embedded ()"><code class="function">gtk_status_icon_is_embedded()</code></a>.</p>
|
||
<div class="refsect3">
|
||
<a name="gtk-status-icon-get-geometry.parameters"></a><h4>Parameters</h4>
|
||
<div class="informaltable"><table class="informaltable" width="100%" border="0">
|
||
<colgroup>
|
||
<col width="150px" class="parameters_name">
|
||
<col class="parameters_description">
|
||
<col width="200px" class="parameters_annotations">
|
||
</colgroup>
|
||
<tbody>
|
||
<tr>
|
||
<td class="parameter_name"><p>status_icon</p></td>
|
||
<td class="parameter_description"><p>a <a class="link" href="GtkStatusIcon.html" title="GtkStatusIcon"><span class="type">GtkStatusIcon</span></a></p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>screen</p></td>
|
||
<td class="parameter_description"><p>return location for
|
||
the screen, or <code class="literal">NULL</code> if the information is not needed. </p></td>
|
||
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="The data is owned by the callee, which is responsible of freeing it."><span class="acronym">transfer none</span></acronym>][<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>area</p></td>
|
||
<td class="parameter_description"><p>return location for the area occupied by
|
||
the status icon, or <code class="literal">NULL</code>. </p></td>
|
||
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>orientation</p></td>
|
||
<td class="parameter_description"><p>return location for the
|
||
orientation of the panel in which the status icon is embedded,
|
||
or <code class="literal">NULL</code>. A panel at the top or bottom of the screen is
|
||
horizontal, a panel at the left or right is vertical. </p></td>
|
||
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
</div>
|
||
<div class="refsect3">
|
||
<a name="gtk-status-icon-get-geometry.returns"></a><h4>Returns</h4>
|
||
<p> <code class="literal">TRUE</code> if the location information has
|
||
been filled in</p>
|
||
</div>
|
||
<p class="since">Since: 2.10</p>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="gtk-status-icon-get-x11-window-id"></a><h3>gtk_status_icon_get_x11_window_id ()</h3>
|
||
<pre class="programlisting"><span class="returnvalue">guint32</span>
|
||
gtk_status_icon_get_x11_window_id (<em class="parameter"><code><a class="link" href="GtkStatusIcon.html" title="GtkStatusIcon"><span class="type">GtkStatusIcon</span></a> *status_icon</code></em>);</pre>
|
||
<div class="warning">
|
||
<p><code class="literal">gtk_status_icon_get_x11_window_id</code> has been deprecated since version 3.14 and should not be used in newly-written code.</p>
|
||
<p>Use <span class="type">GNotification</span> and <a class="link" href="GtkApplication.html" title="GtkApplication"><span class="type">GtkApplication</span></a> to
|
||
provide status notifications; there is no direct replacement
|
||
for this function</p>
|
||
</div>
|
||
<p>This function is only useful on the X11/freedesktop.org platform.</p>
|
||
<p>It returns a window ID for the widget in the underlying
|
||
status icon implementation. This is useful for the Galago
|
||
notification service, which can send a window ID in the protocol
|
||
in order for the server to position notification windows
|
||
pointing to a status icon reliably.</p>
|
||
<p>This function is not intended for other use cases which are
|
||
more likely to be met by one of the non-X11 specific methods, such
|
||
as <a class="link" href="GtkStatusIcon.html#gtk-status-icon-position-menu" title="gtk_status_icon_position_menu ()"><code class="function">gtk_status_icon_position_menu()</code></a>.</p>
|
||
<div class="refsect3">
|
||
<a name="gtk-status-icon-get-x11-window-id.parameters"></a><h4>Parameters</h4>
|
||
<div class="informaltable"><table class="informaltable" width="100%" border="0">
|
||
<colgroup>
|
||
<col width="150px" class="parameters_name">
|
||
<col class="parameters_description">
|
||
<col width="200px" class="parameters_annotations">
|
||
</colgroup>
|
||
<tbody><tr>
|
||
<td class="parameter_name"><p>status_icon</p></td>
|
||
<td class="parameter_description"><p>a <a class="link" href="GtkStatusIcon.html" title="GtkStatusIcon"><span class="type">GtkStatusIcon</span></a></p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr></tbody>
|
||
</table></div>
|
||
</div>
|
||
<div class="refsect3">
|
||
<a name="gtk-status-icon-get-x11-window-id.returns"></a><h4>Returns</h4>
|
||
<p> An 32 bit unsigned integer identifier for the
|
||
underlying X11 Window</p>
|
||
</div>
|
||
<p class="since">Since: 2.14</p>
|
||
</div>
|
||
</div>
|
||
<div class="refsect1">
|
||
<a name="GtkStatusIcon.other_details"></a><h2>Types and Values</h2>
|
||
<div class="refsect2">
|
||
<a name="GtkStatusIcon-struct"></a><h3>struct GtkStatusIcon</h3>
|
||
<pre class="programlisting">struct GtkStatusIcon;</pre>
|
||
</div>
|
||
</div>
|
||
<div class="refsect1">
|
||
<a name="GtkStatusIcon.property-details"></a><h2>Property Details</h2>
|
||
<div class="refsect2">
|
||
<a name="GtkStatusIcon--embedded"></a><h3>The <code class="literal">“embedded”</code> property</h3>
|
||
<pre class="programlisting"> “embedded” <span class="type">gboolean</span></pre>
|
||
<p><code class="literal">TRUE</code> if the statusicon is embedded in a notification area.</p>
|
||
<p>Owner: GtkStatusIcon</p>
|
||
<p>Flags: Read</p>
|
||
<p>Default value: FALSE</p>
|
||
<p class="since">Since: 2.12</p>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="GtkStatusIcon--file"></a><h3>The <code class="literal">“file”</code> property</h3>
|
||
<pre class="programlisting"> “file” <span class="type">char</span> *</pre>
|
||
<p>Filename to load and display.</p>
|
||
<p>Owner: GtkStatusIcon</p>
|
||
<p>Flags: Write</p>
|
||
<p>Default value: NULL</p>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="GtkStatusIcon--gicon"></a><h3>The <code class="literal">“gicon”</code> property</h3>
|
||
<pre class="programlisting"> “gicon” <span class="type">GIcon</span> *</pre>
|
||
<p>The <span class="type">GIcon</span> displayed in the <a class="link" href="GtkStatusIcon.html" title="GtkStatusIcon"><span class="type">GtkStatusIcon</span></a>. For themed icons,
|
||
the image will be updated automatically if the theme changes.</p>
|
||
<p>Owner: GtkStatusIcon</p>
|
||
<p>Flags: Read / Write</p>
|
||
<p class="since">Since: 2.14</p>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="GtkStatusIcon--has-tooltip"></a><h3>The <code class="literal">“has-tooltip”</code> property</h3>
|
||
<pre class="programlisting"> “has-tooltip” <span class="type">gboolean</span></pre>
|
||
<p>Enables or disables the emission of <a class="link" href="GtkStatusIcon.html#GtkStatusIcon-query-tooltip" title="The “query-tooltip” signal"><span class="type">“query-tooltip”</span></a> on
|
||
<em class="parameter"><code>status_icon</code></em>
|
||
. A value of <code class="literal">TRUE</code> indicates that <em class="parameter"><code>status_icon</code></em>
|
||
can have a
|
||
tooltip, in this case the status icon will be queried using
|
||
<a class="link" href="GtkStatusIcon.html#GtkStatusIcon-query-tooltip" title="The “query-tooltip” signal"><span class="type">“query-tooltip”</span></a> to determine whether it will provide a
|
||
tooltip or not.</p>
|
||
<p>Note that setting this property to <code class="literal">TRUE</code> for the first time will change
|
||
the event masks of the windows of this status icon to include leave-notify
|
||
and motion-notify events. This will not be undone when the property is set
|
||
to <code class="literal">FALSE</code> again.</p>
|
||
<p>Whether this property is respected is platform dependent.
|
||
For plain text tooltips, use <a class="link" href="GtkStatusIcon.html#GtkStatusIcon--tooltip-text" title="The “tooltip-text” property"><span class="type">“tooltip-text”</span></a> in preference.</p>
|
||
<p>Owner: GtkStatusIcon</p>
|
||
<p>Flags: Read / Write</p>
|
||
<p>Default value: FALSE</p>
|
||
<p class="since">Since: 2.16</p>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="GtkStatusIcon--icon-name"></a><h3>The <code class="literal">“icon-name”</code> property</h3>
|
||
<pre class="programlisting"> “icon-name” <span class="type">char</span> *</pre>
|
||
<p>The name of the icon from the icon theme.</p>
|
||
<p>Owner: GtkStatusIcon</p>
|
||
<p>Flags: Read / Write</p>
|
||
<p>Default value: NULL</p>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="GtkStatusIcon--orientation"></a><h3>The <code class="literal">“orientation”</code> property</h3>
|
||
<pre class="programlisting"> “orientation” <a class="link" href="gtk3-Standard-Enumerations.html#GtkOrientation" title="enum GtkOrientation"><span class="type">GtkOrientation</span></a></pre>
|
||
<p>The orientation of the tray in which the statusicon
|
||
|
||
is embedded.</p>
|
||
<p>Owner: GtkStatusIcon</p>
|
||
<p>Flags: Read</p>
|
||
<p>Default value: GTK_ORIENTATION_HORIZONTAL</p>
|
||
<p class="since">Since: 2.12</p>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="GtkStatusIcon--pixbuf"></a><h3>The <code class="literal">“pixbuf”</code> property</h3>
|
||
<pre class="programlisting"> “pixbuf” <span class="type">GdkPixbuf</span> *</pre>
|
||
<p>A GdkPixbuf to display.</p>
|
||
<p>Owner: GtkStatusIcon</p>
|
||
<p>Flags: Read / Write</p>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="GtkStatusIcon--screen"></a><h3>The <code class="literal">“screen”</code> property</h3>
|
||
<pre class="programlisting"> “screen” <span class="type">GdkScreen</span> *</pre>
|
||
<p>The screen where this status icon will be displayed.</p>
|
||
<p>Owner: GtkStatusIcon</p>
|
||
<p>Flags: Read / Write</p>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="GtkStatusIcon--size"></a><h3>The <code class="literal">“size”</code> property</h3>
|
||
<pre class="programlisting"> “size” <span class="type">int</span></pre>
|
||
<p>The size of the icon.</p>
|
||
<p>Owner: GtkStatusIcon</p>
|
||
<p>Flags: Read</p>
|
||
<p>Allowed values: >= 0</p>
|
||
<p>Default value: 0</p>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="GtkStatusIcon--stock"></a><h3>The <code class="literal">“stock”</code> property</h3>
|
||
<pre class="programlisting"> “stock” <span class="type">char</span> *</pre>
|
||
<p>Stock ID for a stock image to display.</p>
|
||
<div class="warning">
|
||
<p><code class="literal">GtkStatusIcon:stock</code> has been deprecated since version 3.10 and should not be used in newly-written code.</p>
|
||
<p>Use <a class="link" href="GtkStatusIcon.html#GtkStatusIcon--icon-name" title="The “icon-name” property"><span class="type">“icon-name”</span></a> instead.</p>
|
||
</div>
|
||
<p>Owner: GtkStatusIcon</p>
|
||
<p>Flags: Read / Write</p>
|
||
<p>Default value: NULL</p>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="GtkStatusIcon--storage-type"></a><h3>The <code class="literal">“storage-type”</code> property</h3>
|
||
<pre class="programlisting"> “storage-type” <a class="link" href="GtkImage.html#GtkImageType" title="enum GtkImageType"><span class="type">GtkImageType</span></a></pre>
|
||
<p>The representation being used for image data.</p>
|
||
<p>Owner: GtkStatusIcon</p>
|
||
<p>Flags: Read</p>
|
||
<p>Default value: GTK_IMAGE_EMPTY</p>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="GtkStatusIcon--title"></a><h3>The <code class="literal">“title”</code> property</h3>
|
||
<pre class="programlisting"> “title” <span class="type">char</span> *</pre>
|
||
<p>The title of this tray icon. This should be a short, human-readable,
|
||
localized string describing the tray icon. It may be used by tools
|
||
like screen readers to render the tray icon.</p>
|
||
<p>Owner: GtkStatusIcon</p>
|
||
<p>Flags: Read / Write</p>
|
||
<p>Default value: NULL</p>
|
||
<p class="since">Since: 2.18</p>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="GtkStatusIcon--tooltip-markup"></a><h3>The <code class="literal">“tooltip-markup”</code> property</h3>
|
||
<pre class="programlisting"> “tooltip-markup” <span class="type">char</span> *</pre>
|
||
<p>Sets the text of tooltip to be the given string, which is marked up
|
||
with the Pango text markup language.
|
||
Also see <a class="link" href="GtkTooltip.html#gtk-tooltip-set-markup" title="gtk_tooltip_set_markup ()"><code class="function">gtk_tooltip_set_markup()</code></a>.</p>
|
||
<p>This is a convenience property which will take care of getting the
|
||
tooltip shown if the given string is not <code class="literal">NULL</code>.
|
||
<a class="link" href="GtkStatusIcon.html#GtkStatusIcon--has-tooltip" title="The “has-tooltip” property"><span class="type">“has-tooltip”</span></a> will automatically be set to <code class="literal">TRUE</code> and
|
||
the default handler for the <a class="link" href="GtkStatusIcon.html#GtkStatusIcon-query-tooltip" title="The “query-tooltip” signal"><span class="type">“query-tooltip”</span></a> signal
|
||
will take care of displaying the tooltip.</p>
|
||
<p>On some platforms, embedded markup will be ignored.</p>
|
||
<p>Owner: GtkStatusIcon</p>
|
||
<p>Flags: Read / Write</p>
|
||
<p>Default value: NULL</p>
|
||
<p class="since">Since: 2.16</p>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="GtkStatusIcon--tooltip-text"></a><h3>The <code class="literal">“tooltip-text”</code> property</h3>
|
||
<pre class="programlisting"> “tooltip-text” <span class="type">char</span> *</pre>
|
||
<p>Sets the text of tooltip to be the given string.</p>
|
||
<p>Also see <a class="link" href="GtkTooltip.html#gtk-tooltip-set-text" title="gtk_tooltip_set_text ()"><code class="function">gtk_tooltip_set_text()</code></a>.</p>
|
||
<p>This is a convenience property which will take care of getting the
|
||
tooltip shown if the given string is not <code class="literal">NULL</code>.
|
||
<a class="link" href="GtkStatusIcon.html#GtkStatusIcon--has-tooltip" title="The “has-tooltip” property"><span class="type">“has-tooltip”</span></a> will automatically be set to <code class="literal">TRUE</code> and
|
||
the default handler for the <a class="link" href="GtkStatusIcon.html#GtkStatusIcon-query-tooltip" title="The “query-tooltip” signal"><span class="type">“query-tooltip”</span></a> signal
|
||
will take care of displaying the tooltip.</p>
|
||
<p>Note that some platforms have limitations on the length of tooltips
|
||
that they allow on status icons, e.g. Windows only shows the first
|
||
64 characters.</p>
|
||
<p>Owner: GtkStatusIcon</p>
|
||
<p>Flags: Read / Write</p>
|
||
<p>Default value: NULL</p>
|
||
<p class="since">Since: 2.16</p>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="GtkStatusIcon--visible"></a><h3>The <code class="literal">“visible”</code> property</h3>
|
||
<pre class="programlisting"> “visible” <span class="type">gboolean</span></pre>
|
||
<p>Whether the status icon is visible.</p>
|
||
<p>Owner: GtkStatusIcon</p>
|
||
<p>Flags: Read / Write</p>
|
||
<p>Default value: TRUE</p>
|
||
</div>
|
||
</div>
|
||
<div class="refsect1">
|
||
<a name="GtkStatusIcon.signal-details"></a><h2>Signal Details</h2>
|
||
<div class="refsect2">
|
||
<a name="GtkStatusIcon-activate"></a><h3>The <code class="literal">“activate”</code> signal</h3>
|
||
<pre class="programlisting"><span class="returnvalue">void</span>
|
||
user_function (<a class="link" href="GtkStatusIcon.html" title="GtkStatusIcon"><span class="type">GtkStatusIcon</span></a> *status_icon,
|
||
<span class="type">gpointer</span> user_data)</pre>
|
||
<p>Gets emitted when the user activates the status icon.
|
||
|
||
If and how status icons can activated is platform-dependent.</p>
|
||
<p>Unlike most G_SIGNAL_ACTION signals, this signal is meant to
|
||
|
||
be used by applications and should be wrapped by language bindings.</p>
|
||
<div class="refsect3">
|
||
<a name="GtkStatusIcon-activate.parameters"></a><h4>Parameters</h4>
|
||
<div class="informaltable"><table class="informaltable" width="100%" border="0">
|
||
<colgroup>
|
||
<col width="150px" class="parameters_name">
|
||
<col class="parameters_description">
|
||
<col width="200px" class="parameters_annotations">
|
||
</colgroup>
|
||
<tbody>
|
||
<tr>
|
||
<td class="parameter_name"><p>status_icon</p></td>
|
||
<td class="parameter_description"><p>the object which received the signal</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>user_data</p></td>
|
||
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
</div>
|
||
<p>Flags: Action</p>
|
||
<p class="since">Since: 2.10</p>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="GtkStatusIcon-button-press-event"></a><h3>The <code class="literal">“button-press-event”</code> signal</h3>
|
||
<pre class="programlisting"><span class="returnvalue">gboolean</span>
|
||
user_function (<a class="link" href="GtkStatusIcon.html" title="GtkStatusIcon"><span class="type">GtkStatusIcon</span></a> *status_icon,
|
||
<span class="type">GdkEvent</span> *event,
|
||
<span class="type">gpointer</span> user_data)</pre>
|
||
<p>The ::button-press-event signal will be emitted when a button
|
||
(typically from a mouse) is pressed.</p>
|
||
<p>Whether this event is emitted is platform-dependent. Use the ::activate
|
||
and ::popup-menu signals in preference.</p>
|
||
<div class="refsect3">
|
||
<a name="GtkStatusIcon-button-press-event.parameters"></a><h4>Parameters</h4>
|
||
<div class="informaltable"><table class="informaltable" width="100%" border="0">
|
||
<colgroup>
|
||
<col width="150px" class="parameters_name">
|
||
<col class="parameters_description">
|
||
<col width="200px" class="parameters_annotations">
|
||
</colgroup>
|
||
<tbody>
|
||
<tr>
|
||
<td class="parameter_name"><p>status_icon</p></td>
|
||
<td class="parameter_description"><p>the object which received the signal</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>event</p></td>
|
||
<td class="parameter_description"><p>the <span class="type">GdkEventButton</span> which triggered
|
||
this signal. </p></td>
|
||
<td class="parameter_annotations"><span class="annotation">[<acronym title="Override the parsed C type with given type."><span class="acronym">type</span></acronym> Gdk.EventButton]</span></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>user_data</p></td>
|
||
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
</div>
|
||
<div class="refsect3">
|
||
<a name="GtkStatusIcon-button-press-event.returns"></a><h4>Returns</h4>
|
||
<p> <code class="literal">TRUE</code> to stop other handlers from being invoked
|
||
for the event. <code class="literal">FALSE</code> to propagate the event further.</p>
|
||
</div>
|
||
<p>Flags: Run Last</p>
|
||
<p class="since">Since: 2.14</p>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="GtkStatusIcon-button-release-event"></a><h3>The <code class="literal">“button-release-event”</code> signal</h3>
|
||
<pre class="programlisting"><span class="returnvalue">gboolean</span>
|
||
user_function (<a class="link" href="GtkStatusIcon.html" title="GtkStatusIcon"><span class="type">GtkStatusIcon</span></a> *status_icon,
|
||
<span class="type">GdkEvent</span> *event,
|
||
<span class="type">gpointer</span> user_data)</pre>
|
||
<p>The ::button-release-event signal will be emitted when a button
|
||
(typically from a mouse) is released.</p>
|
||
<p>Whether this event is emitted is platform-dependent. Use the ::activate
|
||
and ::popup-menu signals in preference.</p>
|
||
<div class="refsect3">
|
||
<a name="GtkStatusIcon-button-release-event.parameters"></a><h4>Parameters</h4>
|
||
<div class="informaltable"><table class="informaltable" width="100%" border="0">
|
||
<colgroup>
|
||
<col width="150px" class="parameters_name">
|
||
<col class="parameters_description">
|
||
<col width="200px" class="parameters_annotations">
|
||
</colgroup>
|
||
<tbody>
|
||
<tr>
|
||
<td class="parameter_name"><p>status_icon</p></td>
|
||
<td class="parameter_description"><p>the object which received the signal</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>event</p></td>
|
||
<td class="parameter_description"><p>the <span class="type">GdkEventButton</span> which triggered
|
||
this signal. </p></td>
|
||
<td class="parameter_annotations"><span class="annotation">[<acronym title="Override the parsed C type with given type."><span class="acronym">type</span></acronym> Gdk.EventButton]</span></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>user_data</p></td>
|
||
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
</div>
|
||
<div class="refsect3">
|
||
<a name="GtkStatusIcon-button-release-event.returns"></a><h4>Returns</h4>
|
||
<p> <code class="literal">TRUE</code> to stop other handlers from being invoked
|
||
for the event. <code class="literal">FALSE</code> to propagate the event further.</p>
|
||
</div>
|
||
<p>Flags: Run Last</p>
|
||
<p class="since">Since: 2.14</p>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="GtkStatusIcon-popup-menu"></a><h3>The <code class="literal">“popup-menu”</code> signal</h3>
|
||
<pre class="programlisting"><span class="returnvalue">void</span>
|
||
user_function (<a class="link" href="GtkStatusIcon.html" title="GtkStatusIcon"><span class="type">GtkStatusIcon</span></a> *status_icon,
|
||
<span class="type">guint</span> button,
|
||
<span class="type">guint</span> activate_time,
|
||
<span class="type">gpointer</span> user_data)</pre>
|
||
<p>Gets emitted when the user brings up the context menu
|
||
of the status icon. Whether status icons can have context
|
||
|
||
menus and how these are activated is platform-dependent.</p>
|
||
<p>The <em class="parameter"><code>button</code></em>
|
||
and <em class="parameter"><code>activate_time</code></em>
|
||
parameters should be
|
||
|
||
passed as the last to arguments to <a class="link" href="GtkMenu.html#gtk-menu-popup" title="gtk_menu_popup ()"><code class="function">gtk_menu_popup()</code></a>.</p>
|
||
<p>Unlike most G_SIGNAL_ACTION signals, this signal is meant to
|
||
|
||
be used by applications and should be wrapped by language bindings.</p>
|
||
<div class="refsect3">
|
||
<a name="GtkStatusIcon-popup-menu.parameters"></a><h4>Parameters</h4>
|
||
<div class="informaltable"><table class="informaltable" width="100%" border="0">
|
||
<colgroup>
|
||
<col width="150px" class="parameters_name">
|
||
<col class="parameters_description">
|
||
<col width="200px" class="parameters_annotations">
|
||
</colgroup>
|
||
<tbody>
|
||
<tr>
|
||
<td class="parameter_name"><p>status_icon</p></td>
|
||
<td class="parameter_description"><p>the object which received the signal</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>button</p></td>
|
||
<td class="parameter_description"><p>the button that was pressed, or 0 if the
|
||
signal is not emitted in response to a button press event</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>activate_time</p></td>
|
||
<td class="parameter_description"><p>the timestamp of the event that
|
||
triggered the signal emission</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>user_data</p></td>
|
||
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
</div>
|
||
<p>Flags: Action</p>
|
||
<p class="since">Since: 2.10</p>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="GtkStatusIcon-query-tooltip"></a><h3>The <code class="literal">“query-tooltip”</code> signal</h3>
|
||
<pre class="programlisting"><span class="returnvalue">gboolean</span>
|
||
user_function (<a class="link" href="GtkStatusIcon.html" title="GtkStatusIcon"><span class="type">GtkStatusIcon</span></a> *status_icon,
|
||
<span class="type">int</span> x,
|
||
<span class="type">int</span> y,
|
||
<span class="type">gboolean</span> keyboard_mode,
|
||
<a class="link" href="GtkTooltip.html" title="GtkTooltip"><span class="type">GtkTooltip</span></a> *tooltip,
|
||
<span class="type">gpointer</span> user_data)</pre>
|
||
<p>Emitted when the hover timeout has expired with the
|
||
cursor hovering above <em class="parameter"><code>status_icon</code></em>
|
||
; or emitted when <em class="parameter"><code>status_icon</code></em>
|
||
got
|
||
focus in keyboard mode.</p>
|
||
<p>Using the given coordinates, the signal handler should determine
|
||
whether a tooltip should be shown for <em class="parameter"><code>status_icon</code></em>
|
||
. If this is
|
||
the case <code class="literal">TRUE</code> should be returned, <code class="literal">FALSE</code> otherwise. Note that if
|
||
<em class="parameter"><code>keyboard_mode</code></em>
|
||
is <code class="literal">TRUE</code>, the values of <em class="parameter"><code>x</code></em>
|
||
and <em class="parameter"><code>y</code></em>
|
||
are undefined and
|
||
should not be used.</p>
|
||
<p>The signal handler is free to manipulate <em class="parameter"><code>tooltip</code></em>
|
||
with the therefore
|
||
destined function calls.</p>
|
||
<p>Whether this signal is emitted is platform-dependent.
|
||
For plain text tooltips, use <a class="link" href="GtkStatusIcon.html#GtkStatusIcon--tooltip-text" title="The “tooltip-text” property"><span class="type">“tooltip-text”</span></a> in preference.</p>
|
||
<div class="refsect3">
|
||
<a name="GtkStatusIcon-query-tooltip.parameters"></a><h4>Parameters</h4>
|
||
<div class="informaltable"><table class="informaltable" width="100%" border="0">
|
||
<colgroup>
|
||
<col width="150px" class="parameters_name">
|
||
<col class="parameters_description">
|
||
<col width="200px" class="parameters_annotations">
|
||
</colgroup>
|
||
<tbody>
|
||
<tr>
|
||
<td class="parameter_name"><p>status_icon</p></td>
|
||
<td class="parameter_description"><p>the object which received the signal</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>x</p></td>
|
||
<td class="parameter_description"><p>the x coordinate of the cursor position where the request has been
|
||
emitted, relative to <em class="parameter"><code>status_icon</code></em>
|
||
</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>y</p></td>
|
||
<td class="parameter_description"><p>the y coordinate of the cursor position where the request has been
|
||
emitted, relative to <em class="parameter"><code>status_icon</code></em>
|
||
</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>keyboard_mode</p></td>
|
||
<td class="parameter_description"><p><code class="literal">TRUE</code> if the tooltip was trigged using the keyboard</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>tooltip</p></td>
|
||
<td class="parameter_description"><p>a <a class="link" href="GtkTooltip.html" title="GtkTooltip"><span class="type">GtkTooltip</span></a></p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>user_data</p></td>
|
||
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
</div>
|
||
<div class="refsect3">
|
||
<a name="GtkStatusIcon-query-tooltip.returns"></a><h4>Returns</h4>
|
||
<p> <code class="literal">TRUE</code> if <em class="parameter"><code>tooltip</code></em>
|
||
should be shown right now, <code class="literal">FALSE</code> otherwise.</p>
|
||
</div>
|
||
<p>Flags: Run Last</p>
|
||
<p class="since">Since: 2.16</p>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="GtkStatusIcon-scroll-event"></a><h3>The <code class="literal">“scroll-event”</code> signal</h3>
|
||
<pre class="programlisting"><span class="returnvalue">gboolean</span>
|
||
user_function (<a class="link" href="GtkStatusIcon.html" title="GtkStatusIcon"><span class="type">GtkStatusIcon</span></a> *status_icon,
|
||
<span class="type">GdkEvent</span> *event,
|
||
<span class="type">gpointer</span> user_data)</pre>
|
||
<p>The ::scroll-event signal is emitted when a button in the 4 to 7
|
||
range is pressed. Wheel mice are usually configured to generate
|
||
button press events for buttons 4 and 5 when the wheel is turned.</p>
|
||
<p>Whether this event is emitted is platform-dependent.</p>
|
||
<div class="refsect3">
|
||
<a name="GtkStatusIcon-scroll-event.parameters"></a><h4>Parameters</h4>
|
||
<div class="informaltable"><table class="informaltable" width="100%" border="0">
|
||
<colgroup>
|
||
<col width="150px" class="parameters_name">
|
||
<col class="parameters_description">
|
||
<col width="200px" class="parameters_annotations">
|
||
</colgroup>
|
||
<tbody>
|
||
<tr>
|
||
<td class="parameter_name"><p>status_icon</p></td>
|
||
<td class="parameter_description"><p>the object which received the signal.</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>event</p></td>
|
||
<td class="parameter_description"><p>the <span class="type">GdkEventScroll</span> which triggered
|
||
this signal. </p></td>
|
||
<td class="parameter_annotations"><span class="annotation">[<acronym title="Override the parsed C type with given type."><span class="acronym">type</span></acronym> Gdk.EventScroll]</span></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>user_data</p></td>
|
||
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
</div>
|
||
<div class="refsect3">
|
||
<a name="GtkStatusIcon-scroll-event.returns"></a><h4>Returns</h4>
|
||
<p> <code class="literal">TRUE</code> to stop other handlers from being invoked for the event.
|
||
<code class="literal">FALSE</code> to propagate the event further.</p>
|
||
</div>
|
||
<p>Flags: Run Last</p>
|
||
<p class="since">Since: 2.16</p>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="GtkStatusIcon-size-changed"></a><h3>The <code class="literal">“size-changed”</code> signal</h3>
|
||
<pre class="programlisting"><span class="returnvalue">gboolean</span>
|
||
user_function (<a class="link" href="GtkStatusIcon.html" title="GtkStatusIcon"><span class="type">GtkStatusIcon</span></a> *status_icon,
|
||
<span class="type">int</span> size,
|
||
<span class="type">gpointer</span> user_data)</pre>
|
||
<p>Gets emitted when the size available for the image
|
||
changes, e.g. because the notification area got resized.</p>
|
||
<div class="refsect3">
|
||
<a name="GtkStatusIcon-size-changed.parameters"></a><h4>Parameters</h4>
|
||
<div class="informaltable"><table class="informaltable" width="100%" border="0">
|
||
<colgroup>
|
||
<col width="150px" class="parameters_name">
|
||
<col class="parameters_description">
|
||
<col width="200px" class="parameters_annotations">
|
||
</colgroup>
|
||
<tbody>
|
||
<tr>
|
||
<td class="parameter_name"><p>status_icon</p></td>
|
||
<td class="parameter_description"><p>the object which received the signal</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>size</p></td>
|
||
<td class="parameter_description"><p>the new size</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>user_data</p></td>
|
||
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
</div>
|
||
<div class="refsect3">
|
||
<a name="GtkStatusIcon-size-changed.returns"></a><h4>Returns</h4>
|
||
<p> <code class="literal">TRUE</code> if the icon was updated for the new
|
||
size. Otherwise, GTK+ will scale the icon as necessary.</p>
|
||
</div>
|
||
<p>Flags: Run Last</p>
|
||
<p class="since">Since: 2.10</p>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="footer">
|
||
<hr>Generated by GTK-Doc V1.33.1</div>
|
||
</body>
|
||
</html> |