ACC SHELL

Path : /usr/share/doc/packages/yast2-backup/autodocs/
File Upload :
Current File : //usr/share/doc/packages/yast2-backup/autodocs/ui.html

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">

<html>
 <head>
  <title>

    Backup module
</title>
  <style type="text/css">body { background-color: #c8c8c8 }
h1 { color: #e00000 }
table { width: 100%/ border: none }
img { border: 0px }
.sigbox { background-color: #ffc080; border: solid thin #f96500 }
.sig { font: larger monospace }
.padtbl { background-color: #ffc080; padding: 10px; margin: 10px }
/* arrow */
.a { color: #606060 }
/* type, parameter */
.t, .p { color: #c05000 }
.pbox { width: 20% }
.descbox { }
.right { align: right }
.header {}
.footer { clear: both}
.menu { width: 10%; float: left }
.main { width: 90%; float: left }
</style>
 </head>
 <body>
  <div class="header">
   <i>YaST2 Developers Documentation:</i>
   <a href="index.html">
    <b>

    Backup module
</b>
   </a>
   <img class="right" alt="" src="/usr/share/doc/packages/yast2-devtools/images/yast2-mini.png" />
   <hr />
  </div>
  <div class="menu">
   <img alt="YaST" src="/usr/share/doc/packages/yast2-devtools/images/yast2-half.png" />
   <br />
   <br />
   <a href="index.html">functions</a>
   <br />
   <a href="files.html">files</a>
   <br />
   <a href="intro.html">intro</a>
  </div>
  <div class="main">
   <div class="sigbox">
    <table class="padtbl">
     <tr>
      <td>
       <h1>

    Backup module
</h1>
      </td>
      <td class="filecell">
    ui.ycp
</td>
     </tr>
     <tr>
      <td></td>
     </tr>
     <tr>
      <td>
       <ul>
        <li>    Ladislav Slezak <lslezak@suse.cz></li>
       </ul>
      </td>
     </tr>
     <tr>
      <td>
       <p>This module has an unstable interface.</p>
      </td>
     </tr>
    </table>
    <table class="padtbl">
     <tr>
      <td>

  Yast2 user interface functions - dialogs

       <h1>Imports</h1>
       <ul>
        <li>Backup</li>
        <li>Confirm</li>
        <li>Label</li>
        <li>Mode</li>
        <li>NetworkPopup</li>
        <li>Nfs</li>
        <li>PackageSystem</li>
        <li>Popup</li>
        <li>Popup</li>
        <li>Progress</li>
        <li>Report</li>
        <li>String</li>
        <li>Wizard</li>
       </ul>
       <h1>Includes</h1>
       <ul>
        <li>backup/functions.ycp</li>
        <li>backup/help_texts.ycp</li>
       </ul>
       <h1>Local Functions</h1>
       <ul>
        <li>
         <a href="#AbortNewProfileCreation">AbortNewProfileCreation (string profile_name)</a>
        </li>
        <li>
         <a href="#ArchDialog">ArchDialog ()</a>
        </li>
        <li>
         <a href="#ArchivingDialog">ArchivingDialog ()</a>
        </li>
        <li>
         <a href="#AskNewProfileName">AskNewProfileName (string current_name)</a>
        </li>
        <li>
         <a href="#BackupDialog">BackupDialog ()</a>
        </li>
        <li>
         <a href="#CheckFreeSpace">CheckFreeSpace ()</a>
        </li>
        <li>
         <a href="#ConstraintDialog">ConstraintDialog ()</a>
        </li>
        <li>
         <a href="#CronDialog">CronDialog ()</a>
        </li>
        <li>
         <a href="#DirPopup">DirPopup (string label, string dir)</a>
        </li>
        <li>
         <a href="#ExpertOptionsDialog">ExpertOptionsDialog ()</a>
        </li>
        <li>
         <a href="#FilesDialog">FilesDialog ()</a>
        </li>
        <li>
         <a href="#InitConstraintDialog">InitConstraintDialog ()</a>
        </li>
        <li>
         <a href="#InitSearchingModifiedDialog">InitSearchingModifiedDialog ()</a>
        </li>
        <li>
         <a href="#InstallNeededPackages">InstallNeededPackages (list&lt;string&gt; packages)</a>
        </li>
        <li>
         <a href="#PrepareSearching">PrepareSearching ()</a>
        </li>
        <li>
         <a href="#RedrawConstraintsTable">RedrawConstraintsTable ()</a>
        </li>
        <li>
         <a href="#RenameProfilePupupDialog">RenameProfilePupupDialog (string current_name)</a>
        </li>
        <li>
         <a href="#Search_ModifiedFiles">Search_ModifiedFiles ()</a>
        </li>
        <li>
         <a href="#Search_ProcessInstalledPackages">Search_ProcessInstalledPackages ()</a>
        </li>
        <li>
         <a href="#Search_ReadListOfFilesAndPackages">Search_ReadListOfFilesAndPackages ()</a>
        </li>
        <li>
         <a href="#SearchingModifiedDialog">SearchingModifiedDialog ()</a>
        </li>
        <li>
         <a href="#SelectProfileDialog">SelectProfileDialog ()</a>
        </li>
        <li>
         <a href="#SetDialogContents_SearchingFiles">SetDialogContents_SearchingFiles ()</a>
        </li>
        <li>
         <a href="#SetDialogContents_SearchingForModifiedFiles">SetDialogContents_SearchingForModifiedFiles (integer total_packages)</a>
        </li>
        <li>
         <a href="#SummaryDialog">SummaryDialog ()</a>
        </li>
        <li>
         <a href="#SystemBackupDialog">SystemBackupDialog ()</a>
        </li>
        <li>
         <a href="#TarOptionsDialog">TarOptionsDialog ()</a>
        </li>
        <li>
         <a href="#WriteArchive">WriteArchive ()</a>
        </li>
        <li>
         <a href="#check_space">check_space (integer found_size, string tmp_dir, string target_dir, symbol target_type)</a>
        </li>
        <li>
         <a href="#display_free_space_warning">display_free_space_warning (boolean fits, string dir)</a>
        </li>
        <li>
         <a href="#is_space">is_space (integer required, integer available, symbol target_type)</a>
        </li>
        <li>
         <a href="#list2items">list2items (integer start_id, string type, list&lt;string&gt; input)</a>
        </li>
        <li>
         <a href="#refresh_widget_status">refresh_widget_status (boolean enable_archive_type)</a>
        </li>
        <li>
         <a href="#size2map">size2map (integer sz)</a>
        </li>
        <li>
         <a href="#symbol2string">symbol2string (symbol s, integer user_size)</a>
        </li>
        <li>
         <a href="#update_cron_dialog">update_cron_dialog ()</a>
        </li>
        <li>
         <a href="#update_location_dialog">update_location_dialog ()</a>
        </li>
        <li>
         <a href="#waitForUserOrProcess">waitForUserOrProcess (integer wait, symbol abort_question)</a>
        </li>
       </ul>
      </td>
     </tr>
    </table>
   </div>
   <p />
   <div class="sigbox">
    <span class="sig" id="CheckFreeSpace">local
     <b>CheckFreeSpace ()
      <span class="a"> -&gt; </span>
      <span class="t">void</span>
     </b>
    </span>
   </div>
   <p>
 Function periodically checks the free space</p>
   <div class="sigbox">
    <span class="sig" id="waitForUserOrProcess">local
     <b>waitForUserOrProcess (integer wait, symbol abort_question)
      <span class="a"> -&gt; </span>
      <span class="t">symbol</span>
     </b>
    </span>
   </div>
   <p>
 Wait for output from subprocess or user action. If user press `abort button, then subprocess is terminated.</p>
   <dl>
    <dt>
     <b>Parameters:</b>
    </dt>
    <dd>
     <table>
      <tr>
       <td class="pbox">
        <span class="p">wait</span>
       </td>
       <td class="descbox">Delay in miliseconds between user action checks (if no output from subprocess is available)</td>
      </tr>
      <tr>
       <td class="pbox">
        <span class="p">abort_question</span>
       </td>
       <td class="descbox">Symbol for AbortConfirmation function - which dialog will be displayed if Abort button is pressed</td>
      </tr>
     </table>
    </dd>
   </dl>
   <dl>
    <dt>
     <b>Return value:</b>
    </dt>
    <dd>
     <table>
      <tr>
       <td class="pbox">
        <span class="t" />
       </td>
       <td class="descbox">Pressed button id or nil if some data is ready from subprocess.</td>
      </tr>
     </table>
    </dd>
   </dl>
   <div class="sigbox">
    <span class="sig" id="InstallNeededPackages">local
     <b>InstallNeededPackages (list&lt;string&gt; packages)
      <span class="a"> -&gt; </span>
      <span class="t">boolean</span>
     </b>
    </span>
   </div>
   <p>
 Function for installing packages</p>
   <dl>
    <dt>
     <b>Parameters:</b>
    </dt>
    <dd>
     <table>
      <tr>
       <td class="pbox">
        <span class="p">packages</span>
       </td>
       <td class="descbox"></td>
      </tr>
     </table>
    </dd>
   </dl>
   <div class="sigbox">
    <span class="sig" id="update_cron_dialog">local
     <b>update_cron_dialog ()
      <span class="a"> -&gt; </span>
      <span class="t">void</span>
     </b>
    </span>
   </div>
   <p>
 Update widget status in the dialog. Enable/disable widget according to
 checkbox/combobox value.</p>
   <div class="sigbox">
    <span class="sig" id="update_location_dialog">local
     <b>update_location_dialog ()
      <span class="a"> -&gt; </span>
      <span class="t">void</span>
     </b>
    </span>
   </div>
   <p>
 Refresh widget states in the location dialog</p>
   <div class="sigbox">
    <span class="sig" id="WriteArchive">local
     <b>WriteArchive ()
      <span class="a"> -&gt; </span>
      <span class="t">boolean</span>
     </b>
    </span>
   </div>
   <p>
 Ask whether archive can be overwritten if it already exists</p>
   <dl>
    <dt>
     <b>Return value:</b>
    </dt>
    <dd>
     <table>
      <tr>
       <td class="pbox">
        <span class="t" />
       </td>
       <td class="descbox">true when archive can be overwritten, nil when an error occured (e.g. NFS mount failed)</td>
      </tr>
     </table>
    </dd>
   </dl>
   <div class="sigbox">
    <span class="sig" id="CronDialog">local
     <b>CronDialog ()
      <span class="a"> -&gt; </span>
      <span class="t">symbol</span>
     </b>
    </span>
   </div>
   <p>
 Display dialog for automatic backup - set time when backup module will
 be started at background with current selected profile.</p>
   <dl>
    <dt>
     <b>Return value:</b>
    </dt>
    <dd>
     <table>
      <tr>
       <td class="pbox">
        <span class="t" />
       </td>
       <td class="descbox">User input value</td>
      </tr>
     </table>
    </dd>
   </dl>
   <div class="sigbox">
    <span class="sig" id="refresh_widget_status">local
     <b>refresh_widget_status (boolean enable_archive_type)
      <span class="a"> -&gt; </span>
      <span class="t">void</span>
     </b>
    </span>
   </div>
   <p>
 Refresh widget status (enable/disable) in the displayed dialog.</p>
   <dl>
    <dt>
     <b>Parameters:</b>
    </dt>
    <dd>
     <table>
      <tr>
       <td class="pbox">
        <span class="p">enable_archive_type</span>
       </td>
       <td class="descbox">if true enable archive selection combo box
	and option push button, select "archive" radio button.
	If enable_archive_type is false then disbale widgets, select
	"only list" radio button.</td>
      </tr>
     </table>
    </dd>
   </dl>
   <div class="sigbox">
    <span class="sig" id="AbortNewProfileCreation">local
     <b>AbortNewProfileCreation (string profile_name)
      <span class="a"> -&gt; </span>
      <span class="t">boolean</span>
     </b>
    </span>
   </div>
   <p>
 Dialog asks for aborting the new profile creation,
 If aborted, profile is deleted and true returned.</p>
   <dl>
    <dt>
     <b>Parameters:</b>
    </dt>
    <dd>
     <table>
      <tr>
       <td class="pbox">
        <span class="p">profile_name</span>
       </td>
       <td class="descbox"></td>
      </tr>
     </table>
    </dd>
   </dl>
   <dl>
    <dt>
     <b>Return value:</b>
    </dt>
    <dd>
     <table>
      <tr>
       <td class="pbox">
        <span class="t" />
       </td>
       <td class="descbox">whether `abort` meaning is returned</td>
      </tr>
     </table>
    </dd>
   </dl>
   <div class="sigbox">
    <span class="sig" id="ArchDialog">local
     <b>ArchDialog ()
      <span class="a"> -&gt; </span>
      <span class="t">symbol</span>
     </b>
    </span>
   </div>
   <p>
 Dialog for setting archive options</p>
   <dl>
    <dt>
     <b>Return value:</b>
    </dt>
    <dd>
     <table>
      <tr>
       <td class="pbox">
        <span class="t" />
       </td>
       <td class="descbox">Symbol for wizard sequencer - pressed button</td>
      </tr>
     </table>
    </dd>
   </dl>
   <div class="sigbox">
    <span class="sig" id="TarOptionsDialog">local
     <b>TarOptionsDialog ()
      <span class="a"> -&gt; </span>
      <span class="t">symbol</span>
     </b>
    </span>
   </div>
   <p>
 Setting multi volume archive options</p>
   <dl>
    <dt>
     <b>Return value:</b>
    </dt>
    <dd>
     <table>
      <tr>
       <td class="pbox">
        <span class="t" />
       </td>
       <td class="descbox">Symbol for wizard sequencer - pressed button</td>
      </tr>
     </table>
    </dd>
   </dl>
   <div class="sigbox">
    <span class="sig" id="BackupDialog">local
     <b>BackupDialog ()
      <span class="a"> -&gt; </span>
      <span class="t">symbol</span>
     </b>
    </span>
   </div>
   <p>
 Dialog for setting backup options</p>
   <dl>
    <dt>
     <b>Return value:</b>
    </dt>
    <dd>
     <table>
      <tr>
       <td class="pbox">
        <span class="t" />
       </td>
       <td class="descbox">Symbol for wizard sequencer - pressed button</td>
      </tr>
     </table>
    </dd>
   </dl>
   <div class="sigbox">
    <span class="sig" id="SystemBackupDialog">local
     <b>SystemBackupDialog ()
      <span class="a"> -&gt; </span>
      <span class="t">symbol</span>
     </b>
    </span>
   </div>
   <p>
 System area backup options</p>
   <dl>
    <dt>
     <b>Return value:</b>
    </dt>
    <dd>
     <table>
      <tr>
       <td class="pbox">
        <span class="t" />
       </td>
       <td class="descbox">Symbol for wizard sequencer - pressed button</td>
      </tr>
     </table>
    </dd>
   </dl>
   <div class="sigbox">
    <span class="sig" id="is_space">local
     <b>is_space (integer required, integer available, symbol target_type)
      <span class="a"> -&gt; </span>
      <span class="t">boolean</span>
     </b>
    </span>
   </div>
   <p>
 Check whether there is enough free space.</p>
   <dl>
    <dt>
     <b>Parameters:</b>
    </dt>
    <dd>
     <table>
      <tr>
       <td class="pbox">
        <span class="p">required</span>
       </td>
       <td class="descbox">required space in kB</td>
      </tr>
      <tr>
       <td class="pbox">
        <span class="p">available</span>
       </td>
       <td class="descbox">required space in kB</td>
      </tr>
      <tr>
       <td class="pbox">
        <span class="p">target_type</span>
       </td>
       <td class="descbox">selected target archive type</td>
      </tr>
     </table>
    </dd>
   </dl>
   <dl>
    <dt>
     <b>Return value:</b>
    </dt>
    <dd>
     <table>
      <tr>
       <td class="pbox">
        <span class="t" />
       </td>
       <td class="descbox">true = there is enough free space, false = not enough free space,
   nil = may be not enough space (compression is used, impossible to tell exactly)</td>
      </tr>
     </table>
    </dd>
   </dl>
   <div class="sigbox">
    <span class="sig" id="display_free_space_warning">local
     <b>display_free_space_warning (boolean fits, string dir)
      <span class="a"> -&gt; </span>
      <span class="t">boolean</span>
     </b>
    </span>
   </div>
   <p>
 Display warning dialog - there is (may) not enough free space in the directory.
 The dialog is not displayed when cron mode is active (there is no real UI).</p>
   <dl>
    <dt>
     <b>Parameters:</b>
    </dt>
    <dd>
     <table>
      <tr>
       <td class="pbox">
        <span class="p">fits</span>
       </td>
       <td class="descbox">if true no dialog is displayed, if false display "there is no space",
 if nil display "there may not be space"</td>
      </tr>
      <tr>
       <td class="pbox">
        <span class="p">dir</span>
       </td>
       <td class="descbox">directory</td>
      </tr>
     </table>
    </dd>
   </dl>
   <dl>
    <dt>
     <b>Return value:</b>
    </dt>
    <dd>
     <table>
      <tr>
       <td class="pbox">
        <span class="t" />
       </td>
       <td class="descbox">false = abort backup</td>
      </tr>
     </table>
    </dd>
   </dl>
   <div class="sigbox">
    <span class="sig" id="check_space">local
     <b>check_space (integer found_size, string tmp_dir, string target_dir, symbol target_type)
      <span class="a"> -&gt; </span>
      <span class="t">boolean</span>
     </b>
    </span>
   </div>
   <p>
 Check available free space and decide whether archive will fit</p>
   <dl>
    <dt>
     <b>Parameters:</b>
    </dt>
    <dd>
     <table>
      <tr>
       <td class="pbox">
        <span class="p">found_size</span>
       </td>
       <td class="descbox">total size of found files in bytes</td>
      </tr>
      <tr>
       <td class="pbox">
        <span class="p">tmp_dir</span>
       </td>
       <td class="descbox">selected temporary directory</td>
      </tr>
      <tr>
       <td class="pbox">
        <span class="p">target_dir</span>
       </td>
       <td class="descbox">target archive directory</td>
      </tr>
      <tr>
       <td class="pbox">
        <span class="p">target_type</span>
       </td>
       <td class="descbox">target archive type</td>
      </tr>
     </table>
    </dd>
   </dl>
   <dl>
    <dt>
     <b>Return value:</b>
    </dt>
    <dd>
     <table>
      <tr>
       <td class="pbox">
        <span class="t" />
       </td>
       <td class="descbox">true = archive fits, false = it doesn't fit,
    nil = may not fit (compression is used, there is no guarantee that
    archive will fit but it can be possible if compression ratio will
    be enough high</td>
      </tr>
     </table>
    </dd>
   </dl>
   <div class="sigbox">
    <span class="sig" id="SetDialogContents_SearchingForModifiedFiles">local
     <b>SetDialogContents_SearchingForModifiedFiles (integer total_packages)
      <span class="a"> -&gt; </span>
      <span class="t">void</span>
     </b>
    </span>
   </div>
   <p>
 Sets dialog contents - Searching for Modified Files</p>
   <dl>
    <dt>
     <b>Parameters:</b>
    </dt>
    <dd>
     <table>
      <tr>
       <td class="pbox">
        <span class="p">total_packages</span>
       </td>
       <td class="descbox"></td>
      </tr>
     </table>
    </dd>
   </dl>
   <div class="sigbox">
    <span class="sig" id="InitSearchingModifiedDialog">local
     <b>InitSearchingModifiedDialog ()
      <span class="a"> -&gt; </span>
      <span class="t">void</span>
     </b>
    </span>
   </div>
   <p>
 Initializes variables before the SearchingModifiedDialog</p>
   <div class="sigbox">
    <span class="sig" id="Search_ProcessInstalledPackages">local
     <b>Search_ProcessInstalledPackages ()
      <span class="a"> -&gt; </span>
      <span class="t">void</span>
     </b>
    </span>
   </div>
   <p>
 Takes care about installed packages</p>
   <div class="sigbox">
    <span class="sig" id="Search_ModifiedFiles">local
     <b>Search_ModifiedFiles ()
      <span class="a"> -&gt; </span>
      <span class="t">void</span>
     </b>
    </span>
   </div>
   <p>
 not sure</p>
   <div class="sigbox">
    <span class="sig" id="Search_ReadListOfFilesAndPackages">local
     <b>Search_ReadListOfFilesAndPackages ()
      <span class="a"> -&gt; </span>
      <span class="t">void</span>
     </b>
    </span>
   </div>
   <p>
 Reads list of packages files, installed packages</p>
   <div class="sigbox">
    <span class="sig" id="SetDialogContents_SearchingFiles">local
     <b>SetDialogContents_SearchingFiles ()
      <span class="a"> -&gt; </span>
      <span class="t">void</span>
     </b>
    </span>
   </div>
   <p>
 Function sets the dialog contents before searching files...</p>
   <div class="sigbox">
    <span class="sig" id="SearchingModifiedDialog">local
     <b>SearchingModifiedDialog ()
      <span class="a"> -&gt; </span>
      <span class="t">symbol</span>
     </b>
    </span>
   </div>
   <p>
 Display progress of searching modified files in packages</p>
   <dl>
    <dt>
     <b>Return value:</b>
    </dt>
    <dd>
     <table>
      <tr>
       <td class="pbox">
        <span class="t" />
       </td>
       <td class="descbox">Symbol for wizard sequencer - pressed button</td>
      </tr>
     </table>
    </dd>
   </dl>
   <div class="sigbox">
    <span class="sig" id="FilesDialog">local
     <b>FilesDialog ()
      <span class="a"> -&gt; </span>
      <span class="t">symbol</span>
     </b>
    </span>
   </div>
   <p>
 Display found files, user can select files to backup</p>
   <dl>
    <dt>
     <b>Return value:</b>
    </dt>
    <dd>
     <table>
      <tr>
       <td class="pbox">
        <span class="t" />
       </td>
       <td class="descbox">Symbol for wizard sequencer - pressed button</td>
      </tr>
     </table>
    </dd>
   </dl>
   <div class="sigbox">
    <span class="sig" id="ArchivingDialog">local
     <b>ArchivingDialog ()
      <span class="a"> -&gt; </span>
      <span class="t">symbol</span>
     </b>
    </span>
   </div>
   <p>
 Display progress of creating archive</p>
   <dl>
    <dt>
     <b>Return value:</b>
    </dt>
    <dd>
     <table>
      <tr>
       <td class="pbox">
        <span class="t" />
       </td>
       <td class="descbox">Symbol for wizard sequencer - pressed button</td>
      </tr>
     </table>
    </dd>
   </dl>
   <div class="sigbox">
    <span class="sig" id="AskNewProfileName">local
     <b>AskNewProfileName (string current_name)
      <span class="a"> -&gt; </span>
      <span class="t">string</span>
     </b>
    </span>
   </div>
   <p>
 Allow user to enter a new profile name. If the profile already exists, it allows
 to replace it. Allows to rename current profile if current_name in not nil or "".</p>
   <dl>
    <dt>
     <b>Parameters:</b>
    </dt>
    <dd>
     <table>
      <tr>
       <td class="pbox">
        <span class="p">current_name</span>
       </td>
       <td class="descbox"></td>
      </tr>
     </table>
    </dd>
   </dl>
   <dl>
    <dt>
     <b>Return value:</b>
    </dt>
    <dd>
     <table>
      <tr>
       <td class="pbox">
        <span class="t" />
       </td>
       <td class="descbox">the name for the new profile, "" for cancel</td>
      </tr>
     </table>
    </dd>
   </dl>
   <div class="sigbox">
    <span class="sig" id="SummaryDialog">local
     <b>SummaryDialog ()
      <span class="a"> -&gt; </span>
      <span class="t">symbol</span>
     </b>
    </span>
   </div>
   <p>
 Display backup summary</p>
   <dl>
    <dt>
     <b>Return value:</b>
    </dt>
    <dd>
     <table>
      <tr>
       <td class="pbox">
        <span class="t" />
       </td>
       <td class="descbox">Symbol for wizard sequencer - pressed button</td>
      </tr>
     </table>
    </dd>
   </dl>
   <div class="sigbox">
    <span class="sig" id="ExpertOptionsDialog">local
     <b>ExpertOptionsDialog ()
      <span class="a"> -&gt; </span>
      <span class="t">symbol</span>
     </b>
    </span>
   </div>
   <p>
 Display dialog with expert options (e.g. system area backup,
 temporary location...)</p>
   <dl>
    <dt>
     <b>Return value:</b>
    </dt>
    <dd>
     <table>
      <tr>
       <td class="pbox">
        <span class="t" />
       </td>
       <td class="descbox">user input - widget ID</td>
      </tr>
     </table>
    </dd>
   </dl>
   <div class="sigbox">
    <span class="sig" id="RenameProfilePupupDialog">local
     <b>RenameProfilePupupDialog (string current_name)
      <span class="a"> -&gt; </span>
      <span class="t">string</span>
     </b>
    </span>
   </div>
   <p>
 Displays a popup dialog asking for new name for the current profile.
 If nil returned, no redraw is needed, no changes are done.</p>
   <dl>
    <dt>
     <b>Parameters:</b>
    </dt>
    <dd>
     <table>
      <tr>
       <td class="pbox">
        <span class="p">current_name</span>
       </td>
       <td class="descbox"></td>
      </tr>
     </table>
    </dd>
   </dl>
   <div class="sigbox">
    <span class="sig" id="SelectProfileDialog">local
     <b>SelectProfileDialog ()
      <span class="a"> -&gt; </span>
      <span class="t">symbol</span>
     </b>
    </span>
   </div>
   <p>
 Dialog for selection of a profile before backup</p>
   <dl>
    <dt>
     <b>Return value:</b>
    </dt>
    <dd>
     <table>
      <tr>
       <td class="pbox">
        <span class="t" />
       </td>
       <td class="descbox">Symbol for wizard sequencer - pressed button</td>
      </tr>
     </table>
    </dd>
   </dl>
   <div class="sigbox">
    <span class="sig" id="PrepareSearching">local
     <b>PrepareSearching ()
      <span class="a"> -&gt; </span>
      <span class="t">symbol</span>
     </b>
    </span>
   </div>
   <p>
 Choose the next step - start searching or return to the profile dialog.</p>
   <dl>
    <dt>
     <b>Return value:</b>
    </dt>
    <dd>
     <table>
      <tr>
       <td class="pbox">
        <span class="t" />
       </td>
       <td class="descbox">Symbol for wizard sequencer - `next for searching, `next2 for return to profile dialog</td>
      </tr>
     </table>
    </dd>
   </dl>
   <div class="sigbox">
    <span class="sig" id="DirPopup">local
     <b>DirPopup (string label, string dir)
      <span class="a"> -&gt; </span>
      <span class="t">map</span>
     </b>
    </span>
   </div>
   <p>
 Directory selection dialog</p>
   <dl>
    <dt>
     <b>Parameters:</b>
    </dt>
    <dd>
     <table>
      <tr>
       <td class="pbox">
        <span class="p">label</span>
       </td>
       <td class="descbox">dialog label</td>
      </tr>
      <tr>
       <td class="pbox">
        <span class="p">dir</span>
       </td>
       <td class="descbox">start directory</td>
      </tr>
     </table>
    </dd>
   </dl>
   <dl>
    <dt>
     <b>Return value:</b>
    </dt>
    <dd>
     <table>
      <tr>
       <td class="pbox">
        <span class="t" />
       </td>
       <td class="descbox">result $[ "input" : symbol (user input, `ok or `cancel), "dir" : string (selected directory) ];</td>
      </tr>
     </table>
    </dd>
   </dl>
   <div class="sigbox">
    <span class="sig" id="size2map">local
     <b>size2map (integer sz)
      <span class="a"> -&gt; </span>
      <span class="t">map</span>
     </b>
    </span>
   </div>
   <p>
 Convert size in bytes to B, kiB, kB, MiB or MB</p>
   <dl>
    <dt>
     <b>Parameters:</b>
    </dt>
    <dd>
     <table>
      <tr>
       <td class="pbox">
        <span class="p">sz</span>
       </td>
       <td class="descbox">size in bytes</td>
      </tr>
     </table>
    </dd>
   </dl>
   <dl>
    <dt>
     <b>Return value:</b>
    </dt>
    <dd>
     <table>
      <tr>
       <td class="pbox">
        <span class="t" />
       </td>
       <td class="descbox">map $[ "string" : string (textual representation), "size" : integer (value), "unit" : symbol (unit of the value) ]</td>
      </tr>
     </table>
    </dd>
   </dl>
   <div class="sigbox">
    <span class="sig" id="symbol2string">local
     <b>symbol2string (symbol s, integer user_size)
      <span class="a"> -&gt; </span>
      <span class="t">string</span>
     </b>
    </span>
   </div>
   <p>
 Convert size description to string</p>
   <dl>
    <dt>
     <b>Parameters:</b>
    </dt>
    <dd>
     <table>
      <tr>
       <td class="pbox">
        <span class="p">s</span>
       </td>
       <td class="descbox">volume size</td>
      </tr>
      <tr>
       <td class="pbox">
        <span class="p">user_size</span>
       </td>
       <td class="descbox">user defined size</td>
      </tr>
     </table>
    </dd>
   </dl>
   <dl>
    <dt>
     <b>Return value:</b>
    </dt>
    <dd>
     <table>
      <tr>
       <td class="pbox">
        <span class="t" />
       </td>
       <td class="descbox">result</td>
      </tr>
     </table>
    </dd>
   </dl>
   <div class="sigbox">
    <span class="sig" id="list2items">local
     <b>list2items (integer start_id, string type, list&lt;string&gt; input)
      <span class="a"> -&gt; </span>
      <span class="t">list&lt;term&gt;</span>
     </b>
    </span>
   </div>
   <p>
 Convert list of strings to list of items</p>
   <dl>
    <dt>
     <b>Parameters:</b>
    </dt>
    <dd>
     <table>
      <tr>
       <td class="pbox">
        <span class="p">start_id</span>
       </td>
       <td class="descbox">identification of the first item</td>
      </tr>
      <tr>
       <td class="pbox">
        <span class="p">type</span>
       </td>
       <td class="descbox">description of item</td>
      </tr>
      <tr>
       <td class="pbox">
        <span class="p">input</span>
       </td>
       <td class="descbox">input</td>
      </tr>
     </table>
    </dd>
   </dl>
   <dl>
    <dt>
     <b>Return value:</b>
    </dt>
    <dd>
     <table>
      <tr>
       <td class="pbox">
        <span class="t" />
       </td>
       <td class="descbox">result</td>
      </tr>
     </table>
    </dd>
   </dl>
   <div class="sigbox">
    <span class="sig" id="RedrawConstraintsTable">local
     <b>RedrawConstraintsTable ()
      <span class="a"> -&gt; </span>
      <span class="t">void</span>
     </b>
    </span>
   </div>
   <p>
 Redraws contstraints table content -
 directories, regular expressions and
 file systems to exclude</p>
   <div class="sigbox">
    <span class="sig" id="InitConstraintDialog">local
     <b>InitConstraintDialog ()
      <span class="a"> -&gt; </span>
      <span class="t">symbol</span>
     </b>
    </span>
   </div>
   <p>
 Initialize the "Search Constraints" dialog</p>
   <div class="sigbox">
    <span class="sig" id="ConstraintDialog">local
     <b>ConstraintDialog ()
      <span class="a"> -&gt; </span>
      <span class="t">symbol</span>
     </b>
    </span>
   </div>
   <p>
 Dialog for setting excluded directories, file systems and reg. expressions</p>
   <dl>
    <dt>
     <b>Return value:</b>
    </dt>
    <dd>
     <table>
      <tr>
       <td class="pbox">
        <span class="t" />
       </td>
       <td class="descbox">Symbol for wizard sequencer - pressed button</td>
      </tr>
     </table>
    </dd>
   </dl>
  </div>
  <div class="footer">
   <hr />
   <i>YaST2 Developers Documentation</i>
   <img class="right" alt="" src="/usr/share/doc/packages/yast2-devtools/images/yast2-mini.png" />
  </div>
 </body>
</html>

ACC SHELL 2018