|
|
<!DOCTYPE html> |
|
|
<html class="writer-html5" lang="en" > |
|
|
<head> |
|
|
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" /> |
|
|
|
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" /> |
|
|
<title>TermTk.TTkCore.string — pyTermTk 0.36.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" /> |
|
|
<link rel="next" title="TermTk.TTkCore.timer" href="TermTk.TTkCore.timer.html" /> |
|
|
<link rel="prev" title="TermTk.TTkCore.signal" href="TermTk.TTkCore.signal.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 - < <strong>the Examples</strong> ></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 & 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> |
|
|
</ul> |
|
|
<p class="caption" role="heading"><span class="caption-text">API Reference</span></p> |
|
|
<ul class="current"> |
|
|
<li class="toctree-l1"><a class="reference internal" href="TermTk.TTkAbstract.html">TermTk.TTkAbstract</a></li> |
|
|
<li class="toctree-l1 current"><a class="reference internal" href="TermTk.TTkCore.html">TermTk.TTkCore</a><ul class="current"> |
|
|
<li class="toctree-l2"><a class="reference internal" href="TermTk.TTkCore.TTkTerm.html">TermTk.TTkCore.TTkTerm</a></li> |
|
|
<li class="toctree-l2"><a class="reference internal" href="TermTk.TTkCore.canvas.html">TermTk.TTkCore.canvas</a></li> |
|
|
<li class="toctree-l2"><a class="reference internal" href="TermTk.TTkCore.cfg.html">TermTk.TTkCore.cfg</a></li> |
|
|
<li class="toctree-l2"><a class="reference internal" href="TermTk.TTkCore.color.html">TermTk.TTkCore.color</a></li> |
|
|
<li class="toctree-l2"><a class="reference internal" href="TermTk.TTkCore.constant.html">TermTk.TTkCore.constant</a></li> |
|
|
<li class="toctree-l2"><a class="reference internal" href="TermTk.TTkCore.drivers.html">TermTk.TTkCore.drivers</a></li> |
|
|
<li class="toctree-l2"><a class="reference internal" href="TermTk.TTkCore.filebuffer.html">TermTk.TTkCore.filebuffer</a></li> |
|
|
<li class="toctree-l2"><a class="reference internal" href="TermTk.TTkCore.helper.html">TermTk.TTkCore.helper</a></li> |
|
|
<li class="toctree-l2"><a class="reference internal" href="TermTk.TTkCore.log.html">TermTk.TTkCore.log</a></li> |
|
|
<li class="toctree-l2"><a class="reference internal" href="TermTk.TTkCore.propertyanimation.html">TermTk.TTkCore.propertyanimation</a></li> |
|
|
<li class="toctree-l2"><a class="reference internal" href="TermTk.TTkCore.signal.html">TermTk.TTkCore.signal</a></li> |
|
|
<li class="toctree-l2 current"><a class="current reference internal" href="#">TermTk.TTkCore.string</a><ul> |
|
|
<li class="toctree-l3"><a class="reference internal" href="#ttkstring">TTkString</a></li> |
|
|
</ul> |
|
|
</li> |
|
|
<li class="toctree-l2"><a class="reference internal" href="TermTk.TTkCore.timer.html">TermTk.TTkCore.timer</a></li> |
|
|
<li class="toctree-l2"><a class="reference internal" href="TermTk.TTkCore.timer_pyodide.html">TermTk.TTkCore.timer_pyodide</a></li> |
|
|
<li class="toctree-l2"><a class="reference internal" href="TermTk.TTkCore.timer_unix.html">TermTk.TTkCore.timer_unix</a></li> |
|
|
<li class="toctree-l2"><a class="reference internal" href="TermTk.TTkCore.ttk.html">TermTk.TTkCore.ttk</a></li> |
|
|
<li class="toctree-l2"><a class="reference internal" href="TermTk.TTkCore.util.html">TermTk.TTkCore.util</a></li> |
|
|
</ul> |
|
|
</li> |
|
|
<li class="toctree-l1"><a class="reference internal" href="TermTk.TTkCore.TTkTerm.html">TermTk.TTkCore.TTkTerm</a></li> |
|
|
<li class="toctree-l1"><a class="reference internal" href="TermTk.TTkGui.html">TermTk.TTkGui</a></li> |
|
|
<li class="toctree-l1"><a class="reference internal" href="TermTk.TTkLayouts.html">TermTk.TTkLayouts</a></li> |
|
|
<li class="toctree-l1"><a class="reference internal" href="TermTk.TTkTemplates.html">TermTk.TTkTemplates</a></li> |
|
|
<li class="toctree-l1"><a class="reference internal" href="TermTk.TTkTestWidgets.html">TermTk.TTkTestWidgets</a></li> |
|
|
<li class="toctree-l1"><a class="reference internal" href="TermTk.TTkTheme.html">TermTk.TTkTheme</a></li> |
|
|
<li class="toctree-l1"><a class="reference internal" href="TermTk.TTkTypes.html">TermTk.TTkTypes</a></li> |
|
|
<li class="toctree-l1"><a class="reference internal" href="TermTk.TTkUiTools.html">TermTk.TTkUiTools</a></li> |
|
|
<li class="toctree-l1"><a class="reference internal" href="TermTk.TTkWidgets.html">TermTk.TTkWidgets</a></li> |
|
|
<li class="toctree-l1"><a class="reference internal" href="TermTk.TTkWidgets.TTkModelView.html">TermTk.TTkWidgets.TTkModelView</a></li> |
|
|
<li class="toctree-l1"><a class="reference internal" href="TermTk.TTkWidgets.TTkPickers.html">TermTk.TTkWidgets.TTkPickers</a></li> |
|
|
<li class="toctree-l1"><a class="reference internal" href="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> »</li> |
|
|
<li><a href="TermTk.TTkCore.html">TermTk.TTkCore</a> »</li> |
|
|
<li>TermTk.TTkCore.string</li> |
|
|
<li class="wy-breadcrumbs-aside"> |
|
|
<a href="../_sources/autogen.TermTk/TermTk.TTkCore.string.rst.txt" rel="nofollow"> View page source</a> |
|
|
</li> |
|
|
</ul> |
|
|
<hr/> |
|
|
</div> |
|
|
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> |
|
|
<div itemprop="articleBody"> |
|
|
|
|
|
<section id="module-TermTk.TTkCore.string"> |
|
|
<span id="termtk-ttkcore-string"></span><h1>TermTk.TTkCore.string<a class="headerlink" href="#module-TermTk.TTkCore.string" title="Permalink to this heading"></a></h1> |
|
|
<section id="ttkstring"> |
|
|
<h2>TTkString<a class="headerlink" href="#ttkstring" title="Permalink to this heading"></a></h2> |
|
|
<dl class="py class"> |
|
|
<dt class="sig sig-object py" id="TermTk.TTkCore.string.TTkString"> |
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">TTkString</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">text</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">color</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/TermTk/TTkCore/string.html#TTkString"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#TermTk.TTkCore.string.TTkString" title="Permalink to this definition"></a></dt> |
|
|
<dd><p>TermTk String Helper</p> |
|
|
<p>The TTkString constructor creates a terminal String object.</p> |
|
|
<dl class="field-list simple"> |
|
|
<dt class="field-odd">Parameters</dt> |
|
|
<dd class="field-odd"><ul class="simple"> |
|
|
<li><p><strong>text</strong> (<em>str</em><em>, </em><em>optional</em>) – text of the string, defaults to “”</p></li> |
|
|
<li><p><strong>color</strong> (<a class="reference internal" href="TermTk.TTkCore.color.html#TermTk.TTkCore.color.TTkColor" title="TermTk.TTkCore.color.TTkColor"><code class="xref py py-class docutils literal notranslate"><span class="pre">TTkColor</span></code></a>, optional) – the color of the string, defaults to <a class="reference internal" href="TermTk.TTkCore.color.html#TermTk.TTkCore.color.TTkColor.RST" title="TermTk.TTkCore.color.TTkColor.RST"><code class="xref py py-class docutils literal notranslate"><span class="pre">RST</span></code></a></p></li> |
|
|
</ul> |
|
|
</dd> |
|
|
</dl> |
|
|
<p>Example:</p> |
|
|
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="c1"># No params Constructor</span> |
|
|
<span class="n">str1</span> <span class="o">=</span> <span class="n">TTkString</span><span class="p">()</span> <span class="o">+</span> <span class="s2">"test 1"</span> |
|
|
<span class="n">str2</span> <span class="o">=</span> <span class="n">TTkString</span><span class="p">()</span> <span class="o">+</span> <span class="n">TTkColor</span><span class="o">.</span><span class="n">BOLD</span> <span class="o">+</span> <span class="s2">"test 2"</span> |
|
|
|
|
|
<span class="c1"># Indexed params constructor</span> |
|
|
<span class="n">str3</span> <span class="o">=</span> <span class="n">TTkString</span><span class="p">(</span><span class="s2">"test 3"</span><span class="p">)</span> |
|
|
<span class="n">str4</span> <span class="o">=</span> <span class="n">TTkString</span><span class="p">(</span><span class="s2">"test 4"</span><span class="p">,</span> <span class="n">TTkColor</span><span class="o">.</span><span class="n">ITALIC</span><span class="p">)</span> |
|
|
|
|
|
<span class="c1"># Named params constructor</span> |
|
|
<span class="n">str5</span> <span class="o">=</span> <span class="n">TTkString</span><span class="p">(</span><span class="n">text</span><span class="o">=</span><span class="s2">"test 5"</span><span class="p">)</span> |
|
|
<span class="n">str6</span> <span class="o">=</span> <span class="n">TTkString</span><span class="p">(</span><span class="n">text</span><span class="o">=</span><span class="s2">"test 6"</span><span class="p">,</span> <span class="n">color</span><span class="o">=</span><span class="n">TTkColor</span><span class="o">.</span><span class="n">ITALIC</span><span class="o">+</span><span class="n">TTkColor</span><span class="o">.</span><span class="n">bg</span><span class="p">(</span><span class="s2">"000044"</span><span class="p">))</span> |
|
|
|
|
|
<span class="c1"># Combination of constructors (Highly Unrecommended)</span> |
|
|
<span class="n">str7</span> <span class="o">=</span> <span class="n">TTkString</span><span class="p">(</span><span class="s2">"test 7"</span><span class="p">,</span> <span class="n">color</span><span class="o">=</span><span class="n">TTkColor</span><span class="o">.</span><span class="n">fg</span><span class="p">(</span><span class="s1">'#FF0000'</span><span class="p">))</span> |
|
|
</pre></div> |
|
|
</div> |
|
|
<dl class="py method"> |
|
|
<dt class="sig sig-object py" id="TermTk.TTkCore.string.TTkString.align"> |
|
|
<span class="sig-name descname"><span class="pre">align</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">width=None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">color=<TermTk.TTkCore.color._TTkColor</span> <span class="pre">object></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">alignment=0</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/TermTk/TTkCore/string.html#TTkString.align"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#TermTk.TTkCore.string.TTkString.align" title="Permalink to this definition"></a></dt> |
|
|
<dd><p>Align the string</p> |
|
|
<dl class="field-list simple"> |
|
|
<dt class="field-odd">Parameters</dt> |
|
|
<dd class="field-odd"><ul class="simple"> |
|
|
<li><p><strong>width</strong> (<em>int</em><em>, </em><em>optional</em>) – the new width</p></li> |
|
|
<li><p><strong>color</strong> (<a class="reference internal" href="TermTk.TTkCore.color.html#TermTk.TTkCore.color.TTkColor" title="TermTk.TTkCore.color.TTkColor"><code class="xref py py-class docutils literal notranslate"><span class="pre">TTkColor</span></code></a>, optional) – the color of the padding, defaults to <a class="reference internal" href="TermTk.TTkCore.color.html#TermTk.TTkCore.color.TTkColor.RST" title="TermTk.TTkCore.color.TTkColor.RST"><code class="xref py py-class docutils literal notranslate"><span class="pre">RST</span></code></a></p></li> |
|
|
<li><p><strong>alignment</strong> (<a class="reference internal" href="TermTk.TTkCore.constant.html#TermTk.TTkCore.constant.TTkConstant.Alignment" title="TermTk.TTkCore.constant.TTkConstant.Alignment"><code class="xref py py-class docutils literal notranslate"><span class="pre">Alignment</span></code></a>, optional) – the alignment of the text to the full width <a class="reference internal" href="TermTk.TTkCore.constant.html#TermTk.TTkCore.constant.TTkConstant.Alignment.NONE" title="TermTk.TTkCore.constant.TTkConstant.Alignment.NONE"><code class="xref py py-class docutils literal notranslate"><span class="pre">NONE</span></code></a></p></li> |
|
|
</ul> |
|
|
</dd> |
|
|
</dl> |
|
|
</dd></dl> |
|
|
|
|
|
<dl class="py method"> |
|
|
<dt class="sig sig-object py" id="TermTk.TTkCore.string.TTkString.completeColor"> |
|
|
<span class="sig-name descname"><span class="pre">completeColor</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">color</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">match</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">posFrom</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">posTo</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/TermTk/TTkCore/string.html#TTkString.completeColor"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#TermTk.TTkCore.string.TTkString.completeColor" title="Permalink to this definition"></a></dt> |
|
|
<dd><p>Complete the color of the entire string or a slice of it</p> |
|
|
<p>The Fg and/or Bg of the string is replaced with the selected Fg/Bg color only if missing</p> |
|
|
<p>If only the color is specified, the entire string is colorized</p> |
|
|
<dl class="field-list simple"> |
|
|
<dt class="field-odd">Parameters</dt> |
|
|
<dd class="field-odd"><ul class="simple"> |
|
|
<li><p><strong>color</strong> (<a class="reference internal" href="TermTk.TTkCore.color.html#TermTk.TTkCore.color.TTkColor" title="TermTk.TTkCore.color.TTkColor"><code class="xref py py-class docutils literal notranslate"><span class="pre">TTkColor</span></code></a>) – the color to be used, defaults to <a class="reference internal" href="TermTk.TTkCore.color.html#TermTk.TTkCore.color.TTkColor.RST" title="TermTk.TTkCore.color.TTkColor.RST"><code class="xref py py-class docutils literal notranslate"><span class="pre">RST</span></code></a></p></li> |
|
|
<li><p><strong>match</strong> (<em>str</em><em>, </em><em>optional</em>) – the match to colorize</p></li> |
|
|
<li><p><strong>posFrom</strong> (<em>int</em><em>, </em><em>optional</em>) – the initial position of the color</p></li> |
|
|
<li><p><strong>posTo</strong> (<em>int</em><em>, </em><em>optional</em>) – the final position of the color</p></li> |
|
|
</ul> |
|
|
</dd> |
|
|
</dl> |
|
|
</dd></dl> |
|
|
|
|
|
<dl class="py method"> |
|
|
<dt class="sig sig-object py" id="TermTk.TTkCore.string.TTkString.findall"> |
|
|
<span class="sig-name descname"><span class="pre">findall</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">regexp</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ignoreCase</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/TermTk/TTkCore/string.html#TTkString.findall"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#TermTk.TTkCore.string.TTkString.findall" title="Permalink to this definition"></a></dt> |
|
|
<dd><p>FindAll the <strong>regexp</strong> matches in the string</p> |
|
|
<dl class="field-list simple"> |
|
|
<dt class="field-odd">Parameters</dt> |
|
|
<dd class="field-odd"><ul class="simple"> |
|
|
<li><p><strong>regexp</strong> (<em>str</em>) – the regular expression to be matched</p></li> |
|
|
<li><p><strong>ignoreCase</strong> (<em>bool</em>) – Ignore case, defaults to <strong>False</strong></p></li> |
|
|
</ul> |
|
|
</dd> |
|
|
</dl> |
|
|
</dd></dl> |
|
|
|
|
|
<dl class="py method"> |
|
|
<dt class="sig sig-object py" id="TermTk.TTkCore.string.TTkString.join"> |
|
|
<span class="sig-name descname"><span class="pre">join</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">strings</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/TermTk/TTkCore/string.html#TTkString.join"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#TermTk.TTkCore.string.TTkString.join" title="Permalink to this definition"></a></dt> |
|
|
<dd><p>Join the input strings using the current as separator</p> |
|
|
<dl class="field-list simple"> |
|
|
<dt class="field-odd">Parameters</dt> |
|
|
<dd class="field-odd"><p><strong>strings</strong> (<em>list</em>) – the list of strings to be joined</p> |
|
|
</dd> |
|
|
</dl> |
|
|
</dd></dl> |
|
|
|
|
|
<dl class="py method"> |
|
|
<dt class="sig sig-object py" id="TermTk.TTkCore.string.TTkString.replace"> |
|
|
<span class="sig-name descname"><span class="pre">replace</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/TermTk/TTkCore/string.html#TTkString.replace"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#TermTk.TTkCore.string.TTkString.replace" title="Permalink to this definition"></a></dt> |
|
|
<dd><p><strong>replace</strong> (<em>old</em>, <em>new</em>, <em>count</em>)</p> |
|
|
<p>Replace “<strong>old</strong>” match with “<strong>new</strong>” string for “<strong>count</strong>” times</p> |
|
|
<dl class="field-list simple"> |
|
|
<dt class="field-odd">Parameters</dt> |
|
|
<dd class="field-odd"><ul class="simple"> |
|
|
<li><p><strong>old</strong> (<em>str</em>) – the match to be placed</p></li> |
|
|
<li><p><strong>new</strong> (<em>str</em><em>, </em><em>optional</em>) – the match to replace</p></li> |
|
|
<li><p><strong>count</strong> (<em>int</em><em>, </em><em>optional</em>) – the number of occurrences</p></li> |
|
|
</ul> |
|
|
</dd> |
|
|
</dl> |
|
|
</dd></dl> |
|
|
|
|
|
<dl class="py method"> |
|
|
<dt class="sig sig-object py" id="TermTk.TTkCore.string.TTkString.search"> |
|
|
<span class="sig-name descname"><span class="pre">search</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">regexp</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ignoreCase</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/TermTk/TTkCore/string.html#TTkString.search"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#TermTk.TTkCore.string.TTkString.search" title="Permalink to this definition"></a></dt> |
|
|
<dd><p>Return the <strong>re.match</strong> of the <strong>regexp</strong></p> |
|
|
<dl class="field-list simple"> |
|
|
<dt class="field-odd">Parameters</dt> |
|
|
<dd class="field-odd"><ul class="simple"> |
|
|
<li><p><strong>regexp</strong> (<em>str</em>) – the regular expression to be matched</p></li> |
|
|
<li><p><strong>ignoreCase</strong> (<em>bool</em>) – Ignore case, defaults to <strong>False</strong></p></li> |
|
|
</ul> |
|
|
</dd> |
|
|
</dl> |
|
|
</dd></dl> |
|
|
|
|
|
<dl class="py method"> |
|
|
<dt class="sig sig-object py" id="TermTk.TTkCore.string.TTkString.setColor"> |
|
|
<span class="sig-name descname"><span class="pre">setColor</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">color</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">match</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">posFrom</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">posTo</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/TermTk/TTkCore/string.html#TTkString.setColor"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#TermTk.TTkCore.string.TTkString.setColor" title="Permalink to this definition"></a></dt> |
|
|
<dd><p>Set the color of the entire string or a slice of it</p> |
|
|
<p>If only the color is specified, the entire string is colorized</p> |
|
|
<dl class="field-list simple"> |
|
|
<dt class="field-odd">Parameters</dt> |
|
|
<dd class="field-odd"><ul class="simple"> |
|
|
<li><p><strong>color</strong> (<a class="reference internal" href="TermTk.TTkCore.color.html#TermTk.TTkCore.color.TTkColor" title="TermTk.TTkCore.color.TTkColor"><code class="xref py py-class docutils literal notranslate"><span class="pre">TTkColor</span></code></a>) – the color to be used, defaults to <a class="reference internal" href="TermTk.TTkCore.color.html#TermTk.TTkCore.color.TTkColor.RST" title="TermTk.TTkCore.color.TTkColor.RST"><code class="xref py py-class docutils literal notranslate"><span class="pre">RST</span></code></a></p></li> |
|
|
<li><p><strong>match</strong> (<em>str</em><em>, </em><em>optional</em>) – the match to colorize</p></li> |
|
|
<li><p><strong>posFrom</strong> (<em>int</em><em>, </em><em>optional</em>) – the initial position of the color</p></li> |
|
|
<li><p><strong>posTo</strong> (<em>int</em><em>, </em><em>optional</em>) – the final position of the color</p></li> |
|
|
</ul> |
|
|
</dd> |
|
|
</dl> |
|
|
</dd></dl> |
|
|
|
|
|
<dl class="py method"> |
|
|
<dt class="sig sig-object py" id="TermTk.TTkCore.string.TTkString.split"> |
|
|
<span class="sig-name descname"><span class="pre">split</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">separator</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/TermTk/TTkCore/string.html#TTkString.split"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#TermTk.TTkCore.string.TTkString.split" title="Permalink to this definition"></a></dt> |
|
|
<dd><p>Split the string using a separator</p> |
|
|
<div class="admonition note"> |
|
|
<p class="admonition-title">Note</p> |
|
|
<p>Only a one char separator is currently supported</p> |
|
|
</div> |
|
|
<dl class="field-list simple"> |
|
|
<dt class="field-odd">Parameters</dt> |
|
|
<dd class="field-odd"><p><strong>separator</strong> (<em>str</em>) – the “<strong>char</strong>” separator to be used</p> |
|
|
</dd> |
|
|
</dl> |
|
|
</dd></dl> |
|
|
|
|
|
<dl class="py method"> |
|
|
<dt class="sig sig-object py" id="TermTk.TTkCore.string.TTkString.substring"> |
|
|
<span class="sig-name descname"><span class="pre">substring</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">fr</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">to</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/TermTk/TTkCore/string.html#TTkString.substring"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#TermTk.TTkCore.string.TTkString.substring" title="Permalink to this definition"></a></dt> |
|
|
<dd><p>Return the substring</p> |
|
|
<dl class="field-list simple"> |
|
|
<dt class="field-odd">Parameters</dt> |
|
|
<dd class="field-odd"><ul class="simple"> |
|
|
<li><p><strong>fr</strong> (<em>int</em><em>, </em><em>optional</em>) – the starting of the slice, defaults to 0</p></li> |
|
|
<li><p><strong>to</strong> (<em>int</em><em>, </em><em>optional</em>) – the ending of the slice, defaults to the end of the string</p></li> |
|
|
</ul> |
|
|
</dd> |
|
|
</dl> |
|
|
</dd></dl> |
|
|
|
|
|
<dl class="py method"> |
|
|
<dt class="sig sig-object py" id="TermTk.TTkCore.string.TTkString.tab2spaces"> |
|
|
<span class="sig-name descname"><span class="pre">tab2spaces</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">tabSpaces</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">4</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/TermTk/TTkCore/string.html#TTkString.tab2spaces"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#TermTk.TTkCore.string.TTkString.tab2spaces" title="Permalink to this definition"></a></dt> |
|
|
<dd><p>Return the string representation with the tabs (converted in spaces) trimmed and aligned</p> |
|
|
</dd></dl> |
|
|
|
|
|
<dl class="py method"> |
|
|
<dt class="sig sig-object py" id="TermTk.TTkCore.string.TTkString.tabCharPos"> |
|
|
<span class="sig-name descname"><span class="pre">tabCharPos</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">pos</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tabSpaces</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">4</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">alignTabRight</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/TermTk/TTkCore/string.html#TTkString.tabCharPos"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#TermTk.TTkCore.string.TTkString.tabCharPos" title="Permalink to this definition"></a></dt> |
|
|
<dd><p>Return the char position in the string from the position in its representation with the tab and variable char sizes are solved</p> |
|
|
<p>i.e.</p> |
|
|
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>pos X = 11 |
|
|
tab2Spaces |----------|---------------------| |
|
|
Tabs |-| | |-| |-| | |
|
|
_text L😁rem ipsum dolor sit amet, |
|
|
chars .. ...t .....t .....t ...t..... |
|
|
ret x = 7 (tab is a char) |
|
|
</pre></div> |
|
|
</div> |
|
|
</dd></dl> |
|
|
|
|
|
<dl class="py method"> |
|
|
<dt class="sig sig-object py" id="TermTk.TTkCore.string.TTkString.toAnsi"> |
|
|
<span class="sig-name descname"><span class="pre">toAnsi</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">strip</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/TermTk/TTkCore/string.html#TTkString.toAnsi"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#TermTk.TTkCore.string.TTkString.toAnsi" title="Permalink to this definition"></a></dt> |
|
|
<dd><p>Return the ansii (terminal colors/events) representation of the string</p> |
|
|
</dd></dl> |
|
|
|
|
|
<dl class="py method"> |
|
|
<dt class="sig sig-object py" id="TermTk.TTkCore.string.TTkString.toAscii"> |
|
|
<span class="sig-name descname"><span class="pre">toAscii</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/TermTk/TTkCore/string.html#TTkString.toAscii"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#TermTk.TTkCore.string.TTkString.toAscii" title="Permalink to this definition"></a></dt> |
|
|
<dd><p>Return the ascii representation of the string</p> |
|
|
</dd></dl> |
|
|
|
|
|
</dd></dl> |
|
|
|
|
|
</section> |
|
|
</section> |
|
|
|
|
|
|
|
|
</div> |
|
|
</div> |
|
|
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer"> |
|
|
<a href="TermTk.TTkCore.signal.html" class="btn btn-neutral float-left" title="TermTk.TTkCore.signal" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> |
|
|
<a href="TermTk.TTkCore.timer.html" class="btn btn-neutral float-right" title="TermTk.TTkCore.timer" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a> |
|
|
</div> |
|
|
|
|
|
<hr/> |
|
|
|
|
|
<div role="contentinfo"> |
|
|
<p>© 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> |
