<!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: XSettingsClient 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
 <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 Page</span></a></li>
<li><a href="pages.html"><span>Related 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 List</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 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_1XSettingsClient.html">XSettingsClient</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-static-methods">Static Public Member Functions</a> </div>
<div class="headertitle">
<div class="title">XSettingsClient Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<!-- doxytag: class="edelib::XSettingsClient" -->
<p>Client part of XSETTINGS protocol.
<a href="classedelib_1_1XSettingsClient.html#details">More...</a></p>
<p><code>#include <<a class="el" href="XSettingsClient_8h_source.html">edelib/XSettingsClient.h</a>></code></p>
<p><a href="classedelib_1_1XSettingsClient-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"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classedelib_1_1XSettingsClient.html#aad10fa6adf65accafb8e5342cf8fbcad">XSettingsClient</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classedelib_1_1XSettingsClient.html#a74623689dc4016a7c3c015ebe088a658">~XSettingsClient</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classedelib_1_1XSettingsClient.html#a35182a282756ae5240221d45b33e5922">init</a> (Display *dpy, int screen, XSettingsCallback cb=0, void *data=0)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classedelib_1_1XSettingsClient.html#ae683fe63c33c388e9ba1c6392dd477eb">clear</a> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classedelib_1_1XSettingsClient.html#a93c0ccf053544ab3dbc3240103042dce">callback</a> (XSettingsCallback cb, void *data=0)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classedelib_1_1XSettingsClient.html#aae697bd205bbe4130ada7cb0a57257ba">process_xevent</a> (const XEvent *xev)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classedelib_1_1XSettingsClient.html#ab070096c2414d378ac917b479cde8f35">set</a> (const char *name, int val)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classedelib_1_1XSettingsClient.html#a65bd95d847353560d38540050404e6ef">set</a> (const char *name, const char *val)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classedelib_1_1XSettingsClient.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 </td><td class="memItemRight" valign="bottom"><a class="el" href="classedelib_1_1XSettingsClient.html#a304c6ee1545439de03334b5d4a63526f">manager_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 </td><td class="memItemRight" valign="bottom"><a class="el" href="classedelib_1_1XSettingsClient.html#a25144a9fba193196bf5d3992f12c29c8">manager_running</a> (Display *dpy, int screen)</td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Client part of XSETTINGS protocol. </p>
<p>This class is used to query XSETTINGS data from manager. Due XSETTINGS protocol requirements, manager must already be running. To see differences between official protocol and current implementation, please see <a class="el" href="structedelib_1_1XSettingsData.html" title="Main data shared between client and manager.">XSettingsData</a> documentation.</p>
<p>Before query data, <a class="el" href="classedelib_1_1XSettingsClient.html#a35182a282756ae5240221d45b33e5922">init()</a> must be called. <a class="el" href="classedelib_1_1XSettingsClient.html#a35182a282756ae5240221d45b33e5922">init()</a> will register needed data and (optionaly) register callback for listening changes. This callback will be triggered when one of the settings are changed on manager side so application can update needed data.</p>
<p>Also to get changes via callback, <a class="el" href="classedelib_1_1XSettingsClient.html#aae697bd205bbe4130ada7cb0a57257ba">process_xevent()</a> must be placed in loop with X events so <a class="el" href="classedelib_1_1XSettingsClient.html" title="Client part of XSETTINGS protocol.">XSettingsClient</a> can capture needed events and process them.</p>
<p>This is simple example how stuff should be set up: </p>
<div class="fragment"><pre class="fragment"> <span class="keywordtype">void</span> xsettings_cb(<span class="keyword">const</span> <span class="keywordtype">char</span>* name, <a class="code" href="namespaceedelib.html#a5dde6e1f34a39a4d59acee51e1bcece3" title="Flags telling what was done with setting.">XSettingsAction</a> action, XSettingsSetting* setting, <span class="keywordtype">void</span>* data) {
<span class="keywordflow">if</span>(strcmp(name, <span class="stringliteral">"Test/MySetting"</span>) == 0) {
<span class="keywordflow">switch</span>(action) {
<span class="keywordflow">case</span> <a class="code" href="namespaceedelib.html#a5dde6e1f34a39a4d59acee51e1bcece3aeb517d0886083ab45a785445245dd648" title="New setting added.">XSETTINGS_ACTION_NEW</a>:
<span class="comment">// added setting</span>
<span class="keywordflow">if</span>(setting->type == XSETTING_TYPE_INT)
printf(<span class="stringliteral">"Added %s with value %i\n"</span>, setting->name, setting->data.v_int);
<span class="keywordflow">if</span>(setting->type == XSETTING_TYPE_STRING)
printf(<span class="stringliteral">"Added %s with value %i\n"</span>, setting->name, setting->data.v_string);
<span class="comment">// and so on...</span>
<span class="keywordflow">break</span>;
<span class="keywordflow">case</span> <a class="code" href="namespaceedelib.html#a5dde6e1f34a39a4d59acee51e1bcece3a14352b4dfc4c3e74e3758667d34f2ff4" title="One of the settings changed.">XSETTINGS_ACTION_CHANGED</a>:
<span class="comment">// changed setting</span>
<span class="comment">// inspect them as for XSETTINGS_ACTION_NEW</span>
<span class="keywordflow">break</span>;
<span class="keywordflow">case</span> <a class="code" href="namespaceedelib.html#a5dde6e1f34a39a4d59acee51e1bcece3a866857b90dc512939da830f0978a4521" title="One of the settings deleted.">XSETTINGS_ACTION_DELETED</a>:
<span class="comment">// deleted setting</span>
<span class="comment">// inspect them as for XSETTINGS_ACTION_NEW</span>
<span class="keywordflow">break</span>;
}
}
<span class="keywordflow">return</span>;
}
<span class="comment">// in some function...</span>
<a class="code" href="classedelib_1_1XSettingsClient.html#aad10fa6adf65accafb8e5342cf8fbcad">XSettingsClient</a> client;
<span class="keywordflow">if</span>(!client.init(fl_display, fl_screen, xsettings_cb)) {
puts(<span class="stringliteral">"Unable to init XSETTINGS client"</span>);
<span class="keywordflow">return</span>;
}
XEvent ev;
<span class="keywordflow">while</span>(1) {
XNextEvent(display, &ev);
<span class="keywordflow">return</span> client.process_xevent(&ev);
}
</pre></div><p><a class="el" href="classedelib_1_1XSettingsClient.html#a35182a282756ae5240221d45b33e5922">init()</a> function intentionally have (optional) callback parameter since after calling <a class="el" href="classedelib_1_1XSettingsClient.html#a35182a282756ae5240221d45b33e5922">init()</a>, callback can be triggered immediately if manager is running so <a class="el" href="classedelib_1_1XSettingsClient.html" title="Client part of XSETTINGS protocol.">XSettingsClient</a> can pick up currently stored settings from it. Alternatively there is <a class="el" href="classedelib_1_1XSettingsClient.html#a93c0ccf053544ab3dbc3240103042dce">callback()</a> function which can be used to change callback during runtime.</p>
<p>Calling <a class="el" href="classedelib_1_1XSettingsClient.html#a93c0ccf053544ab3dbc3240103042dce">callback()</a> before <a class="el" href="classedelib_1_1XSettingsClient.html#a35182a282756ae5240221d45b33e5922">init()</a> is the same as calling <a class="el" href="classedelib_1_1XSettingsClient.html#a35182a282756ae5240221d45b33e5922">init()</a> with callback function.</p>
<p>Note that if <a class="el" href="classedelib_1_1XSettingsClient.html#a93c0ccf053544ab3dbc3240103042dce">callback()</a> is called <em>after</em> <a class="el" href="classedelib_1_1XSettingsClient.html#a35182a282756ae5240221d45b33e5922">init()</a>, settings will not be queried from manager until one of the settings is changed on manager side. </p>
</div><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="aad10fa6adf65accafb8e5342cf8fbcad"></a><!-- doxytag: member="edelib::XSettingsClient::XSettingsClient" ref="aad10fa6adf65accafb8e5342cf8fbcad" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classedelib_1_1XSettingsClient.html">XSettingsClient</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Empty constructor </p>
</div>
</div>
<a class="anchor" id="a74623689dc4016a7c3c015ebe088a658"></a><!-- doxytag: member="edelib::XSettingsClient::~XSettingsClient" ref="a74623689dc4016a7c3c015ebe088a658" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">~<a class="el" href="classedelib_1_1XSettingsClient.html">XSettingsClient</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Clears internal data </p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a93c0ccf053544ab3dbc3240103042dce"></a><!-- doxytag: member="edelib::XSettingsClient::callback" ref="a93c0ccf053544ab3dbc3240103042dce" args="(XSettingsCallback cb, void *data=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classedelib_1_1XSettingsClient.html#a93c0ccf053544ab3dbc3240103042dce">callback</a> </td>
<td>(</td>
<td class="paramtype">XSettingsCallback </td>
<td class="paramname"><em>cb</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>data</em> = <code>0</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set callback for listening changes </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">cb</td><td>is callback parameter </td></tr>
<tr><td class="paramname">data</td><td>is data passed to the callback function </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ae683fe63c33c388e9ba1c6392dd477eb"></a><!-- doxytag: member="edelib::XSettingsClient::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_1XSettingsClient.html#ae683fe63c33c388e9ba1c6392dd477eb">clear</a> </td>
<td>(</td>
<td class="paramtype">void </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_1XSettingsClient.html#a35182a282756ae5240221d45b33e5922">init()</a> must be called agan if other functions are going to be called </p>
</div>
</div>
<a class="anchor" id="a35182a282756ae5240221d45b33e5922"></a><!-- doxytag: member="edelib::XSettingsClient::init" ref="a35182a282756ae5240221d45b33e5922" args="(Display *dpy, int screen, XSettingsCallback cb=0, void *data=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classedelib_1_1XSettingsClient.html#a35182a282756ae5240221d45b33e5922">init</a> </td>
<td>(</td>
<td class="paramtype">Display * </td>
<td class="paramname"><em>dpy</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>screen</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">XSettingsCallback </td>
<td class="paramname"><em>cb</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>data</em> = <code>0</code> </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, true otherwise </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>
<tr><td class="paramname">cb</td><td>is callback parameter </td></tr>
<tr><td class="paramname">data</td><td>is data passed to the callback function </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a304c6ee1545439de03334b5d4a63526f"></a><!-- doxytag: member="edelib::XSettingsClient::manager_notify" ref="a304c6ee1545439de03334b5d4a63526f" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classedelib_1_1XSettingsClient.html#a304c6ee1545439de03334b5d4a63526f">manager_notify</a> </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Send changed data to manager. This should be called aftear <a class="el" href="classedelib_1_1XSettingsClient.html#ab070096c2414d378ac917b479cde8f35">set()</a> </p>
</div>
</div>
<a class="anchor" id="a25144a9fba193196bf5d3992f12c29c8"></a><!-- doxytag: member="edelib::XSettingsClient::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_1XSettingsClient.html#a25144a9fba193196bf5d3992f12c29c8">manager_running</a> </td>
<td>(</td>
<td class="paramtype">Display * </td>
<td class="paramname"><em>dpy</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>screen</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Checks if 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="aae697bd205bbe4130ada7cb0a57257ba"></a><!-- doxytag: member="edelib::XSettingsClient::process_xevent" ref="aae697bd205bbe4130ada7cb0a57257ba" args="(const XEvent *xev)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="classedelib_1_1XSettingsClient.html#aae697bd205bbe4130ada7cb0a57257ba">process_xevent</a> </td>
<td>(</td>
<td class="paramtype">const XEvent * </td>
<td class="paramname"><em>xev</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This function should be placed in loop with X events </p>
</div>
</div>
<a class="anchor" id="ab070096c2414d378ac917b479cde8f35"></a><!-- doxytag: member="edelib::XSettingsClient::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_1XSettingsClient.html#ab070096c2414d378ac917b479cde8f35">set</a> </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>val</em> </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::XSettingsClient::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_1XSettingsClient.html#ab070096c2414d378ac917b479cde8f35">set</a> </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>val</em> </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::XSettingsClient::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_1XSettingsClient.html#ab070096c2414d378ac917b479cde8f35">set</a> </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned short </td>
<td class="paramname"><em>red</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned short </td>
<td class="paramname"><em>green</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned short </td>
<td class="paramname"><em>blue</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned short </td>
<td class="paramname"><em>alpha</em> </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>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>edelib/<a class="el" href="XSettingsClient_8h_source.html">XSettingsClient.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  <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>
