--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/eric7/Documentation/Source/eric7.eric7_post_install.html Mon May 24 11:19:57 2021 +0200 @@ -0,0 +1,259 @@ +<!DOCTYPE html> +<html><head> +<title>eric7.eric7_post_install</title> +<meta charset="UTF-8"> +<style> +body { + background: #EDECE6; + margin: 0em 1em 10em 1em; + color: black; +} + +h1 { color: white; background: #85774A; } +h2 { color: white; background: #85774A; } +h3 { color: white; background: #9D936E; } +h4 { color: white; background: #9D936E; } + +a { color: #BA6D36; } + +</style> +</head> +<body> +<a NAME="top" ID="top"></a> +<h1>eric7.eric7_post_install</h1> + +<p> +Module implementing the post install logic for 'pip install'. +</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="#copyDesktopFile">copyDesktopFile</a></td> +<td>Modify a desktop file and write it to its destination.</td> +</tr> +<tr> +<td><a href="#copyLinuxMetaData">copyLinuxMetaData</a></td> +<td>Function to copy the meta data files.</td> +</tr> +<tr> +<td><a href="#copyMetaFilesTree">copyMetaFilesTree</a></td> +<td>Function to copy the files of a directory tree.</td> +</tr> +<tr> +<td><a href="#createWindowsLinks">createWindowsLinks</a></td> +<td>Create Desktop and Start Menu links.</td> +</tr> +<tr> +<td><a href="#createWindowsShortcut">createWindowsShortcut</a></td> +<td>Create Windows shortcut.</td> +</tr> +<tr> +<td><a href="#getWinregEntry">getWinregEntry</a></td> +<td>Function to get an entry from the Windows Registry.</td> +</tr> +<tr> +<td><a href="#main">main</a></td> +<td>Main script orchestrating the platform dependent post installation tasks.</td> +</tr> +<tr> +<td><a href="#windowsDesktopEntries">windowsDesktopEntries</a></td> +<td>Function to generate data for the Windows Desktop links.</td> +</tr> +<tr> +<td><a href="#windowsProgramsEntry">windowsProgramsEntry</a></td> +<td>Function to generate the name of the Start Menu top entry.</td> +</tr> +</table> +<hr /> +<hr /> +<a NAME="copyDesktopFile" ID="copyDesktopFile"></a> +<h2>copyDesktopFile</h2> +<b>copyDesktopFile</b>(<i>src, dst, scriptsdir</i>) + +<p> + Modify a desktop file and write it to its destination. +</p> +<dl> + +<dt><i>src</i></dt> +<dd> +source file name (string) +</dd> +<dt><i>dst</i></dt> +<dd> +destination file name (string) +</dd> +<dt><i>scriptsdir</i></dt> +<dd> +directory containing the scripts (string) +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +<hr /> +<a NAME="copyLinuxMetaData" ID="copyLinuxMetaData"></a> +<h2>copyLinuxMetaData</h2> +<b>copyLinuxMetaData</b>(<i></i>) + +<p> + Function to copy the meta data files. +</p> +<div align="right"><a href="#top">Up</a></div> +<hr /> +<hr /> +<a NAME="copyMetaFilesTree" ID="copyMetaFilesTree"></a> +<h2>copyMetaFilesTree</h2> +<b>copyMetaFilesTree</b>(<i>src, dst</i>) + +<p> + Function to copy the files of a directory tree. +</p> +<dl> + +<dt><i>src</i></dt> +<dd> +name of the source directory +</dd> +<dt><i>dst</i></dt> +<dd> +name of the destination directory +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +<hr /> +<a NAME="createWindowsLinks" ID="createWindowsLinks"></a> +<h2>createWindowsLinks</h2> +<b>createWindowsLinks</b>(<i></i>) + +<p> + Create Desktop and Start Menu links. +</p> +<div align="right"><a href="#top">Up</a></div> +<hr /> +<hr /> +<a NAME="createWindowsShortcut" ID="createWindowsShortcut"></a> +<h2>createWindowsShortcut</h2> +<b>createWindowsShortcut</b>(<i>linkPath, targetPath, iconPath</i>) + +<p> + Create Windows shortcut. +</p> +<dl> + +<dt><i>linkPath</i> (str)</dt> +<dd> +path of the shortcut file +</dd> +<dt><i>targetPath</i> (str)</dt> +<dd> +path the shortcut shall point to +</dd> +<dt><i>iconPath</i> (str)</dt> +<dd> +path of the icon file +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +<hr /> +<a NAME="getWinregEntry" ID="getWinregEntry"></a> +<h2>getWinregEntry</h2> +<b>getWinregEntry</b>(<i>name, path</i>) + +<p> + Function to get an entry from the Windows Registry. +</p> +<dl> + +<dt><i>name</i> (str)</dt> +<dd> +variable name +</dd> +<dt><i>path</i> (str)</dt> +<dd> +registry path of the variable +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +value of requested registry variable +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +any +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +<hr /> +<a NAME="main" ID="main"></a> +<h2>main</h2> +<b>main</b>(<i></i>) + +<p> + Main script orchestrating the platform dependent post installation tasks. +</p> +<div align="right"><a href="#top">Up</a></div> +<hr /> +<hr /> +<a NAME="windowsDesktopEntries" ID="windowsDesktopEntries"></a> +<h2>windowsDesktopEntries</h2> +<b>windowsDesktopEntries</b>(<i></i>) + +<p> + Function to generate data for the Windows Desktop links. +</p> +<dl> +<dt>Return:</dt> +<dd> +list of tuples containing the desktop link name, + the link target and the icon target +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +list of tuples of (str, str, str) +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +<hr /> +<a NAME="windowsProgramsEntry" ID="windowsProgramsEntry"></a> +<h2>windowsProgramsEntry</h2> +<b>windowsProgramsEntry</b>(<i></i>) + +<p> + Function to generate the name of the Start Menu top entry. +</p> +<dl> +<dt>Return:</dt> +<dd> +name of the Start Menu top entry +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html> \ No newline at end of file