GtkScrolledWindow           package:RGtk2           R Documentation

_G_t_k_S_c_r_o_l_l_e_d_W_i_n_d_o_w

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

     Adds scrollbars to its child widget

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

     'gtkScrolledWindowNew(hadjustment = NULL, vadjustment = NULL, show
     = TRUE)'
      'gtkScrolledWindowGetHadjustment(object)'
      'gtkScrolledWindowGetVadjustment(object)'
      'gtkScrolledWindowGetHscrollbar(object)'
      'gtkScrolledWindowGetVscrollbar(object)'
      'gtkScrolledWindowSetPolicy(object, hscrollbar.policy,
     vscrollbar.policy)'
      'gtkScrolledWindowAddWithViewport(object, child)'
      'gtkScrolledWindowSetPlacement(object, window.placement)'
      'gtkScrolledWindowUnsetPlacement(object)'
      'gtkScrolledWindowSetShadowType(object, type)'
      'gtkScrolledWindowSetHadjustment(object, hadjustment)'
      'gtkScrolledWindowSetVadjustment(object, hadjustment)'
      'gtkScrolledWindowGetPlacement(object)'
      'gtkScrolledWindowGetPolicy(object)'
      'gtkScrolledWindowGetShadowType(object)'
      'gtkScrolledWindow(hadjustment = NULL, vadjustment = NULL, show =
     TRUE)'

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

     GObject
        +----GInitiallyUnowned
              +----GtkObject
                    +----GtkWidget
                          +----GtkContainer
                                +----GtkBin
                                      +----GtkScrolledWindow 

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

     GtkScrolledWindow implements AtkImplementorIface and 
     'GtkBuildable'.

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

     'GtkScrolledWindow' is a 'GtkBin' subclass: it's a container  the
     accepts a single child widget. 'GtkScrolledWindow' adds scrollbars
     to the child widget and optionally draws a beveled frame around
     the  child widget.

     The scrolled window can work in two ways. Some widgets have native
     scrolling support; these widgets have "slots" for 'GtkAdjustment'
     objects.  *PLEASE NOTE:* The scrolled window installs
     'GtkAdjustment' objects in the child window's slots using the
     set_scroll_adjustments_signal, found in 'GtkWidgetClass'.
     (Conceptually, these widgets implement a "Scrollable" interface;
     because GTK+ 1.2 lacked interface support in the object system,
     this interface is hackily implemented as a signal in
     'GtkWidgetClass'. The GTK+ 2.0 object system would allow a clean
     implementation, but it wasn't worth breaking the API.) Widgets
     with native scroll support include 'GtkTreeView', 'GtkTextView', 
     and 'GtkLayout'.

     For widgets that lack native scrolling support, the 'GtkViewport'
     widget acts as an adaptor class, implementing scrollability for
     child widgets that lack their own scrolling capabilities. Use
     'GtkViewport' to scroll child widgets such as 'GtkTable',
     'GtkBox', and so on.

     If a widget has native scrolling abilities, it can be added to the
     'GtkScrolledWindow' with 'gtkContainerAdd'. If a widget does not,
     you must first add the widget to a 'GtkViewport', then add the
     'GtkViewport' to the scrolled window. The convenience function
     'gtkScrolledWindowAddWithViewport' does exactly this, so you can
     ignore the presence of the viewport.

     The position of the scrollbars is controlled by the scroll
     adjustments. See 'GtkAdjustment' for the fields in an adjustment -
     for 'GtkScrollbar', used by 'GtkScrolledWindow', the "value" field
     represents the position of the scrollbar, which must be between
     the "lower" field and "upper - page_size." The "page_size" field
     represents the size of the visible scrollable area. The
     "step_increment" and "page_increment" fields are used when the
     user asks to step down (using the small stepper arrows) or page
     down (using for example the PageDown key).

     If a 'GtkScrolledWindow' doesn't behave quite as you would like,
     or doesn't have exactly the right layout, it's very possible to
     set up your own scrolling with 'GtkScrollbar' and for example a
     'GtkTable'.

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


     '_G_t_k_S_c_r_o_l_l_e_d_W_i_n_d_o_w' There are no public fields in the
          'GtkScrolledWindow' struct; it should  only be accessed using
          the functions below.


_C_o_n_v_e_n_i_e_n_t _C_o_n_s_t_r_u_c_t_i_o_n:

     'gtkScrolledWindow' is the equivalent of 'gtkScrolledWindowNew'.

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


     '_m_o_v_e-_f_o_c_u_s-_o_u_t(_s_c_r_o_l_l_e_d_w_i_n_d_o_w, _a_r_g_1, _u_s_e_r._d_a_t_a)' _undocumented _

          '_s_c_r_o_l_l_e_d_w_i_n_d_o_w' ['GtkScrolledWindow'] the object which
               received the signal.

          '_a_r_g_1' ['GtkDirectionType'] 

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


     '_s_c_r_o_l_l-_c_h_i_l_d(_s_c_r_o_l_l_e_d_w_i_n_d_o_w, _a_r_g_1, _a_r_g_2, _u_s_e_r._d_a_t_a)' 
          _undocumented _

          '_s_c_r_o_l_l_e_d_w_i_n_d_o_w' ['GtkScrolledWindow'] the object which
               received the signal.

          '_a_r_g_1' ['GtkScrollType'] 

          '_a_r_g_2' [logical] 

          '_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:


     '_h_a_d_j_u_s_t_m_e_n_t' ['_G_t_k_A_d_j_u_s_t_m_e_n_t' : _R_e_a_d / _W_r_i_t_e / _C_o_n_s_t_r_u_c_t] The
          GtkAdjustment for the horizontal position.


     '_h_s_c_r_o_l_l_b_a_r-_p_o_l_i_c_y' ['_G_t_k_P_o_l_i_c_y_T_y_p_e' : _R_e_a_d / _W_r_i_t_e] When the
          horizontal scrollbar is displayed.  Default value:
          GTK_POLICY_ALWAYS


     '_s_h_a_d_o_w-_t_y_p_e' ['_G_t_k_S_h_a_d_o_w_T_y_p_e' : _R_e_a_d / _W_r_i_t_e] Style of bevel
          around the contents.  Default value: GTK_SHADOW_NONE


     '_v_a_d_j_u_s_t_m_e_n_t' ['_G_t_k_A_d_j_u_s_t_m_e_n_t' : _R_e_a_d / _W_r_i_t_e / _C_o_n_s_t_r_u_c_t] The
          GtkAdjustment for the vertical position.


     '_v_s_c_r_o_l_l_b_a_r-_p_o_l_i_c_y' ['_G_t_k_P_o_l_i_c_y_T_y_p_e' : _R_e_a_d / _W_r_i_t_e] When the
          vertical scrollbar is displayed.  Default value:
          GTK_POLICY_ALWAYS


     '_w_i_n_d_o_w-_p_l_a_c_e_m_e_n_t' ['_G_t_k_C_o_r_n_e_r_T_y_p_e' : _R_e_a_d / _W_r_i_t_e] Where the
          contents are located with respect to the scrollbars. This
          property only takes effect if "window-placement-set" is TRUE.
           Default value: GTK_CORNER_TOP_LEFT


     '_w_i_n_d_o_w-_p_l_a_c_e_m_e_n_t-_s_e_t' [_l_o_g_i_c_a_l : _R_e_a_d / _W_r_i_t_e] Whether
          "window-placement" should be used to determine the location 
          of the contents with respect to the scrollbars. Otherwise,
          the  "gtk-scrolled-window-placement" setting is used.  

          Default value: FALSE  Since  2.10


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


     '_s_c_r_o_l_l_b_a_r-_s_p_a_c_i_n_g' [_i_n_t_e_g_e_r : _R_e_a_d] Number of pixels between the
          scrollbars and the scrolled window.  Allowed values: >= 0 
          Default value: 3


     '_s_c_r_o_l_l_b_a_r_s-_w_i_t_h_i_n-_b_e_v_e_l' [_l_o_g_i_c_a_l : _R_e_a_d] Whether to place
          scrollbars within the scrolled window's bevel.  

          Default value: FALSE  Since  2.12


_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/GtkScrolledWindow.html>

_S_e_e _A_l_s_o:

     'GtkViewport' 'GtkAdjustment' 'GtkWidgetClass'

