gntbox.h
Go to the documentation of this file.
/*
* GNT - The GLib Ncurses Toolkit
*
* GNT is the legal property of its developers, whose names are too numerous
* to list here. Please refer to the COPYRIGHT file distributed with this
* source distribution.
*
* This library is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02111-1301 USA
*/
#ifndef GNT_BOX_H
#define GNT_BOX_H
#include "gnt.h"
#include "gntwidget.h"
#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))
typedef struct _GntBox GntBox;
typedef struct _GntBoxClass GntBoxClass;
typedef enum
{
/* These for vertical boxes */
GNT_ALIGN_LEFT,
GNT_ALIGN_RIGHT,
GNT_ALIGN_MID,
/* These for horizontal boxes */
GNT_ALIGN_TOP,
GNT_ALIGN_BOTTOM
} GntAlignment;
struct _GntBox
{
GntWidget parent;
gboolean vertical;
gboolean homogeneous;
gboolean fill;
GList *list; /* List of widgets */
GntWidget *active;
int pad; /* Number of spaces to use between widgets */
GntAlignment alignment; /* How are the widgets going to be aligned? */
char *title;
GList *focus; /* List of widgets to cycle focus (only valid for parent boxes) */
void (*gnt_reserved1)(void);
void (*gnt_reserved2)(void);
void (*gnt_reserved3)(void);
void (*gnt_reserved4)(void);
};
struct _GntBoxClass
{
GntWidgetClass parent;
void (*gnt_reserved1)(void);
void (*gnt_reserved2)(void);
void (*gnt_reserved3)(void);
void (*gnt_reserved4)(void);
};
G_BEGIN_DECLS
GType gnt_box_get_gtype(void);
#define gnt_vbox_new(homo) gnt_box_new(homo, TRUE)
#define gnt_hbox_new(homo) gnt_box_new(homo, FALSE)
GntWidget * gnt_box_new(gboolean homo, gboolean vert);
void gnt_box_add_widget(GntBox *box, GntWidget *widget);
void gnt_box_set_title(GntBox *box, const char *title);
void gnt_box_set_pad(GntBox *box, int pad);
void gnt_box_set_toplevel(GntBox *box, gboolean set);
void gnt_box_sync_children(GntBox *box);
void gnt_box_set_alignment(GntBox *box, GntAlignment alignment);
void gnt_box_remove(GntBox *box, GntWidget *widget);
void gnt_box_remove_all(GntBox *box);
void gnt_box_readjust(GntBox *box);
void gnt_box_set_fill(GntBox *box, gboolean fill);
void gnt_box_move_focus(GntBox *box, int dir);
void gnt_box_give_focus_to_child(GntBox *box, GntWidget *widget);
G_END_DECLS
#endif /* GNT_BOX_H */
gnt_box_readjust
void gnt_box_readjust(GntBox *box)
Readjust the size of each child widget, reposition the child widgets and recalculate the size of the ...
gnt_box_move_focus
void gnt_box_move_focus(GntBox *box, int dir)
Move the focus from one widget to the other.
gnt_box_add_widget
void gnt_box_add_widget(GntBox *box, GntWidget *widget)
Add a widget in the box.
_GntWidget
Definition: gntwidget.h:98
gnt.h
gnt_box_give_focus_to_child
void gnt_box_give_focus_to_child(GntBox *box, GntWidget *widget)
Give focus to a specific child widget.
gnt_box_remove_all
void gnt_box_remove_all(GntBox *box)
Remove all widgets from the box.
gnt_box_set_toplevel
void gnt_box_set_toplevel(GntBox *box, gboolean set)
Set whether it's a toplevel box (ie, a window) or not.
_GntBox
Definition: gntbox.h:56
gnt_box_set_alignment
void gnt_box_set_alignment(GntBox *box, GntAlignment alignment)
Set the alignment for the widgets in the box.
gnt_box_new
GntWidget * gnt_box_new(gboolean homo, gboolean vert)
Create a new GntBox.
gnt_box_remove
void gnt_box_remove(GntBox *box, GntWidget *widget)
Remove a widget from the box.
gnt_box_set_title
void gnt_box_set_title(GntBox *box, const char *title)
Set a title for the box.
_GntWidgetClass
Definition: gntwidget.h:113
gntwidget.h
_GntBoxClass
Definition: gntbox.h:78
gnt_box_get_gtype
G_BEGIN_DECLS GType gnt_box_get_gtype(void)
The GType for GntBox.
gnt_box_set_fill
void gnt_box_set_fill(GntBox *box, gboolean fill)
Set whether the widgets in the box should fill the empty spaces.
gnt_box_sync_children
void gnt_box_sync_children(GntBox *box)
Reposition and refresh the widgets in the box.
gnt_box_set_pad
void gnt_box_set_pad(GntBox *box, int pad)
Set the padding to use between the widgets in the box.