<!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"/>
<title>Xcm: X Color Management Event API's</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.3 -->
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">Xcm <span id="projectnumber">0.4.0</span></div>
</td>
</tr>
</tbody>
</table>
</div>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#define-members">Defines</a> |
<a href="#typedef-members">Typedefs</a> |
<a href="#enum-members">Enumerations</a> |
<a href="#enumval-members">Enumerator</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<h1>X Color Management Event API's</h1> </div>
</div>
<div class="contents">
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="define-members"></a>
Defines</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__XcmEvents.html#ga6d5da67e7bcc737d0f3f36ad16e36d89">XCM_ICC_COLOUR_SERVER_TARGET_PROFILE_IN_X_BASE</a>   "_ICC_DEVICE_PROFILE"</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">net-color spec atoms <a href="#ga6d5da67e7bcc737d0f3f36ad16e36d89"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__XcmEvents.html#gadb0dfc6a47dda039b029b3b669ffab07">XCM_ICC_V0_3_TARGET_PROFILE_IN_X_BASE</a>   "_ICC_PROFILE"</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">_ICC_PROFILE_(xxx) in X spec atoms <a href="#gadb0dfc6a47dda039b029b3b669ffab07"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef struct XcmeContext_s_ </td><td class="memItemRight" valign="bottom"><a class="el" href="group__XcmEvents.html#gaa4aa8681bfbba02df28de6402e7ff47b">XcmeContext_s</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">context for parsing events <a href="#gaa4aa8681bfbba02df28de6402e7ff47b"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__XcmEvents.html#ga282b8a52d05421489650cd0b2a9586b3">XCME_MSG_e</a> { <br/>
  <a class="el" href="group__XcmEvents.html#gga282b8a52d05421489650cd0b2a9586b3aca2d8d5cd7598c585d424e5abec396b8">XCME_MSG_TITLE</a> = 400,
<a class="el" href="group__XcmEvents.html#gga282b8a52d05421489650cd0b2a9586b3a9305b768bf1272c4bdd64b0b7a986c38">XCME_MSG_COPYRIGHT</a>,
<a class="el" href="group__XcmEvents.html#gga282b8a52d05421489650cd0b2a9586b3a8c8a2c3e10e5802475cf2ddda279fe03">XCME_MSG_INFO</a>,
<a class="el" href="group__XcmEvents.html#gga282b8a52d05421489650cd0b2a9586b3a9317c452623832caac46450ae2301f9f">XCME_MSG_SYSTEM</a>,
<br/>
  <a class="el" href="group__XcmEvents.html#gga282b8a52d05421489650cd0b2a9586b3a588fd4325af7f146f68c67c3b2a137f7">XCME_MSG_DISPLAY_ERROR</a>,
