Data Structures | Macros | Typedefs | Enumerations | Functions
gntbox.h File Reference

Box API. More...

#include "gnt.h"
#include "gntwidget.h"

Go to the source code of this file.

Data Structures

struct  _GntBox
 
struct  _GntBoxClass
 

Macros

#define GNT_TYPE_BOX   (gnt_box_get_gtype())
 
#define GNT_BOX(obj)   (G_TYPE_CHECK_INSTANCE_CAST((obj), GNT_TYPE_BOX, GntBox))
 
#define GNT_BOX_CLASS(klass)   (G_TYPE_CHECK_CLASS_CAST((klass), GNT_TYPE_BOX, GntBoxClass))
 
#define GNT_IS_BOX(obj)   (G_TYPE_CHECK_INSTANCE_TYPE((obj), GNT_TYPE_BOX))
 
#define GNT_IS_BOX_CLASS(klass)   (G_TYPE_CHECK_CLASS_TYPE((klass), GNT_TYPE_BOX))
 
#define GNT_BOX_GET_CLASS(obj)   (G_TYPE_INSTANCE_GET_CLASS((obj), GNT_TYPE_BOX, GntBoxClass))
 
#define gnt_vbox_new(homo)   gnt_box_new(homo, TRUE)
 
#define gnt_hbox_new(homo)   gnt_box_new(homo, FALSE)
 

Typedefs

typedef struct _GntBox GntBox
 
typedef struct _GntBoxClass GntBoxClass
 

Enumerations

enum  GntAlignment {
  GNT_ALIGN_LEFT, GNT_ALIGN_RIGHT, GNT_ALIGN_MID, GNT_ALIGN_TOP,
  GNT_ALIGN_BOTTOM
}
 

Functions

G_BEGIN_DECLS GType gnt_box_get_gtype (void)
 The GType for GntBox. More...
 
GntWidgetgnt_box_new (gboolean homo, gboolean vert)
 Create a new GntBox. More...
 
void gnt_box_add_widget (GntBox *box, GntWidget *widget)
 Add a widget in the box. More...
 
void gnt_box_set_title (GntBox *box, const char *title)
 Set a title for the box. More...
 
void gnt_box_set_pad (GntBox *box, int pad)
 Set the padding to use between the widgets in the box. More...
 
void gnt_box_set_toplevel (GntBox *box, gboolean set)
 Set whether it's a toplevel box (ie, a window) or not. More...
 
void gnt_box_sync_children (GntBox *box)
 Reposition and refresh the widgets in the box. More...
 
void gnt_box_set_alignment (GntBox *box, GntAlignment alignment)
 Set the alignment for the widgets in the box. More...
 
void gnt_box_remove (GntBox *box, GntWidget *widget)
 Remove a widget from the box. More...
 
void gnt_box_remove_all (GntBox *box)
 Remove all widgets from the box. More...
 
void gnt_box_readjust (GntBox *box)
 Readjust the size of each child widget, reposition the child widgets and recalculate the size of the box. More...
 
void gnt_box_set_fill (GntBox *box, gboolean fill)
 Set whether the widgets in the box should fill the empty spaces. More...
 
void gnt_box_move_focus (GntBox *box, int dir)
 Move the focus from one widget to the other. More...
 
void gnt_box_give_focus_to_child (GntBox *box, GntWidget *widget)
 Give focus to a specific child widget. More...
 

Detailed Description

Box API.

Definition in file gntbox.h.

Function Documentation

void gnt_box_add_widget ( GntBox box,
GntWidget widget 
)

Add a widget in the box.

Parameters
boxThe box
widgetThe widget to add
G_BEGIN_DECLS GType gnt_box_get_gtype ( void  )

The GType for GntBox.

Returns
The GType.
void gnt_box_give_focus_to_child ( GntBox box,
GntWidget widget 
)

Give focus to a specific child widget.

Parameters
boxThe box
widgetThe child widget to give focus
void gnt_box_move_focus ( GntBox box,
int  dir 
)

Move the focus from one widget to the other.

Parameters
boxThe box
dirThe direction. If it's 1, then the focus is moved forwards, if it's -1, the focus is moved backwards.
GntWidget* gnt_box_new ( gboolean  homo,
gboolean  vert 
)

Create a new GntBox.

Parameters
homoIf TRUE, all the widgets in it will have the same width (or height)
vertWhether the widgets in it should be stacked vertically (if TRUE) or horizontally (if FALSE).
Returns
The new GntBox.
void gnt_box_readjust ( GntBox box)

Readjust the size of each child widget, reposition the child widgets and recalculate the size of the box.

Parameters
boxThe box
void gnt_box_remove ( GntBox box,
GntWidget widget 
)

Remove a widget from the box.

Calling this does NOT destroy the removed widget.

Parameters
boxThe box
widgetThe widget to remove
void gnt_box_remove_all ( GntBox box)

Remove all widgets from the box.

This DOES destroy all widgets in the box.

Parameters
boxThe box
void gnt_box_set_alignment ( GntBox box,
GntAlignment  alignment 
)

Set the alignment for the widgets in the box.

Parameters
boxThe box
alignmentThe alignment to use
void gnt_box_set_fill ( GntBox box,
gboolean  fill 
)

Set whether the widgets in the box should fill the empty spaces.

Parameters
boxThe box
fillWhether the child widgets should fill the empty space
void gnt_box_set_pad ( GntBox box,
int  pad 
)

Set the padding to use between the widgets in the box.

Parameters
boxThe box
padThe padding to use
void gnt_box_set_title ( GntBox box,
const char *  title 
)

Set a title for the box.

Parameters
boxThe box
titleThe title to set
void gnt_box_set_toplevel ( GntBox box,
gboolean  set 
)

Set whether it's a toplevel box (ie, a window) or not.

If a box is toplevel, then it will show borders, the title (if set) and shadow (if enabled in .gntrc)

Parameters
boxThe box
setTRUE if it's a toplevel box, FALSE otherwise.
void gnt_box_sync_children ( GntBox box)

Reposition and refresh the widgets in the box.

Parameters
boxThe box