GTK+ Reference Manual
<<< Previous Page | Home | Up | Next Page >>>

# GtkPaned

## 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_gutter_size           (p,s)
    void        gtk_paned_pack1                 (GtkPaned *paned,
                                                 GtkWidget *child,
                                                 gboolean resize,
                                                 gboolean shrink);
    void        gtk_paned_pack2                 (GtkPaned *paned,
                                                 GtkWidget *child,
                                                 gboolean resize,
                                                 gboolean shrink);
    #define     gtk_paned_set_gutter_size       (p,s)
    void        gtk_paned_set_position          (GtkPaned *paned,
                                                 gint position);
    gint        gtk_paned_get_position          (GtkPaned *paned);

## Object Hierarchy

      GObject
       +----GtkObject
             +----GtkWidget
                   +----GtkContainer
                         +----GtkPaned

## Properties

      "position"             gint                 : Read / Write
      "position-set"         gboolean             : Read / Write

## Style Properties

      "handle-size"          gint                 : Read

## Signal Prototypes

    "accept-position"
                gboolean    user_function      (GtkPaned *paned,
                                                gpointer user_data);
    "cancel-position"
                gboolean    user_function      (GtkPaned *paned,
                                                gpointer user_data);
    "cycle-child-focus"
                gboolean    user_function      (GtkPaned *paned,
                                                gboolean arg1,
                                                gpointer user_data);
    "cycle-handle-focus"
                gboolean    user_function      (GtkPaned *paned,
                                                gboolean arg1,
                                                gpointer user_data);
    "move-handle"
                gboolean    user_function      (GtkPaned *paned,
                                                GtkScrollType arg1,
                                                gpointer user_data);
    "toggle-handle-focus"
                gboolean    user_function      (GtkPaned *paned,
                                                gpointer user_data);

## 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_size_request (hpaned, 200 + GTK_PANED (hpaned)->gutter_size, -1);

    gtk_paned_pack1 (GTK_PANED (hpaned), frame1, TRUE, FALSE);
    gtk_widget_set_size_request (frame1, 50, -1);

    gtk_paned_pack2 (GTK_PANED (hpaned), frame1, FALSE, FALSE);
    gtk_widget_set_size_request (frame1, 50, -1);

## Details

### struct GtkPaned

    struct GtkPaned;

### gtk_paned_add1 ()

    void        gtk_paned_add1                  (GtkPaned *paned,
                                                 GtkWidget *child);

Adds a child to the top or left pane with default parameters. This is equivalent to `gtk_paned_pack1 (paned, child, FALSE, TRUE)`.

`paned` : | a paned widget
`child` : | the child to add

### gtk_paned_add2 ()

    void        gtk_paned_add2                  (GtkPaned *paned,
                                                 GtkWidget *child);

Adds a child to the bottom or right pane with default parameters. This is equivalent to `gtk_paned_pack2 (paned, child, TRUE, TRUE)`.

`paned` : | a paned widget
`child` : | the child to add

### gtk_paned_gutter_size()

    #define	gtk_paned_gutter_size(p,s)		(void) 0

Warning
`gtk_paned_gutter_size` is deprecated and should not be used in newly-written code.

Old name for gtk_paned_set_gutter_size().

`p` : |
`s` : |

### gtk_paned_pack1 ()

    void        gtk_paned_pack1                 (GtkPaned *paned,
                                                 GtkWidget *child,
                                                 gboolean resize,
                                                 gboolean shrink);

Adds a child to the top or left pane.

`paned` : | a paned widget
`child` : | the child to add
`resize` : | should this child expand when the paned widget is resized.
`shrink` : | can this child be made smaller than its requsition.

### gtk_paned_pack2 ()

    void        gtk_paned_pack2                 (GtkPaned *paned,
                                                 GtkWidget *child,
                                                 gboolean resize,
                                                 gboolean shrink);

Adds a child to the bottom or right pane.

`paned` : | a paned widget
`child` : | the child to add
`resize` : | should this child expand when the paned widget is resized.
`shrink` : | can this child be made smaller than its requsition.

### gtk_paned_set_gutter_size()

    #define	gtk_paned_set_gutter_size(p,s)		(void) 0

Warning
`gtk_paned_set_gutter_size` is deprecated and should not be used in newly-written code.

In older versions of GTK+, this function used to set the width of the gutter (the area between the two panes). It does nothing now.

`p` : | a paned widget
`s` : | the width of the gutter in pixels

### gtk_paned_set_position ()

    void        gtk_paned_set_position          (GtkPaned *paned,
                                                 gint position);

Sets the position of the divider between the two panes.

`paned` : | a GtkPaned widget
`position` : | pixel position of divider, a negative value means that the position is unset.

### gtk_paned_get_position ()

    gint        gtk_paned_get_position          (GtkPaned *paned);

Obtains the position of the divider between the two panes.

`paned` : | a GtkPaned widget
Returns : | position of the divider

## Properties

"`position`" (gint : Read / Write)

  Position of paned separator in pixels (0 means all the way to the left/top)

"`position-set`" (gboolean : Read / Write)

  TRUE if the Position property should be used

## Style Properties

"`handle-size`" (gint : Read)

  Width of handle

## Signals

### The "accept-position" signal

    gboolean    user_function                  (GtkPaned *paned,
                                                gpointer user_data);

`paned` : | the object which received the signal.
`user_data` : | user data set when the signal handler was connected.
Returns : |

### The "cancel-position" signal

    gboolean    user_function                  (GtkPaned *paned,
                                                gpointer user_data);

`paned` : | the object which received the signal.
`user_data` : | user data set when the signal handler was connected.
Returns : |

### The "cycle-child-focus" signal

    gboolean    user_function                  (GtkPaned *paned,
                                                gboolean arg1,
                                                gpointer user_data);

`paned` : | the object which received the signal.
`arg1` : |
`user_data` : | user data set when the signal handler was connected.
Returns : |

### The "cycle-handle-focus" signal

    gboolean    user_function                  (GtkPaned *paned,
                                                gboolean arg1,
                                                gpointer user_data);

`paned` : | the object which received the signal.
`arg1` : |
`user_data` : | user data set when the signal handler was connected.
Returns : |

### The "move-handle" signal

    gboolean    user_function                  (GtkPaned *paned,
                                                GtkScrollType arg1,
                                                gpointer user_data);

`paned` : | the object which received the signal.
`arg1` : |
`user_data` : | user data set when the signal handler was connected.
Returns : |

### The "toggle-handle-focus" signal

    gboolean    user_function                  (GtkPaned *paned,
                                                gpointer user_data);

`paned` : | the object which received the signal.
`user_data` : | user data set when the signal handler was connected.
Returns : |

<<< Previous Page | Home | Up | Next Page >>>
GtkObject | GtkRange