<a class="el" href="group__XcmEvents.html#gga282b8a52d05421489650cd0b2a9586b3a1f5ff9536fe89e52a74ad053dcdd3449">XCME_MSG_DISPLAY_EVENT</a>,
<a class="el" href="group__XcmEvents.html#gga282b8a52d05421489650cd0b2a9586b3adf1059f2b6faf80a49f1231a194e1072">XCME_MSG_DISPLAY_STATUS</a>
<br/>
}</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight"><p>customisable signals for a observer </p>
<a href="group__XcmEvents.html#ga282b8a52d05421489650cd0b2a9586b3">More...</a><br/></td></tr>
<tr><td colspan="2"><h2><a name="func-members"></a>
Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__XcmEvents.html#gaf78f828fd329ef44a1fd7f1bdc83aee5">XcmMessage</a> (<a class="el" href="group__XcmEvents.html#ga282b8a52d05421489650cd0b2a9586b3">XCME_MSG_e</a> code, const void *context, const char *format,...)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">default message function <a href="#gaf78f828fd329ef44a1fd7f1bdc83aee5"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__XcmEvents.html#ga6b80859560011a58011b126638bcbff1">XcmMessageFuncSet</a> (XcmMessage_f message_func)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">set a message function to customise messages <a href="#ga6b80859560011a58011b126638bcbff1"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__XcmEvents.html#gaa13e46d0ed0ce8b3bda40185e92b3dba">xcmePrintWindowName</a> (Display *display, Window w)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">return a short window description text <a href="#gaa13e46d0ed0ce8b3bda40185e92b3dba"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__XcmEvents.html#gaae64d96602a949a1485399572ac4896f">XcmICCprofileGetNameFuncSet</a> (XcmICCprofileGetName_f getName)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">plugin more informations capabilities for ICC profiles <a href="#gaae64d96602a949a1485399572ac4896f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__XcmEvents.html#gaa326653097aa44448da57029ed78b904">XcmICCprofileFromMD5FuncSet</a> (XcmICCprofileGetFromMD5_f fromMD5)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">plugin more informations capabilities for ICC profiles <a href="#gaa326653097aa44448da57029ed78b904"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__XcmEvents.html#gab1382175d16c907709323866b37f3270">xcmePrintWindowRegions</a> (Display *display, Window w, int always)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">send a message about window regions <a href="#gab1382175d16c907709323866b37f3270"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__XcmEvents.html#gaa4aa8681bfbba02df28de6402e7ff47b">XcmeContext_s</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__XcmEvents.html#ga56507d84aed5ca22391802ccffe550d9">XcmeContext_New</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">allocate a event observer context structure <a href="#ga56507d84aed5ca22391802ccffe550d9"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__XcmEvents.html#gaa4aa8681bfbba02df28de6402e7ff47b">XcmeContext_s</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__XcmEvents.html#ga20eb458ab8169ad4c7b0d903fd531930">XcmeContext_Create</a> (const char *display_name)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">allocate and initialise a event observer context structure <a href="#ga20eb458ab8169ad4c7b0d903fd531930"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__XcmEvents.html#gadbbd179802fd077e6b9e2c0bf4598407">XcmeContext_Setup</a> (<a class="el" href="group__XcmEvents.html#gaa4aa8681bfbba02df28de6402e7ff47b">XcmeContext_s</a> *c, const char *display_name)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">allocate and initialise a event observer context structure <a href="#gadbbd179802fd077e6b9e2c0bf4598407"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__XcmEvents.html#ga984af4e32d1d158d4c7bcd96181036f9">XcmeContext_Release</a> (<a class="el" href="group__XcmEvents.html#gaa4aa8681bfbba02df28de6402e7ff47b">XcmeContext_s</a> **c)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">clean owned resources <a href="#ga984af4e32d1d158d4c7bcd96181036f9"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__XcmEvents.html#ga096f3899ce1043c2c387bf4de8fd70a6">XcmeContext_InLoop</a> (<a class="el" href="group__XcmEvents.html#gaa4aa8681bfbba02df28de6402e7ff47b">XcmeContext_s</a> *c, XEvent *event)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">check for colour management events <a href="#ga096f3899ce1043c2c387bf4de8fd70a6"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">Display * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__XcmEvents.html#ga02cf45368f400ec3c48d33e20fa497f4">XcmeContext_DisplayGet</a> (<a class="el" href="group__XcmEvents.html#gaa4aa8681bfbba02df28de6402e7ff47b">XcmeContext_s</a> *c)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">return the Display <a href="#ga02cf45368f400ec3c48d33e20fa497f4"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__XcmEvents.html#ga7d1aa4e0e17ead7c755d98844a9ceafd">XcmeContext_DisplaySet</a> (<a class="el" href="group__XcmEvents.html#gaa4aa8681bfbba02df28de6402e7ff47b">XcmeContext_s</a> *c, Display *display)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">set a custom X11 Display <a href="#ga7d1aa4e0e17ead7c755d98844a9ceafd"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__XcmEvents.html#ga8121d9e5387016b0d7cc0f33ccf98f5a">XcmeContext_WindowSet</a> (<a class="el" href="group__XcmEvents.html#gaa4aa8681bfbba02df28de6402e7ff47b">XcmeContext_s</a> *c, Window window)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">set a custom X11 Window <a href="#ga8121d9e5387016b0d7cc0f33ccf98f5a"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>The observer context can be allocated and setup through XcmeContext_Create. You can pass in a own X11 Display handle through <a class="el" href="group__XcmEvents.html#ga56507d84aed5ca22391802ccffe550d9" title="allocate a event observer context structure">XcmeContext_New()</a>, <a class="el" href="group__XcmEvents.html#ga7d1aa4e0e17ead7c755d98844a9ceafd" title="set a custom X11 Display">XcmeContext_DisplaySet()</a> and <a class="el" href="group__XcmEvents.html#gadbbd179802fd077e6b9e2c0bf4598407" title="allocate and initialise a event observer context structure">XcmeContext_Setup()</a>. The events can be processed by passing all XEvents to <a class="el" href="group__XcmEvents.html#ga096f3899ce1043c2c387bf4de8fd70a6" title="check for colour management events">XcmeContext_InLoop()</a> from inside your X event handling loop. To release allocated resources call <a class="el" href="group__XcmEvents.html#ga984af4e32d1d158d4c7bcd96181036f9" title="clean owned resources">XcmeContext_Release()</a>. For a examle look at the xcmsevents application, which is distributed along the sources.</p>
<p>XcmEvents.h</p>
<p>A small X11 colour management event observer.</p>
<dl class="author"><dt><b>Author:</b></dt><dd>Kai-Uwe Behrmann <<a href="mailto:ku.b@gmx.de">ku.b@gmx.de</a>> </dd></dl>
<dl class="user"><dt><b>License:</b></dt><dd>MIT <<a href="http://www.opensource.org/licenses/mit-license.php">http://www.opensource.org/licenses/mit-license.php</a>> </dd></dl>
<dl class="user"><dt><b>Copyright:</b></dt><dd>2009-2010 - Kai-Uwe Behrmann <<a href="mailto:ku.b@gmx.de">ku.b@gmx.de</a>> </dd></dl>
<hr/><h2>Define Documentation</h2>
<a class="anchor" id="ga6d5da67e7bcc737d0f3f36ad16e36d89"></a><!-- doxytag: member="XcmEvents.h::XCM_ICC_COLOUR_SERVER_TARGET_PROFILE_IN_X_BASE" ref="ga6d5da67e7bcc737d0f3f36ad16e36d89" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define XCM_ICC_COLOUR_SERVER_TARGET_PROFILE_IN_X_BASE   "_ICC_DEVICE_PROFILE"</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>net-color spec atoms </p>
</div>
</div>
<a class="anchor" id="gadb0dfc6a47dda039b029b3b669ffab07"></a><!-- doxytag: member="XcmEvents.h::XCM_ICC_V0_3_TARGET_PROFILE_IN_X_BASE" ref="gadb0dfc6a47dda039b029b3b669ffab07" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define XCM_ICC_V0_3_TARGET_PROFILE_IN_X_BASE   "_ICC_PROFILE"</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>_ICC_PROFILE_(xxx) in X spec atoms </p>
</div>
</div>
<hr/><h2>Typedef Documentation</h2>
<a class="anchor" id="gaa4aa8681bfbba02df28de6402e7ff47b"></a><!-- doxytag: member="XcmEvents.h::XcmeContext_s" ref="gaa4aa8681bfbba02df28de6402e7ff47b" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct XcmeContext_s_ <a class="el" href="group__XcmEvents.html#gaa4aa8681bfbba02df28de6402e7ff47b">XcmeContext_s</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>context for parsing events </p>
</div>
</div>
<hr/><h2>Enumeration Type Documentation</h2>
<a class="anchor" id="ga282b8a52d05421489650cd0b2a9586b3"></a><!-- doxytag: member="XcmEvents.h::XCME_MSG_e" ref="ga282b8a52d05421489650cd0b2a9586b3" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="group__XcmEvents.html#ga282b8a52d05421489650cd0b2a9586b3">XCME_MSG_e</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>customisable signals for a observer </p>
<dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" id="gga282b8a52d05421489650cd0b2a9586b3aca2d8d5cd7598c585d424e5abec396b8"></a><!-- doxytag: member="XCME_MSG_TITLE" ref="gga282b8a52d05421489650cd0b2a9586b3aca2d8d5cd7598c585d424e5abec396b8" args="" -->XCME_MSG_TITLE</em> </td><td>
<p>basic library title </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="gga282b8a52d05421489650cd0b2a9586b3a9305b768bf1272c4bdd64b0b7a986c38"></a><!-- doxytag: member="XCME_MSG_COPYRIGHT" ref="gga282b8a52d05421489650cd0b2a9586b3a9305b768bf1272c4bdd64b0b7a986c38" args="" -->XCME_MSG_COPYRIGHT</em> </td><td>
<p>Copyright infos. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="gga282b8a52d05421489650cd0b2a9586b3a8c8a2c3e10e5802475cf2ddda279fe03"></a><!-- doxytag: member="XCME_MSG_INFO" ref="gga282b8a52d05421489650cd0b2a9586b3a8c8a2c3e10e5802475cf2ddda279fe03" args="" -->XCME_MSG_INFO</em> </td><td>
<p>normaly ignored </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="gga282b8a52d05421489650cd0b2a9586b3a9317c452623832caac46450ae2301f9f"></a><!-- doxytag: member="XCME_MSG_SYSTEM" ref="gga282b8a52d05421489650cd0b2a9586b3a9317c452623832caac46450ae2301f9f" args="" -->XCME_MSG_SYSTEM</em> </td><td>
<p>forwarded system message </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="gga282b8a52d05421489650cd0b2a9586b3a588fd4325af7f146f68c67c3b2a137f7"></a><!-- doxytag: member="XCME_MSG_DISPLAY_ERROR" ref="gga282b8a52d05421489650cd0b2a9586b3a588fd4325af7f146f68c67c3b2a137f7" args="" -->XCME_MSG_DISPLAY_ERROR</em> </td><td>
<p>errors during run </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="gga282b8a52d05421489650cd0b2a9586b3a1f5ff9536fe89e52a74ad053dcdd3449"></a><!-- doxytag: member="XCME_MSG_DISPLAY_EVENT" ref="gga282b8a52d05421489650cd0b2a9586b3a1f5ff9536fe89e52a74ad053dcdd3449" args="" -->XCME_MSG_DISPLAY_EVENT</em> </td><td>
<p>event smessage </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="gga282b8a52d05421489650cd0b2a9586b3adf1059f2b6faf80a49f1231a194e1072"></a><!-- doxytag: member="XCME_MSG_DISPLAY_STATUS" ref="gga282b8a52d05421489650cd0b2a9586b3adf1059f2b6faf80a49f1231a194e1072" args="" -->XCME_MSG_DISPLAY_STATUS</em> </td><td>
<p>initial status infos </p>
</td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="ga20eb458ab8169ad4c7b0d903fd531930"></a><!-- doxytag: member="XcmEvents.c::XcmeContext_Create" ref="ga20eb458ab8169ad4c7b0d903fd531930" args="(const char *display_name)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__XcmEvents.html#gaa4aa8681bfbba02df28de6402e7ff47b">XcmeContext_s</a> * XcmeContext_Create </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>display_name</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>allocate and initialise a event observer context structure </p>
<p>Function XcmeContext_Create The context is needed to observe colour management events.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">display_name</td><td>a valid X11 display name </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>the context</dd></dl>
<dl class="version"><dt><b>Version:</b></dt><dd>libXcm: 0.3.0 </dd></dl>
<dl class="since"><dt><b>Since:</b></dt><dd>2009/00/00 (libXcm: 0.3.0) </dd></dl>
<dl class="date"><dt><b>Date:</b></dt><dd>2010/10/01 </dd></dl>
</div>
</div>
<a class="anchor" id="ga02cf45368f400ec3c48d33e20fa497f4"></a><!-- doxytag: member="XcmEvents.c::XcmeContext_DisplayGet" ref="ga02cf45368f400ec3c48d33e20fa497f4" args="(XcmeContext_s *c)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Display * XcmeContext_DisplayGet </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__XcmEvents.html#gaa4aa8681bfbba02df28de6402e7ff47b">XcmeContext_s</a> * </td>
<td class="paramname"><em>c</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>return the Display </p>
<p>Function XcmeContext_DisplayGet </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">c</td><td>a event observer context </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>the X11 display</dd></dl>
<dl class="version"><dt><b>Version:</b></dt><dd>libXcm: 0.3.0 </dd></dl>
<dl class="since"><dt><b>Since:</b></dt><dd>2010/10/01 (libXcm: 0.3.0) </dd></dl>
<dl class="date"><dt><b>Date:</b></dt><dd>2010/10/01 </dd></dl>
</div>
</div>
<a class="anchor" id="ga7d1aa4e0e17ead7c755d98844a9ceafd"></a><!-- doxytag: member="XcmEvents.c::XcmeContext_DisplaySet" ref="ga7d1aa4e0e17ead7c755d98844a9ceafd" args="(XcmeContext_s *c, Display *display)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int XcmeContext_DisplaySet </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__XcmEvents.html#gaa4aa8681bfbba02df28de6402e7ff47b">XcmeContext_s</a> * </td>
<td class="paramname"><em>c</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">Display * </td>
<td class="paramname"><em>display</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>set a custom X11 Display </p>
<p>Function XcmeContext_DisplaySet </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramdir">[in,out]</td><td class="paramname">c</td><td>a event observer context </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">display</td><td>the custom X11 display </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>error</dd></dl>
<dl class="version"><dt><b>Version:</b></dt><dd>libXcm: 0.3.0 </dd></dl>
<dl class="since"><dt><b>Since:</b></dt><dd>2010/10/01 (libXcm: 0.3.0) </dd></dl>
<dl class="date"><dt><b>Date:</b></dt><dd>2010/10/01 </dd></dl>
</div>
</div>
<a class="anchor" id="ga096f3899ce1043c2c387bf4de8fd70a6"></a><!-- doxytag: member="XcmEvents.c::XcmeContext_InLoop" ref="ga096f3899ce1043c2c387bf4de8fd70a6" args="(XcmeContext_s *c, XEvent *event)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int XcmeContext_InLoop </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__XcmEvents.html#gaa4aa8681bfbba02df28de6402e7ff47b">XcmeContext_s</a> * </td>
<td class="paramname"><em>c</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">XEvent * </td>
<td class="paramname"><em>event</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>check for colour management events </p>
<p>Function XcmeContext_InLoop This function needs to be called inside the X11 event loop, to observe the related events and send messages about them.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramdir">[in,out]</td><td class="paramname">c</td><td>a event observer context </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">event</td><td>a X event handle </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>- 0: success<ul>
<li>1: error</li>
</ul>
</dd></dl>
<dl class="version"><dt><b>Version:</b></dt><dd>libXcm: 0.3.0 </dd></dl>
<dl class="since"><dt><b>Since:</b></dt><dd>2009/00/00 (libXcm: 0.3.0) </dd></dl>
<dl class="date"><dt><b>Date:</b></dt><dd>2010/10/01 </dd></dl>
</div>
</div>
<a class="anchor" id="ga56507d84aed5ca22391802ccffe550d9"></a><!-- doxytag: member="XcmEvents.c::XcmeContext_New" ref="ga56507d84aed5ca22391802ccffe550d9" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__XcmEvents.html#gaa4aa8681bfbba02df28de6402e7ff47b">XcmeContext_s</a> * XcmeContext_New </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>allocate a event observer context structure </p>
<p>Function XcmeContext_New The context is needed to observe colour management events. After the allocation the context needs initialisation.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>the context</dd></dl>
<dl class="version"><dt><b>Version:</b></dt><dd>libXcm: 0.3.0 </dd></dl>
<dl class="since"><dt><b>Since:</b></dt><dd>2009/00/00 (libXcm: 0.3.0) </dd></dl>
<dl class="date"><dt><b>Date:</b></dt><dd>2010/10/01 </dd></dl>
</div>
</div>
<a class="anchor" id="ga984af4e32d1d158d4c7bcd96181036f9"></a><!-- doxytag: member="XcmEvents.c::XcmeContext_Release" ref="ga984af4e32d1d158d4c7bcd96181036f9" args="(XcmeContext_s **c)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int XcmeContext_Release </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__XcmEvents.html#gaa4aa8681bfbba02df28de6402e7ff47b">XcmeContext_s</a> ** </td>
<td class="paramname"><em>c</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>clean owned resources </p>
<p>Function XcmeContext_Release </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramdir">[in,out]</td><td class="paramname">c</td><td>a event observer context</td></tr>
</table>
</dd>
</dl>
<dl class="version"><dt><b>Version:</b></dt><dd>libXcm: 0.3.0 </dd></dl>
<dl class="since"><dt><b>Since:</b></dt><dd>2009/00/00 (libXcm: 0.3.0) </dd></dl>
<dl class="date"><dt><b>Date:</b></dt><dd>2010/10/01 </dd></dl>
</div>
</div>
<a class="anchor" id="gadbbd179802fd077e6b9e2c0bf4598407"></a><!-- doxytag: member="XcmEvents.c::XcmeContext_Setup" ref="gadbbd179802fd077e6b9e2c0bf4598407" args="(XcmeContext_s *c, const char *display_name)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int XcmeContext_Setup </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__XcmEvents.html#gaa4aa8681bfbba02df28de6402e7ff47b">XcmeContext_s</a> * </td>
<td class="paramname"><em>c</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>display_name</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>allocate and initialise a event observer context structure </p>
<p>Function XcmeContext_Setup The initialised context is needed for observing colour management events.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramdir">[in,out]</td><td class="paramname">c</td><td>a event observer context A existing X11 display will be honoured. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">display_name</td><td>a valid X11 display name or NULL; With a existing X11 display inside c, this option will be ignored.</td></tr>
</table>
</dd>
</dl>
<dl class="version"><dt><b>Version:</b></dt><dd>libXcm: 0.3.0 </dd></dl>
<dl class="since"><dt><b>Since:</b></dt><dd>2009/00/00 (libXcm: 0.3.0) </dd></dl>
<dl class="date"><dt><b>Date:</b></dt><dd>2010/10/01 </dd></dl>
</div>
</div>
<a class="anchor" id="ga8121d9e5387016b0d7cc0f33ccf98f5a"></a><!-- doxytag: member="XcmEvents.c::XcmeContext_WindowSet" ref="ga8121d9e5387016b0d7cc0f33ccf98f5a" args="(XcmeContext_s *c, Window window)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int XcmeContext_WindowSet </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__XcmEvents.html#gaa4aa8681bfbba02df28de6402e7ff47b">XcmeContext_s</a> * </td>
<td class="paramname"><em>c</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">Window </td>
<td class="paramname"><em>window</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>set a custom X11 Window </p>
<p>Function xcmeContext_WindowSet </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramdir">[in,out]</td><td class="paramname">c</td><td>a event observer context </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">window</td><td>the custom X11 window </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>error</dd></dl>
<dl class="version"><dt><b>Version:</b></dt><dd>libXcm: 0.3.0 </dd></dl>
<dl class="since"><dt><b>Since:</b></dt><dd>2010/10/01 (libXcm: 0.3.0) </dd></dl>
<dl class="date"><dt><b>Date:</b></dt><dd>2010/10/01 </dd></dl>
</div>
</div>
<a class="anchor" id="gaa13e46d0ed0ce8b3bda40185e92b3dba"></a><!-- doxytag: member="XcmEvents.c::xcmePrintWindowName" ref="gaa13e46d0ed0ce8b3bda40185e92b3dba" args="(Display *display, Window w)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* xcmePrintWindowName </td>
<td>(</td>
<td class="paramtype">Display * </td>
<td class="paramname"><em>display</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">Window </td>
<td class="paramname"><em>w</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>return a short window description text </p>
</div>
</div>
<a class="anchor" id="gab1382175d16c907709323866b37f3270"></a><!-- doxytag: member="XcmEvents.c::xcmePrintWindowRegions" ref="gab1382175d16c907709323866b37f3270" args="(Display *display, Window w, int always)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void xcmePrintWindowRegions </td>
<td>(</td>
<td class="paramtype">Display * </td>
<td class="paramname"><em>display</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">Window </td>
<td class="paramname"><em>w</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>always</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>send a message about window regions </p>
<p>Function xcmePrintWindowRegions The function informs about _NET_COLOR_REGIONS atom.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">display</td><td>X display </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">w</td><td>X window </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">always</td><td>send always a message, even for a empty property</td></tr>
</table>
</dd>
</dl>
<dl class="version"><dt><b>Version:</b></dt><dd>libXcm: 0.3.0 </dd></dl>
<dl class="since"><dt><b>Since:</b></dt><dd>2009/00/00 (libXcm: 0.3.0) </dd></dl>
<dl class="date"><dt><b>Date:</b></dt><dd>2010/10/01 </dd></dl>
</div>
</div>
<a class="anchor" id="gaa326653097aa44448da57029ed78b904"></a><!-- doxytag: member="XcmEvents.c::XcmICCprofileFromMD5FuncSet" ref="gaa326653097aa44448da57029ed78b904" args="(XcmICCprofileGetFromMD5_f fromMD5)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void XcmICCprofileFromMD5FuncSet </td>
<td>(</td>
<td class="paramtype">XcmICCprofileGetFromMD5_f </td>
<td class="paramname"><em>fromMD5</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>plugin more informations capabilities for ICC profiles </p>
<p>Function XcmICCprofileFromMD5FuncSet </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">fromMD5</td><td>a function to resolve a ICC profile in ICC profile paths from a md5 hash sum</td></tr>
</table>
</dd>
</dl>
<dl class="version"><dt><b>Version:</b></dt><dd>libXcm: 0.3.0 </dd></dl>
<dl class="since"><dt><b>Since:</b></dt><dd>2010/10/01 (libXcm: 0.3.0) </dd></dl>
<dl class="date"><dt><b>Date:</b></dt><dd>2010/10/02 </dd></dl>
</div>
</div>
<a class="anchor" id="gaae64d96602a949a1485399572ac4896f"></a><!-- doxytag: member="XcmEvents.c::XcmICCprofileGetNameFuncSet" ref="gaae64d96602a949a1485399572ac4896f" args="(XcmICCprofileGetName_f getName)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void XcmICCprofileGetNameFuncSet </td>
<td>(</td>
<td class="paramtype">XcmICCprofileGetName_f </td>
<td class="paramname"><em>getName</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>plugin more informations capabilities for ICC profiles </p>
<p>Function XcmICCprofileGetNameFuncSet </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">getName</td><td>get internal and external profile name</td></tr>
</table>
</dd>
</dl>
<dl class="version"><dt><b>Version:</b></dt><dd>libXcm: 0.3.0 </dd></dl>
<dl class="since"><dt><b>Since:</b></dt><dd>2010/10/01 (libXcm: 0.3.0) </dd></dl>
<dl class="date"><dt><b>Date:</b></dt><dd>2010/10/02 </dd></dl>
</div>
</div>
<a class="anchor" id="gaf78f828fd329ef44a1fd7f1bdc83aee5"></a><!-- doxytag: member="XcmEvents.c::XcmMessage" ref="gaf78f828fd329ef44a1fd7f1bdc83aee5" args="(XCME_MSG_e code, const void *context, const char *format,...)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int XcmMessage </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__XcmEvents.html#ga282b8a52d05421489650cd0b2a9586b3">XCME_MSG_e</a> </td>
<td class="paramname"><em>code</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const void * </td>
<td class="paramname"><em>context</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>format</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname"><em>...</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>default message function </p>
<p>Function XcmMessage Messages are printed out to stdout console text stream.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>- 0: fine<ul>
<li>1: error</li>
</ul>
</dd></dl>
<dl class="version"><dt><b>Version:</b></dt><dd>libXcm: 0.3.0 </dd></dl>
<dl class="since"><dt><b>Since:</b></dt><dd>2008/04/03 (libXcm: 0.3.0) </dd></dl>
<dl class="date"><dt><b>Date:</b></dt><dd>2010/10/01 </dd></dl>
</div>
</div>
<a class="anchor" id="ga6b80859560011a58011b126638bcbff1"></a><!-- doxytag: member="XcmEvents.c::XcmMessageFuncSet" ref="ga6b80859560011a58011b126638bcbff1" args="(XcmMessage_f message_func)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int XcmMessageFuncSet </td>
<td>(</td>
<td class="paramtype">XcmMessage_f </td>
<td class="paramname"><em>message_func</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>set a message function to customise messages </p>
</div>
</div>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Tue Feb 8 2011 for Xcm by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.3 </small></address>
</body>
</html>
