GtkCTree                package:RGtk2                R Documentation

_G_t_k_C_T_r_e_e

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

     A widget displaying a hierarchical tree

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

     'gtkCTreeNewWithTitles(columns = 1, tree.column = 0, titles, show
     = TRUE)'
      'gtkCTreeNew(columns = 1, tree.column = 0, show = TRUE)'
      'gtkCTreeInsertNode(object, parent, sibling, text, spacing = 5,
     pixmap.closed = NULL, mask.closed = NULL, pixmap.opened = NULL,
     mask.opened = NULL, is.leaf = 1, expanded = 0)'
      'gtkCTreeRemoveNode(object, node)'
      'gtkCTreeInsertGnode(object, parent, sibling, gnode, func, data =
     NULL)'
      'gtkCTreeExportToGnode(object, parent, sibling, node, func, data
     = NULL)'
      'gtkCTreePostRecursive(object, node, func, data = NULL)'
      'gtkCTreePostRecursiveToDepth(object, node, depth, func, data =
     NULL)'
      'gtkCTreePreRecursive(object, node, func, data = NULL)'
      'gtkCTreePreRecursiveToDepth(object, node, depth, func, data =
     NULL)'
      'gtkCTreeIsViewable(object, node)'
      'gtkCTreeLast(object, node)'
      'gtkCTreeFindNodePtr(object, ctree.row)'
      'gtkCTreeFind(object, node, child)'
      'gtkCTreeIsAncestor(object, node, child)'
      'gtkCTreeFindByRowData(object, node, data = NULL)'
      'gtkCTreeFindAllByRowData(object, node, data = NULL)'
      'gtkCTreeFindByRowDataCustom(object, node, data = NULL, func)'
      'gtkCTreeFindAllByRowDataCustom(object, node, data = NULL, func)'
      'gtkCTreeIsHotSpot(object, x, y)'
      'gtkCTreeMove(object, node, new.parent = NULL, new.sibling =
     NULL)'
      'gtkCTreeExpand(object, node)'
      'gtkCTreeExpandRecursive(object, node)'
      'gtkCTreeExpandToDepth(object, node, depth)'
      'gtkCTreeCollapse(object, node)'
      'gtkCTreeCollapseRecursive(object, node)'
      'gtkCTreeCollapseToDepth(object, node, depth)'
      'gtkCTreeToggleExpansion(object, node)'
      'gtkCTreeToggleExpansionRecursive(object, node)'
      'gtkCTreeSelect(object, node)'
      'gtkCTreeSelectRecursive(object, node)'
      'gtkCTreeUnselect(object, node)'
      'gtkCTreeUnselectRecursive(object, node)'
      'gtkCTreeRealSelectRecursive(object, node, state)'
      'gtkCTreeNodeSetText(object, node, column, text)'
      'gtkCTreeNodeSetPixmap(object, node, column, pixmap, mask =
     NULL)'
      'gtkCTreeNodeSetPixtext(object, node, column, text, spacing,
     pixmap, mask = NULL)'
      'gtkCTreeSetNodeInfo(object, node, text, spacing, pixmap.closed =
     NULL, mask.closed = NULL, pixmap.opened = NULL, mask.opened =
     NULL, is.leaf, expanded)'
      'gtkCTreeNodeSetShift(object, node, column, vertical,
     horizontal)'
      'gtkCTreeNodeSetSelectable(object, node, selectable)'
      'gtkCTreeNodeGetSelectable(object, node)'
      'gtkCTreeNodeGetCellType(object, node, column)'
      'gtkCTreeNodeGetText(object, node, column)'
      'gtkCTreeNodeGetPixmap(object, node, column)'
      'gtkCTreeNodeGetPixtext(object, node, column)'
      'gtkCTreeGetNodeInfo(object, node)'
      'gtkCTreeNodeSetRowStyle(object, node, style)'
      'gtkCTreeNodeGetRowStyle(object, node)'
      'gtkCTreeNodeSetCellStyle(object, node, column, style)'
      'gtkCTreeNodeGetCellStyle(object, node, column)'
      'gtkCTreeNodeSetForeground(object, node, color)'
      'gtkCTreeNodeSetBackground(object, node, color)'
      'gtkCTreeNodeSetRowData(object, node, data)'
      'gtkCTreeNodeSetRowDataFull(object, node, data)'
      'gtkCTreeNodeGetRowData(object, node)'
      'gtkCTreeNodeMoveto(object, node, column, row.align, col.align)'
      'gtkCTreeNodeIsVisible(object, node)'
      'gtkCTreeSetIndent(object, indent)'
      'gtkCTreeSetSpacing(object, spacing)'
      'gtkCTreeSetLineStyle(object, line.style)'
      'gtkCTreeSetExpanderStyle(object, expander.style)'
      'gtkCTreeSetDragCompareFunc(object, cmp.func)'
      'gtkCTreeSortNode(object, node)'
      'gtkCTreeSortRecursive(object, node)'
      'gtkCTreeNodeNth(object, row)'
      'gtkCTreeSetShowStub(object, show.stub)'
      'gtkCTree(columns = 1, tree.column = 0, titles, show = TRUE)'

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

     GObject
        +----GInitiallyUnowned
              +----GtkObject
                    +----GtkWidget
                          +----GtkContainer
                                +----GtkCList
                                      +----GtkCTree 

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

     GtkCTree implements AtkImplementorIface and  'GtkBuildable'.

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

     The 'GtkCTree' widget is used for showing a hierarchical tree  to
     the user, for example a directory tree.

     The tree is internally represented as a set of 'GtkCTreeNode'
     structures.

     The interface has much in common with the 'GtkCList' widget: rows
     (nodes) can be selected by the user etc.

     Positions in the tree are often indicated by two arguments, a
     parent and a sibling, both 'GtkCTreeNode' pointers. If the parent
     is 'NULL', the position is at the root of the tree and if the
     sibling is 'NULL', it will be the last child of parent, otherwise
     it will be inserted just before the sibling.

     GtkCTree has been deprecated since GTK+ 2.0 and should not be used
     in newly written code. Use 'GtkTreeView' instead.

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


     '_G_t_k_C_T_r_e_e' *WARNING: 'GtkCTree' is deprecated and should not be
          used in newly-written code.* The 'GtkCTree' contains the
          following user-accessible fields. These fields should be
          considered read-only; to set the values, use the methods
          below.

            'integer'  'tree_indent'  ;                   The number of pixels each successive level of the tree is indented in the display.
            'integer'  'tree_spacing'  ;                  The space in pixels between the graphical tree and the text in the node.
            'integer'  'tree_column'  ;                   The index of the column for which the tree graphics is drawn.
            'GtkCTreeLineStyle'  'line_style'  ;          The style in which the lines in the tree graphics are drawn.
            'GtkCTreeExpanderStyle'  'expander_style'  ;  The style in which the expander buttons are drawn.
            'GtkCTreeExpanderStyle'  'expander_style'  ;  FIXME.


     '_G_t_k_C_T_r_e_e_R_o_w' *WARNING: 'GtkCTreeRow' is deprecated and should not
          be used in newly-written code.* A structure representing a
          single row in the tree graph. The values inside the structure
          should be considered read-only. This structure is derived
          from the 'GtkCListRow' structure.

            'GtkCTreeNode'   *  'parent'  ;      The parent node of the node corresponding to this row.
            'GtkCTreeNode'   *  'sibling'  ;     The next sibling node of the node corresponding to this row.
            'GtkCTreeNode'   *  'children'  ;    The first child node corresponding to this row; to access the other children, just use the siblings of that node.
            'GdkPixmap'   *  'pixmap_closed'  ;  The pixmap to be shown when the node is collapsed.
            'GdkBitmap'   *  'mask_closed'  ;    The mask for the above pixmap.
            'GdkPixmap'   *  'pixmap_opened'  ;  The pixmap to be shown when the node is expanded.
            'GdkBitmap'   *  'mask_opened'  ;    The mask for the above pixmap.
            'integer'  'level'  ;                The level of this node in the tree.
            'numeric'  'is_leaf'   : 1;          Whether this row is a leaf.
            'numeric'  'expanded'   : 1;         Whether the children of this row are visible.


     '_G_t_k_C_T_r_e_e_N_o_d_e' *WARNING: 'GtkCTreeNode' is deprecated and should
          not be used in newly-written code.* This structure is opaque
          - you should use the functions 'GTK_CTREE_ROW',
          'GTK_CTREE_NODE_NEXT' etc. as well as the functions below to
          access it.


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

     'gtkCTree' is the result of collapsing the constructors of
     'GtkCTree' ('gtkCTreeNewWithTitles', 'gtkCTreeNew') and accepts a
     subset of its arguments matching the required arguments of one of
     its delegate constructors.

