GtkPaned                package:RGtk2                R Documentation

_G_t_k_P_a_n_e_d

_D_e_s_c_r_i_p_t_i_o_n:

     Base class for widgets with two adjustable panes

_M_e_t_h_o_d_s _a_n_d _F_u_n_c_t_i_o_n_s:

     'gtkPanedAdd1(object, child)'
      'gtkPanedAdd2(object, child)'
      'gtkPanedPack1(object, child, resize = FALSE, shrink = TRUE)'
      'gtkPanedPack2(object, child, resize = TRUE, shrink = TRUE)'
      'gtkPanedGetChild1(object)'
      'gtkPanedGetChild2(object)'
      'gtkPanedSetPosition(object, position)'
      'gtkPanedGetPosition(object)'

_H_i_e_r_a_r_c_h_y:

     GObject
        +----GInitiallyUnowned
              +----GtkObject
                    +----GtkWidget
                          +----GtkContainer
                                +----GtkPaned
                                      +----GtkHPaned
                                      +----GtkVPaned 

_I_n_t_e_r_f_a_c_e_s:

     GtkPaned implements AtkImplementorIface and  'GtkBuildable'.

_D_e_t_a_i_l_e_d _D_e_s_c_r_i_p_t_i_o_n:

     '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
     'gtkPanedPack1' and 'gtkPanedPack2'. 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. No separator is drawn if one of the children
     is missing.

     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 its 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 'gtkPanedSetPosition'.

     _Creating a paned widget with minimum sizes._


     hpaned <- gtkHPaned()
     frame1 <- gtkFrame()
     frame2 <- gtkFrame()
     frame1$setShadowType("in")
     frame2$setShadowType("in")

     hpaned$setSizeRequest(200 + hpaned$styleGet("handle-size"), -1)

     hpaned$pack1(frame1, TRUE, FALSE)
     frame1$setSizeRequest(50, -1)

     hpaned$pack2(frame2, FALSE, FALSE)
     frame2$setSizeRequest(50, -1)



_S_t_r_u_c_t_u_r_e_s:


     '_G_t_k_P_a_n_e_d' _undocumented _


_S_i_g_n_a_l_s:


     '_a_c_c_e_p_t-_p_o_s_i_t_i_o_n(_w_i_d_g_e_t, _u_s_e_r._d_a_t_a)' The ::accept-position signal
          is a  keybinding signal which gets emitted to accept the
          current position of the handle when  moving it using key
          bindings.

          The default binding for this signal is Return or Space.  

          Since  2.0

          '_w_i_d_g_e_t' ['GtkPaned']  the object that received the signal

          '_u_s_e_r._d_a_t_a' [R object] user data set when the signal handler
               was connected.


     '_c_a_n_c_e_l-_p_o_s_i_t_i_o_n(_w_i_d_g_e_t, _u_s_e_r._d_a_t_a)' The ::cancel-position signal
          is a  keybinding signal which gets emitted to cancel moving
          the position of the handle using key  bindings. The position
          of the handle will be reset to the value prior to  moving it.

          The default binding for this signal is Escape.  

          Since  2.0

          '_w_i_d_g_e_t' ['GtkPaned']  the object that received the signal

          '_u_s_e_r._d_a_t_a' [R object] user data set when the signal handler
               was connected.


     '_c_y_c_l_e-_c_h_i_l_d-_f_o_c_u_s(_w_i_d_g_e_t, _r_e_v_e_r_s_e_d, _u_s_e_r._d_a_t_a)' The
          ::cycle-child-focus signal is a  keybinding signal which gets
          emitted to cycle the focus between the children of the paned.

          The default binding is f6.  

          Since  2.0

          '_w_i_d_g_e_t' ['GtkPaned']  the object that received the signal

          '_r_e_v_e_r_s_e_d' [logical]  whether cycling backward or forward

          '_u_s_e_r._d_a_t_a' [R object] user data set when the signal handler
               was connected.


     '_c_y_c_l_e-_h_a_n_d_l_e-_f_o_c_u_s(_w_i_d_g_e_t, _r_e_v_e_r_s_e_d, _u_s_e_r._d_a_t_a)' The
          ::cycle-handle-focus signal is a  keybinding signal which
          gets emitted to cycle whether the paned should grab focus to
          allow the user to change position of the handle by using key
          bindings.

          The default binding for this signal is f8.  

          Since  2.0

          '_w_i_d_g_e_t' ['GtkPaned']  the object that received the signal

          '_r_e_v_e_r_s_e_d' [logical]  whether cycling backward or forward

          '_u_s_e_r._d_a_t_a' [R object] user data set when the signal handler
               was connected.


     '_m_o_v_e-_h_a_n_d_l_e(_w_i_d_g_e_t, _s_c_r_o_l_l._t_y_p_e, _u_s_e_r._d_a_t_a)' The ::move-handle
          signal is a  keybinding signal which gets emitted to move the
          handle when the user is using key bindings  to move it.  

          Since  2.0

          '_w_i_d_g_e_t' ['GtkPaned']  the object that received the signal

          '_s_c_r_o_l_l._t_y_p_e' ['GtkScrollType']  a 'GtkScrollType'

          '_u_s_e_r._d_a_t_a' [R object] user data set when the signal handler
               was connected.


     '_t_o_g_g_l_e-_h_a_n_d_l_e-_f_o_c_u_s(_w_i_d_g_e_t, _u_s_e_r._d_a_t_a)' The ::toggle-handle-focus
          is a  keybinding signal which gets emitted to accept the
          current position of the handle and then  move focus to the
          next widget in the focus chain.

          The default binding is Tab.  

          Since  2.0

          '_w_i_d_g_e_t' ['GtkPaned']  the object that received the signal

          '_u_s_e_r._d_a_t_a' [R object] user data set when the signal handler
               was connected.


_P_r_o_p_e_r_t_i_e_s:


     '_m_a_x-_p_o_s_i_t_i_o_n' [_i_n_t_e_g_e_r : _R_e_a_d] The largest possible value for the
          position property. This property is derived from the size and
          shrinkability of the widget's children.  

          Allowed values: >= 0  Default value: 2147483647  Since  2.4


     '_m_i_n-_p_o_s_i_t_i_o_n' [_i_n_t_e_g_e_r : _R_e_a_d] The smallest possible value for
          the position property. This property is derived from the size
          and shrinkability of the widget's children.  

          Allowed values: >= 0  Default value: 0  Since  2.4


     '_p_o_s_i_t_i_o_n' [_i_n_t_e_g_e_r : _R_e_a_d / _W_r_i_t_e] Position of paned separator in
          pixels (0 means all the way to the left/top).  Allowed
          values: >= 0  Default value: 0


     '_p_o_s_i_t_i_o_n-_s_e_t' [_l_o_g_i_c_a_l : _R_e_a_d / _W_r_i_t_e] TRUE if the Position
          property should be used.  Default value: FALSE


_S_t_y_l_e _P_r_o_p_e_r_t_i_e_s:


     '_h_a_n_d_l_e-_s_i_z_e' [_i_n_t_e_g_e_r : _R_e_a_d] Width of handle.  Allowed values:
          >= 0  Default value: 5


_A_u_t_h_o_r(_s):

     Derived by RGtkGen from GTK+ documentation

_R_e_f_e_r_e_n_c_e_s:

     <URL: http://developer.gnome.org/doc/API/2.0/gtk/GtkPaned.html>

