Gtk-- Reference: Gtk::Frame

Class Index | Cross Index | Namespace Index

# Class Gtk::Frame

A decrative border
Contained in: Gtk
Derived from: Gtk::Bin
Derived by: Gtk::AspectFrame

#include <gtk--/frame.h>

### public function member index:
`` | `Frame` | `(`const` `nstring`& `label`)`;
`` | `Frame` | `()`;
``string`` | `get_label` | `() `const``;
``GtkShadowType`` | `get_shadow_type` | `() `const``;
``float`` | `get_xalign` | `() `const``;
``float`` | `get_yalign` | `() `const``;
``GtkFrame`*` | `gtkobj` | `()`;
``const` `GtkFrame`*` | `gtkobj` | `() `const``;
``static` `bool`` | `isA` | `(`Object`* `object`)`;
``void`` | `set_label` | `(`const` `nstring`& `str`)`;
``void`` | `set_label_align` | `(`gfloat` `xalign`=0.0, `gfloat` `yalign`=0.5)`;
``void`` | `set_shadow_type` | `(`GtkShadowType` `type`)`;
``virtual`` | `~Frame` | `()`;

## Description:

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.

## Function Member Descriptions:

Gtk::Frame::get_label - Returns a copy of the label which appears in the frame.

``string`` `get_label``() `const``;

> If there is no label, the string will be empty.

Gtk::Frame::get_shadow_type - Returns the current shadow type of a frame.

``GtkShadowType`` `get_shadow_type``() `const``;
Gtk::Frame::get_xalign - Returns the current horizontal label position.

``float`` `get_xalign``() `const``;

> Range from 0 (left) to 1.0 (right).

Gtk::Frame::get_yalign - Returns the current vertical label position.

``float`` `get_yalign``() `const``;

> Range from 0 (top) to 1.0 (bottom).

Gtk::Frame::gtkobj - Returns the underlaying gtk+ object.

``GtkFrame`*` `gtkobj``()`;
Gtk::Frame::isA - Returns true if object is this type.

``static` `bool`` `isA``(`Object`* `object`)`;
Gtk::Frame::set_label - Adds a label to appear in the top edge of the frame.

``void`` `set_label``(`const` `nstring`& `str`)`;

> Label alignment defaults to the upper left corner of the frame. ``str`` can be a NULL pointer.

Gtk::Frame::set_label_align - Sets the alignment of a frame's label.

``void`` `set_label_align``(`gfloat` `xalign`=0.0, `gfloat` `yalign`=0.5)`;

> ``xalign`` sets the horizontal label position and should be between 0 (left) and 1.0 (right). ``yalign`` does not appear to have any effect in this version of gtk+. Defaults to (0.0,0.5).

Gtk::Frame::set_shadow_type - Sets shadow type of the frame.

``void`` `set_shadow_type``(`GtkShadowType` `type`)`;

> The possible choices are: `GTK_SHADOW_NONE,GTK_SHADOW_IN,GTK_SHADOW_OUT,GTK_SHADOW_ETCHED_IN, GTK_SHADOW_ETCHED_OUT`

> declaration of the enum GtkShadowType can be found from gtkenums.h