GtkBox                 package:RGtk2                 R Documentation

_G_t_k_B_o_x

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

     Base class for box containers

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

     'gtkBoxPackStart(object, child, expand = TRUE, fill = TRUE,
     padding = 0)'
      'gtkBoxPackEnd(object, child, expand = TRUE, fill = TRUE, padding
     = 0)'
      'gtkBoxPackStartDefaults(object, widget)'
      'gtkBoxPackEndDefaults(object, widget)'
      'gtkBoxGetHomogeneous(object)'
      'gtkBoxSetHomogeneous(object, homogeneous)'
      'gtkBoxGetSpacing(object)'
      'gtkBoxSetSpacing(object, spacing)'
      'gtkBoxReorderChild(object, child, position)'
      'gtkBoxQueryChildPacking(object, child)'
      'gtkBoxSetChildPacking(object, child, expand, fill, padding,
     pack.type)'

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

     GObject
        +----GtkObject
              +----GtkWidget
                    +----GtkContainer
                          +----GtkBox
                                +----GtkButtonBox
                                +----GtkVBox
                                +----GtkHBox 

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

     GtkBox implements AtkImplementorIface.

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

     GtkBox is an abstract widget which encapsulates functionallity for
     a particular kind of container, one that organizes a variable
     number of widgets into a rectangular area.  GtkBox currently has
     two derived classes, 'GtkHBox' and 'GtkVBox'.

     The rectangular area of a GtkBox is organized into either a single
     row or a single column of child widgets depending upon whether the
     box is of type 'GtkHBox' or 'GtkVBox', respectively.  Thus, all
     children of a GtkBox are allocated one dimension in common, which
     is the height of a row, or the width of a column.

     GtkBox uses a notion of _packing_.  Packing refers to adding
     widgets with reference to a particular position in a
     'GtkContainer'.  For a GtkBox, there are two reference positions:
     the _start_ and the _end_ of the box.  For a 'GtkVBox', the start
     is defined as the top of the box and the end is defined as the
     bottom.  For a 'GtkHBox' the start is defined as the left side and
     the end is defined as the right side.

     Use repeated calls to 'gtkBoxPackStart' to pack widgets into a
     GtkBox from start to end.  Use 'gtkBoxPackEnd' to add widgets from
     end to start.  You may intersperse these calls and add widgets
     from both ends of the same GtkBox.

     Use 'gtkBoxPackStartDefaults' or 'gtkBoxPackEndDefaults' to pack
     widgets into a GtkBox if you do not need to specify the 'expand',
     'fill', or 'padding' attributes of the child to be added.

     Because GtkBox is a 'GtkContainer', you may also use
     'gtkContainerAdd' to insert widgets into the box, and they will be
     packed as if with 'gtkBoxPackStartDefaults'.  Use
     'gtkContainerRemove' to remove widgets from the GtkBox.

     Use 'gtkBoxSetHomogeneous' to specify whether or not all children
     of the GtkBox are forced to get the same amount of space.

     Use 'gtkBoxSetSpacing' to determine how much space will be
     minimally placed between all children in the GtkBox.

     Use 'gtkBoxReorderChild' to move a GtkBox child to a different
     place in the box.

     Use 'gtkBoxSetChildPacking' to reset the 'expand', 'fill', and
     'padding' attributes of any GtkBox child. Use
     'gtkBoxQueryChildPacking' to query these fields.

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

     '_G_t_k_B_o_x' The 'GtkBox' describes an instance of GtkBox and contains
          the following fields. (These fields should be considered
          read-only. They should never be set by an application.)

            'list'   *   'children'  ;      a list of children belonging the GtkBox.  The data is a list of structures of type   'GtkBoxChild'  .
            'integer'     'spacing'  ;      the number of pixels to put between children of the GtkBox, zero by default.  Use   'gtkBoxSetSpacing'   to set this field.
            'numeric'     'homogeneous'  ;  a flag that if   'TRUE'   forces all children to get equal space in the GtkBox;   'FALSE'   by default.  Use   'gtkBoxSetHomogeneous'   to set this field.


     '_G_t_k_B_o_x_C_h_i_l_d' The 'GtkBoxChild' holds a child widget of GtkBox and
          describes how the child is to be packed into the GtkBox.  Use
          'gtkBoxQueryChildPacking' and 'gtkBoxSetChildPacking' to
          query and reset the 'padding', 'expand', 'fill', and 'pack'
          fields.

          'GtkBoxChild' contains the following fields.  (These fields
          should be considered read-only. They should never be directly
          set by an application.)

            'GtkWidget'   *   'widget'  ;  the child widget, packed into the GtkBox.
            'integer'     'padding'  ;     the number of extra pixels to put between this child and its neighbors, set when packed, zero by default.
            'numeric'     'expand'  ;      flag indicates whether extra space should be given to this child.  Any extra space given to the parent GtkBox is divided up among all children with this attribute set to   'TRUE'  ; set when packed,   'TRUE'   by default.
            'numeric'     'fill'  ;        flag indicates whether any extra space given to this child due to its 'expand'   attribute being set is actually allocated to the child, rather than being used as padding around the widget; set when packed,   'TRUE'   by default.
            'numeric'     'pack'  ;        one of 'GtkPackType'   indicating whether the child is packed with reference to the start (top/left) or end (bottom/right) of the GtkBox.


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

     '_h_o_m_o_g_e_n_e_o_u_s' [_l_o_g_i_c_a_l : _R_e_a_d / _W_r_i_t_e] Whether the children should
          all be the same size.  Default value: FALSE


     '_s_p_a_c_i_n_g' [_i_n_t_e_g_e_r : _R_e_a_d / _W_r_i_t_e] The amount of space between
          children.  Allowed values: >= 0  Default value: 0


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

