gtk3/docs/reference/gtk/html/GtkSeparatorToolItem.html
2021-04-15 09:52:10 +01:00

267 lines
14 KiB
HTML
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GtkSeparatorToolItem: 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="MenusAndCombos.html" title="Menus, Combo Box, Toolbar">
<link rel="prev" href="GtkToolItemGroup.html" title="GtkToolItemGroup">
<link rel="next" href="GtkToolButton.html" title="GtkToolButton">
<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="#GtkSeparatorToolItem.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
<a href="#GtkSeparatorToolItem.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces">  <span class="dim">|</span> 
<a href="#GtkSeparatorToolItem.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span><span id="nav_properties">  <span class="dim">|</span> 
<a href="#GtkSeparatorToolItem.properties" class="shortcut">Properties</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="MenusAndCombos.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="GtkToolItemGroup.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="GtkToolButton.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="GtkSeparatorToolItem"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GtkSeparatorToolItem.top_of_page"></a>GtkSeparatorToolItem</span></h2>
<p>GtkSeparatorToolItem — A toolbar item that separates groups of other
toolbar items</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="GtkSeparatorToolItem.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="GtkToolItem.html" title="GtkToolItem"><span class="returnvalue">GtkToolItem</span></a> *
</td>
<td class="function_name">
<a class="link" href="GtkSeparatorToolItem.html#gtk-separator-tool-item-new" title="gtk_separator_tool_item_new ()">gtk_separator_tool_item_new</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="GtkSeparatorToolItem.html#gtk-separator-tool-item-set-draw" title="gtk_separator_tool_item_set_draw ()">gtk_separator_tool_item_set_draw</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="GtkSeparatorToolItem.html#gtk-separator-tool-item-get-draw" title="gtk_separator_tool_item_get_draw ()">gtk_separator_tool_item_get_draw</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GtkSeparatorToolItem.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="GtkSeparatorToolItem.html#GtkSeparatorToolItem--draw" title="The “draw” property">draw</a></td>
<td class="property_flags">Read / Write</td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GtkSeparatorToolItem.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="GtkSeparatorToolItem.html#GtkSeparatorToolItem-struct" title="struct GtkSeparatorToolItem">GtkSeparatorToolItem</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="GtkSeparatorToolItem.html#GtkSeparatorToolItemClass" title="struct GtkSeparatorToolItemClass">GtkSeparatorToolItemClass</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GtkSeparatorToolItem.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> GObject
<span class="lineart">╰──</span> GInitiallyUnowned
<span class="lineart">╰──</span> <a class="link" href="GtkWidget.html" title="GtkWidget">GtkWidget</a>
<span class="lineart">╰──</span> <a class="link" href="GtkContainer.html" title="GtkContainer">GtkContainer</a>
<span class="lineart">╰──</span> <a class="link" href="GtkBin.html" title="GtkBin">GtkBin</a>
<span class="lineart">╰──</span> <a class="link" href="GtkToolItem.html" title="GtkToolItem">GtkToolItem</a>
<span class="lineart">╰──</span> GtkSeparatorToolItem
</pre>
</div>
<div class="refsect1">
<a name="GtkSeparatorToolItem.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
GtkSeparatorToolItem implements
AtkImplementorIface, <a class="link" href="GtkBuildable.html" title="GtkBuildable">GtkBuildable</a> and <a class="link" href="GtkActivatable.html" title="GtkActivatable">GtkActivatable</a>.</p>
</div>
<div class="refsect1">
<a name="GtkSeparatorToolItem.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include &lt;gtk/gtk.h&gt;
</pre>
</div>
<div class="refsect1">
<a name="GtkSeparatorToolItem.description"></a><h2>Description</h2>
<p>A <a class="link" href="GtkSeparatorToolItem.html" title="GtkSeparatorToolItem"><span class="type">GtkSeparatorToolItem</span></a> is a <a class="link" href="GtkToolItem.html" title="GtkToolItem"><span class="type">GtkToolItem</span></a> that separates groups of other
<a href="GtkToolItem.html#GtkToolItem-struct"><span class="type">GtkToolItems</span></a>. Depending on the theme, a <a class="link" href="GtkSeparatorToolItem.html" title="GtkSeparatorToolItem"><span class="type">GtkSeparatorToolItem</span></a> will
often look like a vertical line on horizontally docked toolbars.</p>
<p>If the <a class="link" href="GtkToolbar.html" title="GtkToolbar"><span class="type">GtkToolbar</span></a> child property “expand” is <code class="literal">TRUE</code> and the property
<a class="link" href="GtkSeparatorToolItem.html#GtkSeparatorToolItem--draw" title="The “draw” property"><span class="type">“draw”</span></a> is <code class="literal">FALSE</code>, a <a class="link" href="GtkSeparatorToolItem.html" title="GtkSeparatorToolItem"><span class="type">GtkSeparatorToolItem</span></a> will act as
a “spring” that forces other items to the ends of the toolbar.</p>
<p>Use <a class="link" href="GtkSeparatorToolItem.html#gtk-separator-tool-item-new" title="gtk_separator_tool_item_new ()"><code class="function">gtk_separator_tool_item_new()</code></a> to create a new <a class="link" href="GtkSeparatorToolItem.html" title="GtkSeparatorToolItem"><span class="type">GtkSeparatorToolItem</span></a>.</p>
<div class="refsect2">
<a name="id-1.3.13.15.9.5"></a><h3>CSS nodes</h3>
<p>GtkSeparatorToolItem has a single CSS node with name separator.</p>
</div>
</div>
<div class="refsect1">
<a name="GtkSeparatorToolItem.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="gtk-separator-tool-item-new"></a><h3>gtk_separator_tool_item_new ()</h3>
<pre class="programlisting"><a class="link" href="GtkToolItem.html" title="GtkToolItem"><span class="returnvalue">GtkToolItem</span></a> *
gtk_separator_tool_item_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Create a new <a class="link" href="GtkSeparatorToolItem.html" title="GtkSeparatorToolItem"><span class="type">GtkSeparatorToolItem</span></a></p>
<div class="refsect3">
<a name="gtk-separator-tool-item-new.returns"></a><h4>Returns</h4>
<p> the new <a class="link" href="GtkSeparatorToolItem.html" title="GtkSeparatorToolItem"><span class="type">GtkSeparatorToolItem</span></a></p>
</div>
<p class="since">Since: 2.4</p>
</div>
<hr>
<div class="refsect2">
<a name="gtk-separator-tool-item-set-draw"></a><h3>gtk_separator_tool_item_set_draw ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gtk_separator_tool_item_set_draw (<em class="parameter"><code><a class="link" href="GtkSeparatorToolItem.html" title="GtkSeparatorToolItem"><span class="type">GtkSeparatorToolItem</span></a> *item</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> draw</code></em>);</pre>
<p>Whether <em class="parameter"><code>item</code></em>
is drawn as a vertical line, or just blank.
Setting this to <code class="literal">FALSE</code> along with <a class="link" href="GtkToolItem.html#gtk-tool-item-set-expand" title="gtk_tool_item_set_expand ()"><code class="function">gtk_tool_item_set_expand()</code></a> is useful
to create an item that forces following items to the end of the toolbar.</p>
<div class="refsect3">
<a name="gtk-separator-tool-item-set-draw.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>item</p></td>
<td class="parameter_description"><p>a <a class="link" href="GtkSeparatorToolItem.html" title="GtkSeparatorToolItem"><span class="type">GtkSeparatorToolItem</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>draw</p></td>
<td class="parameter_description"><p>whether <em class="parameter"><code>item</code></em>
is drawn as a vertical line</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: 2.4</p>
</div>
<hr>
<div class="refsect2">
<a name="gtk-separator-tool-item-get-draw"></a><h3>gtk_separator_tool_item_get_draw ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
gtk_separator_tool_item_get_draw (<em class="parameter"><code><a class="link" href="GtkSeparatorToolItem.html" title="GtkSeparatorToolItem"><span class="type">GtkSeparatorToolItem</span></a> *item</code></em>);</pre>
<p>Returns whether <em class="parameter"><code>item</code></em>
is drawn as a line, or just blank.
See <a class="link" href="GtkSeparatorToolItem.html#gtk-separator-tool-item-set-draw" title="gtk_separator_tool_item_set_draw ()"><code class="function">gtk_separator_tool_item_set_draw()</code></a>.</p>
<div class="refsect3">
<a name="gtk-separator-tool-item-get-draw.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>item</p></td>
<td class="parameter_description"><p>a <a class="link" href="GtkSeparatorToolItem.html" title="GtkSeparatorToolItem"><span class="type">GtkSeparatorToolItem</span></a> </p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gtk-separator-tool-item-get-draw.returns"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> if <em class="parameter"><code>item</code></em>
is drawn as a line, or just blank.</p>
</div>
<p class="since">Since: 2.4</p>
</div>
</div>
<div class="refsect1">
<a name="GtkSeparatorToolItem.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="GtkSeparatorToolItem-struct"></a><h3>struct GtkSeparatorToolItem</h3>
<pre class="programlisting">struct GtkSeparatorToolItem;</pre>
</div>
<hr>
<div class="refsect2">
<a name="GtkSeparatorToolItemClass"></a><h3>struct GtkSeparatorToolItemClass</h3>
<pre class="programlisting">struct GtkSeparatorToolItemClass {
GtkToolItemClass parent_class;
};
</pre>
<div class="refsect3">
<a name="GtkSeparatorToolItemClass.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="struct_members_name">
<col class="struct_members_description">
<col width="200px" class="struct_members_annotations">
</colgroup>
<tbody></tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="GtkSeparatorToolItem.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="GtkSeparatorToolItem--draw"></a><h3>The <code class="literal">“draw”</code> property</h3>
<pre class="programlisting"> “draw” <span class="type">gboolean</span></pre>
<p>Whether the separator is drawn, or just blank.</p>
<p>Owner: GtkSeparatorToolItem</p>
<p>Flags: Read / Write</p>
<p>Default value: TRUE</p>
</div>
</div>
<div class="refsect1">
<a name="GtkSeparatorToolItem.see-also"></a><h2>See Also</h2>
<p><a class="link" href="GtkToolbar.html" title="GtkToolbar"><span class="type">GtkToolbar</span></a>, <a class="link" href="GtkRadioToolButton.html" title="GtkRadioToolButton"><span class="type">GtkRadioToolButton</span></a></p>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.33.1</div>
</body>
</html>