_E_n_u_m_s _a_n_d _F_l_a_g_s:


     '_G_t_k_C_T_r_e_e_P_o_s' *WARNING: 'GtkCTreePos' is deprecated and should not
          be used in newly-written code.* A value specifying the
          position of a new node relative to an old one.

            GTK_CTREE_POS_BEFORE    As a sibling, before the specified node.
            GTK_CTREE_POS_AS_CHILD  As a child of the specified node.
            GTK_CTREE_POS_AFTER     As a sibling, after the specified node.


     '_G_t_k_C_T_r_e_e_L_i_n_e_S_t_y_l_e' *WARNING: 'GtkCTreeLineStyle' is deprecated
          and should not be used in newly-written code.* The appearance
          of the lines in the tree graphics.

            GTK_CTREE_LINES_NONE    No lines.
            GTK_CTREE_LINES_SOLID   Solid lines.
            GTK_CTREE_LINES_DOTTED  Dotted lines.
            GTK_CTREE_LINES_TABBED  FIXME.


     '_G_t_k_C_T_r_e_e_E_x_p_a_n_d_e_r_S_t_y_l_e' *WARNING: 'GtkCTreeExpanderStyle' is
          deprecated and should not be used in newly-written code.* The
          appearance of the expander buttons, i.e. the small buttons
          which expand or contract parts of the tree when pressed.

            GTK_CTREE_EXPANDER_NONE      No expanders.
            GTK_CTREE_EXPANDER_SQUARE    Square expanders.
            GTK_CTREE_EXPANDER_TRIANGLE  Triangular expanders.
            GTK_CTREE_EXPANDER_CIRCULAR  Round expanders.


     '_G_t_k_C_T_r_e_e_E_x_p_a_n_s_i_o_n_T_y_p_e' *WARNING: 'GtkCTreeExpansionType' is
          deprecated and should not be used in newly-written code.* How
          to expand or collapse a part of a tree.

            GTK_CTREE_EXPANSION_EXPAND              Expand this node.
            GTK_CTREE_EXPANSION_EXPAND_RECURSIVE    Expand this node and everything below it in the hierarchy.
            GTK_CTREE_EXPANSION_COLLAPSE            Collapse this node.
            GTK_CTREE_EXPANSION_COLLAPSE_RECURSIVE  Collapse this node and everything below it in the hierarchy.
            GTK_CTREE_EXPANSION_TOGGLE              Toggle this node (i.e. expand if collapsed and vice versa).
            GTK_CTREE_EXPANSION_TOGGLE_RECURSIVE    Toggle this node and everything below it in the hierarchy.


