GTK+ Reference Manual
<<< Previous Page | Home | Up | Next Page >>>

# GtkFrame

## Name

GtkFrame -- A bin with a decorative frame and optional label.

## Synopsis

    #include <gtk/gtk.h>

    struct      GtkFrame;
    GtkWidget*  gtk_frame_new                   (const gchar *label);
    void        gtk_frame_set_label             (GtkFrame *frame,
                                                 const gchar *label);
    void        gtk_frame_set_label_align       (GtkFrame *frame,
                                                 gfloat xalign,
                                                 gfloat yalign);
    void        gtk_frame_set_shadow_type       (GtkFrame *frame,
                                                 GtkShadowType type);

## Object Hierarchy

      GtkObject
       +----GtkWidget
             +----GtkContainer
                   +----GtkBin
                         +----GtkFrame

## Properties

      "label"                gchar*               : Read / Write
      "label-xalign"         gfloat               : Read / Write
      "label-yalign"         gfloat               : Read / Write
      "shadow"               GtkShadowType        : Read / Write

## Description

The frame widget is a Bin that surrounds its 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 gtk_frame_set_label_align().

## Details

### struct GtkFrame

    struct GtkFrame;

### gtk_frame_new ()

    GtkWidget*  gtk_frame_new                   (const gchar *label);

Create a new Frame, with optional label `label`. If `label` is `NULL`, the label is omitted.

`label` : |
Returns : |

### gtk_frame_set_label ()

    void        gtk_frame_set_label             (GtkFrame *frame,
                                                 const gchar *label);

Set the text of the label. If `label` is `NULL`, the current label, if any, is removed.

`frame` : |
`label` : |

### gtk_frame_set_label_align ()

    void        gtk_frame_set_label_align       (GtkFrame *frame,
                                                 gfloat xalign,
                                                 gfloat yalign);

Set the alignment of the Frame widget's label. The default value for a newly created Frame is 0.0.

`frame` : | The Frame widget.
`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. Currently ignored.

### gtk_frame_set_shadow_type ()

    void        gtk_frame_set_shadow_type       (GtkFrame *frame,
                                                 GtkShadowType type);

Set the shadow type for the Frame widget.

`frame` : | The Frame widget.
`type` : | New shadow type.

## Properties

"`label`" (gchar* : Read / Write)

"`label-xalign`" (gfloat : Read / Write)

"`label-yalign`" (gfloat : Read / Write)

"`shadow`" (GtkShadowType : Read / Write)

<<< Previous Page | Home | Up | Next Page >>>
GtkFontSelectionDialog | GtkGammaCurve