GtkHandleBox              package:RGtk2              R Documentation

_G_t_k_H_a_n_d_l_e_B_o_x

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

     a widget for detachable window portions

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

     'gtkHandleBoxNew(show = TRUE)'
      'gtkHandleBoxSetShadowType(object, type)'
      'gtkHandleBoxSetHandlePosition(object, position)'
      'gtkHandleBoxSetSnapEdge(object, edge)'
      'gtkHandleBoxGetHandlePosition(object)'
      'gtkHandleBoxGetShadowType(object)'
      'gtkHandleBoxGetSnapEdge(object)'
      'gtkHandleBox(show = TRUE)'

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

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

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

     GtkHandleBox implements AtkImplementorIface and  'GtkBuildable'.

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

     The 'GtkHandleBox' widget allows a portion of a window to be "torn
     off". It is a bin widget which displays its child and a handle
     that the user can drag to tear off a separate window (the float
     window) containing the child widget. A thin ghost is drawn in the
     original location of the handlebox. By dragging the separate
     window back to its original location, it can be reattached.

     When reattaching, the ghost and float window, must be aligned
     along one of the edges, the snap edge. This either can be
     specified by the application programmer explicitely, or GTK+ will
     pick a reasonable default based on the handle position.

     To make detaching and reattaching the handlebox as minimally
     confusing as possible to the user, it is important to set the snap
     edge so that the snap edge does not move when the handlebox is
     deattached. For instance, if the handlebox is packed at the bottom
     of a VBox, then when the handlebox is detached, the bottom edge of
     the handlebox's allocation will remain fixed as the height of the
     handlebox shrinks, so the snap edge should be set to
     'GTK_POS_BOTTOM'.

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


     '_G_t_k_H_a_n_d_l_e_B_o_x' The 'GtkHandleBox' struct contains the following
          fields. (These fields should be considered read-only. They
          should never be set by an application.)

            GtkShadowType shadow_type;        The shadow type for the entry. (See   'gtkHandleBoxSetShadowType'  ).
            GtkPositionType handle_position;  The position of the handlebox's handle with respect to the child. (See   'gtkHandleBoxSetHandlePosition'  )
            gint snap_edge;                   A value of type   'GtkPosition'   type indicating snap edge for the widget. (See gtk_handle_box_set_snap_edge). The value of -1 indicates that this value has not been set.
            'logical'   child_detached;       A boolean value indicating whether the handlebox's child is attached or detached.


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

     'gtkHandleBox' is the equivalent of 'gtkHandleBoxNew'.

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


     '_c_h_i_l_d-_a_t_t_a_c_h_e_d(_h_a_n_d_l_e_b_o_x, _w_i_d_g_e_t, _u_s_e_r._d_a_t_a)' This signal is
          emitted when the contents of the handlebox are reattached to
          the main window.

          '_h_a_n_d_l_e_b_o_x' ['GtkHandleBox'] the object which received the
               signal.

          '_w_i_d_g_e_t' ['GtkWidget'] the child widget of the handlebox.
               (this argument provides no extra information and is here
               only for backwards-compatibility)

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


     '_c_h_i_l_d-_d_e_t_a_c_h_e_d(_h_a_n_d_l_e_b_o_x, _w_i_d_g_e_t, _u_s_e_r._d_a_t_a)' This signal is
          emitted when the contents of the handlebox are detached from
          the main window.

          '_h_a_n_d_l_e_b_o_x' ['GtkHandleBox'] the object which received the
               signal.

          '_w_i_d_g_e_t' ['GtkWidget'] the child widget of the handlebox. 
               (this argument provides no extra information and is here
               only for backwards-compatibility)

          '_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_n_d_l_e-_p_o_s_i_t_i_o_n' ['_G_t_k_P_o_s_i_t_i_o_n_T_y_p_e' : _R_e_a_d / _W_r_i_t_e] Position of
          the handle relative to the child widget.  Default value:
          GTK_POS_LEFT


     '_s_h_a_d_o_w' ['_G_t_k_S_h_a_d_o_w_T_y_p_e' : _R_e_a_d / _W_r_i_t_e] Deprecated property, use
          shadow_type instead.  Default value: GTK_SHADOW_ETCHED_OUT


     '_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] Appearance of the
          shadow that surrounds the container.  Default value:
          GTK_SHADOW_ETCHED_OUT


     '_s_n_a_p-_e_d_g_e' ['_G_t_k_P_o_s_i_t_i_o_n_T_y_p_e' : _R_e_a_d / _W_r_i_t_e] Side of the
          handlebox that's lined up with the docking point to dock the
          handlebox.  Default value: GTK_POS_TOP


     '_s_n_a_p-_e_d_g_e-_s_e_t' [_l_o_g_i_c_a_l : _R_e_a_d / _W_r_i_t_e] Whether to use the value
          from the snap_edge property or a value derived from
          handle_position.  Default value: FALSE


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

