U PeT@sdZddlmZddlmZddlmZddlmZm Z m Z m Z m Z m Z mZGdddeZGdd d eZGd d d eeZGd d d eZedkrddlmZGdddeZedS)a Tree View ========= .. image:: images/treeview.png :align: right .. versionadded:: 1.0.4 :class:`TreeView` is a widget used to represent a tree structure. It is currently very basic, supporting a minimal feature set. Introduction ------------ A :class:`TreeView` is populated with :class:`TreeViewNode` instances, but you cannot use a :class:`TreeViewNode` directly. You must combine it with another widget, such as :class:`~kivy.uix.label.Label`, :class:`~kivy.uix.button.Button` or even your own widget. The TreeView always creates a default root node, based on :class:`TreeViewLabel`. :class:`TreeViewNode` is a class object containing needed properties for serving as a tree node. Extend :class:`TreeViewNode` to create custom node types for use with a :class:`TreeView`. For constructing your own subclass, follow the pattern of TreeViewLabel which combines a Label and a TreeViewNode, producing a :class:`TreeViewLabel` for direct use in a TreeView instance. To use the TreeViewLabel class, you could create two nodes directly attached to root:: tv = TreeView() tv.add_node(TreeViewLabel(text='My first item')) tv.add_node(TreeViewLabel(text='My second item')) Or, create two nodes attached to a first:: tv = TreeView() n1 = tv.add_node(TreeViewLabel(text='Item 1')) tv.add_node(TreeViewLabel(text='SubItem 1'), n1) tv.add_node(TreeViewLabel(text='SubItem 2'), n1) If you have a large tree structure, perhaps you would need a utility function to populate the tree view:: def populate_tree_view(tree_view, parent, node): if parent is None: tree_node = tree_view.add_node(TreeViewLabel(text=node['node_id'], is_open=True)) else: tree_node = tree_view.add_node(TreeViewLabel(text=node['node_id'], is_open=True), parent) for child_node in node['children']: populate_tree_view(tree_view, tree_node, child_node) tree = {'node_id': '1', 'children': [{'node_id': '1.1', 'children': [{'node_id': '1.1.1', 'children': [{'node_id': '1.1.1.1', 'children': []}]}, {'node_id': '1.1.2', 'children': []}, {'node_id': '1.1.3', 'children': []}]}, {'node_id': '1.2', 'children': []}]} class TreeWidget(FloatLayout): def __init__(self, **kwargs): super(TreeWidget, self).__init__(**kwargs) tv = TreeView(root_options=dict(text='Tree One'), hide_root=False, indent_level=4) populate_tree_view(tv, None, tree) self.add_widget(tv) The root widget in the tree view is opened by default and has text set as 'Root'. If you want to change that, you can use the :attr:`TreeView.root_options` property. This will pass options to the root widget:: tv = TreeView(root_options=dict(text='My root label')) Creating Your Own Node Widget ----------------------------- For a button node type, combine a :class:`~kivy.uix.button.Button` and a :class:`TreeViewNode` as follows:: class TreeViewButton(Button, TreeViewNode): pass You must know that, for a given node, only the :attr:`~kivy.uix.widget.Widget.size_hint_x` will be honored. The allocated width for the node will depend of the current width of the TreeView and the level of the node. For example, if a node is at level 4, the width allocated will be: treeview.width - treeview.indent_start - treeview.indent_level * node.level You might have some trouble with that. It is the developer's responsibility to correctly handle adapting the graphical representation nodes, if needed. )Clock)Label)Widget)BooleanProperty ListPropertyObjectProperty AliasPropertyNumericPropertyReferenceListProperty ColorPropertyc@seZdZdZdS)TreeViewExceptionz3Exception for errors in the :class:`TreeView`. N__name__ __module__ __qualname____doc__rr5/tmp/pip-unpacked-wheel-xzebddm3/kivy/uix/treeview.pyr ysr cseZdZdZfddZedZedZedZedZ edZ e gZ e dddZedZed d d d gZedZed d d d gZed d d d gZZS) TreeViewNodezJTreeViewNode class, used to build a node class for a TreeView object. c s(|jtkrtdtt|jf|dS)Nz%You cannot use directly TreeViewNode.) __class__rr super__init__)selfkwargsrrrrs zTreeViewNode.__init__TFNZ allownoneg333333?g?gg?g?)rrrrrris_leafis_open is_loaded is_selected no_selectionrnodesr parent_noder levelr Zcolor_selectedoddZ odd_colorZ even_color __classcell__rrrrrs      rc@seZdZdZdS) TreeViewLabelzCombines a :class:`~kivy.uix.label.Label` and a :class:`TreeViewNode` to create a :class:`TreeViewLabel` that can be used as a text node in the tree. See module documentation for more information. Nr rrrrr'sr'cs<eZdZdZdZfddZd7ddZdd Zd d Zd d Z ddZ ddZ ddZ ddZ d8ddZd9ddZddZddZddZd d!Zd"d#Zd$d%Zd&d'Zd(d)ZedZedd*d+Zed,Zed,ZeeeZed-Z ed.Z!e"d/Z#d0d1Z$e%e$dd2d3Z&d4d5Z'e%e'dd6d3Z(eiZ)edZ*Z+S):TreeViewzTreeView class. See module documentation for more information. :Events: `on_node_expand`: (node, ) Fired when a node is being expanded `on_node_collapse`: (node, ) Fired when a node is being collapsed )on_node_expandon_node_collapsec st|jd|_tt|jf|tdddd}|j D]\}}t |||q:| |d|_ |j}|j }|d||d||d||d ||dS) NrZRootTr)textrr$possize indent_level indent_start)rZcreate_trigger _do_layout_trigger_layoutrr(rr' root_optionsitemssetattradd_node_rootfbind)rrZtvlabelkeyvalueZtriggerr7rrrrs    zTreeView.__init__NcCsht|tstd|dkr&|jr&|j}|rNd|_|j|||_|jd|_| d|j | |S)aAdd a new node to the tree. :Parameters: `node`: instance of a :class:`TreeViewNode` Node to add into the tree `parent`: instance of a :class:`TreeViewNode`, defaults to None Parent node to attach the new node. If `None`, it is added to the :attr:`root` node. :returns: the node `node`. +The node must be a subclass of TreeViewNodeNFr-) isinstancerr r6rr"appendr#r$r7r1)rnodeparentrrrr5(s   zTreeView.add_nodecCs~t|tstd|j}|dk rz||jkr6d|_d|_|j}||krN||tt | |_ d|_| d|j | dS)aRemoves a node from the tree. .. versionadded:: 1.0.7 :Parameters: `node`: instance of a :class:`TreeViewNode` Node to remove from the tree. If `node` is :attr:`root`, it is not removed. r:NFr-) r<rr r#_selected_noder r"removeboollenrZfunbindr1)rr>r?r"rrr remove_nodeEs   zTreeView.remove_nodecCsdSNrrr>rrrr)`szTreeView.on_node_expandcCsdSrErrFrrrr*cszTreeView.on_node_collapsecCs(|jr dS|jrd|j_d|_||_dS)z#Select a node in the tree. NFT)r!r@r rFrrr select_nodefs zTreeView.select_nodecGs|jrd|j_d|_dS)zFDeselect any selected node. .. versionadded:: 1.10.0 FN)r@r )rargsrrr deselect_nodepszTreeView.deselect_nodecCsL|j |_|jr4|jr&|js&|||d|n |d||dS)z7Toggle the state of the node (open/collapsed). r)r*N)r load_funcr _do_node_loaddispatchr1rFrrr toggle_nodeys    zTreeView.toggle_nodecCs^|\}}||jD]D}|j|kr0|jkrnq|j|krL|jkrnq|SqdS)z-Get the node at the position (x, y). N)iterate_open_nodesrootxrightytop)rr,rPrRr>rrrget_node_at_poss zTreeView.get_node_at_posccsV|s |j}|jr||jkrn|V|js,dS|j}|jD]}||D] }|VqDq8dS)a`Generator to iterate over all the expended nodes starting from `node` and down. If `node` is `None`, the generator start with :attr:`root`. To get all the open nodes:: treeview = TreeView() # ... add nodes ... for node in treeview.iterate_open_nodes(): print(node) N)rO hide_rootrrNr"rr>fcnodeZynoderrrrNs   zTreeView.iterate_open_nodesccs:|s |j}|V|j}|jD]}||D] }|Vq(qdS)zGenerator to iterate over all nodes from `node` and down whether expanded or not. If `node` is `None`, the generator start with :attr:`root`. N)rOiterate_all_nodesr"rVrrrrYs  zTreeView.iterate_all_nodescCs|rt|jdSrE)rZ schedule_once_do_initial_load)rinstancer9rrr on_load_funcszTreeView.on_load_funccGs|js dS|ddSrE)rJrK)rlargsrrrrZszTreeView._do_initial_loadcCs8|||}|rd|_|sdS|D]}|||q"dS)NT)rJrr5)rr>genrXrrrrKs zTreeView._do_node_loadcCs.|js dS|D]\}}t|j||qdSrE)rOr3r4)rr[r9r8rrron_root_optionsszTreeView.on_root_optionscGs|||j||jd|jd}}t||jD]6\}}|drRdnd|_t||j |j }||j 7}q>||f|_ dS)NrFT) Z clear_widgets _do_open_noderO_do_layout_noderS enumeraterNr%maxrQrPheight minimum_size)rr]Z min_widthZ min_heightcountr>rrrr0s  zTreeView._do_layoutcCsN|jr||jkrd}n|||j}|js0|S|jD]}|||7}q6|S)Nr)rUrOZ add_widgetrerr"ra)rr>rerXrrrras  zTreeView._do_open_nodecCs|jr||jkr|d8}nR|j|j||j|_||_|jrX|j|j|j|j|_||j8}|j sl|S|j D]}| ||d|}qr|S)Nr;) rUrOrPr/r.rSZ size_hint_xwidthrerr"rb)rr>r$rRrXrrrrbs   zTreeView._do_layout_nodecCst||j}|sdS|jrdS|j|j|jkr>|jkrNnn ||n"|j|jkrp|||d|dS)N on_touch_downT)rTr,disabledrPr/rMrGrL)rtouchr>rrrris $    zTreeView.on_touch_downTrrZ16dpZ24dpFcCs|jSrEr@rrrrget_selected_nodeKszTreeView.get_selected_noderl)bindcCs|jSrEr6rmrrrget_rootVszTreeView.get_rootrp)N)N)N),rrrrZ __events__rr5rDr)r*rGrIrMrTrNrYr\rZrKr_r0rarbrirr6r@r Z minimum_widthZminimum_heightr rfr.r/rrUrnrZ selected_noderqrOr2rJr&rrrrr( sL               r(__main__)Appc@seZdZddZdS)TestAppcCstdd}|j}|tddd}tdD]}|td|d|q(|tdd d}td D]}|td|d|qZtdD]}|td|d|q||td d d|}td D]}|td|d|q|S) NT)rUzLevel 1, entry 1)r+rz Element %d)r+zLevel 1, entry 2FzElement childs 2)r(r5r'range)rtvaddrOrProot2rrrbuilds       z TestApp.buildN)rrrr{rrrrrtsrtN)rZ kivy.clockrZkivy.uix.labelrZkivy.uix.widgetrZkivy.propertiesrrrrr r r Exceptionr objectrr'r(rZkivy.apprsrtrunrrrrsq   $ z