Tutorials > lablgtk2 tutorial > Container widgets > Frames

Frames

Frames can be used to enclose one or a group of widgets with a box which can optionally be labelled. The position of the label and the style of the box can be altered to suit.

A Frame can be created with the function GBin.frame :

val frame :
	?label:string ->
	?label_xalign:Gtk.clampf ->
	?label_yalign:Gtk.clampf ->
	?shadow_type:Gtk.Tags.shadow_type ->
	?border_width:int ->
	?width:int ->
	?height:int ->
	?packing:(GObj.widget -> unit) ->
	?show:bool -> unit -> frame

The label is by default placed in the upper left hand corner of the frame. A value of NULL for the label argument will result in no label being displayed. The text of the label can be changed using the next function.

method set_label : string option -> unit

The position of the label can be changed using these functions:

method set_label_xalign : float -> unit
method set_label_yalign : float -> unit

xalign and yalign take values between 0.0 and 1.0. xalign indicates the position of the label along the top horizontal of the frame. yalign is not currently used. The default value of xalign is 0.0 which places the label at the left hand end of the frame.

The next function alters the style of the box that is used to outline the frame.

method set_shadow_type : Gtk.Tags.shadow_type -> unit

The type argument can take one of the following values:

  `NONE
  `IN
  `OUT
  `ETCHED_IN (the default)
  `ETCHED_OUT

The following code example illustrates the use of the Frame widget.

frames

(* file: frame.ml *)

let main () =
  (* Create a new window; set title and border width *)
  let window = GWindow.window ~title:"Frame Example" ~width:300 ~height:300 ~border_width:10 () in

  (* Here we connect the "destroy" event to a signal handler *)
  window#connect#destroy ~callback:GMain.Main.quit;

  (* Create a Frame
   * Set the frame's label
   * Align the label at the right of the frame
   * Set the style of the frame *)
  let frame = GBin.frame ~label:"Frame Widget" ~label_xalign:1.0 ~shadow_type:`ETCHED_OUT ~packing:window#add () in

  window#show ();
  GMain.Main.main ()

let _ = Printexc.print main ()