src/eric7/Documentation/Source/eric7.Plugins.WizardPlugins.QRegularExpressionWizard.QRegularExpressionWizardServer.html

Fri, 22 Dec 2023 19:45:17 +0100

author
Detlev Offenbach <detlev@die-offenbachs.de>
date
Fri, 22 Dec 2023 19:45:17 +0100
branch
eric7
changeset 10437
2f70ca07f0af
parent 9209
b99e7fd55fd3
child 10479
856476537696
permissions
-rw-r--r--

Converted some source code documentation to the new style.

<!DOCTYPE html>
<html><head>
<title>eric7.Plugins.WizardPlugins.QRegularExpressionWizard.QRegularExpressionWizardServer</title>
<meta charset="UTF-8">
<link rel="stylesheet" href="styles.css">
</head>
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.Plugins.WizardPlugins.QRegularExpressionWizard.QRegularExpressionWizardServer</h1>

<p>
Module implementing the PyQt6 server part of the QRegularExpression wizzard.
</p>
<h3>Global Attributes</h3>

<table>
<tr><td>None</td></tr>
</table>
<h3>Classes</h3>

<table>
<tr><td>None</td></tr>
</table>
<h3>Functions</h3>

<table>

<tr>
<td><a href="#main">main</a></td>
<td>Function containing the main routine.</td>
</tr>
<tr>
<td><a href="#rxExecute">rxExecute</a></td>
<td>Function to execute the given regular expression for a given text.</td>
</tr>
<tr>
<td><a href="#rxValidate">rxValidate</a></td>
<td>Function to validate the given regular expression.</td>
</tr>
</table>
<hr />
<hr />
<a NAME="main" ID="main"></a>
<h2>main</h2>
<b>main</b>(<i></i>)

<p>
    Function containing the main routine.
</p>
<div align="right"><a href="#top">Up</a></div>
<hr />
<hr />
<a NAME="rxExecute" ID="rxExecute"></a>
<h2>rxExecute</h2>
<b>rxExecute</b>(<i>regexp, options, text, startpos</i>)

<p>
    Function to execute the given regular expression for a given text.
</p>
<dl>

<dt><i>regexp</i> (str)</dt>
<dd>
regular expression to validate
</dd>
<dt><i>options</i> (list of str)</dt>
<dd>
list of options
</dd>
<dt><i>text</i> (str)</dt>
<dd>
text to execute on
</dd>
<dt><i>startpos</i> (int)</dt>
<dd>
start position for the execution
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
tuple of a flag indicating a successful match and a list of captures
        containing the complete match as matched string, match start, match end
        and match length for each entry
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
tuple of (bool, list of [str, int, int, int])
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
<hr />
<a NAME="rxValidate" ID="rxValidate"></a>
<h2>rxValidate</h2>
<b>rxValidate</b>(<i>regexp, options</i>)

<p>
    Function to validate the given regular expression.
</p>
<dl>

<dt><i>regexp</i> (str)</dt>
<dd>
regular expression to validate
</dd>
<dt><i>options</i> (list of str)</dt>
<dd>
list of options
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
tuple of flag indicating validity, error string and error offset
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
tuple of (bool, str, int)
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>

eric ide

mercurial