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

212 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.

This file contains Unicode characters that might be confused with other characters. 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>GtkOrientable: 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="LayoutContainers.html" title="Layout Containers">
<link rel="prev" href="GtkExpander.html" title="GtkExpander">
<link rel="next" href="GtkAspectFrame.html" title="GtkAspectFrame">
<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="#gtk3-Orientable.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
<a href="#gtk3-Orientable.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_prerequisites">  <span class="dim">|</span> 
<a href="#gtk3-Orientable.prerequisites" class="shortcut">Prerequisites</a></span><span id="nav_implementations">  <span class="dim">|</span> 
<a href="#gtk3-Orientable.implementations" class="shortcut">Known Implementations</a></span><span id="nav_properties">  <span class="dim">|</span> 
<a href="#gtk3-Orientable.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="LayoutContainers.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="GtkExpander.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="GtkAspectFrame.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="gtk3-Orientable"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="gtk3-Orientable.top_of_page"></a>GtkOrientable</span></h2>
<p>GtkOrientable — An interface for flippable widgets</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="gtk3-Orientable.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="gtk3-Standard-Enumerations.html#GtkOrientation" title="enum GtkOrientation"><span class="returnvalue">GtkOrientation</span></a>
</td>
<td class="function_name">
<a class="link" href="gtk3-Orientable.html#gtk-orientable-get-orientation" title="gtk_orientable_get_orientation ()">gtk_orientable_get_orientation</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="gtk3-Orientable.html#gtk-orientable-set-orientation" title="gtk_orientable_set_orientation ()">gtk_orientable_set_orientation</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="gtk3-Orientable.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"><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="gtk3-Orientable.html#GtkOrientable--orientation" title="The “orientation” property">orientation</a></td>
<td class="property_flags">Read / Write</td>
</tr></tbody>
</table></div>
</div>
<a name="GtkOrientable"></a><div class="refsect1">
<a name="gtk3-Orientable.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"> </td>
<td class="function_name"><a class="link" href="gtk3-Orientable.html#GtkOrientable-struct" title="GtkOrientable">GtkOrientable</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="gtk3-Orientable.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> <a href="/usr/share/gtk-doc/html/gobject/GTypeModule.html">GInterface</a>
<span class="lineart">╰──</span> GtkOrientable
</pre>
</div>
<div class="refsect1">
<a name="gtk3-Orientable.prerequisites"></a><h2>Prerequisites</h2>
<p>
GtkOrientable requires
GObject.</p>
</div>
<div class="refsect1">
<a name="gtk3-Orientable.implementations"></a><h2>Known Implementations</h2>
<p>
GtkOrientable is implemented by
<a class="link" href="GtkAppChooserWidget.html" title="GtkAppChooserWidget">GtkAppChooserWidget</a>, <a class="link" href="GtkBox.html" title="GtkBox">GtkBox</a>, <a class="link" href="GtkButtonBox.html" title="GtkButtonBox">GtkButtonBox</a>, <a class="link" href="GtkCellAreaBox.html" title="GtkCellAreaBox">GtkCellAreaBox</a>, <a class="link" href="GtkCellRendererProgress.html" title="GtkCellRendererProgress">GtkCellRendererProgress</a>, <a class="link" href="GtkCellView.html" title="GtkCellView">GtkCellView</a>, <a class="link" href="GtkColorChooserWidget.html" title="GtkColorChooserWidget">GtkColorChooserWidget</a>, <a class="link" href="GtkColorSelection.html" title="GtkColorSelection">GtkColorSelection</a>, <a class="link" href="GtkFileChooserButton.html" title="GtkFileChooserButton">GtkFileChooserButton</a>, <a class="link" href="GtkFileChooserWidget.html" title="GtkFileChooserWidget">GtkFileChooserWidget</a>, <a class="link" href="GtkFlowBox.html" title="GtkFlowBox">GtkFlowBox</a>, <a class="link" href="GtkFontChooserWidget.html" title="GtkFontChooserWidget">GtkFontChooserWidget</a>, <a class="link" href="GtkFontSelection.html" title="GtkFontSelection">GtkFontSelection</a>, <a class="link" href="GtkGrid.html" title="GtkGrid">GtkGrid</a>, <a class="link" href="GtkHBox.html" title="GtkHBox">GtkHBox</a>, <a class="link" href="GtkHButtonBox.html" title="GtkHButtonBox">GtkHButtonBox</a>, <a class="link" href="GtkHPaned.html" title="GtkHPaned">GtkHPaned</a>, <a class="link" href="GtkHScale.html" title="GtkHScale">GtkHScale</a>, <a class="link" href="GtkHScrollbar.html" title="GtkHScrollbar">GtkHScrollbar</a>, <a class="link" href="GtkHSeparator.html" title="GtkHSeparator">GtkHSeparator</a>, <a class="link" href="GtkInfoBar.html" title="GtkInfoBar">GtkInfoBar</a>, <a class="link" href="GtkLevelBar.html" title="GtkLevelBar">GtkLevelBar</a>, <a class="link" href="GtkPaned.html" title="GtkPaned">GtkPaned</a>, <a class="link" href="GtkProgressBar.html" title="GtkProgressBar">GtkProgressBar</a>, <a class="link" href="GtkRange.html" title="GtkRange">GtkRange</a>, <a class="link" href="GtkRecentChooserWidget.html" title="GtkRecentChooserWidget">GtkRecentChooserWidget</a>, <a class="link" href="GtkScale.html" title="GtkScale">GtkScale</a>, <a class="link" href="GtkScaleButton.html" title="GtkScaleButton">GtkScaleButton</a>, <a class="link" href="GtkScrollbar.html" title="GtkScrollbar">GtkScrollbar</a>, <a class="link" href="GtkSeparator.html" title="GtkSeparator">GtkSeparator</a>, <a class="link" href="GtkShortcutsGroup.html" title="GtkShortcutsGroup">GtkShortcutsGroup</a>, <a class="link" href="GtkShortcutsSection.html" title="GtkShortcutsSection">GtkShortcutsSection</a>, <a class="link" href="GtkShortcutsShortcut.html" title="GtkShortcutsShortcut">GtkShortcutsShortcut</a>, <a class="link" href="GtkSpinButton.html" title="GtkSpinButton">GtkSpinButton</a>, <a class="link" href="GtkStackSwitcher.html" title="GtkStackSwitcher">GtkStackSwitcher</a>, <a class="link" href="GtkStatusbar.html" title="GtkStatusbar">GtkStatusbar</a>, <a class="link" href="GtkToolPalette.html" title="GtkToolPalette">GtkToolPalette</a>, <a class="link" href="GtkToolbar.html" title="GtkToolbar">GtkToolbar</a>, <a class="link" href="GtkVBox.html" title="GtkVBox">GtkVBox</a>, <a class="link" href="GtkVButtonBox.html" title="GtkVButtonBox">GtkVButtonBox</a>, <a class="link" href="GtkVPaned.html" title="GtkVPaned">GtkVPaned</a>, <a class="link" href="GtkVScale.html" title="GtkVScale">GtkVScale</a>, <a class="link" href="GtkVScrollbar.html" title="GtkVScrollbar">GtkVScrollbar</a>, <a class="link" href="GtkVSeparator.html" title="GtkVSeparator">GtkVSeparator</a> and <a class="link" href="GtkVolumeButton.html" title="GtkVolumeButton">GtkVolumeButton</a>.</p>
</div>
<div class="refsect1">
<a name="gtk3-Orientable.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include &lt;gtk/gtk.h&gt;
</pre>
</div>
<div class="refsect1">
<a name="gtk3-Orientable.description"></a><h2>Description</h2>
<p>The <a class="link" href="gtk3-Orientable.html#GtkOrientable"><span class="type">GtkOrientable</span></a> interface is implemented by all widgets that can be
oriented horizontally or vertically. Historically, such widgets have been
realized as subclasses of a common base class (e.g <a class="link" href="GtkBox.html" title="GtkBox"><span class="type">GtkBox</span></a>/<a class="link" href="GtkHBox.html" title="GtkHBox"><span class="type">GtkHBox</span></a>/<a class="link" href="GtkVBox.html" title="GtkVBox"><span class="type">GtkVBox</span></a>
or <a class="link" href="GtkScale.html" title="GtkScale"><span class="type">GtkScale</span></a>/<a class="link" href="GtkHScale.html" title="GtkHScale"><span class="type">GtkHScale</span></a>/<a class="link" href="GtkVScale.html" title="GtkVScale"><span class="type">GtkVScale</span></a>). <a class="link" href="gtk3-Orientable.html#GtkOrientable"><span class="type">GtkOrientable</span></a> is more flexible in that
it allows the orientation to be changed at runtime, allowing the widgets
to “flip”.</p>
<p><a class="link" href="gtk3-Orientable.html#GtkOrientable"><span class="type">GtkOrientable</span></a> was introduced in GTK+ 2.16.</p>
</div>
<div class="refsect1">
<a name="gtk3-Orientable.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="gtk-orientable-get-orientation"></a><h3>gtk_orientable_get_orientation ()</h3>
<pre class="programlisting"><a class="link" href="gtk3-Standard-Enumerations.html#GtkOrientation" title="enum GtkOrientation"><span class="returnvalue">GtkOrientation</span></a>
gtk_orientable_get_orientation (<em class="parameter"><code><a class="link" href="gtk3-Orientable.html#GtkOrientable"><span class="type">GtkOrientable</span></a> *orientable</code></em>);</pre>
<p>Retrieves the orientation of the <em class="parameter"><code>orientable</code></em>
.</p>
<div class="refsect3">
<a name="gtk-orientable-get-orientation.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>orientable</p></td>
<td class="parameter_description"><p>a <a class="link" href="gtk3-Orientable.html#GtkOrientable"><span class="type">GtkOrientable</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gtk-orientable-get-orientation.returns"></a><h4>Returns</h4>
<p> the orientation of the <em class="parameter"><code>orientable</code></em>
.</p>
</div>
<p class="since">Since: 2.16</p>
</div>
<hr>
<div class="refsect2">
<a name="gtk-orientable-set-orientation"></a><h3>gtk_orientable_set_orientation ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gtk_orientable_set_orientation (<em class="parameter"><code><a class="link" href="gtk3-Orientable.html#GtkOrientable"><span class="type">GtkOrientable</span></a> *orientable</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>
<p>Sets the orientation of the <em class="parameter"><code>orientable</code></em>
.</p>
<div class="refsect3">
<a name="gtk-orientable-set-orientation.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>orientable</p></td>
<td class="parameter_description"><p>a <a class="link" href="gtk3-Orientable.html#GtkOrientable"><span class="type">GtkOrientable</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>orientation</p></td>
<td class="parameter_description"><p>the orientables new orientation.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: 2.16</p>
</div>
</div>
<div class="refsect1">
<a name="gtk3-Orientable.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="GtkOrientable-struct"></a><h3>GtkOrientable</h3>
<pre class="programlisting">typedef struct _GtkOrientable GtkOrientable;</pre>
</div>
</div>
<div class="refsect1">
<a name="gtk3-Orientable.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="GtkOrientable--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 orientable.</p>
<p>Owner: GtkOrientable</p>
<p>Flags: Read / Write</p>
<p>Default value: GTK_ORIENTATION_HORIZONTAL</p>
<p class="since">Since: 2.16</p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.33.1</div>
</body>
</html>