<html> <head><title>Gtk-- Reference: Gtk::Frame</title></head> <body bgcolor="#F0F0F0" text="#000000" link="#0000FF" vlink="#000077" alink="#FF0000"> <table align=center border=0 cellspacing=10> <tr> <td><a href="class_index.html">Class Index</a></td> <td><a href="cross_index.html">Cross Index</a></td> <td><a href="name_index.html">Namespace Index</a></td> </table> <h1 align=center>Class Gtk::Frame</h1><p> <b> A decrative border</b><br> Contained in: <a href="Gtk.html">Gtk</a><br> Derived from: <a href="Gtk%3A%3ABin.html">Gtk::Bin</a> <br> Derived by: <a href="Gtk::AspectFrame.html">Gtk::AspectFrame</a> <p> #include <gtk--/frame.h> <p> <hr noshade> <table border=0> <tr><td colspan=3><h3>public function member index:</h3></td> <tr valign=top><td align=right><tt></tt> </td><td align=right><a href="Gtk%3A%3AFrame.html#1568"><tt><font color=blue><b>Frame</b></font></tt></a></td><td><tt>(<tt>const</tt> <a href="Gtk%3A%3Anstring.html"><tt><font color=navy><b>nstring</b></font></tt></a>& <tt><font color=blue>label</font></tt>)</tt>;</td> <tr valign=top><td align=right><tt></tt> </td><td align=right><a href="Gtk%3A%3AFrame.html#1569"><tt><font color=blue><b>Frame</b></font></tt></a></td><td><tt>()</tt>;</td> <tr valign=top><td align=right><tt><tt><font color=navy>string</font></tt></tt> </td><td align=right><a href="Gtk%3A%3AFrame.html#1571"><tt><font color=blue><b>get_label</b></font></tt></a></td><td><tt>() <tt>const</tt></tt>;</td> <tr valign=top><td align=right><tt><tt><font color=navy>GtkShadowType</font></tt></tt> </td><td align=right><a href="Gtk%3A%3AFrame.html#1576"><tt><font color=blue><b>get_shadow_type</b></font></tt></a></td><td><tt>() <tt>const</tt></tt>;</td> <tr valign=top><td align=right><tt><tt><font color=purple>float</font></tt></tt> </td><td align=right><a href="Gtk%3A%3AFrame.html#1573"><tt><font color=blue><b>get_xalign</b></font></tt></a></td><td><tt>() <tt>const</tt></tt>;</td> <tr valign=top><td align=right><tt><tt><font color=purple>float</font></tt></tt> </td><td align=right><a href="Gtk%3A%3AFrame.html#1574"><tt><font color=blue><b>get_yalign</b></font></tt></a></td><td><tt>() <tt>const</tt></tt>;</td> <tr valign=top><td align=right><tt><tt><font color=navy>GtkFrame</font></tt>*</tt> </td><td align=right><a href="Gtk%3A%3AFrame.html#1564"><tt><font color=blue><b>gtkobj</b></font></tt></a></td><td><tt>()</tt>;</td> <tr valign=top><td align=right><tt><tt>const</tt> <tt><font color=navy>GtkFrame</font></tt>*</tt> </td><td align=right><a href="Gtk%3A%3AFrame.html#1565"><tt><font color=blue><b>gtkobj</b></font></tt></a></td><td><tt>() <tt>const</tt></tt>;</td> <tr valign=top><td align=right><tt><tt>static</tt> <tt><font color=purple>bool</font></tt></tt> </td><td align=right><a href="Gtk%3A%3AFrame.html#1566"><tt><font color=blue><b>isA</b></font></tt></a></td><td><tt>(<a href="Gtk%3A%3AObject.html"><tt><font color=navy><b>Object</b></font></tt></a>* <tt><font color=blue>object</font></tt>)</tt>;</td> <tr valign=top><td align=right><tt><tt><font color=purple>void</font></tt></tt> </td><td align=right><a href="Gtk%3A%3AFrame.html#1570"><tt><font color=blue><b>set_label</b></font></tt></a></td><td><tt>(<tt>const</tt> <a href="Gtk%3A%3Anstring.html"><tt><font color=navy><b>nstring</b></font></tt></a>& <tt><font color=blue>str</font></tt>)</tt>;</td> <tr valign=top><td align=right><tt><tt><font color=purple>void</font></tt></tt> </td><td align=right><a href="Gtk%3A%3AFrame.html#1572"><tt><font color=blue><b>set_label_align</b></font></tt></a></td><td><tt>(<tt><font color=purple>gfloat</font></tt> <tt><font color=blue>xalign</font></tt>=0.0, <tt><font color=purple>gfloat</font></tt> <tt><font color=blue>yalign</font></tt>=0.5)</tt>;</td> <tr valign=top><td align=right><tt><tt><font color=purple>void</font></tt></tt> </td><td align=right><a href="Gtk%3A%3AFrame.html#1575"><tt><font color=blue><b>set_shadow_type</b></font></tt></a></td><td><tt>(<tt><font color=navy>GtkShadowType</font></tt> <tt><font color=blue>type</font></tt>)</tt>;</td> <tr valign=top><td align=right><tt><tt>virtual</tt> </tt> </td><td align=right><a href="Gtk%3A%3AFrame.html#1567"><tt><font color=blue><b>~Frame</b></font></tt></a></td><td><tt>()</tt>;</td> <tr><td> </td></table> <hr noshade> <h2>Description:</h2> The frame widget puts a simple border around what ever widget is packed into it. It can also contain a lable to identify the widget(s) inside.<br> <p> <hr noshade> <h2>Function Member Descriptions:</h2> <a name="1571"><font size=+1><b>Gtk::Frame::get_label</b></font></a> - Returns a copy of the label which appears in the frame.<br> <hr size="1" width="70%" align="left" noshade="noshade"><tt><tt><font color=navy>string</font></tt></tt> <a href="Gtk%3A%3AFrame.html#1571"><tt><font color=blue><b>get_label</b></font></tt></a><tt>() <tt>const</tt></tt>;<br><blockquote> If there is no label, the string will be empty.</blockquote> <br><br> <a name="1576"><font size=+1><b>Gtk::Frame::get_shadow_type</b></font></a> - Returns the current shadow type of a frame.<br> <hr size="1" width="70%" align="left" noshade="noshade"><tt><tt><font color=navy>GtkShadowType</font></tt></tt> <a href="Gtk%3A%3AFrame.html#1576"><tt><font color=blue><b>get_shadow_type</b></font></tt></a><tt>() <tt>const</tt></tt>;<br><br> <a name="1573"><font size=+1><b>Gtk::Frame::get_xalign</b></font></a> - Returns the current horizontal label position.<br> <hr size="1" width="70%" align="left" noshade="noshade"><tt><tt><font color=purple>float</font></tt></tt> <a href="Gtk%3A%3AFrame.html#1573"><tt><font color=blue><b>get_xalign</b></font></tt></a><tt>() <tt>const</tt></tt>;<br><blockquote> Range from 0 (left) to 1.0 (right).</blockquote> <br><br> <a name="1574"><font size=+1><b>Gtk::Frame::get_yalign</b></font></a> - Returns the current vertical label position.<br> <hr size="1" width="70%" align="left" noshade="noshade"><tt><tt><font color=purple>float</font></tt></tt> <a href="Gtk%3A%3AFrame.html#1574"><tt><font color=blue><b>get_yalign</b></font></tt></a><tt>() <tt>const</tt></tt>;<br><blockquote> Range from 0 (top) to 1.0 (bottom).</blockquote> <br><br> <a name="1564"><font size=+1><b>Gtk::Frame::gtkobj</b></font></a> - Returns the underlaying gtk+ object.<br> <hr size="1" width="70%" align="left" noshade="noshade"><tt><tt><font color=navy>GtkFrame</font></tt>*</tt> <a href="Gtk%3A%3AFrame.html#1564"><tt><font color=blue><b>gtkobj</b></font></tt></a><tt>()</tt>;<br><br> <a name="1566"><font size=+1><b>Gtk::Frame::isA</b></font></a> - Returns true if object is this type.<br> <hr size="1" width="70%" align="left" noshade="noshade"><tt><tt>static</tt> <tt><font color=purple>bool</font></tt></tt> <a href="Gtk%3A%3AFrame.html#1566"><tt><font color=blue><b>isA</b></font></tt></a><tt>(<a href="Gtk%3A%3AObject.html"><tt><font color=navy><b>Object</b></font></tt></a>* <tt><font color=blue>object</font></tt>)</tt>;<br><br> <a name="1570"><font size=+1><b>Gtk::Frame::set_label</b></font></a> - Adds a label to appear in the top edge of the frame.<br> <hr size="1" width="70%" align="left" noshade="noshade"><tt><tt><font color=purple>void</font></tt></tt> <a href="Gtk%3A%3AFrame.html#1570"><tt><font color=blue><b>set_label</b></font></tt></a><tt>(<tt>const</tt> <a href="Gtk%3A%3Anstring.html"><tt><font color=navy><b>nstring</b></font></tt></a>& <tt><font color=blue>str</font></tt>)</tt>;<br><blockquote> Label alignment defaults to the upper left corner of the frame. <tt><tt><font color=blue>str</font></tt></tt> can be a NULL pointer.</blockquote> <br><br> <a name="1572"><font size=+1><b>Gtk::Frame::set_label_align</b></font></a> - Sets the alignment of a frame's label.<br> <hr size="1" width="70%" align="left" noshade="noshade"><tt><tt><font color=purple>void</font></tt></tt> <a href="Gtk%3A%3AFrame.html#1572"><tt><font color=blue><b>set_label_align</b></font></tt></a><tt>(<tt><font color=purple>gfloat</font></tt> <tt><font color=blue>xalign</font></tt>=0.0, <tt><font color=purple>gfloat</font></tt> <tt><font color=blue>yalign</font></tt>=0.5)</tt>;<br><blockquote> <tt><tt><font color=blue>xalign</font></tt></tt> sets the horizontal label position and should be between 0 (left) and 1.0 (right). <tt><tt><font color=blue>yalign</font></tt></tt> does not appear to have any effect in this version of gtk+. Defaults to (0.0,0.5).</blockquote> <br><br> <a name="1575"><font size=+1><b>Gtk::Frame::set_shadow_type</b></font></a> - Sets shadow type of the frame.<br> <hr size="1" width="70%" align="left" noshade="noshade"><tt><tt><font color=purple>void</font></tt></tt> <a href="Gtk%3A%3AFrame.html#1575"><tt><font color=blue><b>set_shadow_type</b></font></tt></a><tt>(<tt><font color=navy>GtkShadowType</font></tt> <tt><font color=blue>type</font></tt>)</tt>;<br><blockquote> The possible choices are: <tt><font color=green> GTK_SHADOW_NONE,GTK_SHADOW_IN,GTK_SHADOW_OUT,GTK_SHADOW_ETCHED_IN, GTK_SHADOW_ETCHED_OUT</font></tt> <P> declaration of the enum GtkShadowType can be found from gtkenums.h</blockquote> <br><br> <hr noshade> </html>