_U_s_e_r _F_u_n_c_t_i_o_n_s:


     '_G_t_k_C_T_r_e_e_F_u_n_c(_c_t_r_e_e, _n_o_d_e, _d_a_t_a)' A generic callback type to do
          something with a particular node.

          '_c_t_r_e_e' ['GtkCTree'] The 'GtkCTree' object.

          '_n_o_d_e' ['GtkCTreeNode'] The 'GtkCTreeNode' in the tree.

          '_d_a_t_a' [R object] The user data associated with the node.


     '_G_t_k_C_T_r_e_e_G_N_o_d_e_F_u_n_c(_c_t_r_e_e, _d_e_p_t_h, _g_n_o_d_e, _c_n_o_d_e, _d_a_t_a)' FIXME

          '_c_t_r_e_e' ['GtkCTree'] 

          '_d_e_p_t_h' [numeric] 

          '_g_n_o_d_e' [GNode] 

          '_c_n_o_d_e' ['GtkCTreeNode'] 

          '_d_a_t_a' [R object] 


     '_G_t_k_C_T_r_e_e_C_o_m_p_a_r_e_D_r_a_g_F_u_n_c(_c_t_r_e_e, _s_o_u_r_c_e._n_o_d_e, _n_e_w._p_a_r_e_n_t, _n_e_w._s_i_b_l_i_n_g)' 
          FIXME

          '_c_t_r_e_e' ['GtkCTree'] 

          '_s_o_u_r_c_e._n_o_d_e' ['GtkCTreeNode'] 

          '_n_e_w._p_a_r_e_n_t' ['GtkCTreeNode'] 

          '_n_e_w._s_i_b_l_i_n_g' ['GtkCTreeNode'] 


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


     '_c_h_a_n_g_e-_f_o_c_u_s-_r_o_w-_e_x_p_a_n_s_i_o_n(_c_t_r_e_e, _e_x_p_a_n_s_i_o_n, _u_s_e_r._d_a_t_a)' The row
          which has the focus is either collapsed or expanded or
          toggled.

          '_c_t_r_e_e' ['GtkCTree'] the object which received the signal.

          '_e_x_p_a_n_s_i_o_n' ['GtkCTreeExpansionType'] What is being done.

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


     '_t_r_e_e-_c_o_l_l_a_p_s_e(_c_t_r_e_e, _n_o_d_e, _u_s_e_r._d_a_t_a)' Emitted when a node is
          collapsed.

          '_c_t_r_e_e' ['GtkCTree'] the object which received the signal.

          '_n_o_d_e' ['GtkCTreeNode'] 

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


     '_t_r_e_e-_e_x_p_a_n_d(_c_t_r_e_e, _n_o_d_e, _u_s_e_r._d_a_t_a)' Emitted when a node is
          expanded.

          '_c_t_r_e_e' ['GtkCTree'] the object which received the signal.

          '_n_o_d_e' ['GtkCTreeNode'] 

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


     '_t_r_e_e-_m_o_v_e(_c_t_r_e_e, _n_o_d_e, _n_e_w._p_a_r_e_n_t, _n_e_w._s_i_b_l_i_n_g, _u_s_e_r._d_a_t_a)' 
          Emitted when a node is moved.

          '_c_t_r_e_e' ['GtkCTree'] the object which received the signal.

          '_n_o_d_e' ['GtkCTreeNode'] The node that is moved.

          '_n_e_w._p_a_r_e_n_t' ['GtkCTreeNode'] The new parent of the node.

          '_n_e_w._s_i_b_l_i_n_g' ['GtkCTreeNode'] The new sibling of the node.

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


     '_t_r_e_e-_s_e_l_e_c_t-_r_o_w(_c_t_r_e_e, _n_o_d_e, _c_o_l_u_m_n, _u_s_e_r._d_a_t_a)' Emitted when a
          row is selected.

          '_c_t_r_e_e' ['GtkCTree'] the object which received the signal.

          '_n_o_d_e' ['GtkCTreeNode'] The node corresponding to the
               selected row.

          '_c_o_l_u_m_n' [integer] The column which was selected.

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


     '_t_r_e_e-_u_n_s_e_l_e_c_t-_r_o_w(_c_t_r_e_e, _n_o_d_e, _c_o_l_u_m_n, _u_s_e_r._d_a_t_a)' Emitted when a
          node is unselected.

          '_c_t_r_e_e' ['GtkCTree'] the object which received the signal.

          '_n_o_d_e' ['GtkCTreeNode'] The node  corresponding to the
               selected row.

          '_c_o_l_u_m_n' [integer] 

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


     '_e_x_p_a_n_d_e_r-_s_t_y_l_e' ['_G_t_k_C_T_r_e_e_E_x_p_a_n_d_e_r_S_t_y_l_e' : _R_e_a_d / _W_r_i_t_e] The
          style of the expander buttons. Default value:
          GTK_CTREE_EXPANDER_NONE


     '_i_n_d_e_n_t' [_n_u_m_e_r_i_c : _R_e_a_d / _W_r_i_t_e] The number of pixels to indent
          the tree levels. Default value: 0


     '_l_i_n_e-_s_t_y_l_e' ['_G_t_k_C_T_r_e_e_L_i_n_e_S_t_y_l_e' : _R_e_a_d / _W_r_i_t_e] The style of the
          lines in the tree graphic. Default value:
          GTK_CTREE_LINES_NONE


     '_n-_c_o_l_u_m_n_s' [_n_u_m_e_r_i_c : _R_e_a_d / _W_r_i_t_e / _C_o_n_s_t_r_u_c_t _O_n_l_y] The number
          of columns in the tree. Default value: 0


     '_s_h_o_w-_s_t_u_b' [_l_o_g_i_c_a_l : _R_e_a_d / _W_r_i_t_e] Default value: FALSE


     '_s_p_a_c_i_n_g' [_n_u_m_e_r_i_c : _R_e_a_d / _W_r_i_t_e] The number of pixels between
          the tree and the columns. Default value: 0


     '_t_r_e_e-_c_o_l_u_m_n' [_n_u_m_e_r_i_c : _R_e_a_d / _W_r_i_t_e / _C_o_n_s_t_r_u_c_t _O_n_l_y] The column
          in which the actual tree graphic appears. 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/GtkCTree.html>

