Sophie

Sophie

distrib > Mandriva > 2011.0 > x86_64 > by-pkgid > e4e5aca55b6d7244e6bae95bf4fde3ca > files > 298

lib64edelib-devel-2.0-1.x86_64.rpm

<!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"/>
<title>edelib: XSettingsManager Class Reference</title>

<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css" />



</head>
<body>
<div id="top"><!-- do not remove this div! -->


<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  
  
  <td style="padding-left: 0.5em;">
   <div id="projectname">edelib
   &#160;<span id="projectnumber">2.0.0</span>
   </div>
   
  </td>
  
  
  
 </tr>
 </tbody>
</table>
</div>

<!-- Generated by Doxygen 1.7.6.1 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li><a href="namespaces.html"><span>Namespaces</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>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
  <div id="nav-path" class="navpath">
    <ul>
      <li class="navelem"><a class="el" href="namespaceedelib.html">edelib</a>      </li>
      <li class="navelem"><a class="el" href="classedelib_1_1XSettingsManager.html">XSettingsManager</a>      </li>
    </ul>
  </div>
</div>
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="#pro-attribs">Protected Attributes</a>  </div>
  <div class="headertitle">
<div class="title">XSettingsManager Class Reference</div>  </div>
</div><!--header-->
<div class="contents">
<!-- doxytag: class="edelib::XSettingsManager" -->
<p>Manager part of XSETTINGS protocol.  
 <a href="classedelib_1_1XSettingsManager.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="XSettingsManager_8h_source.html">edelib/XSettingsManager.h</a>&gt;</code></p>

<p><a href="classedelib_1_1XSettingsManager-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classedelib_1_1XSettingsManager.html#a7ba6dbfc92eaa2d56fc38a6d9c210579">XSettingsManager</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classedelib_1_1XSettingsManager.html#afa4e9c88c203d204a30e583d67713bd3">~XSettingsManager</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classedelib_1_1XSettingsManager.html#a824351d42f3c571a4b4f537805be507d">init</a> (Display *dpy, int screen)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classedelib_1_1XSettingsManager.html#ae683fe63c33c388e9ba1c6392dd477eb">clear</a> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classedelib_1_1XSettingsManager.html#a5c36575edb05d71b627cc199431eb1c3">should_terminate</a> (const XEvent *xev)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classedelib_1_1XSettingsManager.html#ab070096c2414d378ac917b479cde8f35">set</a> (const char *name, int val)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classedelib_1_1XSettingsManager.html#a65bd95d847353560d38540050404e6ef">set</a> (const char *name, const char *val)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classedelib_1_1XSettingsManager.html#ad5c91026bbc411f93abd2f78702e5689">set</a> (const char *name, unsigned short red, unsigned short green, unsigned short blue, unsigned short alpha)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classedelib_1_1XSettingsManager.html#ae0f4c62d4e6ce587da63e43d1e3dcf85">notify</a> (void)</td></tr>
<tr><td colspan="2"><h2><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classedelib_1_1XSettingsManager.html#a25144a9fba193196bf5d3992f12c29c8">manager_running</a> (Display *dpy, int screen)</td></tr>
<tr><td colspan="2"><h2><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="structedelib_1_1XSettingsData.html">XSettingsData</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classedelib_1_1XSettingsManager.html#a1a6e1ad274fe719ec93ff9b329f5442a">manager_data</a></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Manager part of XSETTINGS protocol. </p>
<p><a class="el" href="classedelib_1_1XSettingsManager.html" title="Manager part of XSETTINGS protocol.">XSettingsManager</a> is class used to make manager(s) for XSETTINGS. Please note that XSETTINGS supports <em>only one</em> manager to be up so this must be taken into account.</p>
<p>Final applications should not use this class except manager is not provided. </p>
</div><hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a7ba6dbfc92eaa2d56fc38a6d9c210579"></a><!-- doxytag: member="edelib::XSettingsManager::XSettingsManager" ref="a7ba6dbfc92eaa2d56fc38a6d9c210579" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classedelib_1_1XSettingsManager.html">XSettingsManager</a> </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Empty constructor </p>

</div>
</div>
<a class="anchor" id="afa4e9c88c203d204a30e583d67713bd3"></a><!-- doxytag: member="edelib::XSettingsManager::~XSettingsManager" ref="afa4e9c88c203d204a30e583d67713bd3" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">~<a class="el" href="classedelib_1_1XSettingsManager.html">XSettingsManager</a> </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Clears internal data </p>

</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ae683fe63c33c388e9ba1c6392dd477eb"></a><!-- doxytag: member="edelib::XSettingsManager::clear" ref="ae683fe63c33c388e9ba1c6392dd477eb" args="(void)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="classedelib_1_1XSettingsManager.html#ae683fe63c33c388e9ba1c6392dd477eb">clear</a> </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Clears internal data. <a class="el" href="classedelib_1_1XSettingsManager.html#a824351d42f3c571a4b4f537805be507d">init()</a> must be called agan if other functions are going to be called </p>

