3
<_6 @ st d dl Z d dlZd dlZd dlZd dlmZ d dlmZ G dd dejZdd Z dd Z
G d
d d ejej Z dS ) N)GObject)Gtkc @ s< e Zd ZdejfdejfdejfdejfgZedd ZdS )
_CTreeIterstamp user_dataZ
user_data2Z
user_data3c C s$ t jt }tj| jt|| S )N)sys getsizeofobjectctypesZPOINTERZ from_addressid)clsiteroffset r (/usr/lib64/python3.6/generictreemodel.py from_iter& s z_CTreeIter.from_iterN) __name__
__module__ __qualname__r
Zc_intZc_void_pZ_fields_ classmethodr r r r r r s
r c C s t j| }tj|jjtjjS )N)r r r
castcontentsr Z py_objectvalue)r
Zciterr r r _get_user_data_as_pyobject, s
r c s fdd}|S )a] Returns a function which can act as a decorator for wrapping exceptions and
returning "default_return" upon an exception being thrown.
This is used to wrap Gtk.TreeModel "do_" method implementations so we can return
a proper value from the override upon an exception occurring with client code
implemented by the "on_" methods.
c s fdd}|S )Nc s* y
| |S t jt j Y nX S )N)r
excepthookexc_info)argsZkargs)default_returnfuncr r wrapped_func: s
z9handle_exception..decorator..wrapped_funcr )r r )r )r r decorator9 s z#handle_exception..decoratorr )r r r )r r handle_exception1 s
r! c s e Zd ZdZejdeddZ fddZdd Z d d
Z
d d Z d
d Z dd Z
dd Zdd Zdd ZdT fdd Zeddd Zedd d Zeejd d ZedUd"d# Zed!d$d% Zedd&d' Zedd(d) ZedVd*d+ Zed!d,d- Z edd.d/ Z edWd0d1 Z edXd2d3 Z edd4d5 Z edd6d7 Z!d8d9 Z"d:d; Z#dd? Z%d@dA Z&dBdC Z'dDdE Z(dFdG Z)dHdI Z*dJdK Z+dLdM Z,dNdO Z-dPdQ Z.dRdS Z/ Z0S )YGenericTreeModela A base implementation of a Gtk.TreeModel for python.
The GenericTreeModel eases implementing the Gtk.TreeModel interface in Python.
The class can be subclassed to provide a TreeModel implementation which works
directly with Python objects instead of iterators.
All of the on_* methods should be overridden by subclasses to provide the
underlying implementation a way to access custom model data. For the purposes of
this API, all custom model data supplied or handed back through the overridable
API will use the argument names: node, parent, and child in regards to user data
python objects.
The create_tree_iter, set_user_data, invalidate_iters, iter_is_valid methods are
available to help manage Gtk.TreeIter objects and their Python object references.
GenericTreeModel manages a pool of user data nodes that have been used with iters.
This pool stores a references to user data nodes as a dictionary value with the
key being the integer id of the data. This id is what the Gtk.TreeIter objects
use to reference data in the pool.
References will be removed from the pool when the model is deleted or explicitly
by using the optional "node" argument to the "row_deleted" method when notifying
the model of row deletion.
TzIf True, strong references to user data attached to iters are stored in a dictionary pool (default). Otherwise the user data is stored as a raw pointer to a python object without a reference.)defaulttypeZblurbc s( t t| j d| _t | _| j dS )zFInitialize. Make sure to call this from derived classes if overridden.r N)superr" __init__r dict
_held_refsinvalidate_iters)self) __class__r r r& g s zGenericTreeModel.__init__c # sb t jdg}xP|r\|j dk r.j V fddtj D }|jt| qW dS )zHDepth-first iteration of the entire TreeModel yielding the python nodes.Nc s g | ]}j |qS r )Ziter_nth_child).0i)itr* r r
y s z5GenericTreeModel.iter_depth_first..) collectionsdequepopleft
get_user_datarangeZiter_n_children
extendleftreversed)r* stackZchildrenr )r. r* r iter_depth_firstr s z!GenericTreeModel.iter_depth_firstc C s, d|_ |jr(|j| jkr"| j|j= d|_dS )z?Clear user data and its reference from the iter and this model.r N)r r r( )r* r
r r r invalidate_iter| s
z GenericTreeModel.invalidate_iterc C s t jdd| _| jj dS )z
This method invalidates all TreeIter objects associated with this custom tree model
and frees their locally pooled references.
l iNi )randomZrandintr r( clear)r* r r r r) s z!GenericTreeModel.invalidate_itersc C s |j | j kS )zv
:Returns:
True if the gtk.TreeIter specified by iter is valid for the custom tree model.
)r )r* r
r r r
iter_is_valid s z GenericTreeModel.iter_is_validc C s | j r| j|j S t|S dS )zGet the user_data associated with the given TreeIter.
GenericTreeModel stores arbitrary Python objects mapped to instances of Gtk.TreeIter.
This method allows to retrieve the Python object held by the given iterator.
N)leak_referencesr( r r )r* r
r r r r3 s z GenericTreeModel.get_user_datac C s< t ||_|dkr | j| n| j|_| jr8|| j|j< dS )zApplies user_data and stamp to the given iter.
If the models "leak_references" property is set, a reference to the
user_data is stored with the model to ensure we don't run into bad
memory problems with the TreeIter.
N)r r r9 r r= r( )r* r
r r r r
set_user_data s
z GenericTreeModel.set_user_datac C s t j }| j|| |S )a Create a Gtk.TreeIter instance with the given user_data specific for this model.
Use this method to create Gtk.TreeIter instance instead of directly calling
Gtk.Treeiter(), this will ensure proper reference managment of wrapped used_data.
)r ZTreeIterr> )r* r r
r r r create_tree_iter s z!GenericTreeModel.create_tree_iterc C s" |dkr dS | j |}d|fS dS )zyInternal creation of a (bool, TreeIter) pair for returning directly
back to the view interfacing with this model.NFT)FN)r? )r* datar. r r r _create_tree_iter s
z"GenericTreeModel._create_tree_iterNc s. t t| j| t|}|| jkr*| j|= dS )a Notify the model a row has been deleted.
Use the node parameter to ensure the user_data reference associated
with the path is properly freed by this model.
:Parameters:
path : Gtk.TreePath
Path to the row that has been deleted.
node : object
Python object used as the node returned from "on_get_iter". This is
optional but ensures the model will not leak references to this object.
N)r% r" row_deletedr r( )r* pathnodeZnode_id)r+ r r rB s
z GenericTreeModel.row_deletedr c C s | j S )zInternal method.) on_get_flags)r* r r r do_get_flags s z GenericTreeModel.do_get_flagsc C s | j S )zInternal method.)on_get_n_columns)r* r r r do_get_n_columns s z!GenericTreeModel.do_get_n_columnsc C s
| j |S )zInternal method.)on_get_column_type)r* indexr r r do_get_column_type s z#GenericTreeModel.do_get_column_typeFc C s | j | j|S )zInternal method.)rA on_get_iter)r* rC r r r do_get_iter s z GenericTreeModel.do_get_iterc C s8 |dkr| j d}n| j | j|}| j|| |dk S )zInternal method.N) on_iter_nextr3 r> )r* r
Z next_datar r r do_iter_next s
z GenericTreeModel.do_iter_nextc C s* | j | j|}|dkr dS tj|S dS )zInternal method.N) on_get_pathr3 r ZTreePath)r* r
rC r r r do_get_path s z GenericTreeModel.do_get_pathc C s | j | j||S )zInternal method.) on_get_valuer3 )r* r
columnr r r do_get_value s z GenericTreeModel.do_get_valuec C s" |r| j |nd}| j| j|S )zInternal method.N)r3 rA on_iter_children)r* parentr@ r r r do_iter_children s z!GenericTreeModel.do_iter_childrenc C s | j | j|S )zInternal method.)on_iter_has_childr3 )r* rV r r r do_iter_has_child s z"GenericTreeModel.do_iter_has_childc C s" |dkr| j dS | j | j|S )zInternal method.N)on_iter_n_childrenr3 )r* r
r r r do_iter_n_children s
z#GenericTreeModel.do_iter_n_childrenc C s2 |dkr| j d|}n| j | j||}| j|S )zInternal method.N)on_iter_nth_childr3 rA )r* rV nr@ r r r do_iter_nth_child s z"GenericTreeModel.do_iter_nth_childc C s | j | j| j|S )zInternal method.)rA on_iter_parentr3 )r* childr r r do_iter_parent s z GenericTreeModel.do_iter_parentc C s | j | j| d S )N) on_ref_noder3 )r* r
r r r do_ref_node# s z GenericTreeModel.do_ref_nodec C s | j | j| d S )N)
on_unref_noder3 )r* r
r r r
do_unref_node' s z GenericTreeModel.do_unref_nodec C s t dS )zyOverridable.
:Returns Gtk.TreeModelFlags:
The flags for this model. See: Gtk.TreeModelFlags
N)NotImplementedError)r* r r r rE . s z GenericTreeModel.on_get_flagsc C s t dS )zZOverridable.
:Returns:
The number of columns for this model.
N)rf )r* r r r rG 6 s z!GenericTreeModel.on_get_n_columnsc C s t dS )zYOverridable.
:Returns:
The column type for the given index.
N)rf )r* rJ r r r rI > s z#GenericTreeModel.on_get_column_typec C s t dS )zcOverridable.
:Returns:
A python object (node) for the given TreePath.
N)rf )r* rC r r r rL F s z GenericTreeModel.on_get_iterc C s t dS )zOverridable.
:Parameters:
node : object
Node at current level.
:Returns:
A python object (node) following the given node at the current level.
N)rf )r* rD r r r rN N s
z GenericTreeModel.on_iter_nextc C s t dS )zSOverridable.
:Returns:
A TreePath for the given node.
N)rf )r* rD r r r rP Z s z GenericTreeModel.on_get_pathc C s t dS )zOverridable.
:Parameters:
node : object
column : int
Column index to get the value from.
:Returns:
The value of the column for the given node.N)rf )r* rD rS r r r rR b s
z GenericTreeModel.on_get_valuec C s t dS )zOverridable.
:Returns:
The first child of parent or None if parent has no children.
If parent is None, return the first node of the model.
N)rf )r* rV r r r rU n s z!GenericTreeModel.on_iter_childrenc C s t dS )zYOverridable.
:Returns:
True if the given node has children.
N)rf )r* rD r r r rX w s z"GenericTreeModel.on_iter_has_childc C s t dS )zOverridable.
:Returns:
The number of children for the given node. If node is None,
return the number of top level nodes.
N)rf )r* rD r r r rZ s z#GenericTreeModel.on_iter_n_childrenc C s t dS )ah Overridable.
:Parameters:
parent : object
n : int
Index of child within parent.
:Returns:
The child for the given parent index starting at 0. If parent None,
return the top level node corresponding to "n".
If "n" is larger then available nodes, return None.
N)rf )r* rV r] r r r r\ s
z"GenericTreeModel.on_iter_nth_childc C s t dS )zjOverridable.
:Returns:
The parent node of child or None if child is a top level node.N)rf )r* r` r r r r_ s z GenericTreeModel.on_iter_parentc C s d S )Nr )r* rD r r r rb s z GenericTreeModel.on_ref_nodec C s d S )Nr )r* rD r r r rd s z GenericTreeModel.on_unref_node)N)FN)FN)FN)FN)1r r r __doc__r ZPropertyboolr= r& r8 r9 r) r< r3 r> r? rA rB r! rF rH Z TYPE_INVALIDrK rM rO rQ rT rW rY r[ r^ ra rc re rE rG rI rL rN rP rR rU rX rZ r\ r_ rb rd
__classcell__r r )r+ r r" F sR
r" )
r r: r0 r
Z
gi.repositoryr r Z Structurer r r! Z TreeModelr" r r r r s