Name
GtkPaned -- Base class for widgets with two adjustable panes
Synopsis
#include <gtk/gtk.h>
struct GtkPaned;
void gtk_paned_add1 (GtkPaned *paned,
GtkWidget *child);
void gtk_paned_add2 (GtkPaned *paned,
GtkWidget *child);
#define gtk_paned_handle_size
#define gtk_paned_gutter_size
void gtk_paned_compute_position (GtkPaned *paned,
gint allocation,
gint child1_req,
gint child2_req);
void gtk_paned_pack1 (GtkPaned *paned,
GtkWidget *child,
gboolean resize,
gboolean shrink);
void gtk_paned_pack2 (GtkPaned *paned,
GtkWidget *child,
gboolean resize,
gboolean shrink);
void gtk_paned_set_gutter_size (GtkPaned *paned,
guint16 size);
void gtk_paned_set_handle_size (GtkPaned *paned,
guint16 size);
void gtk_paned_set_position (GtkPaned *paned,
gint position);
|
Description
GtkPaned is the base class for widgets with two panes,
arranged either horizontally (GtkHPaned) or
vertically (GtkVPaned). Child widgets are
added to the panes of the widget with
gtk_paned_pack1() and gtk_paned_pack2(). The division
beween the two children is set by default from the
size requests of the children, but it can be adjusted
by the user.
A paned widget draws a separator between the two
child widgets and a small handle that the user
can drag to adjust the division. It does not
draw any relief around the children or around
the separator. (The space in which the separator
is called the gutter). Often, it is useful
to put each child inside a GtkFrame with the
shadow type set to GTK_SHADOW_IN so that the
gutter appears as a ridge.
Each child has two options that can be set,
resize and shrink. If resize is true, then when the
GtkPaned is resized, that child will expand
or shrink along with the paned widget. If shrink
is true, then when that child can be made smaller
than it's requisition by the user. Setting shrink
to FALSE allows the application to set a minimum
size. If resize is false for both children, then
this is treated as if resize is true for both
children.
The application can set the position of the slider
as if it were set by the user, by calling
gtk_paned_set_position().
Example 1. Creating a paned widget with minimum sizes
GtkWidget *hpaned = gtk_hpaned_new();
GtkWidget *frame1 = gtk_frame_new(NULL);
GtkWidget *frame2 = gtk_frame_new(NULL);
gtk_frame_set_shadow_type (GTK_FRAME (frame1), GTK_SHADOW_IN);
gtk_frame_set_shadow_type (GTK_FRAME (frame2), GTK_SHADOW_IN);
gtk_widget_set_usize (hpaned, 200 + GTK_PANED (hpaned)->gutter_size, -1);
gtk_paned_pack1 (GTK_PANED (hpaned), frame1, TRUE, FALSE);
gtk_widget_set_usize (frame1, 50, -1);
gtk_paned_pack2 (GTK_PANED (hpaned), frame1, FALSE, FALSE);
gtk_widget_set_usize (frame1, 50, -1); |
Details
struct GtkPaned
struct GtkPaned {
guint16 handle_size;
guint16 gutter_size;
}; |
gtk_paned_add1 ()
Add a child to the top or left pane with
default parameters. This is equivalent
to
gtk_paned_pack1(paned, FALSE, TRUE); |
gtk_paned_add2 ()
Add a child to the bottom or right pane with default
parameters. This is equivalent to
gtk_paned_pack1(paned, FALSE, FALSE); |
gtk_paned_pack1 ()
Add a child to the top or left pane.
gtk_paned_pack2 ()
Add a child to the bottom or right pane.
gtk_paned_set_gutter_size ()
Set the width of the gutter. (The area between the two panes).
gtk_paned_set_handle_size ()
Set the the handle size to size x size pixels.
gtk_paned_set_position ()
void gtk_paned_set_position (GtkPaned *paned,
gint position); |
Set the position of the separator, as if set by the user.
If position is negative, the remembered position is
forgotten, and the division is recomputed from the
the requisitions of the children.