<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <meta http-equiv="X-UA-Compatible" content="IE=9"/> <meta name="generator" content="Doxygen 1.8.5"/> <title>libyui: YEnvVar Class Reference</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="jquery.js"></script> <script type="text/javascript" src="dynsections.js"></script> <link href="navtree.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="resize.js"></script> <script type="text/javascript" src="navtree.js"></script> <script type="text/javascript"> $(document).ready(initResizable); $(window).load(resizeHeight); </script> <link href="search/search.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="search/search.js"></script> <script type="text/javascript"> $(document).ready(function() { searchBox.OnSelectItem(0); }); </script> <link href="doxygen.css" rel="stylesheet" type="text/css" /> </head> <body> <div id="top"><!-- do not remove this div, it is closed by doxygen! --> <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;"> <td style="padding-left: 0.5em;"> <div id="projectname">libyui  <span id="projectnumber">3.0.10</span> </div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.5 --> <script type="text/javascript"> var searchBox = new SearchBox("searchBox", "search",false,'Search'); </script> <div id="navrow1" class="tabs"> <ul class="tablist"> <li><a href="index.html"><span>Main Page</span></a></li> <li class="current"><a href="annotated.html"><span>Classes</span></a></li> <li><a href="files.html"><span>Files</span></a></li> <li> <div id="MSearchBox" class="MSearchBoxInactive"> <span class="left"> <img id="MSearchSelect" src="search/mag_sel.png" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" alt=""/> <input type="text" id="MSearchField" value="Search" accesskey="S" onfocus="searchBox.OnSearchFieldFocus(true)" onblur="searchBox.OnSearchFieldFocus(false)" onkeyup="searchBox.OnSearchFieldChange(event)"/> </span><span class="right"> <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> </span> </div> </li> </ul> </div> <div id="navrow2" class="tabs2"> <ul class="tablist"> <li><a href="annotated.html"><span>Class List</span></a></li> <li><a href="classes.html"><span>Class Index</span></a></li> <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> <li><a href="functions.html"><span>Class Members</span></a></li> </ul> </div> </div><!-- top --> <div id="side-nav" class="ui-resizable side-nav-resizable"> <div id="nav-tree"> <div id="nav-tree-contents"> <div id="nav-sync" class="sync"></div> </div> </div> <div id="splitbar" style="-moz-user-select:none;" class="ui-resizable-handle"> </div> </div> <script type="text/javascript"> $(document).ready(function(){initNavTree('classYEnvVar.html','');}); </script> <div id="doc-content"> <!-- window showing the filter options --> <div id="MSearchSelectWindow" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" onkeydown="return searchBox.OnSearchSelectKey(event)"> <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Friends</a></div> <!-- iframe showing the search results (closed by default) --> <div id="MSearchResultsWindow"> <iframe src="javascript:void(0)" frameborder="0" name="MSearchResults" id="MSearchResults"> </iframe> </div> <div class="header"> <div class="summary"> <a href="#pub-methods">Public Member Functions</a> | <a href="classYEnvVar-members.html">List of all members</a> </div> <div class="headertitle"> <div class="title">YEnvVar Class Reference</div> </div> </div><!--header--> <div class="contents"> <p><code>#include <<a class="el" href="YEnvVar_8h_source.html">YEnvVar.h</a>></code></p> <table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> Public Member Functions</h2></td></tr> <tr class="memitem:aa81512c8782126fb693b7e144534fa2b"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classYEnvVar.html#aa81512c8782126fb693b7e144534fa2b">YEnvVar</a> (const std::string &<a class="el" href="classYEnvVar.html#aeccbf267e91b9da07d103ec4f6e8acf9">name</a>=std::string())</td></tr> <tr class="separator:aa81512c8782126fb693b7e144534fa2b"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:aeccbf267e91b9da07d103ec4f6e8acf9"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classYEnvVar.html#aeccbf267e91b9da07d103ec4f6e8acf9">name</a> () const </td></tr> <tr class="separator:aeccbf267e91b9da07d103ec4f6e8acf9"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a3b061a18bd03eeb25f73c3bdcddd439c"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classYEnvVar.html#a3b061a18bd03eeb25f73c3bdcddd439c">isSet</a> () const </td></tr> <tr class="separator:a3b061a18bd03eeb25f73c3bdcddd439c"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a7705ff5c9c0690311989c578b1596582"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classYEnvVar.html#a7705ff5c9c0690311989c578b1596582">value</a> () const </td></tr> <tr class="separator:a7705ff5c9c0690311989c578b1596582"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a6f669f5c7eb3ac6c07e879b3db8e2f5f"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classYEnvVar.html#a6f669f5c7eb3ac6c07e879b3db8e2f5f">isEqual</a> (const std::string &str, bool caseSensitive=false) const </td></tr> <tr class="separator:a6f669f5c7eb3ac6c07e879b3db8e2f5f"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a871a4c1c1f4f45239bdafbb20885f1a0"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classYEnvVar.html#a871a4c1c1f4f45239bdafbb20885f1a0">operator==</a> (const std::string &str) const </td></tr> <tr class="separator:a871a4c1c1f4f45239bdafbb20885f1a0"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a269eea5ecc1d84568997efd125f4aec6"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classYEnvVar.html#a269eea5ecc1d84568997efd125f4aec6">contains</a> (const std::string &str, bool caseSensitive=false) const </td></tr> <tr class="separator:a269eea5ecc1d84568997efd125f4aec6"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <div class="textblock"><p>Helper class to represent an environment variable and its value. </p> <p>Definition at line <a class="el" href="YEnvVar_8h_source.html#l00036">36</a> of file <a class="el" href="YEnvVar_8h_source.html">YEnvVar.h</a>.</p> </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> <a class="anchor" id="aa81512c8782126fb693b7e144534fa2b"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">YEnvVar::YEnvVar </td> <td>(</td> <td class="paramtype">const std::string & </td> <td class="paramname"><em>name</em> = <code>std::string()</code></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Constructor: Retrieve the environment variable 'name' and store the value (unless 'name' is empty). </p> <p>Definition at line <a class="el" href="YEnvVar_8cc_source.html#l00036">36</a> of file <a class="el" href="YEnvVar_8cc_source.html">YEnvVar.cc</a>.</p> </div> </div> <h2 class="groupheader">Member Function Documentation</h2> <a class="anchor" id="a269eea5ecc1d84568997efd125f4aec6"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool YEnvVar::contains </td> <td>(</td> <td class="paramtype">const std::string & </td> <td class="paramname"><em>str</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">bool </td> <td class="paramname"><em>caseSensitive</em> = <code>false</code> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td> const</td> </tr> </table> </div><div class="memdoc"> <p>Return 'true' if the environment variable is set and the value contains 'str'. </p> <p>Definition at line <a class="el" href="YEnvVar_8cc_source.html#l00066">66</a> of file <a class="el" href="YEnvVar_8cc_source.html">YEnvVar.cc</a>.</p> </div> </div> <a class="anchor" id="a6f669f5c7eb3ac6c07e879b3db8e2f5f"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool YEnvVar::isEqual </td> <td>(</td> <td class="paramtype">const std::string & </td> <td class="paramname"><em>str</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">bool </td> <td class="paramname"><em>caseSensitive</em> = <code>false</code> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td> const</td> </tr> </table> </div><div class="memdoc"> <p>Return 'true' if the environment variable is set and the value is 'str'. </p> <p>Definition at line <a class="el" href="YEnvVar_8cc_source.html#l00054">54</a> of file <a class="el" href="YEnvVar_8cc_source.html">YEnvVar.cc</a>.</p> </div> </div> <a class="anchor" id="a3b061a18bd03eeb25f73c3bdcddd439c"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">bool YEnvVar::isSet </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const</td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">inline</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Return 'true' if the environment variable is set. </p> <p>Definition at line <a class="el" href="YEnvVar_8h_source.html#l00054">54</a> of file <a class="el" href="YEnvVar_8h_source.html">YEnvVar.h</a>.</p> </div> </div> <a class="anchor" id="aeccbf267e91b9da07d103ec4f6e8acf9"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">std::string YEnvVar::name </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const</td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">inline</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Return the name of the environment variable. </p> <p>Definition at line <a class="el" href="YEnvVar_8h_source.html#l00049">49</a> of file <a class="el" href="YEnvVar_8h_source.html">YEnvVar.h</a>.</p> </div> </div> <a class="anchor" id="a871a4c1c1f4f45239bdafbb20885f1a0"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">bool YEnvVar::operator== </td> <td>(</td> <td class="paramtype">const std::string & </td> <td class="paramname"><em>str</em></td><td>)</td> <td> const</td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">inline</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Case-insensitive comparison (shortcut for <a class="el" href="classYEnvVar.html#a6f669f5c7eb3ac6c07e879b3db8e2f5f">isEqual()</a> ): Return 'true' if the environment variable is set and the value is 'str'. </p> <p>Definition at line <a class="el" href="YEnvVar_8h_source.html#l00072">72</a> of file <a class="el" href="YEnvVar_8h_source.html">YEnvVar.h</a>.</p> </div> </div> <a class="anchor" id="a7705ff5c9c0690311989c578b1596582"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">std::string YEnvVar::value </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const</td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">inline</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Return the value of the environment variable. </p> <p>Definition at line <a class="el" href="YEnvVar_8h_source.html#l00059">59</a> of file <a class="el" href="YEnvVar_8h_source.html">YEnvVar.h</a>.</p> </div> </div> <hr/>The documentation for this class was generated from the following files:<ul> <li>/home/iurt/rpmbuild/BUILD/libyui-3.0.10-b316a3f/src/<a class="el" href="YEnvVar_8h_source.html">YEnvVar.h</a></li> <li>/home/iurt/rpmbuild/BUILD/libyui-3.0.10-b316a3f/src/<a class="el" href="YEnvVar_8cc_source.html">YEnvVar.cc</a></li> </ul> </div><!-- contents --> </div><!-- doc-content --> <!-- start footer part --> <div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> <ul> <li class="navelem"><a class="el" href="classYEnvVar.html">YEnvVar</a></li> <li class="footer">Generated by <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.5 </li> </ul> </div> </body> </html>