ACC SHELL

Path : /usr/share/doc/packages/yast2-bootloader/autodocs/
File Upload :
Current File : //usr/share/doc/packages/yast2-bootloader/autodocs/section_widgets.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>

      Bootloader installation and configuration
</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>

      Bootloader installation and configuration
</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>

      Bootloader installation and configuration
</h1>
      </td>
      <td class="filecell">
      include/bootloader/routines/widgets.ycp
</td>
     </tr>
     <tr>
      <td>
      Common widgets for being used by several bootloaders
</td>
     </tr>
     <tr>
      <td>
       <ul>
        <li>      Jiri Srain <jsrain@suse.cz></li>
        <li>      Olaf Dabrunz <od@suse.de></li>
        <li>      Josef Reidinger <jreidinger@suse.cz></li>
       </ul>
      </td>
     </tr>
     <tr>
      <td>
       <p>This module has an unstable interface.</p>
      </td>
     </tr>
    </table>
    <table class="padtbl">
     <tr>
      <td>


       <h1>Imports</h1>
       <ul>
        <li>BootStorage</li>
        <li>Bootloader</li>
        <li>CWM</li>
        <li>FileUtils</li>
        <li>Initrd</li>
        <li>Label</li>
        <li>Mode</li>
        <li>Popup</li>
        <li>Storage</li>
        <li>StorageDevices</li>
       </ul>
       <h1>Includes</h1>
       <ul>
        <li>bootloader/routines/helps.ycp</li>
        <li>bootloader/routines/section_helps.ycp</li>
       </ul>
       <h1>Local Variables</h1>
       <ul>
        <li>
         <a href="#_common_section_widgets">_common_section_widgets</a>
        </li>
        <li>
         <a href="#section_handlers">section_handlers</a>
        </li>
       </ul>
       <h1>Local Functions</h1>
       <ul>
        <li>
         <a href="#ChainloaderInit">ChainloaderInit (string widget)</a>
        </li>
        <li>
         <a href="#CommonSectionWidgets">CommonSectionWidgets ()</a>
        </li>
        <li>
         <a href="#HandleSectionBrowse">HandleSectionBrowse (string widget, map event)</a>
        </li>
        <li>
         <a href="#HandleSectionBrowseDirectory">HandleSectionBrowseDirectory (string widget, map event)</a>
        </li>
        <li>
         <a href="#RootDeviceHandle">RootDeviceHandle (string widget, map event)</a>
        </li>
        <li>
         <a href="#RootDeviceInit">RootDeviceInit (string widget)</a>
        </li>
        <li>
         <a href="#RootDeviceStore">RootDeviceStore (string widget, map event)</a>
        </li>
        <li>
         <a href="#SectionInputFieldBrowseWidget">SectionInputFieldBrowseWidget (string id)</a>
        </li>
        <li>
         <a href="#SectionNameStore">SectionNameStore (string widget, map event)</a>
        </li>
        <li>
         <a href="#SectionNameValidate">SectionNameValidate (string widget, map event)</a>
        </li>
        <li>
         <a href="#SectionOptionInit">SectionOptionInit (string widget)</a>
        </li>
        <li>
         <a href="#SectionOptionStore">SectionOptionStore (string widget, map event)</a>
        </li>
        <li>
         <a href="#SectionTypeHandle">SectionTypeHandle (string widget, map event)</a>
        </li>
        <li>
         <a href="#SectionTypesWidget">SectionTypesWidget ()</a>
        </li>
        <li>
         <a href="#VgaModeInit">VgaModeInit (string widget)</a>
        </li>
       </ul>
      </td>
     </tr>
    </table>
   </div>
   <p />
   <div class="sigbox">
    <span class="sig" id="SectionOptionInit">local
     <b>SectionOptionInit (string widget)
      <span class="a"> -&gt; </span>
      <span class="t">void</span>
     </b>
    </span>
   </div>
   <p>
 Init function for widget value</p>
   <dl>
    <dt>
     <b>Parameters:</b>
    </dt>
    <dd>
     <table>
      <tr>
       <td class="pbox">
        <span class="p">widget</span>
       </td>
       <td class="descbox">any id of the widget</td>
      </tr>
     </table>
    </dd>
   </dl>
   <div class="sigbox">
    <span class="sig" id="SectionOptionStore">local
     <b>SectionOptionStore (string widget, map event)
      <span class="a"> -&gt; </span>
      <span class="t">void</span>
     </b>
    </span>
   </div>
   <p>
 Store function of a widget</p>
   <dl>
    <dt>
     <b>Parameters:</b>
    </dt>
    <dd>
     <table>
      <tr>
       <td class="pbox">
        <span class="p">widget</span>
       </td>
       <td class="descbox">any widget key</td>
      </tr>
      <tr>
       <td class="pbox">
        <span class="p">event</span>
       </td>
       <td class="descbox">map event description of event that occured</td>
      </tr>
     </table>
    </dd>
   </dl>
   <div class="sigbox">
    <span class="sig" id="section_handlers">local
     <b>section_handlers
      <span class="a"> -&gt; </span>
      <span class="t">map&lt;string,any&gt;</span>
     </b>
    </span>
   </div>
   <p>
 Map of fallback handlers for events on sections</p>
   <div class="sigbox">
    <span class="sig" id="HandleSectionBrowse">local
     <b>HandleSectionBrowse (string widget, map event)
      <span class="a"> -&gt; </span>
      <span class="t">symbol</span>
     </b>
    </span>
   </div>
   <p>
 Handle function of a widget (InputField + browse button)</p>
   <dl>
    <dt>
     <b>Parameters:</b>
    </dt>
    <dd>
     <table>
      <tr>
       <td class="pbox">
        <span class="p">widget</span>
       </td>
       <td class="descbox">any widget key</td>
      </tr>
      <tr>
       <td class="pbox">
        <span class="p">event</span>
       </td>
       <td class="descbox">map event description of event that occured</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">nil</td>
      </tr>
     </table>
    </dd>
   </dl>
   <div class="sigbox">
    <span class="sig" id="HandleSectionBrowseDirectory">local
     <b>HandleSectionBrowseDirectory (string widget, map event)
      <span class="a"> -&gt; </span>
      <span class="t">symbol</span>
     </b>
    </span>
   </div>
   <p>
 Handle function of a widget (InputField + browse button)
 Asks for directory instead file</p>
   <dl>
    <dt>
     <b>Parameters:</b>
    </dt>
    <dd>
     <table>
      <tr>
       <td class="pbox">
        <span class="p">widget</span>
       </td>
       <td class="descbox">any widget key</td>
      </tr>
      <tr>
       <td class="pbox">
        <span class="p">event</span>
       </td>
       <td class="descbox">map event description of event that occured</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">nil</td>
      </tr>
     </table>
    </dd>
   </dl>
   <div class="sigbox">
    <span class="sig" id="SectionInputFieldBrowseWidget">local
     <b>SectionInputFieldBrowseWidget (string id)
      <span class="a"> -&gt; </span>
      <span class="t">map&lt;string,any&gt;</span>
     </b>
    </span>
   </div>
   <p>
 Generic widget of a inputfield + browse button
 Use validation function from  validation_map
 if it is necessary create own definition of widget</p>
   <dl>
    <dt>
     <b>Parameters:</b>
    </dt>
    <dd>
     <table>
      <tr>
       <td class="pbox">
        <span class="p">id</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">CWS widget</td>
      </tr>
     </table>
    </dd>
   </dl>
   <div class="sigbox">
    <span class="sig" id="SectionNameValidate">local
     <b>SectionNameValidate (string widget, map event)
      <span class="a"> -&gt; </span>
      <span class="t">boolean</span>
     </b>
    </span>
   </div>
   <p>
 Validate function of the name widget</p>
   <dl>
    <dt>
     <b>Parameters:</b>
    </dt>
    <dd>
     <table>
      <tr>
       <td class="pbox">
        <span class="p">widget</span>
       </td>
       <td class="descbox">any widget key</td>
      </tr>
      <tr>
       <td class="pbox">
        <span class="p">event</span>
       </td>
       <td class="descbox">map event description of event that occured</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 if widget settings ok</td>
      </tr>
     </table>
    </dd>
   </dl>
   <div class="sigbox">
    <span class="sig" id="SectionNameStore">local
     <b>SectionNameStore (string widget, map event)
      <span class="a"> -&gt; </span>
      <span class="t">void</span>
     </b>
    </span>
   </div>
   <p>
 Store function of the name widget</p>
   <dl>
    <dt>
     <b>Parameters:</b>
    </dt>
    <dd>
     <table>
      <tr>
       <td class="pbox">
        <span class="p">widget</span>
       </td>
       <td class="descbox">any widget key</td>
      </tr>
      <tr>
       <td class="pbox">
        <span class="p">event</span>
       </td>
       <td class="descbox">map event description of event that occured</td>
      </tr>
     </table>
    </dd>
   </dl>
   <div class="sigbox">
    <span class="sig" id="RootDeviceInit">local
     <b>RootDeviceInit (string widget)
      <span class="a"> -&gt; </span>
      <span class="t">void</span>
     </b>
    </span>
   </div>
   <p>
 Init function of the root device widget</p>
   <dl>
    <dt>
     <b>Parameters:</b>
    </dt>
    <dd>
     <table>
      <tr>
       <td class="pbox">
        <span class="p">widget</span>
       </td>
       <td class="descbox">any id of the widget</td>
      </tr>
     </table>
    </dd>
   </dl>
   <div class="sigbox">
    <span class="sig" id="RootDeviceStore">local
     <b>RootDeviceStore (string widget, map event)
      <span class="a"> -&gt; </span>
      <span class="t">void</span>
     </b>
    </span>
   </div>
   <p>
 Store function of the root device widget</p>
   <dl>
    <dt>
     <b>Parameters:</b>
    </dt>
    <dd>
     <table>
      <tr>
       <td class="pbox">
        <span class="p">widget</span>
       </td>
       <td class="descbox">any widget key</td>
      </tr>
      <tr>
       <td class="pbox">
        <span class="p">event</span>
       </td>
       <td class="descbox">map event description of event that occured</td>
      </tr>
     </table>
    </dd>
   </dl>
   <div class="sigbox">
    <span class="sig" id="RootDeviceHandle">local
     <b>RootDeviceHandle (string widget, map event)
      <span class="a"> -&gt; </span>
      <span class="t">symbol</span>
     </b>
    </span>
   </div>
   <p>
 Handle function of the root device widget</p>
   <dl>
    <dt>
     <b>Parameters:</b>
    </dt>
    <dd>
     <table>
      <tr>
       <td class="pbox">
        <span class="p">widget</span>
       </td>
       <td class="descbox">any widget key</td>
      </tr>
      <tr>
       <td class="pbox">
        <span class="p">event</span>
       </td>
       <td class="descbox">map event description of event that occured</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">to return to wizard sequencer, or nil</td>
      </tr>
     </table>
    </dd>
   </dl>
   <div class="sigbox">
    <span class="sig" id="VgaModeInit">local
     <b>VgaModeInit (string widget)
      <span class="a"> -&gt; </span>
      <span class="t">void</span>
     </b>
    </span>
   </div>
   <p>
 Init function of widget</p>
   <dl>
    <dt>
     <b>Parameters:</b>
    </dt>
    <dd>
     <table>
      <tr>
       <td class="pbox">
        <span class="p">widget</span>
       </td>
       <td class="descbox">any id of the widget</td>
      </tr>
     </table>
    </dd>
   </dl>
   <div class="sigbox">
    <span class="sig" id="ChainloaderInit">local
     <b>ChainloaderInit (string widget)
      <span class="a"> -&gt; </span>
      <span class="t">void</span>
     </b>
    </span>
   </div>
   <p>
 Init function of widget</p>
   <dl>
    <dt>
     <b>Parameters:</b>
    </dt>
    <dd>
     <table>
      <tr>
       <td class="pbox">
        <span class="p">widget</span>
       </td>
       <td class="descbox">any id of the widget</td>
      </tr>
     </table>
    </dd>
   </dl>
   <div class="sigbox">
    <span class="sig" id="SectionTypesWidget">local
     <b>SectionTypesWidget ()
      <span class="a"> -&gt; </span>
      <span class="t">term</span>
     </b>
    </span>
   </div>
   <p>
 Widget for selecting section type</p>
   <dl>
    <dt>
     <b>Return value:</b>
    </dt>
    <dd>
     <table>
      <tr>
       <td class="pbox">
        <span class="t" />
       </td>
       <td class="descbox">widget</td>
      </tr>
     </table>
    </dd>
   </dl>
   <div class="sigbox">
    <span class="sig" id="SectionTypeHandle">local
     <b>SectionTypeHandle (string widget, map event)
      <span class="a"> -&gt; </span>
      <span class="t">symbol</span>
     </b>
    </span>
   </div>
   <p>
 Handle function of a widget</p>
   <dl>
    <dt>
     <b>Parameters:</b>
    </dt>
    <dd>
     <table>
      <tr>
       <td class="pbox">
        <span class="p">widget</span>
       </td>
       <td class="descbox">string widget key</td>
      </tr>
      <tr>
       <td class="pbox">
        <span class="p">event</span>
       </td>
       <td class="descbox">map event description of event that occured</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">to return to wizard sequencer, or nil</td>
      </tr>
     </table>
    </dd>
   </dl>
   <div class="sigbox">
    <span class="sig" id="_common_section_widgets">local
     <b>_common_section_widgets
      <span class="a"> -&gt; </span>
      <span class="t">map&lt;string,map&lt;string,any&gt; &gt;</span>
     </b>
    </span>
   </div>
   <p>
 Cache for CommonSectionWidgets</p>
   <div class="sigbox">
    <span class="sig" id="CommonSectionWidgets">local
     <b>CommonSectionWidgets ()
      <span class="a"> -&gt; </span>
      <span class="t">map&lt;string,map&lt;string,any&gt; &gt;</span>
     </b>
    </span>
   </div>
   <p>
 Get common widgets for loader sections</p>
   <dl>
    <dt>
     <b>Return value:</b>
    </dt>
    <dd>
     <table>
      <tr>
       <td class="pbox">
        <span class="t" />
       </td>
       <td class="descbox">a map describing common loader section related widgets</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