</div>
</div>
<a class="anchor" id="a824351d42f3c571a4b4f537805be507d"></a><!-- doxytag: member="edelib::XSettingsManager::init" ref="a824351d42f3c571a4b4f537805be507d" args="(Display *dpy, int screen)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool <a class="el" href="classedelib_1_1XSettingsManager.html#a824351d42f3c571a4b4f537805be507d">init</a> </td>
          <td>(</td>
          <td class="paramtype">Display *&#160;</td>
          <td class="paramname"><em>dpy</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>screen</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Init needed communication parts. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>false if failed </dd></dl>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">dpy</td><td>is display </td></tr>
    <tr><td class="paramname">screen</td><td>is screen </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="a25144a9fba193196bf5d3992f12c29c8"></a><!-- doxytag: member="edelib::XSettingsManager::manager_running" ref="a25144a9fba193196bf5d3992f12c29c8" args="(Display *dpy, int screen)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">static bool <a class="el" href="classedelib_1_1XSettingsManager.html#a25144a9fba193196bf5d3992f12c29c8">manager_running</a> </td>
          <td>(</td>
          <td class="paramtype">Display *&#160;</td>
          <td class="paramname"><em>dpy</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>screen</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td><code> [static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Checks if other manager is running </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if does otherwise false </dd></dl>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">dpy</td><td>is display </td></tr>
    <tr><td class="paramname">screen</td><td>is screen </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="ae0f4c62d4e6ce587da63e43d1e3dcf85"></a><!-- doxytag: member="edelib::XSettingsManager::notify" ref="ae0f4c62d4e6ce587da63e43d1e3dcf85" args="(void)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="classedelib_1_1XSettingsManager.html#ae0f4c62d4e6ce587da63e43d1e3dcf85">notify</a> </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Notify for changed data. This should be called aftear <a class="el" href="classedelib_1_1XSettingsManager.html#ab070096c2414d378ac917b479cde8f35">set()</a> </p>

</div>
</div>
<a class="anchor" id="ab070096c2414d378ac917b479cde8f35"></a><!-- doxytag: member="edelib::XSettingsManager::set" ref="ab070096c2414d378ac917b479cde8f35" args="(const char *name, int val)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="classedelib_1_1XSettingsManager.html#ab070096c2414d378ac917b479cde8f35">set</a> </td>
          <td>(</td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>name</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>val</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Set integer value on manager </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">name</td><td>is setting name </td></tr>
    <tr><td class="paramname">val</td><td>is int value </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="a65bd95d847353560d38540050404e6ef"></a><!-- doxytag: member="edelib::XSettingsManager::set" ref="a65bd95d847353560d38540050404e6ef" args="(const char *name, const char *val)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="classedelib_1_1XSettingsManager.html#ab070096c2414d378ac917b479cde8f35">set</a> </td>
          <td>(</td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>name</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>val</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Set string (char*) value on manager. Data will be copied </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">name</td><td>is setting name </td></tr>
    <tr><td class="paramname">val</td><td>is string value </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="ad5c91026bbc411f93abd2f78702e5689"></a><!-- doxytag: member="edelib::XSettingsManager::set" ref="ad5c91026bbc411f93abd2f78702e5689" args="(const char *name, unsigned short red, unsigned short green, unsigned short blue, unsigned short alpha)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="classedelib_1_1XSettingsManager.html#ab070096c2414d378ac917b479cde8f35">set</a> </td>
          <td>(</td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>name</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">unsigned short&#160;</td>
          <td class="paramname"><em>red</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">unsigned short&#160;</td>
          <td class="paramname"><em>green</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">unsigned short&#160;</td>
          <td class="paramname"><em>blue</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">unsigned short&#160;</td>
          <td class="paramname"><em>alpha</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Set RGBA color values on manager </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">name</td><td>is setting name </td></tr>
    <tr><td class="paramname">red</td><td>is red component </td></tr>
    <tr><td class="paramname">green</td><td>is green component </td></tr>
    <tr><td class="paramname">blue</td><td>is blue component </td></tr>
    <tr><td class="paramname">alpha</td><td>is alpha component </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="a5c36575edb05d71b627cc199431eb1c3"></a><!-- doxytag: member="edelib::XSettingsManager::should_terminate" ref="a5c36575edb05d71b627cc199431eb1c3" args="(const XEvent *xev)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool <a class="el" href="classedelib_1_1XSettingsManager.html#a5c36575edb05d71b627cc199431eb1c3">should_terminate</a> </td>
          <td>(</td>
          <td class="paramtype">const XEvent *&#160;</td>
          <td class="paramname"><em>xev</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>This function must be placed in X loop </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if should terminate </dd></dl>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">xev</td><td>is X event </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="a1a6e1ad274fe719ec93ff9b329f5442a"></a><!-- doxytag: member="edelib::XSettingsManager::manager_data" ref="a1a6e1ad274fe719ec93ff9b329f5442a" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="structedelib_1_1XSettingsData.html">XSettingsData</a>* <a class="el" href="classedelib_1_1XSettingsManager.html#a1a6e1ad274fe719ec93ff9b329f5442a">manager_data</a><code> [protected]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Data used by manager class </p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>edelib/<a class="el" href="XSettingsManager_8h_source.html">XSettingsManager.h</a></li>
</ul>
</div><!-- contents -->


<hr class="footer"/><address class="footer"><small>
Generated on Tue Jun 5 2012 17:49:03 for edelib by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.7.6.1
</small></address>

</body>
</html>