![]() |

The Frame widget surrounds its single child with a decorative frame and an optional label. If present, the label is drawn in a gap in the top side of the frame. The position of the label can be controlled with set_label_align().
Public Member Functions | ||||
| Frame (const Glib::ustring& label) | ||||
| Frame () | ||||
| Glib::ustring | get_label () const | |||
| If the frame's label widget is a Gtk::Label, returns the text in the label widget. | ||||
| void | get_label_align (float& xalign, float& yalign) const | |||
| Retrieves the X and Y alignment of the frame's label. | ||||
| const Widget* | get_label_widget () const | |||
| Retrieves the label widget for the frame. | ||||
| Widget* | get_label_widget () | |||
| Retrieves the label widget for the frame. | ||||
| ShadowType | get_shadow_type () const | |||
| Retrieves the shadow type of the frame. | ||||
| const GtkFrame* | gobj () const | |||
| Provides access to the underlying C GtkObject. | ||||
| GtkFrame* | gobj () | |||
| Provides access to the underlying C GtkObject. | ||||
| void | set_label (const Glib::ustring& label) | |||
| Sets the text of the label. | ||||
| void | set_label_align (AlignmentEnum xalign, AlignmentEnum yalign=Gtk::ALIGN_CENTER) | |||
| Sets the alignment of the frame widget's label. | ||||
| void | set_label_align (float xalign=0.0, float yalign=0.5) | |||
| Sets the alignment of the frame widget's label. | ||||
| void | set_label_widget (Widget& label_widget) | |||
| Sets the label widget for the frame. | ||||
| void | set_shadow_type (ShadowType type) | |||
| Sets the shadow type for frame . | ||||
| void | unset_label () | |||
| virtual | ~Frame () | |||
Related Functions | ||||
| (Note that these are not member functions.) | ||||
| Gtk::Frame* | wrap (GtkFrame* object, bool take_copy=false) | |||
| ||||
| virtual Gtk::Frame::~Frame | ( | ) | [virtual] |
| Gtk::Frame::Frame | ( | ) |
| Gtk::Frame::Frame | ( | const Glib::ustring & | label | ) | [explicit] |
| Glib::ustring Gtk::Frame::get_label | ( | ) | const |
If the frame's label widget is a Gtk::Label, returns the text in the label widget.
(The frame will have a Gtk::Label for the label widget if a non-0 argument was passed to new().)
0 if there was no label widget or the lable widget was not a Gtk::Label. This string is owned by GTK+ and must not be modified or freed. | void Gtk::Frame::get_label_align | ( | float & | xalign, | |
| float & | yalign | |||
| ) | const |
Retrieves the X and Y alignment of the frame's label.
See set_label_align().
| xalign | Location to store X alignment of frame's label, or 0. | |
| yalign | Location to store X alignment of frame's label, or 0. |
| const Widget* Gtk::Frame::get_label_widget | ( | ) | const |
Retrieves the label widget for the frame.
See set_label_widget().
0 if there is none. | Widget* Gtk::Frame::get_label_widget | ( | ) |
Retrieves the label widget for the frame.
See set_label_widget().
0 if there is none. | ShadowType Gtk::Frame::get_shadow_type | ( | ) | const |
Retrieves the shadow type of the frame.
See set_shadow_type().
| const GtkFrame* Gtk::Frame::gobj | ( | ) | const [inline] |
Provides access to the underlying C GtkObject.
Reimplemented from Gtk::Bin.
Reimplemented in Gtk::AspectFrame.
| GtkFrame* Gtk::Frame::gobj | ( | ) | [inline] |
Provides access to the underlying C GtkObject.
Reimplemented from Gtk::Bin.
Reimplemented in Gtk::AspectFrame.
| void Gtk::Frame::set_label | ( | const Glib::ustring & | label | ) |
Sets the text of the label.
If label is 0, the current label is removed.
| label | The text to use as the label of the frame. |
| void Gtk::Frame::set_label_align | ( | AlignmentEnum | xalign, | |
| AlignmentEnum | yalign = Gtk::ALIGN_CENTER | |||
| ) |
Sets the alignment of the frame widget's label.
The default values for a newly created frame are 0.0 and 0.5.
| xalign | The position of the label along the top edge of the widget. A value of 0.0 represents left alignment; 1.0 represents right alignment. | |
| yalign | The y alignment of the label. A value of 0.0 aligns under the frame; 1.0 aligns above the frame. |
| void Gtk::Frame::set_label_align | ( | float | xalign = 0.0, |
|
| float | yalign = 0.5 | |||
| ) |
Sets the alignment of the frame widget's label.
The default values for a newly created frame are 0.0 and 0.5.
| xalign | The position of the label along the top edge of the widget. A value of 0.0 represents left alignment; 1.0 represents right alignment. | |
| yalign | The y alignment of the label. A value of 0.0 aligns under the frame; 1.0 aligns above the frame. |
| void Gtk::Frame::set_label_widget | ( | Widget& | label_widget | ) |
Sets the label widget for the frame.
This is the widget that will appear embedded in the top edge of the frame as a title.
| label_widget | The new label widget. |
| void Gtk::Frame::set_shadow_type | ( | ShadowType | type | ) |
| void Gtk::Frame::unset_label | ( | ) |
| Gtk::Frame* wrap | ( | GtkFrame * | object, | |
| bool | take_copy = false | |||
| ) | [related] |
| object | The C instance |
| take_copy | False if the result should take ownership of the C instance. True if it should take a new copy or ref. |