mirror
/
pyTermTk
mirror of https://github.com/ceccopierangiolieugenio/pyTermTk.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
111 Commits
8 Branches
107 Tags
36 MiB
 
 
 
 
 
Tree: 44e6bbd9e5
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '44e6bbd9e5'
${ noResults }
pyTermTk/_modules/TermTk/TTkAbstract/abstracttablemodel.html

415 lines
36 KiB
Raw Blame History

<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>TermTk.TTkAbstract.abstracttablemodel &mdash; pyTermTk 0.40.0-a
documentation</title>
<link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../../../_static/theme_overrides.css" type="text/css" />
<link rel="stylesheet" href="../../../_static/ttk.css" type="text/css" />
<link rel="shortcut icon" href="https://ceccopierangiolieugenio.github.io/pyTermTk/sandbox/www/favicon.ico"/>
<!--[if lt IE 9]>
<script src="../../../_static/js/html5shiv.min.js"></script>
<![endif]-->
<script data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js"></script>
<script src="../../../_static/jquery.js"></script>
<script src="../../../_static/underscore.js"></script>
<script src="../../../_static/_sphinx_javascript_frameworks_compat.js"></script>
<script src="../../../_static/doctools.js"></script>
<script src="../../../_static/js/theme.js"></script>
<link rel="index" title="Index" href="../../../genindex.html" />
<link rel="search" title="Search" href="../../../search.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="../../../index.html" class="icon icon-home"> pyTermTk
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<p class="caption" role="heading"><span class="caption-text">Tutorials</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../../tutorial/000-examples.html">pyTermTk - &lt; <strong>the Examples</strong> &gt;</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../tutorial/001-helloworld.html">pyTermTk - Hello World</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../tutorial/002-layout.html">pyTermTk - Layouts</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../tutorial/003-signalslots.html">pyTermTk - Signal &amp; Slots</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../tutorial/004-logging.html">pyTermTk - Logging</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../tutorial/005-calculator.html">pyTermTk - Your first Calculator</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../tutorial/ttkDesigner/textEdit/README.html">ttkDesigner - Your first TextEditor</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Features</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../../info/features/index.html">Features</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../info/features/crosscompatible.html">Cross Compatibility</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../info/features/widgets.html">Widgets</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Dev</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../../info/installing.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../info/installing.html#quickstart">Quickstart</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../info/debug.html">Debug</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../info/resources/index.html">Resources</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">API Reference</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../../autogen.TermTk/TermTk.TTkAbstract.html">TermTk.TTkAbstract</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../autogen.TermTk/TermTk.TTkCore.html">TermTk.TTkCore</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../autogen.TermTk/TermTk.TTkCore.TTkTerm.html">TermTk.TTkCore.TTkTerm</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../autogen.TermTk/TermTk.TTkGui.html">TermTk.TTkGui</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../autogen.TermTk/TermTk.TTkLayouts.html">TermTk.TTkLayouts</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../autogen.TermTk/TermTk.TTkTemplates.html">TermTk.TTkTemplates</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../autogen.TermTk/TermTk.TTkTestWidgets.html">TermTk.TTkTestWidgets</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../autogen.TermTk/TermTk.TTkTheme.html">TermTk.TTkTheme</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../autogen.TermTk/TermTk.TTkTypes.html">TermTk.TTkTypes</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../autogen.TermTk/TermTk.TTkUiTools.html">TermTk.TTkUiTools</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../autogen.TermTk/TermTk.TTkWidgets.html">TermTk.TTkWidgets</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../autogen.TermTk/TermTk.TTkWidgets.TTkModelView.html">TermTk.TTkWidgets.TTkModelView</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../autogen.TermTk/TermTk.TTkWidgets.TTkPickers.html">TermTk.TTkWidgets.TTkPickers</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../autogen.TermTk/TermTk.TTkWidgets.TTkTerminal.html">TermTk.TTkWidgets.TTkTerminal</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../../../index.html">pyTermTk</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="../../../index.html" class="icon icon-home"></a> &raquo;</li>
<li><a href="../../index.html">Module code</a> &raquo;</li>
<li>TermTk.TTkAbstract.abstracttablemodel</li>
<li class="wy-breadcrumbs-aside">
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<h1>Source code for TermTk.TTkAbstract.abstracttablemodel</h1><div class="highlight"><pre>
<span></span><span class="c1"># MIT License</span>
<span class="c1">#</span>
<span class="c1"># Copyright (c) 2024 Eugenio Parodi &lt;ceccopierangiolieugenio AT googlemail DOT com&gt;</span>
<span class="c1">#</span>
<span class="c1"># Permission is hereby granted, free of charge, to any person obtaining a copy</span>
<span class="c1"># of this software and associated documentation files (the &quot;Software&quot;), to deal</span>
<span class="c1"># in the Software without restriction, including without limitation the rights</span>
<span class="c1"># to use, copy, modify, merge, publish, distribute, sublicense, and/or sell</span>
<span class="c1"># copies of the Software, and to permit persons to whom the Software is</span>
<span class="c1"># furnished to do so, subject to the following conditions:</span>
<span class="c1">#</span>
<span class="c1"># The above copyright notice and this permission notice shall be included in all</span>
<span class="c1"># copies or substantial portions of the Software.</span>
<span class="c1">#</span>
<span class="c1"># THE SOFTWARE IS PROVIDED &quot;AS IS&quot;, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR</span>
<span class="c1"># IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,</span>
<span class="c1"># FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE</span>
<span class="c1"># AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER</span>
<span class="c1"># LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,</span>
<span class="c1"># OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE</span>
<span class="c1"># SOFTWARE.</span>
<span class="n">__all__</span> <span class="o">=</span> <span class="p">[</span><span class="s1">&#39;TTkAbstractTableModel&#39;</span><span class="p">,</span><span class="s1">&#39;TTkModelIndex&#39;</span><span class="p">]</span>
<span class="kn">from</span> <span class="nn">TermTk.TTkCore.constant</span> <span class="kn">import</span> <span class="n">TTkK</span>
<span class="kn">from</span> <span class="nn">TermTk.TTkCore.string</span> <span class="kn">import</span> <span class="n">TTkString</span>
<span class="kn">from</span> <span class="nn">TermTk.TTkCore.signal</span> <span class="kn">import</span> <span class="n">pyTTkSignal</span><span class="p">,</span> <span class="n">pyTTkSlot</span>
<div class="viewcode-block" id="TTkModelIndex"><a class="viewcode-back" href="../../../autogen.TermTk/TermTk.TTkAbstract.abstracttablemodel.html#TermTk.TTkAbstract.abstracttablemodel.TTkModelIndex">[docs]</a><span class="k">class</span> <span class="nc">TTkModelIndex</span><span class="p">():</span>
<span class="sd">&#39;&#39;&#39;</span>
<span class="sd"> This class is used as an index into item models derived from :class:`~TermTk.TTkAbstract.abstracttablemodel.TTkAbstractTableModel`.</span>
<span class="sd"> The index is used by item views, delegates, and selection models to locate an item in the model.</span>
<span class="sd"> New :class:`~TermTk.TTkAbstract.abstracttablemodel.TTkModelIndex` objects are created by the model using the :class:`~TermTk.TTkAbstract.abstracttablemodel.TTkAbstractTableModel` -&gt; :meth:`~TermTk.TTkAbstract.abstracttablemodel.TTkAbstractTableModel.index` function.</span>
<span class="sd"> An invalid model index can be constructed with the :class:`~TermTk.TTkAbstract.abstracttablemodel.TTkModelIndex` constructor.</span>
<span class="sd"> Model indexes refer to items in models, and contain all the information required to specify their locations in those models.</span>
<span class="sd"> Each index is located in a given row and column; use :meth:`row`, :meth:`column`, and :meth:`data` to obtain this information.</span>
<span class="sd"> To obtain a model index that refers to an existing item in a model, call :class:`~TermTk.TTkAbstract.abstracttablemodel.TTkAbstractTableModel` -&gt; :meth:`~TermTk.TTkAbstract.abstracttablemodel.TTkAbstractTableModel.index` with the required row and column values.</span>
<span class="sd"> &#39;&#39;&#39;</span>
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
<span class="k">pass</span>
<div class="viewcode-block" id="TTkModelIndex.row"><a class="viewcode-back" href="../../../autogen.TermTk/TermTk.TTkAbstract.abstracttablemodel.html#TermTk.TTkAbstract.abstracttablemodel.TTkModelIndex.row">[docs]</a> <span class="k">def</span> <span class="nf">row</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">int</span><span class="p">:</span>
<span class="sd">&#39;&#39;&#39;</span>
<span class="sd"> Returns the row this model index refers to.</span>
<span class="sd"> :return: int</span>
<span class="sd"> &#39;&#39;&#39;</span>
<span class="k">pass</span></div>
<div class="viewcode-block" id="TTkModelIndex.col"><a class="viewcode-back" href="../../../autogen.TermTk/TermTk.TTkAbstract.abstracttablemodel.html#TermTk.TTkAbstract.abstracttablemodel.TTkModelIndex.col">[docs]</a> <span class="k">def</span> <span class="nf">col</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">int</span><span class="p">:</span>
<span class="sd">&#39;&#39;&#39;</span>
<span class="sd"> Returns the column this model index refers to.</span>
<span class="sd"> :return: int</span>
<span class="sd"> &#39;&#39;&#39;</span>
<span class="k">pass</span></div>
<div class="viewcode-block" id="TTkModelIndex.data"><a class="viewcode-back" href="../../../autogen.TermTk/TermTk.TTkAbstract.abstracttablemodel.html#TermTk.TTkAbstract.abstracttablemodel.TTkModelIndex.data">[docs]</a> <span class="k">def</span> <span class="nf">data</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">object</span><span class="p">:</span>
<span class="sd">&#39;&#39;&#39;</span>
<span class="sd"> Returns the data for the item referred to by the index.</span>
<span class="sd"> :return: object</span>
<span class="sd"> &#39;&#39;&#39;</span>
<span class="k">pass</span></div>
<div class="viewcode-block" id="TTkModelIndex.setData"><a class="viewcode-back" href="../../../autogen.TermTk/TermTk.TTkAbstract.abstracttablemodel.html#TermTk.TTkAbstract.abstracttablemodel.TTkModelIndex.setData">[docs]</a> <span class="k">def</span> <span class="nf">setData</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">data</span><span class="p">:</span><span class="nb">object</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
<span class="sd">&#39;&#39;&#39;</span>
<span class="sd"> Set the data in the item referred by the current index.</span>
<span class="sd"> :param data: the data to be set in the (row,col) position of the table</span>
<span class="sd"> :type data: object</span>
<span class="sd"> &#39;&#39;&#39;</span>
<span class="k">pass</span></div></div>
<span class="k">class</span> <span class="nc">_TTkModelIndexList</span><span class="p">(</span><span class="n">TTkModelIndex</span><span class="p">):</span>
<span class="vm">__slots__</span> <span class="o">=</span> <span class="p">(</span><span class="s1">&#39;_col&#39;</span><span class="p">,</span><span class="s1">&#39;_row&#39;</span><span class="p">,</span><span class="s1">&#39;_model&#39;</span><span class="p">)</span>
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">row</span><span class="p">:</span><span class="nb">int</span><span class="p">,</span> <span class="n">col</span><span class="p">:</span><span class="nb">list</span><span class="p">,</span> <span class="n">model</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_col</span> <span class="o">=</span> <span class="n">col</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_row</span> <span class="o">=</span> <span class="n">row</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_model</span> <span class="o">=</span> <span class="n">model</span>
<span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">()</span>
<span class="k">def</span> <span class="nf">row</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">int</span><span class="p">:</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_row</span>
<span class="k">def</span> <span class="nf">col</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">int</span><span class="p">:</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_col</span>
<span class="k">def</span> <span class="nf">data</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">object</span><span class="p">:</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_model</span><span class="o">.</span><span class="n">data</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_row</span><span class="p">,</span><span class="bp">self</span><span class="o">.</span><span class="n">_col</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">setData</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">data</span><span class="p">:</span> <span class="nb">object</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_model</span><span class="o">.</span><span class="n">setData</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_row</span><span class="p">,</span><span class="bp">self</span><span class="o">.</span><span class="n">_col</span><span class="p">,</span><span class="n">data</span><span class="p">)</span>
<div class="viewcode-block" id="TTkAbstractTableModel"><a class="viewcode-back" href="../../../autogen.TermTk/TermTk.TTkAbstract.abstracttablemodel.html#TermTk.TTkAbstract.abstracttablemodel.TTkAbstractTableModel">[docs]</a><span class="k">class</span> <span class="nc">TTkAbstractTableModel</span><span class="p">():</span>
<span class="sd">&#39;&#39;&#39;</span>
<span class="sd"> :class:`TTkAbstractTableModel` provides a standard interface for</span>
<span class="sd"> models that represent their data as a two-dimensional array of items.</span>
<span class="sd"> It is not used directly, but must be subclassed.</span>
<span class="sd"> Since the model provides a more specialized interface than :class:`~TermTk.TTkAbstract.abstractitemmodel.TTkAbstractItemModel`,</span>
<span class="sd"> it is not suitable for use with tree views.</span>
<span class="sd"> The :meth:`rowCount` and :meth:`columnCount` functions return the dimensions of the table.</span>
<span class="sd"> **Subclassing**</span>
<span class="sd"> When subclassing :class:`TTkAbstractTableModel`, you must implement :meth:`rowCount`, :meth:`columnCount`, and :meth:`data`.</span>
<span class="sd"> Well behaved models will also implement :meth:`headerData`.</span>
<span class="sd"> Editable models need to implement :meth:`setData`.</span>
<span class="sd"> **Built-In Implementation**</span>
<span class="sd"> :class:`~TermTk.TTkWidgets.TTkModelView.tablemodellist.TTkTableModelList` basic subclass implementing a 2d list as data structure</span>
<span class="sd"> :class:`~TermTk.TTkWidgets.TTkModelView.tablemodelcsv.TTkTableModelCSV` subclass of :class:`~TermTk.TTkWidgets.TTkModelView.tablemodellist.TTkTableModelList` including the api to import csv data</span>
<span class="sd"> +-----------------------------------------------------------------------------------------------+</span>
<span class="sd"> | `Signals &lt;https://ceccopierangiolieugenio.github.io/pyTermTk/tutorial/003-signalslots.html&gt;`_ |</span>
<span class="sd"> +-----------------------------------------------------------------------------------------------+</span>
<span class="sd"> .. py:method:: dataChanged(pos,size)</span>
<span class="sd"> :signal:</span>
<span class="sd"> This signal is emitted whenever the data in an existing item changes.</span>
<span class="sd"> If more items are affected, the pos/size definne the minimum area including all of those changes.</span>
<span class="sd"> When reimplementing the :meth:`setData` function, this signal must be emitted explicitly.</span>
<span class="sd"> :param pos: the topLeft margin of the modified area</span>
<span class="sd"> :type pos: tuple(int,int)</span>
<span class="sd"> :param size: the size of the modified area</span>
<span class="sd"> :type size: tuple(int,int)</span>
<span class="sd"> &#39;&#39;&#39;</span>
<span class="vm">__slots__</span> <span class="o">=</span> <span class="p">(</span>
<span class="c1"># Signals</span>
<span class="s1">&#39;dataChanged&#39;</span>
<span class="p">)</span>
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">dataChanged</span> <span class="o">=</span> <span class="n">pyTTkSignal</span><span class="p">(</span><span class="nb">tuple</span><span class="p">[</span><span class="nb">int</span><span class="p">,</span><span class="nb">int</span><span class="p">],</span><span class="nb">tuple</span><span class="p">[</span><span class="nb">int</span><span class="p">,</span><span class="nb">int</span><span class="p">])</span>
<div class="viewcode-block" id="TTkAbstractTableModel.rowCount"><a class="viewcode-back" href="../../../autogen.TermTk/TermTk.TTkAbstract.abstracttablemodel.html#TermTk.TTkAbstract.abstracttablemodel.TTkAbstractTableModel.rowCount">[docs]</a> <span class="k">def</span> <span class="nf">rowCount</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">int</span><span class="p">:</span>
<span class="sd">&#39;&#39;&#39;</span>
<span class="sd"> Returns the number of rows of the current model.</span>
<span class="sd"> :return: int</span>
<span class="sd"> &#39;&#39;&#39;</span>
<span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>
<div class="viewcode-block" id="TTkAbstractTableModel.columnCount"><a class="viewcode-back" href="../../../autogen.TermTk/TermTk.TTkAbstract.abstracttablemodel.html#TermTk.TTkAbstract.abstracttablemodel.TTkAbstractTableModel.columnCount">[docs]</a> <span class="k">def</span> <span class="nf">columnCount</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">int</span><span class="p">:</span>
<span class="sd">&#39;&#39;&#39;</span>
<span class="sd"> Returns the number of columns of the current moodel.</span>
<span class="sd"> :return: int</span>
<span class="sd"> &#39;&#39;&#39;</span>
<span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>
<div class="viewcode-block" id="TTkAbstractTableModel.index"><a class="viewcode-back" href="../../../autogen.TermTk/TermTk.TTkAbstract.abstracttablemodel.html#TermTk.TTkAbstract.abstracttablemodel.TTkAbstractTableModel.index">[docs]</a> <span class="k">def</span> <span class="nf">index</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">row</span><span class="p">:</span><span class="nb">int</span><span class="p">,</span> <span class="n">col</span><span class="p">:</span><span class="nb">int</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">TTkModelIndex</span><span class="p">:</span>
<span class="sd">&#39;&#39;&#39;</span>
<span class="sd"> Returns the index of the item in the model specified by the given row, column.</span>
<span class="sd"> :param row: the row position of the index</span>
<span class="sd"> :type row: int</span>
<span class="sd"> :param col: the column position of the index</span>
<span class="sd"> :type col: int</span>
<span class="sd"> :return: :class:`~TermTk.TTkAbstract.abstracttablemodel.TTkModelIndex`</span>
<span class="sd"> &#39;&#39;&#39;</span>
<span class="k">return</span> <span class="n">_TTkModelIndexList</span><span class="p">(</span><span class="n">row</span><span class="p">,</span><span class="n">col</span><span class="p">,</span><span class="bp">self</span><span class="p">)</span></div>
<div class="viewcode-block" id="TTkAbstractTableModel.data"><a class="viewcode-back" href="../../../autogen.TermTk/TermTk.TTkAbstract.abstracttablemodel.html#TermTk.TTkAbstract.abstracttablemodel.TTkAbstractTableModel.data">[docs]</a> <span class="k">def</span> <span class="nf">data</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">row</span><span class="p">:</span><span class="nb">int</span><span class="p">,</span> <span class="n">col</span><span class="p">:</span><span class="nb">int</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">object</span><span class="p">:</span>
<span class="sd">&#39;&#39;&#39;</span>
<span class="sd"> Returns the data stored for the item referred to by the row/column.</span>
<span class="sd"> Note: If you do not have a value to return, return *None* instead of returning 0.</span>
<span class="sd"> :param row: the row position of the data</span>
<span class="sd"> :type row: int</span>
<span class="sd"> :param col: the column position of the data</span>
<span class="sd"> :type col: int</span>
<span class="sd"> :return: object</span>
<span class="sd"> &#39;&#39;&#39;</span>
<span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>
<div class="viewcode-block" id="TTkAbstractTableModel.setData"><a class="viewcode-back" href="../../../autogen.TermTk/TermTk.TTkAbstract.abstracttablemodel.html#TermTk.TTkAbstract.abstracttablemodel.TTkAbstractTableModel.setData">[docs]</a> <span class="k">def</span> <span class="nf">setData</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">row</span><span class="p">:</span><span class="nb">int</span><span class="p">,</span> <span class="n">col</span><span class="p">:</span><span class="nb">int</span><span class="p">,</span> <span class="n">data</span><span class="p">:</span><span class="nb">object</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">bool</span><span class="p">:</span>
<span class="sd">&#39;&#39;&#39;</span>
<span class="sd"> Returns true if successful; otherwise returns false.</span>
<span class="sd"> The :meth:`~TermTk.TTkAbstract.abstracttablemodel.TTkAbstractTableModel.dataChanged` signal should be emitted if the data was successfully set.</span>
<span class="sd"> The base class implementation returns false. This function and :meth:`data` must be reimplemented for editable models.</span>
<span class="sd"> :param row: the row position of the data</span>
<span class="sd"> :type row: int</span>
<span class="sd"> :param col: the column position of the data</span>
<span class="sd"> :type col: int</span>
<span class="sd"> :param data: the data to be set in the (row,col) position of the table</span>
<span class="sd"> :type data: object</span>
<span class="sd"> :return: bool</span>
<span class="sd"> &#39;&#39;&#39;</span>
<span class="k">return</span> <span class="kc">False</span></div>
<div class="viewcode-block" id="TTkAbstractTableModel.ttkStringData"><a class="viewcode-back" href="../../../autogen.TermTk/TermTk.TTkAbstract.abstracttablemodel.html#TermTk.TTkAbstract.abstracttablemodel.TTkAbstractTableModel.ttkStringData">[docs]</a> <span class="k">def</span> <span class="nf">ttkStringData</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">row</span><span class="p">:</span><span class="nb">int</span><span class="p">,</span> <span class="n">col</span><span class="p">:</span><span class="nb">int</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">TTkString</span><span class="p">:</span>
<span class="sd">&#39;&#39;&#39;</span>
<span class="sd"> Returns the :class:`~TermTk.TTkCore.string.TTkString` reprsents the ddata stored in the row/column.</span>
<span class="sd"> :param row: the row position of the data</span>
<span class="sd"> :type row: int</span>
<span class="sd"> :param col: the column position of the data</span>
<span class="sd"> :type col: int</span>
<span class="sd"> :return: :class:`~TermTk.TTkCore.string.TTkString`</span>
<span class="sd"> &#39;&#39;&#39;</span>
<span class="n">data</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">data</span><span class="p">(</span><span class="n">row</span><span class="p">,</span><span class="n">col</span><span class="p">)</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">data</span><span class="p">,</span><span class="n">TTkString</span><span class="p">):</span>
<span class="k">return</span> <span class="n">data</span>
<span class="k">elif</span> <span class="nb">type</span><span class="p">(</span><span class="n">data</span><span class="p">)</span> <span class="o">==</span> <span class="nb">str</span><span class="p">:</span>
<span class="k">return</span> <span class="n">TTkString</span><span class="p">(</span><span class="n">data</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">return</span> <span class="n">TTkString</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="n">data</span><span class="p">))</span></div>
<div class="viewcode-block" id="TTkAbstractTableModel.headerData"><a class="viewcode-back" href="../../../autogen.TermTk/TermTk.TTkAbstract.abstracttablemodel.html#TermTk.TTkAbstract.abstracttablemodel.TTkAbstractTableModel.headerData">[docs]</a> <span class="k">def</span> <span class="nf">headerData</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">pos</span><span class="p">:</span><span class="nb">int</span><span class="p">,</span> <span class="n">orientation</span><span class="p">:</span><span class="n">TTkK</span><span class="o">.</span><span class="n">Direction</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">TTkString</span><span class="p">:</span>
<span class="sd">&#39;&#39;&#39;</span>
<span class="sd"> Returns the data for the given role and section in the header with the specified orientation.</span>
<span class="sd"> For horizontal headers, the section number corresponds to the column number.</span>
<span class="sd"> Similarly, for vertical headers, the section number corresponds to the row number.</span>
<span class="sd"> :param pos: the position (col or row) of the header</span>
<span class="sd"> :type pos: int</span>
<span class="sd"> :param orientation: the orienttin of the header to be retrieved</span>
<span class="sd"> :type orientation: :class:`~TermTk.TTkCore.constant.TTkConstant.Direction`</span>
<span class="sd"> :return: :class:`~TermTk.TTkCore.string.TTkString`</span>
<span class="sd"> &#39;&#39;&#39;</span>
<span class="k">if</span> <span class="n">orientation</span><span class="o">==</span><span class="n">TTkK</span><span class="o">.</span><span class="n">HORIZONTAL</span><span class="p">:</span>
<span class="k">return</span> <span class="n">TTkString</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="n">pos</span><span class="p">))</span>
<span class="k">elif</span> <span class="n">orientation</span><span class="o">==</span><span class="n">TTkK</span><span class="o">.</span><span class="n">VERTICAL</span><span class="p">:</span>
<span class="k">return</span> <span class="n">TTkString</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="n">pos</span><span class="p">))</span>
<span class="k">return</span> <span class="n">TTkString</span><span class="p">()</span></div>
<div class="viewcode-block" id="TTkAbstractTableModel.flags"><a class="viewcode-back" href="../../../autogen.TermTk/TermTk.TTkAbstract.abstracttablemodel.html#TermTk.TTkAbstract.abstracttablemodel.TTkAbstractTableModel.flags">[docs]</a> <span class="k">def</span> <span class="nf">flags</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">row</span><span class="p">:</span><span class="nb">int</span><span class="p">,</span> <span class="n">col</span><span class="p">:</span><span class="nb">int</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">TTkK</span><span class="o">.</span><span class="n">ItemFlag</span><span class="p">:</span>
<span class="sd">&#39;&#39;&#39;</span>
<span class="sd"> Returns the item flags for the given row,column.</span>
<span class="sd"> The base class implementation returns a combination of flags that</span>
<span class="sd"> enables the item (:class:`~TermTk.TTkCore.constant.TTkConstant.ItemFlag.ItemIsEnabled`)</span>
<span class="sd"> and allows it to be selected (:class:`~TermTk.TTkCore.constant.TTkConstant.ItemFlag.ItemIsSelectable`).</span>
<span class="sd"> :param row: the row position od the data</span>
<span class="sd"> :type row: int</span>
<span class="sd"> :param col: the column position of the data</span>
<span class="sd"> :type col: int</span>
<span class="sd"> :return: :class:`~TermTk.TTkCore.constant.TTkConstant.ItemFlag`</span>
<span class="sd"> &#39;&#39;&#39;</span>
<span class="k">return</span> <span class="p">(</span>
<span class="n">TTkK</span><span class="o">.</span><span class="n">ItemFlag</span><span class="o">.</span><span class="n">ItemIsEnabled</span> <span class="o">|</span>
<span class="n">TTkK</span><span class="o">.</span><span class="n">ItemFlag</span><span class="o">.</span><span class="n">ItemIsSelectable</span> <span class="p">)</span></div>
<div class="viewcode-block" id="TTkAbstractTableModel.sort"><a class="viewcode-back" href="../../../autogen.TermTk/TermTk.TTkAbstract.abstracttablemodel.html#TermTk.TTkAbstract.abstracttablemodel.TTkAbstractTableModel.sort">[docs]</a> <span class="k">def</span> <span class="nf">sort</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">column</span><span class="p">:</span><span class="nb">int</span><span class="p">,</span> <span class="n">order</span><span class="p">:</span><span class="n">TTkK</span><span class="o">.</span><span class="n">SortOrder</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
<span class="sd">&#39;&#39;&#39;</span>
<span class="sd"> Sorts the model by column in the given order.</span>
<span class="sd"> :param column: The column index to be sorted, if -1 is provided the original unsorted order is used.</span>
<span class="sd"> :type column: int</span>
<span class="sd"> :param order: the sorting order</span>
<span class="sd"> :type order: :class:`~TermTk.TTkCore.constant.TTkConstant.SortOrder`</span>
<span class="sd"> &#39;&#39;&#39;</span>
<span class="k">pass</span></div></div>
</pre></div>
</div>
</div>
<footer>
<hr/>
<div role="contentinfo">
<p>&#169; Copyright 2021, Eugenio Parodi.</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>