gtk.Frame.Frame Class Reference

Inheritance diagram for gtk.Frame.Frame:

gtk.Bin.Bin gtk.Container.Container gtk.Widget.Widget gtk.ObjectGtk.ObjectGtk gobject.ObjectG.ObjectG gtk.AspectFrame.AspectFrame List of all members.

Public Member Functions

GtkFramegetFrameStruct ()
 this (GtkFrame *gtkFrame)
 Sets our main struct and passes it to the parent class.
 this (Widget widget, char[] label)
 Creates frame with label and set it's child widget.
 this (char[] label)
 Creates a new GtkFrame, with optional label label.
void setLabel (char[] label)
 Sets the text of the label.
void setLabelWidget (Widget labelWidget)
 Sets the label widget for the frame.
void setLabelAlign (float xalign, float yalign)
 Sets the alignment of the frame widget's label.
void setShadowType (GtkShadowType type)
 Sets the shadow type for frame.
char[] getLabel ()
 If the frame's label widget is a GtkLabel, returns the text in the label widget.
void getLabelAlign (float *xalign, float *yalign)
 Retrieves the X and Y alignment of the frame's label.
Widget getLabelWidget ()
 Retrieves the label widget for the frame.
GtkShadowType getShadowType ()
 Retrieves the shadow type of the frame.

Protected Member Functions

void * getStruct ()
 the main Gtk struct as a void*

Protected Attributes

GtkFramegtkFrame
 the main Gtk struct

Constructor & Destructor Documentation

gtk.Frame.Frame.this ( GtkFrame gtkFrame  ) 

Sets our main struct and passes it to the parent class.

gtk.Frame.Frame.this ( Widget  widget,
char[]  label 
)

Creates frame with label and set it's child widget.

gtk.Frame.Frame.this ( char[]  label  ) 

Creates a new GtkFrame, with optional label label.

If label is NULL, the label is omitted. label: the text to use as the label of the frame Returns: a new GtkFrame widget


Member Function Documentation

GtkFrame* gtk.Frame.Frame.getFrameStruct (  ) 

char [] gtk.Frame.Frame.getLabel (  ) 

If the frame's label widget is a GtkLabel, returns the text in the label widget.

(The frame will have a GtkLabel for the label widget if a non-NULL argument was passed to gtk_frame_new().) frame: a GtkFrame Returns: the text in the label, or NULL if there was no label widget or the lable widget was not a GtkLabel. This string is owned by GTK+ and must not be modified or freed.

void gtk.Frame.Frame.getLabelAlign ( float *  xalign,
float *  yalign 
)

Retrieves the X and Y alignment of the frame's label.

See gtk_frame_set_label_align(). frame: a GtkFrame xalign: location to store X alignment of frame's label, or NULL yalign: location to store X alignment of frame's label, or NULL

Widget gtk.Frame.Frame.getLabelWidget (  ) 

Retrieves the label widget for the frame.

See gtk_frame_set_label_widget(). frame: a GtkFrame Returns: the label widget, or NULL if there is none.

GtkShadowType gtk.Frame.Frame.getShadowType (  ) 

Retrieves the shadow type of the frame.

See gtk_frame_set_shadow_type(). frame: a GtkFrame Returns: the current shadow type of the frame. Property Details The "label" property "label" gchararray : Read / Write Text of the frame's label. Default value: NULL

void* gtk.Frame.Frame.getStruct (  )  [protected]

the main Gtk struct as a void*

Reimplemented from gtk.Bin.Bin.

Reimplemented in gtk.AspectFrame.AspectFrame.

void gtk.Frame.Frame.setLabel ( char[]  label  ) 

Sets the text of the label.

If label is NULL, the current label is removed. frame: a GtkFrame label: the text to use as the label of the frame

void gtk.Frame.Frame.setLabelAlign ( float  xalign,
float  yalign 
)

Sets the alignment of the frame widget's label.

The default values for a newly created frame are 0.0 and 0.5. frame: a GtkFrame 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.Frame.setLabelWidget ( Widget  labelWidget  ) 

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. frame: a GtkFrame label_widget: the new label widget

void gtk.Frame.Frame.setShadowType ( GtkShadowType  type  ) 

Sets the shadow type for frame.

frame: a GtkFrame type: the new GtkShadowType


Member Data Documentation

GtkFrame* gtk.Frame.Frame.gtkFrame [protected]

the main Gtk struct


SourceForge.net Logo DSource.org Logo digitalmars.com Logo