418 lines
60 KiB
HTML
418 lines
60 KiB
HTML
<!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.14"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>PIP: PIObject 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="navtreedata.js"></script>
|
|
<script type="text/javascript" src="navtree.js"></script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
$(document).ready(initResizable);
|
|
/* @license-end */</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 id="projectalign" style="padding-left: 0.5em;">
|
|
<div id="projectname">PIP
|
|
 <span id="projectnumber">1.8.0</span>
|
|
</div>
|
|
<div id="projectbrief">Platform-Independent Primitives</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.14 -->
|
|
<script type="text/javascript" src="menudata.js"></script>
|
|
<script type="text/javascript" src="menu.js"></script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
$(function() {
|
|
initMenu('',false,false,'search.php','Search');
|
|
});
|
|
/* @license-end */</script>
|
|
<div id="main-nav"></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">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
$(document).ready(function(){initNavTree('class_p_i_object.html','');});
|
|
/* @license-end */
|
|
</script>
|
|
<div id="doc-content">
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="#pub-static-methods">Static Public Member Functions</a> |
|
|
<a href="#pro-methods">Protected Member Functions</a> |
|
|
<a href="#related">Related Functions</a> |
|
|
<a href="class_p_i_object-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">PIObject Class Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>This is base class for any classes which use events -> handlers mechanism.
|
|
<a href="class_p_i_object.html#details">More...</a></p>
|
|
<div class="dynheader">
|
|
Inheritance diagram for PIObject:</div>
|
|
<div class="dyncontent">
|
|
<div class="center"><img src="class_p_i_object__inherit__graph.png" border="0" usemap="#_p_i_object_inherit__map" alt="Inheritance graph"/></div>
|
|
<map name="_p_i_object_inherit__map" id="_p_i_object_inherit__map">
|
|
<area shape="rect" id="node2" href="class_p_i_c_l_i.html" title="Command-line arguments parser. " alt="" coords="208,31,271,57"/>
|
|
<area shape="rect" id="node3" href="class_p_i_connection.html" title="Complex Input/Output point. " alt="" coords="180,81,299,108"/>
|
|
<area shape="rect" id="node4" href="class_p_i_state_machine.html" title="Base class for custom state machine. " alt="" coords="140,132,339,159"/>
|
|
<area shape="rect" id="node5" href="class_p_i_stream_packer.html" title="Simple packet wrap aroud any PIIODevice. " alt="" coords="172,183,307,209"/>
|
|
<area shape="rect" id="node6" href="class_p_i_thread.html" title="Thread class. " alt="" coords="196,233,283,260"/>
|
|
<area shape="rect" id="node21" href="class_p_i_timer.html" title="Timer. " alt="" coords="200,309,279,336"/>
|
|
<area shape="rect" id="node7" href="class_p_i_broadcast.html" title="Broadcast for all interfaces, including loopback. " alt="" coords="395,107,505,133"/>
|
|
<area shape="rect" id="node8" href="class_p_i_console.html" title="Console output class. " alt="" coords="403,157,497,184"/>
|
|
<area shape="rect" id="node9" href="class_p_i_i_o_device.html" title="Base class for input/output classes. " alt="" coords="399,208,501,235"/>
|
|
<area shape="rect" id="node19" href="class_p_i_kbd_listener.html" title="Keyboard console input listener. " alt="" coords="387,259,513,285"/>
|
|
<area shape="rect" id="node20" href="class_p_i_process.html" title="PIProcess" alt="" coords="403,309,497,336"/>
|
|
<area shape="rect" id="node10" href="class_p_i_binary_log.html" title="Class for read and write binary data to logfile, and playback this data in realtime, or custom speed. " alt="" coords="593,5,704,32"/>
|
|
<area shape="rect" id="node11" href="class_p_i_ethernet.html" title="Ethernet device. " alt="" coords="597,56,700,83"/>
|
|
<area shape="rect" id="node12" href="class_p_i_file.html" title="Local file. " alt="" coords="613,107,684,133"/>
|
|
<area shape="rect" id="node13" href="class_p_i_i_o_byte_array.html" title="PIIODevice wrapper around PIByteArray. " alt="" coords="585,157,712,184"/>
|
|
<area shape="rect" id="node14" href="class_p_i_i_o_string.html" title="PIIODevice wrapper around PIString. " alt="" coords="597,208,700,235"/>
|
|
<area shape="rect" id="node15" href="class_p_i_packet_extractor.html" title="Packets extractor. " alt="" coords="569,259,728,285"/>
|
|
<area shape="rect" id="node16" href="class_p_i_serial.html" title="Serial device. " alt="" coords="605,309,692,336"/>
|
|
<area shape="rect" id="node17" href="class_p_i_shared_memory.html" title="Shared memory. " alt="" coords="581,360,716,387"/>
|
|
<area shape="rect" id="node18" href="class_p_i_transparent_device.html" title="PIIODevice that pass write to read. " alt="" coords="561,411,736,437"/>
|
|
<area shape="rect" id="node22" href="class_p_i_diagnostics.html" title="Connection quality diagnostics. " alt="" coords="387,360,513,387"/>
|
|
</map>
|
|
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
|
|
<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:a779d66bab882a51ef6389d2e212f2bd6"><td class="memItemLeft" align="right" valign="top"><a id="a779d66bab882a51ef6389d2e212f2bd6"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_object.html#a779d66bab882a51ef6389d2e212f2bd6">PIObject</a> (const <a class="el" href="class_p_i_string.html">PIString</a> &<a class="el" href="class_p_i_object.html#a5c3600479f3e919bbd4f905b7fedc275">name</a>=<a class="el" href="class_p_i_string.html">PIString</a>())</td></tr>
|
|
<tr class="memdesc:a779d66bab882a51ef6389d2e212f2bd6"><td class="mdescLeft"> </td><td class="mdescRight">Contructs <a class="el" href="class_p_i_object.html" title="This is base class for any classes which use events -> handlers mechanism. ">PIObject</a> with name "name". <br /></td></tr>
|
|
<tr class="separator:a779d66bab882a51ef6389d2e212f2bd6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5c3600479f3e919bbd4f905b7fedc275"><td class="memItemLeft" align="right" valign="top"><a id="a5c3600479f3e919bbd4f905b7fedc275"></a>
|
|
<a class="el" href="class_p_i_string.html">PIString</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_object.html#a5c3600479f3e919bbd4f905b7fedc275">name</a> () const</td></tr>
|
|
<tr class="memdesc:a5c3600479f3e919bbd4f905b7fedc275"><td class="mdescLeft"> </td><td class="mdescRight">Returns object name. <br /></td></tr>
|
|
<tr class="separator:a5c3600479f3e919bbd4f905b7fedc275"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac50df87aa63e061abd460f9a71e7176a"><td class="memItemLeft" align="right" valign="top"><a id="ac50df87aa63e061abd460f9a71e7176a"></a>
|
|
virtual const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_object.html#ac50df87aa63e061abd460f9a71e7176a">className</a> () const</td></tr>
|
|
<tr class="memdesc:ac50df87aa63e061abd460f9a71e7176a"><td class="mdescLeft"> </td><td class="mdescRight">Returns object class name. <br /></td></tr>
|
|
<tr class="separator:ac50df87aa63e061abd460f9a71e7176a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a281e02fd3810ec632c5db2e2460aa85c"><td class="memItemLeft" align="right" valign="top"><a id="a281e02fd3810ec632c5db2e2460aa85c"></a>
|
|
virtual const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_object.html#a281e02fd3810ec632c5db2e2460aa85c">parentClassName</a> () const</td></tr>
|
|
<tr class="memdesc:a281e02fd3810ec632c5db2e2460aa85c"><td class="mdescLeft"> </td><td class="mdescRight">Returns parent object class name. <br /></td></tr>
|
|
<tr class="separator:a281e02fd3810ec632c5db2e2460aa85c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8df5efbe08b98034b5ebadad11a2e94e"><td class="memItemLeft" align="right" valign="top"><a id="a8df5efbe08b98034b5ebadad11a2e94e"></a>
|
|
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_object.html#a8df5efbe08b98034b5ebadad11a2e94e">debug</a> () const</td></tr>
|
|
<tr class="memdesc:a8df5efbe08b98034b5ebadad11a2e94e"><td class="mdescLeft"> </td><td class="mdescRight">Return if debug of this object is active. <br /></td></tr>
|
|
<tr class="separator:a8df5efbe08b98034b5ebadad11a2e94e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8eb211f42dfcf7b7a1f32acabbfd6ada"><td class="memItemLeft" align="right" valign="top"><a id="a8eb211f42dfcf7b7a1f32acabbfd6ada"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_object.html#a8eb211f42dfcf7b7a1f32acabbfd6ada">setName</a> (const <a class="el" href="class_p_i_string.html">PIString</a> &<a class="el" href="class_p_i_object.html#a5c3600479f3e919bbd4f905b7fedc275">name</a>)</td></tr>
|
|
<tr class="memdesc:a8eb211f42dfcf7b7a1f32acabbfd6ada"><td class="mdescLeft"> </td><td class="mdescRight">Set object name. <br /></td></tr>
|
|
<tr class="separator:a8eb211f42dfcf7b7a1f32acabbfd6ada"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9a0ec972d4864287fae4d1a0edcd9dc5"><td class="memItemLeft" align="right" valign="top"><a id="a9a0ec972d4864287fae4d1a0edcd9dc5"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_object.html#a9a0ec972d4864287fae4d1a0edcd9dc5">setDebug</a> (bool <a class="el" href="class_p_i_object.html#a8df5efbe08b98034b5ebadad11a2e94e">debug</a>)</td></tr>
|
|
<tr class="memdesc:a9a0ec972d4864287fae4d1a0edcd9dc5"><td class="mdescLeft"> </td><td class="mdescRight">Set object debug active. <br /></td></tr>
|
|
<tr class="separator:a9a0ec972d4864287fae4d1a0edcd9dc5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1363089418ce5b3c22593f8c2ffdf63d"><td class="memItemLeft" align="right" valign="top"><a id="a1363089418ce5b3c22593f8c2ffdf63d"></a>
|
|
const PIMap< <a class="el" href="class_p_i_string.html">PIString</a>, <a class="el" href="class_p_i_variant.html">PIVariant</a> > & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_object.html#a1363089418ce5b3c22593f8c2ffdf63d">properties</a> () const</td></tr>
|
|
<tr class="memdesc:a1363089418ce5b3c22593f8c2ffdf63d"><td class="mdescLeft"> </td><td class="mdescRight">Returns properties of the object. <br /></td></tr>
|
|
<tr class="separator:a1363089418ce5b3c22593f8c2ffdf63d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:acbe8578cf9d01117554ec28d3882661c"><td class="memItemLeft" align="right" valign="top"><a id="acbe8578cf9d01117554ec28d3882661c"></a>
|
|
int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_object.html#acbe8578cf9d01117554ec28d3882661c">propertiesCount</a> () const</td></tr>
|
|
<tr class="memdesc:acbe8578cf9d01117554ec28d3882661c"><td class="mdescLeft"> </td><td class="mdescRight">Returns properties count of the object. <br /></td></tr>
|
|
<tr class="separator:acbe8578cf9d01117554ec28d3882661c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1ea9294ee2f2f59784762992878d7b99"><td class="memItemLeft" align="right" valign="top"><a id="a1ea9294ee2f2f59784762992878d7b99"></a>
|
|
<a class="el" href="class_p_i_variant.html">PIVariant</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_object.html#a1ea9294ee2f2f59784762992878d7b99">property</a> (const <a class="el" href="class_p_i_string.html">PIString</a> &<a class="el" href="class_p_i_object.html#a5c3600479f3e919bbd4f905b7fedc275">name</a>) const</td></tr>
|
|
<tr class="memdesc:a1ea9294ee2f2f59784762992878d7b99"><td class="mdescLeft"> </td><td class="mdescRight">Returns property with name "name". <br /></td></tr>
|
|
<tr class="separator:a1ea9294ee2f2f59784762992878d7b99"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a647e2f79b975cf88d636a2ca2dadfb9c"><td class="memItemLeft" align="right" valign="top"><a id="a647e2f79b975cf88d636a2ca2dadfb9c"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_object.html#a647e2f79b975cf88d636a2ca2dadfb9c">setProperty</a> (const <a class="el" href="class_p_i_string.html">PIString</a> &<a class="el" href="class_p_i_object.html#a5c3600479f3e919bbd4f905b7fedc275">name</a>, const <a class="el" href="class_p_i_variant.html">PIVariant</a> &value)</td></tr>
|
|
<tr class="memdesc:a647e2f79b975cf88d636a2ca2dadfb9c"><td class="mdescLeft"> </td><td class="mdescRight">Set property with name "name" to "value". If there is no such property in object it will be added. <br /></td></tr>
|
|
<tr class="separator:a647e2f79b975cf88d636a2ca2dadfb9c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:afe264bac22327160e40c1db19862cabf"><td class="memItemLeft" align="right" valign="top"><a id="afe264bac22327160e40c1db19862cabf"></a>
|
|
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_object.html#afe264bac22327160e40c1db19862cabf">isPropertyExists</a> (const <a class="el" href="class_p_i_string.html">PIString</a> &<a class="el" href="class_p_i_object.html#a5c3600479f3e919bbd4f905b7fedc275">name</a>) const</td></tr>
|
|
<tr class="memdesc:afe264bac22327160e40c1db19862cabf"><td class="mdescLeft"> </td><td class="mdescRight">Returns if property with name "name" exists. <br /></td></tr>
|
|
<tr class="separator:afe264bac22327160e40c1db19862cabf"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
|
|
Static Public Member Functions</h2></td></tr>
|
|
<tr class="memitem:af4581f822cb17c489e34da1abca2764a"><td class="memItemLeft" align="right" valign="top"><a id="af4581f822cb17c489e34da1abca2764a"></a>
|
|
static void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_object.html#af4581f822cb17c489e34da1abca2764a">piDisconnect</a> (<a class="el" href="class_p_i_object.html">PIObject</a> *src, const <a class="el" href="class_p_i_string.html">PIString</a> &sig)</td></tr>
|
|
<tr class="memdesc:af4581f822cb17c489e34da1abca2764a"><td class="mdescLeft"> </td><td class="mdescRight">Disconnect object "src" from all connections with event name "sig". <br /></td></tr>
|
|
<tr class="separator:af4581f822cb17c489e34da1abca2764a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1d556c03cc2ba29fd2515abc470e3393"><td class="memItemLeft" align="right" valign="top"><a id="a1d556c03cc2ba29fd2515abc470e3393"></a>
|
|
static void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_object.html#a1d556c03cc2ba29fd2515abc470e3393">piDisconnect</a> (<a class="el" href="class_p_i_object.html">PIObject</a> *src)</td></tr>
|
|
<tr class="memdesc:a1d556c03cc2ba29fd2515abc470e3393"><td class="mdescLeft"> </td><td class="mdescRight">Disconnect object "src" from all connections, i.e. all connections where object "src" is emitter. <br /></td></tr>
|
|
<tr class="separator:a1d556c03cc2ba29fd2515abc470e3393"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:afe05189de1d6ebbf44a2e16cfe200848"><td class="memItemLeft" align="right" valign="top"><a id="afe05189de1d6ebbf44a2e16cfe200848"></a>
|
|
static <a class="el" href="class_p_i_object.html">PIObject</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_object.html#afe05189de1d6ebbf44a2e16cfe200848">findByName</a> (const <a class="el" href="class_p_i_string.html">PIString</a> &<a class="el" href="class_p_i_object.html#a5c3600479f3e919bbd4f905b7fedc275">name</a>)</td></tr>
|
|
<tr class="memdesc:afe05189de1d6ebbf44a2e16cfe200848"><td class="mdescLeft"> </td><td class="mdescRight">Returns PIObject* with name "name" or 0, if there is no object found. <br /></td></tr>
|
|
<tr class="separator:afe05189de1d6ebbf44a2e16cfe200848"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
|
|
Protected Member Functions</h2></td></tr>
|
|
<tr class="memitem:a0bbc8d56e4f910c05e17ade5b9a0232f"><td class="memItemLeft" align="right" valign="top"><a id="a0bbc8d56e4f910c05e17ade5b9a0232f"></a>
|
|
<a class="el" href="class_p_i_object.html">PIObject</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_object.html#a0bbc8d56e4f910c05e17ade5b9a0232f">emitter</a> () const</td></tr>
|
|
<tr class="memdesc:a0bbc8d56e4f910c05e17ade5b9a0232f"><td class="mdescLeft"> </td><td class="mdescRight">Returns PIObject* which has raised an event. This value is correct only in definition of some event handler. <br /></td></tr>
|
|
<tr class="separator:a0bbc8d56e4f910c05e17ade5b9a0232f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2f98c7c43b93f9d636e9119f0a577715"><td class="memItemLeft" align="right" valign="top"><a id="a2f98c7c43b93f9d636e9119f0a577715"></a>
|
|
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_object.html#a2f98c7c43b93f9d636e9119f0a577715">propertyChanged</a> (const <a class="el" href="class_p_i_string.html">PIString</a> &<a class="el" href="class_p_i_object.html#a5c3600479f3e919bbd4f905b7fedc275">name</a>)</td></tr>
|
|
<tr class="memdesc:a2f98c7c43b93f9d636e9119f0a577715"><td class="mdescLeft"> </td><td class="mdescRight">Virtual function executes after property with name "name" has been changed. <br /></td></tr>
|
|
<tr class="separator:a2f98c7c43b93f9d636e9119f0a577715"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="related"></a>
|
|
Related Functions</h2></td></tr>
|
|
<tr><td class="ititle" colspan="2"><p>(Note that these are not member functions.) </p>
|
|
</td></tr>
|
|
<tr class="memitem:a722b67a967e55918f6921de66ecffce9"><td class="memItemLeft" align="right" valign="top"><a id="a722b67a967e55918f6921de66ecffce9"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_object.html#a722b67a967e55918f6921de66ecffce9">piCoutObj</a></td></tr>
|
|
<tr class="memdesc:a722b67a967e55918f6921de66ecffce9"><td class="mdescLeft"> </td><td class="mdescRight">Macro used for conditional (piDebug and <a class="el" href="class_p_i_object.html#a8df5efbe08b98034b5ebadad11a2e94e" title="Return if debug of this object is active. ">PIObject::debug()</a>) output to <a class="el" href="class_p_i_cout.html" title="Class for formatted output similar std::cout. ">PICout</a> for subclasses of <a class="el" href="class_p_i_object.html" title="This is base class for any classes which use events -> handlers mechanism. ">PIObject</a>. <br /></td></tr>
|
|
<tr class="separator:a722b67a967e55918f6921de66ecffce9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:affa62b02040517a34b3f173d804e487f"><td class="memItemLeft" align="right" valign="top"><a id="affa62b02040517a34b3f173d804e487f"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_object.html#affa62b02040517a34b3f173d804e487f">PIOBJECT</a>(<a class="el" href="class_p_i_object.html#a5c3600479f3e919bbd4f905b7fedc275">name</a>)</td></tr>
|
|
<tr class="memdesc:affa62b02040517a34b3f173d804e487f"><td class="mdescLeft"> </td><td class="mdescRight">you should use this macro after class declaration to use EVENT and EVENT_HANDLER and correct piCoutObj output <br /></td></tr>
|
|
<tr class="separator:affa62b02040517a34b3f173d804e487f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8cd6444e57a0f7f25888c8b8293d3543"><td class="memItemLeft" align="right" valign="top"><a id="a8cd6444e57a0f7f25888c8b8293d3543"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_object.html#a8cd6444e57a0f7f25888c8b8293d3543">PIOBJECT_SUBCLASS</a>(<a class="el" href="class_p_i_object.html#a5c3600479f3e919bbd4f905b7fedc275">name</a>, parent)</td></tr>
|
|
<tr class="memdesc:a8cd6444e57a0f7f25888c8b8293d3543"><td class="mdescLeft"> </td><td class="mdescRight">you should use this macro after class declaration to use EVENT and EVENT_HANDLER of parent class, and <em>scopeList()</em> <br /></td></tr>
|
|
<tr class="separator:a8cd6444e57a0f7f25888c8b8293d3543"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab605cf0454d34cc72c65bfed2abd696a"><td class="memItemLeft" align="right" valign="top"><a id="ab605cf0454d34cc72c65bfed2abd696a"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_object.html#ab605cf0454d34cc72c65bfed2abd696a">EVENT_HANDLER0</a>(ret, <a class="el" href="class_p_i_object.html#a5c3600479f3e919bbd4f905b7fedc275">name</a>)   ret <a class="el" href="class_p_i_object.html#a5c3600479f3e919bbd4f905b7fedc275">name</a>()</td></tr>
|
|
<tr class="memdesc:ab605cf0454d34cc72c65bfed2abd696a"><td class="mdescLeft"> </td><td class="mdescRight">declare event handler "event" with name "name" and return type "ret", ret <a class="el" href="class_p_i_object.html#a5c3600479f3e919bbd4f905b7fedc275" title="Returns object name. ">name()</a> <br /></td></tr>
|
|
<tr class="separator:ab605cf0454d34cc72c65bfed2abd696a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a56defa004e9b7efb2db50b3a43ca7225"><td class="memItemLeft" align="right" valign="top"><a id="a56defa004e9b7efb2db50b3a43ca7225"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_object.html#a56defa004e9b7efb2db50b3a43ca7225">EVENT_HANDLER1</a>(ret, <a class="el" href="class_p_i_object.html#a5c3600479f3e919bbd4f905b7fedc275">name</a>, type0, var0)   ret <a class="el" href="class_p_i_object.html#a5c3600479f3e919bbd4f905b7fedc275">name</a>(type0 var0)</td></tr>
|
|
<tr class="memdesc:a56defa004e9b7efb2db50b3a43ca7225"><td class="mdescLeft"> </td><td class="mdescRight">declare event handler "event" with name "name" and return type "ret", ret name(type0 var0) <br /></td></tr>
|
|
<tr class="separator:a56defa004e9b7efb2db50b3a43ca7225"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:abb64b696544ee4ee8715add9747c1293"><td class="memItemLeft" align="right" valign="top"><a id="abb64b696544ee4ee8715add9747c1293"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_object.html#abb64b696544ee4ee8715add9747c1293">EVENT_HANDLER2</a>(ret, <a class="el" href="class_p_i_object.html#a5c3600479f3e919bbd4f905b7fedc275">name</a>, type0, var0, type1, var1)   ret <a class="el" href="class_p_i_object.html#a5c3600479f3e919bbd4f905b7fedc275">name</a>(type0 var0, type1 var1)</td></tr>
|
|
<tr class="memdesc:abb64b696544ee4ee8715add9747c1293"><td class="mdescLeft"> </td><td class="mdescRight">declare event handler "event" with name "name" and return type "ret", ret name(type0 var0, type1 var1) <br /></td></tr>
|
|
<tr class="separator:abb64b696544ee4ee8715add9747c1293"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af90eced49fbdb43f5fc631fa7e7a44fb"><td class="memItemLeft" align="right" valign="top"><a id="af90eced49fbdb43f5fc631fa7e7a44fb"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_object.html#af90eced49fbdb43f5fc631fa7e7a44fb">EVENT_HANDLER3</a>(ret, <a class="el" href="class_p_i_object.html#a5c3600479f3e919bbd4f905b7fedc275">name</a>, type0, var0, type1, var1, type2, var2)   ret <a class="el" href="class_p_i_object.html#a5c3600479f3e919bbd4f905b7fedc275">name</a>(type0 var0, type1 var1, type2 var2)</td></tr>
|
|
<tr class="memdesc:af90eced49fbdb43f5fc631fa7e7a44fb"><td class="mdescLeft"> </td><td class="mdescRight">declare event handler "event" with name "name" and return type "ret", ret name(type0 var0, type1 var1, type2 var2) <br /></td></tr>
|
|
<tr class="separator:af90eced49fbdb43f5fc631fa7e7a44fb"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae8a8499ba07a4cc16c0b15c51b197d9f"><td class="memItemLeft" align="right" valign="top"><a id="ae8a8499ba07a4cc16c0b15c51b197d9f"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_object.html#ae8a8499ba07a4cc16c0b15c51b197d9f">EVENT_HANDLER4</a>(ret, <a class="el" href="class_p_i_object.html#a5c3600479f3e919bbd4f905b7fedc275">name</a>, type0, var0, type1, var1, type2, var2, type3, var3)   ret <a class="el" href="class_p_i_object.html#a5c3600479f3e919bbd4f905b7fedc275">name</a>(type0 var0, type1 var1, type2 var2, type3 var3)</td></tr>
|
|
<tr class="memdesc:ae8a8499ba07a4cc16c0b15c51b197d9f"><td class="mdescLeft"> </td><td class="mdescRight">declare event handler "event" with name "name" and return type "ret", ret name(type0 var0, type1 var1, type2 var2, type3 var3) <br /></td></tr>
|
|
<tr class="separator:ae8a8499ba07a4cc16c0b15c51b197d9f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae92ae8e64fbb4c6fa7d87cc1e93d55c0"><td class="memItemLeft" align="right" valign="top"><a id="ae92ae8e64fbb4c6fa7d87cc1e93d55c0"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_object.html#ae92ae8e64fbb4c6fa7d87cc1e93d55c0">EVENT_HANDLER</a>   <a class="el" href="class_p_i_object.html#ab605cf0454d34cc72c65bfed2abd696a">EVENT_HANDLER0</a></td></tr>
|
|
<tr class="memdesc:ae92ae8e64fbb4c6fa7d87cc1e93d55c0"><td class="mdescLeft"> </td><td class="mdescRight">EVENT_HANDLER is synonym of EVENT_HANDLER0. <br /></td></tr>
|
|
<tr class="separator:ae92ae8e64fbb4c6fa7d87cc1e93d55c0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a338377c8ec10707dd26a168b8aef5c31"><td class="memItemLeft" align="right" valign="top"><a id="a338377c8ec10707dd26a168b8aef5c31"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_object.html#a338377c8ec10707dd26a168b8aef5c31">EVENT_VHANDLER0</a>(ret, <a class="el" href="class_p_i_object.html#a5c3600479f3e919bbd4f905b7fedc275">name</a>)   virtual ret <a class="el" href="class_p_i_object.html#a5c3600479f3e919bbd4f905b7fedc275">name</a>()</td></tr>
|
|
<tr class="memdesc:a338377c8ec10707dd26a168b8aef5c31"><td class="mdescLeft"> </td><td class="mdescRight">declare virtual event handler "event" with name "name" and return type "ret", virtual ret <a class="el" href="class_p_i_object.html#a5c3600479f3e919bbd4f905b7fedc275" title="Returns object name. ">name()</a> <br /></td></tr>
|
|
<tr class="separator:a338377c8ec10707dd26a168b8aef5c31"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:abf138848427466a7ae91ada5876f926d"><td class="memItemLeft" align="right" valign="top"><a id="abf138848427466a7ae91ada5876f926d"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_object.html#abf138848427466a7ae91ada5876f926d">EVENT_VHANDLER1</a>(ret, <a class="el" href="class_p_i_object.html#a5c3600479f3e919bbd4f905b7fedc275">name</a>, type0, var0)   virtual ret <a class="el" href="class_p_i_object.html#a5c3600479f3e919bbd4f905b7fedc275">name</a>(type0 var0)</td></tr>
|
|
<tr class="memdesc:abf138848427466a7ae91ada5876f926d"><td class="mdescLeft"> </td><td class="mdescRight">declare virtual event handler "event" with name "name" and return type "ret", virtual ret name(type0 var0) <br /></td></tr>
|
|
<tr class="separator:abf138848427466a7ae91ada5876f926d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad0ba4a14c77b8d968dc13918f9b2d384"><td class="memItemLeft" align="right" valign="top"><a id="ad0ba4a14c77b8d968dc13918f9b2d384"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_object.html#ad0ba4a14c77b8d968dc13918f9b2d384">EVENT_VHANDLER2</a>(ret, <a class="el" href="class_p_i_object.html#a5c3600479f3e919bbd4f905b7fedc275">name</a>, type0, var0, type1, var1)   virtual ret <a class="el" href="class_p_i_object.html#a5c3600479f3e919bbd4f905b7fedc275">name</a>(type0 var0, type1 var1)</td></tr>
|
|
<tr class="memdesc:ad0ba4a14c77b8d968dc13918f9b2d384"><td class="mdescLeft"> </td><td class="mdescRight">declare virtual event handler "event" with name "name" and return type "ret", virtual ret name(type0 var0, type1 var1) <br /></td></tr>
|
|
<tr class="separator:ad0ba4a14c77b8d968dc13918f9b2d384"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4f47b429ac594cebdca1567e1b9a1021"><td class="memItemLeft" align="right" valign="top"><a id="a4f47b429ac594cebdca1567e1b9a1021"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_object.html#a4f47b429ac594cebdca1567e1b9a1021">EVENT_VHANDLER3</a>(ret, <a class="el" href="class_p_i_object.html#a5c3600479f3e919bbd4f905b7fedc275">name</a>, type0, var0, type1, var1, type2, var2)   virtual ret <a class="el" href="class_p_i_object.html#a5c3600479f3e919bbd4f905b7fedc275">name</a>(type0 var0, type1 var1, type2 var2)</td></tr>
|
|
<tr class="memdesc:a4f47b429ac594cebdca1567e1b9a1021"><td class="mdescLeft"> </td><td class="mdescRight">declare virtual event handler "event" with name "name" and return type "ret", virtual ret name(type0 var0, type1 var1, type2 var2) <br /></td></tr>
|
|
<tr class="separator:a4f47b429ac594cebdca1567e1b9a1021"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a96b2461314db11f3b68942bcd4b9d13d"><td class="memItemLeft" align="right" valign="top"><a id="a96b2461314db11f3b68942bcd4b9d13d"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_object.html#a96b2461314db11f3b68942bcd4b9d13d">EVENT_VHANDLER4</a>(ret, <a class="el" href="class_p_i_object.html#a5c3600479f3e919bbd4f905b7fedc275">name</a>, type0, var0, type1, var1, type2, var2, type3, var3)   virtual ret <a class="el" href="class_p_i_object.html#a5c3600479f3e919bbd4f905b7fedc275">name</a>(type0 var0, type1 var1, type2 var2, type3 var3)</td></tr>
|
|
<tr class="memdesc:a96b2461314db11f3b68942bcd4b9d13d"><td class="mdescLeft"> </td><td class="mdescRight">declare virtual event handler "event" with name "name" and return type "ret", virtual ret name(type0 var0, type1 var1, type2 var2, type3 var3) <br /></td></tr>
|
|
<tr class="separator:a96b2461314db11f3b68942bcd4b9d13d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a26a0e3181ebb2a90c11e9a7eb906a99e"><td class="memItemLeft" align="right" valign="top"><a id="a26a0e3181ebb2a90c11e9a7eb906a99e"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_object.html#a26a0e3181ebb2a90c11e9a7eb906a99e">EVENT_VHANDLER</a>   <a class="el" href="class_p_i_object.html#a338377c8ec10707dd26a168b8aef5c31">EVENT_VHANDLER0</a></td></tr>
|
|
<tr class="memdesc:a26a0e3181ebb2a90c11e9a7eb906a99e"><td class="mdescLeft"> </td><td class="mdescRight">EVENT_VHANDLER is synonym of EVENT_VHANDLER0. <br /></td></tr>
|
|
<tr class="separator:a26a0e3181ebb2a90c11e9a7eb906a99e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4fa760299649bc8aeaa0dcf4d605be70"><td class="memItemLeft" align="right" valign="top"><a id="a4fa760299649bc8aeaa0dcf4d605be70"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_object.html#a4fa760299649bc8aeaa0dcf4d605be70">EVENT0</a>(<a class="el" href="class_p_i_object.html#a5c3600479f3e919bbd4f905b7fedc275">name</a>)   void <a class="el" href="class_p_i_object.html#a5c3600479f3e919bbd4f905b7fedc275">name</a>();</td></tr>
|
|
<tr class="memdesc:a4fa760299649bc8aeaa0dcf4d605be70"><td class="mdescLeft"> </td><td class="mdescRight">declare event "event" with name "name", void <a class="el" href="class_p_i_object.html#a5c3600479f3e919bbd4f905b7fedc275" title="Returns object name. ">name()</a>; <br /></td></tr>
|
|
<tr class="separator:a4fa760299649bc8aeaa0dcf4d605be70"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7083e0b630c70def2ce05d60d70a45b9"><td class="memItemLeft" align="right" valign="top"><a id="a7083e0b630c70def2ce05d60d70a45b9"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_object.html#a7083e0b630c70def2ce05d60d70a45b9">EVENT1</a>(<a class="el" href="class_p_i_object.html#a5c3600479f3e919bbd4f905b7fedc275">name</a>, type0, var0)   void <a class="el" href="class_p_i_object.html#a5c3600479f3e919bbd4f905b7fedc275">name</a>(type0 var0);</td></tr>
|
|
<tr class="memdesc:a7083e0b630c70def2ce05d60d70a45b9"><td class="mdescLeft"> </td><td class="mdescRight">declare event "event" with name "name", void name(type0 var0); <br /></td></tr>
|
|
<tr class="separator:a7083e0b630c70def2ce05d60d70a45b9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a91d380b7235ad11b4830c4c2e8860618"><td class="memItemLeft" align="right" valign="top"><a id="a91d380b7235ad11b4830c4c2e8860618"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_object.html#a91d380b7235ad11b4830c4c2e8860618">EVENT2</a>(<a class="el" href="class_p_i_object.html#a5c3600479f3e919bbd4f905b7fedc275">name</a>, type0, var0, type1, var1)   void <a class="el" href="class_p_i_object.html#a5c3600479f3e919bbd4f905b7fedc275">name</a>(type0 var0, type1 var1);</td></tr>
|
|
<tr class="memdesc:a91d380b7235ad11b4830c4c2e8860618"><td class="mdescLeft"> </td><td class="mdescRight">declare event "event" with name "name", void name(type0 var0, type1 var1); <br /></td></tr>
|
|
<tr class="separator:a91d380b7235ad11b4830c4c2e8860618"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a685a85b0791e73158dc0173b4e18dd00"><td class="memItemLeft" align="right" valign="top"><a id="a685a85b0791e73158dc0173b4e18dd00"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_object.html#a685a85b0791e73158dc0173b4e18dd00">EVENT3</a>(<a class="el" href="class_p_i_object.html#a5c3600479f3e919bbd4f905b7fedc275">name</a>, type0, var0, type1, var1, type2, var2)   void <a class="el" href="class_p_i_object.html#a5c3600479f3e919bbd4f905b7fedc275">name</a>(type0 var0, type1 var1, type2 var2);</td></tr>
|
|
<tr class="memdesc:a685a85b0791e73158dc0173b4e18dd00"><td class="mdescLeft"> </td><td class="mdescRight">declare event "event" with name "name", void name(type0 var0, type1 var1, type2 var2); <br /></td></tr>
|
|
<tr class="separator:a685a85b0791e73158dc0173b4e18dd00"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a59032ae5e0b94cdfb52be1f24d5e8252"><td class="memItemLeft" align="right" valign="top"><a id="a59032ae5e0b94cdfb52be1f24d5e8252"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_object.html#a59032ae5e0b94cdfb52be1f24d5e8252">EVENT4</a>(<a class="el" href="class_p_i_object.html#a5c3600479f3e919bbd4f905b7fedc275">name</a>, type0, var0, type1, var1, type2, var2, type3, var3)   void <a class="el" href="class_p_i_object.html#a5c3600479f3e919bbd4f905b7fedc275">name</a>(type0 var0, type1 var1, type2 var2, type3 var3);</td></tr>
|
|
<tr class="memdesc:a59032ae5e0b94cdfb52be1f24d5e8252"><td class="mdescLeft"> </td><td class="mdescRight">declare event "event" with name "name", void name(type0 var0, type1 var1, type2 var2, type3 var3); <br /></td></tr>
|
|
<tr class="separator:a59032ae5e0b94cdfb52be1f24d5e8252"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7877e997621e1161f058fce90febd464"><td class="memItemLeft" align="right" valign="top"><a id="a7877e997621e1161f058fce90febd464"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_object.html#a7877e997621e1161f058fce90febd464">EVENT</a>   <a class="el" href="class_p_i_object.html#a4fa760299649bc8aeaa0dcf4d605be70">EVENT0</a></td></tr>
|
|
<tr class="memdesc:a7877e997621e1161f058fce90febd464"><td class="mdescLeft"> </td><td class="mdescRight">EVENT is synonym of EVENT0. <br /></td></tr>
|
|
<tr class="separator:a7877e997621e1161f058fce90febd464"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac86f9567fcbe10d7e49685e0a01b8427"><td class="memItemLeft" align="right" valign="top"><a id="ac86f9567fcbe10d7e49685e0a01b8427"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_object.html#ac86f9567fcbe10d7e49685e0a01b8427">CONNECTU</a>(src, event, dest, handler)</td></tr>
|
|
<tr class="memdesc:ac86f9567fcbe10d7e49685e0a01b8427"><td class="mdescLeft"> </td><td class="mdescRight">connect event "event" from object "src" to event handler "handler". "Event" and "handler" must has equal argument lists. <br /></td></tr>
|
|
<tr class="separator:ac86f9567fcbe10d7e49685e0a01b8427"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a36eb41db41fc261cf97260d1dbe76867"><td class="memItemLeft" align="right" valign="top"><a id="a36eb41db41fc261cf97260d1dbe76867"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_object.html#a36eb41db41fc261cf97260d1dbe76867">CONNECTU_QUEUED</a>(src, event, dest, handler, performer)</td></tr>
|
|
<tr class="memdesc:a36eb41db41fc261cf97260d1dbe76867"><td class="mdescLeft"> </td><td class="mdescRight">connect event "event" from object "src" to event handler "handler". Event handler will be executed by "performer". "Event" and "handler" must has equal argument lists. <br /></td></tr>
|
|
<tr class="separator:a36eb41db41fc261cf97260d1dbe76867"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a38e74a7ce99df00a10517f5ce4aa66c5"><td class="memItemLeft" align="right" valign="top"><a id="a38e74a7ce99df00a10517f5ce4aa66c5"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_object.html#a38e74a7ce99df00a10517f5ce4aa66c5">CONNECT0</a>(ret, src, event, dest, handler)</td></tr>
|
|
<tr class="memdesc:a38e74a7ce99df00a10517f5ce4aa66c5"><td class="mdescLeft"> </td><td class="mdescRight">connect event "event" from object "src" to event handler "handler" with return type "ret" from object "dest" with check of event and handler exists <br /></td></tr>
|
|
<tr class="separator:a38e74a7ce99df00a10517f5ce4aa66c5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a36132851189bb01db4957595111a28db"><td class="memItemLeft" align="right" valign="top"><a id="a36132851189bb01db4957595111a28db"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_object.html#a36132851189bb01db4957595111a28db">CONNECT1</a>(ret, type0, src, event, dest, handler)</td></tr>
|
|
<tr class="memdesc:a36132851189bb01db4957595111a28db"><td class="mdescLeft"> </td><td class="mdescRight">connect event "event" from object "src" to event handler "handler" with return type "ret" from object "dest" with check of event and handler exists <br /></td></tr>
|
|
<tr class="separator:a36132851189bb01db4957595111a28db"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a850bbf4e8361a106c99da4c46f684247"><td class="memItemLeft" align="right" valign="top"><a id="a850bbf4e8361a106c99da4c46f684247"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_object.html#a850bbf4e8361a106c99da4c46f684247">CONNECT2</a>(ret, type0, type1, src, event, dest, handler)</td></tr>
|
|
<tr class="memdesc:a850bbf4e8361a106c99da4c46f684247"><td class="mdescLeft"> </td><td class="mdescRight">connect event "event" from object "src" to event handler "handler" with return type "ret" from object "dest" with check of event and handler exists <br /></td></tr>
|
|
<tr class="separator:a850bbf4e8361a106c99da4c46f684247"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab45dbd69bde3cde22d4aba27ed585407"><td class="memItemLeft" align="right" valign="top"><a id="ab45dbd69bde3cde22d4aba27ed585407"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_object.html#ab45dbd69bde3cde22d4aba27ed585407">CONNECT3</a>(ret, type0, type1, type2, src, event, dest, handler)</td></tr>
|
|
<tr class="memdesc:ab45dbd69bde3cde22d4aba27ed585407"><td class="mdescLeft"> </td><td class="mdescRight">connect event "event" from object "src" to event handler "handler" with return type "ret" from object "dest" with check of event and handler exists <br /></td></tr>
|
|
<tr class="separator:ab45dbd69bde3cde22d4aba27ed585407"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a34e41d730c07354e07333def3d854019"><td class="memItemLeft" align="right" valign="top"><a id="a34e41d730c07354e07333def3d854019"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_object.html#a34e41d730c07354e07333def3d854019">CONNECT4</a>(ret, type0, type1, type2, type3, src, event, dest, handler)</td></tr>
|
|
<tr class="memdesc:a34e41d730c07354e07333def3d854019"><td class="mdescLeft"> </td><td class="mdescRight">connect event "event" from object "src" to event handler "handler" with return type "ret" from object "dest" with check of event and handler exists <br /></td></tr>
|
|
<tr class="separator:a34e41d730c07354e07333def3d854019"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a65528c74adc6691eac2c7a2f39328064"><td class="memItemLeft" align="right" valign="top"><a id="a65528c74adc6691eac2c7a2f39328064"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_object.html#a65528c74adc6691eac2c7a2f39328064">CONNECT</a>   <a class="el" href="class_p_i_object.html#a38e74a7ce99df00a10517f5ce4aa66c5">CONNECT0</a></td></tr>
|
|
<tr class="memdesc:a65528c74adc6691eac2c7a2f39328064"><td class="mdescLeft"> </td><td class="mdescRight">CONNECT is synonym of CONNECT0. <br /></td></tr>
|
|
<tr class="separator:a65528c74adc6691eac2c7a2f39328064"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aaaba5b68617a43903056bc175b8cd162"><td class="memItemLeft" align="right" valign="top"><a id="aaaba5b68617a43903056bc175b8cd162"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_object.html#aaaba5b68617a43903056bc175b8cd162">WEAK_CONNECT0</a>(ret, src, event, dest, handler)</td></tr>
|
|
<tr class="memdesc:aaaba5b68617a43903056bc175b8cd162"><td class="mdescLeft"> </td><td class="mdescRight">connect event "event" from object "src" to event handler "handler" with return type "ret" from object "dest" without check of event exists <br /></td></tr>
|
|
<tr class="separator:aaaba5b68617a43903056bc175b8cd162"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a37d80492e781bf82b9c22c56977da81e"><td class="memItemLeft" align="right" valign="top"><a id="a37d80492e781bf82b9c22c56977da81e"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_object.html#a37d80492e781bf82b9c22c56977da81e">WEAK_CONNECT1</a>(ret, type0, src, event, dest, handler)</td></tr>
|
|
<tr class="memdesc:a37d80492e781bf82b9c22c56977da81e"><td class="mdescLeft"> </td><td class="mdescRight">connect event "event" from object "src" to event handler "handler" with return type "ret" from object "dest" without check of event exists <br /></td></tr>
|
|
<tr class="separator:a37d80492e781bf82b9c22c56977da81e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a34134cc70172ef5a8d38ba8eb0db327d"><td class="memItemLeft" align="right" valign="top"><a id="a34134cc70172ef5a8d38ba8eb0db327d"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_object.html#a34134cc70172ef5a8d38ba8eb0db327d">WEAK_CONNECT2</a>(ret, type0, type1, src, event, dest, handler)</td></tr>
|
|
<tr class="memdesc:a34134cc70172ef5a8d38ba8eb0db327d"><td class="mdescLeft"> </td><td class="mdescRight">connect event "event" from object "src" to event handler "handler" with return type "ret" from object "dest" without check of event exists <br /></td></tr>
|
|
<tr class="separator:a34134cc70172ef5a8d38ba8eb0db327d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a601eb7e6e4c3c1a2ba741abbaf271fed"><td class="memItemLeft" align="right" valign="top"><a id="a601eb7e6e4c3c1a2ba741abbaf271fed"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_object.html#a601eb7e6e4c3c1a2ba741abbaf271fed">WEAK_CONNECT3</a>(ret, type0, type1, type2, src, event, dest, handler)</td></tr>
|
|
<tr class="memdesc:a601eb7e6e4c3c1a2ba741abbaf271fed"><td class="mdescLeft"> </td><td class="mdescRight">connect event "event" from object "src" to event handler "handler" with return type "ret" from object "dest" without check of event exists <br /></td></tr>
|
|
<tr class="separator:a601eb7e6e4c3c1a2ba741abbaf271fed"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a483ad0828f2c221308d95fd07ba1ee6e"><td class="memItemLeft" align="right" valign="top"><a id="a483ad0828f2c221308d95fd07ba1ee6e"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_object.html#a483ad0828f2c221308d95fd07ba1ee6e">WEAK_CONNECT4</a>(ret, type0, type1, type2, type3, src, event, dest, handler)</td></tr>
|
|
<tr class="memdesc:a483ad0828f2c221308d95fd07ba1ee6e"><td class="mdescLeft"> </td><td class="mdescRight">connect event "event" from object "src" to event handler "handler" with return type "ret" from object "dest" without check of event exists <br /></td></tr>
|
|
<tr class="separator:a483ad0828f2c221308d95fd07ba1ee6e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a52fc22658e025b4c15c8a2454d81b289"><td class="memItemLeft" align="right" valign="top"><a id="a52fc22658e025b4c15c8a2454d81b289"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_object.html#a52fc22658e025b4c15c8a2454d81b289">WEAK_CONNECT</a>   <a class="el" href="class_p_i_object.html#aaaba5b68617a43903056bc175b8cd162">WEAK_CONNECT0</a></td></tr>
|
|
<tr class="memdesc:a52fc22658e025b4c15c8a2454d81b289"><td class="mdescLeft"> </td><td class="mdescRight">WEAK_CONNECT is synonym of WEAK_CONNECT0. <br /></td></tr>
|
|
<tr class="separator:a52fc22658e025b4c15c8a2454d81b289"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aed7fd8edaccbbca33c51417ca43ac32a"><td class="memItemLeft" align="right" valign="top"><a id="aed7fd8edaccbbca33c51417ca43ac32a"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_object.html#aed7fd8edaccbbca33c51417ca43ac32a">DISCONNECT0</a>(ret, src, event, dest, handler)</td></tr>
|
|
<tr class="memdesc:aed7fd8edaccbbca33c51417ca43ac32a"><td class="mdescLeft"> </td><td class="mdescRight">piDisconnect event "event" from object "src" from event handler "handler" with return type "ret" from object "dest" <br /></td></tr>
|
|
<tr class="separator:aed7fd8edaccbbca33c51417ca43ac32a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae030e8deb226c636d2df22076391f12c"><td class="memItemLeft" align="right" valign="top"><a id="ae030e8deb226c636d2df22076391f12c"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_object.html#ae030e8deb226c636d2df22076391f12c">DISCONNECT1</a>(ret, type0, src, event, dest, handler)</td></tr>
|
|
<tr class="memdesc:ae030e8deb226c636d2df22076391f12c"><td class="mdescLeft"> </td><td class="mdescRight">piDisconnect event "event" from object "src" from event handler "handler" with return type "ret" from object "dest" <br /></td></tr>
|
|
<tr class="separator:ae030e8deb226c636d2df22076391f12c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8f0609bfd7dfcd4512d76480bc114dab"><td class="memItemLeft" align="right" valign="top"><a id="a8f0609bfd7dfcd4512d76480bc114dab"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_object.html#a8f0609bfd7dfcd4512d76480bc114dab">DISCONNECT2</a>(ret, type0, type1, src, event, dest, handler)</td></tr>
|
|
<tr class="memdesc:a8f0609bfd7dfcd4512d76480bc114dab"><td class="mdescLeft"> </td><td class="mdescRight">piDisconnect event "event" from object "src" from event handler "handler" with return type "ret" from object "dest" <br /></td></tr>
|
|
<tr class="separator:a8f0609bfd7dfcd4512d76480bc114dab"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af2789f99d1916f231fc579f00370fa6f"><td class="memItemLeft" align="right" valign="top"><a id="af2789f99d1916f231fc579f00370fa6f"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_object.html#af2789f99d1916f231fc579f00370fa6f">DISCONNECT3</a>(ret, type0, type1, type2, src, event, dest, handler)</td></tr>
|
|
<tr class="memdesc:af2789f99d1916f231fc579f00370fa6f"><td class="mdescLeft"> </td><td class="mdescRight">piDisconnect event "event" from object "src" from event handler "handler" with return type "ret" from object "dest" <br /></td></tr>
|
|
<tr class="separator:af2789f99d1916f231fc579f00370fa6f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aedf429d3192da764163c1377cad310e3"><td class="memItemLeft" align="right" valign="top"><a id="aedf429d3192da764163c1377cad310e3"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_object.html#aedf429d3192da764163c1377cad310e3">DISCONNECT4</a>(ret, type0, type1, type2, type3, src, event, dest, handler)</td></tr>
|
|
<tr class="memdesc:aedf429d3192da764163c1377cad310e3"><td class="mdescLeft"> </td><td class="mdescRight">piDisconnect event "event" from object "src" from event handler "handler" with return type "ret" from object "dest" <br /></td></tr>
|
|
<tr class="separator:aedf429d3192da764163c1377cad310e3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a587604e6f3570c0fc32794384d4d0d1f"><td class="memItemLeft" align="right" valign="top"><a id="a587604e6f3570c0fc32794384d4d0d1f"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_object.html#a587604e6f3570c0fc32794384d4d0d1f">DISCONNECT</a>   <a class="el" href="class_p_i_object.html#aed7fd8edaccbbca33c51417ca43ac32a">DISCONNECT0</a></td></tr>
|
|
<tr class="memdesc:a587604e6f3570c0fc32794384d4d0d1f"><td class="mdescLeft"> </td><td class="mdescRight">DISCONNECT is synonym of DISCONNECT0. <br /></td></tr>
|
|
<tr class="separator:a587604e6f3570c0fc32794384d4d0d1f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3f7b0da6b28ced23e1deee48dde17c98"><td class="memItemLeft" align="right" valign="top"><a id="a3f7b0da6b28ced23e1deee48dde17c98"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_object.html#a3f7b0da6b28ced23e1deee48dde17c98">HANDLER</a>(handler)</td></tr>
|
|
<tr class="memdesc:a3f7b0da6b28ced23e1deee48dde17c98"><td class="mdescLeft"> </td><td class="mdescRight">Returns pointer to events handler "handler". <br /></td></tr>
|
|
<tr class="separator:a3f7b0da6b28ced23e1deee48dde17c98"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="member-group"></a>
|
|
Events</h2></td></tr>
|
|
<tr class="memitem:a3d5e7421d26c565d1c20bfa5220c2601"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_object.html#a3d5e7421d26c565d1c20bfa5220c2601">deleted</a> ()</td></tr>
|
|
<tr class="memdesc:a3d5e7421d26c565d1c20bfa5220c2601"><td class="mdescLeft"> </td><td class="mdescRight">Raise before object delete. <a href="#a3d5e7421d26c565d1c20bfa5220c2601">More...</a><br /></td></tr>
|
|
<tr class="separator:a3d5e7421d26c565d1c20bfa5220c2601"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>This is base class for any classes which use events -> handlers mechanism. </p>
|
|
<h1><a class="anchor" id="PIObject_sec0"></a>
|
|
Events and Event handlers</h1>
|
|
<p>PIObject provide notification mechanism similar Qt but implemented on language capabilities without any special preprocessors or compilers. Any class inherits <a class="el" href="class_p_i_object.html" title="This is base class for any classes which use events -> handlers mechanism. ">PIObject</a> should use macro <em><a class="el" href="class_p_i_object.html#affa62b02040517a34b3f173d804e487f" title="you should use this macro after class declaration to use EVENT and EVENT_HANDLER and correct piCoutOb...">PIOBJECT()</a></em> immediate after declaration to proper compile.</p>
|
|
<p>Event is a some abstract event that can be raised at any time. Event is a function but declared with special macro <em><a class="el" href="class_p_i_object.html#a7877e997621e1161f058fce90febd464" title="EVENT is synonym of EVENT0. ">EVENT()</a></em>. To raise event simply execute event function.</p>
|
|
<p>Event handler is a function but declared with special macro <em><a class="el" href="class_p_i_object.html#ae92ae8e64fbb4c6fa7d87cc1e93d55c0" title="EVENT_HANDLER is synonym of EVENT_HANDLER0. ">EVENT_HANDLER()</a></em>. You can use event handlers as ordinary functions.</p>
|
|
<p>Main goal of this mechanism is perform abstract connections between various objects. This functionality provide macro <em><a class="el" href="class_p_i_object.html#a65528c74adc6691eac2c7a2f39328064" title="CONNECT is synonym of CONNECT0. ">CONNECT()</a></em> which connect some event of first object to some event handler or event of second object. Each event can be connected any times to any event handlers.</p>
|
|
<div class="image">
|
|
<img src="events_handlers.png" alt="events_handlers.png"/>
|
|
</div>
|
|
<p>Example: </p><div class="fragment"><div class="line"><span class="keyword">class </span>ObjectA: <span class="keyword">public</span> <a class="code" href="class_p_i_object.html">PIObject</a> {</div><div class="line"> <a class="code" href="class_p_i_object.html#affa62b02040517a34b3f173d804e487f">PIOBJECT</a>(ObjectA)</div><div class="line"><span class="keyword">public</span>:</div><div class="line"> <a class="code" href="class_p_i_object.html#a56defa004e9b7efb2db50b3a43ca7225">EVENT_HANDLER1</a>(<span class="keywordtype">void</span>, handlerA, <span class="keyword">const</span> <a class="code" href="class_p_i_string.html">PIString</a> & , str) {<a class="code" href="class_p_i_object.html#a722b67a967e55918f6921de66ecffce9">piCoutObj</a> << <span class="stringliteral">"handler A:"</span> << str;}</div><div class="line"> <a class="code" href="class_p_i_object.html#a91d380b7235ad11b4830c4c2e8860618">EVENT2</a>(eventA2, <span class="keywordtype">int</span>, i, <span class="keywordtype">float</span>, f);</div><div class="line"> <a class="code" href="class_p_i_object.html#a7083e0b630c70def2ce05d60d70a45b9">EVENT1</a>(eventA1, <span class="keyword">const</span> <a class="code" href="class_p_i_string.html">PIString</a> & , str);</div><div class="line">};</div><div class="line"></div><div class="line"><span class="keyword">class </span>ObjectB: <span class="keyword">public</span> <a class="code" href="class_p_i_object.html">PIObject</a> {</div><div class="line"> <a class="code" href="class_p_i_object.html#affa62b02040517a34b3f173d804e487f">PIOBJECT</a>(ObjectB)</div><div class="line"><span class="keyword">public</span>:</div><div class="line"> <a class="code" href="class_p_i_object.html#abb64b696544ee4ee8715add9747c1293">EVENT_HANDLER2</a>(<span class="keywordtype">void</span>, handlerB, <span class="keywordtype">int</span>, i, <span class="keywordtype">float</span>, f) {<a class="code" href="class_p_i_object.html#a722b67a967e55918f6921de66ecffce9">piCoutObj</a> << <span class="stringliteral">"handler B:"</span> << i << <span class="stringliteral">","</span> << f;}</div><div class="line"> <a class="code" href="class_p_i_object.html#a7083e0b630c70def2ce05d60d70a45b9">EVENT1</a>(eventB, <a class="code" href="class_p_i_string.html">PIString</a>, str);</div><div class="line">};</div><div class="line"></div><div class="line"><span class="keywordtype">int</span> main(<span class="keywordtype">int</span> argc, <span class="keywordtype">char</span> * argv[]) {</div><div class="line"> ObjectA obj_a;</div><div class="line"> ObjectB obj_b;</div><div class="line"> </div><div class="line"> <a class="code" href="class_p_i_object.html#a850bbf4e8361a106c99da4c46f684247">CONNECT2</a>(<span class="keywordtype">void</span>, <span class="keywordtype">int</span>, <span class="keywordtype">float</span>, &obj_a, eventA2, &obj_b, handlerB);</div><div class="line"> obj_a.eventA2(2, 0.5);</div><div class="line"> </div><div class="line"> <a class="code" href="class_p_i_object.html#a36132851189bb01db4957595111a28db">CONNECT1</a>(<span class="keywordtype">void</span>, <a class="code" href="class_p_i_string.html">PIString</a>, &obj_b, eventB, &obj_a, handlerA);</div><div class="line"> obj_b.eventB(<span class="stringliteral">"event to handler"</span>);</div><div class="line"> </div><div class="line"> <a class="code" href="class_p_i_object.html#a36132851189bb01db4957595111a28db">CONNECT1</a>(<span class="keywordtype">void</span>, <a class="code" href="class_p_i_string.html">PIString</a>, &obj_a, eventA1, &obj_b, eventB);</div><div class="line"> obj_a.eventA1(<span class="stringliteral">"event to event"</span>);</div><div class="line">};</div></div><!-- fragment --><p> Result: </p><div class="fragment"><div class="line">handler B: 2 , 0.5</div><div class="line">handler A: <span class="keyword">event</span> to handler</div><div class="line">handler A: <span class="keyword">event</span> to <span class="keyword">event</span></div></div><!-- fragment --> </div><h2 class="groupheader">Member Function Documentation</h2>
|
|
<a id="a3d5e7421d26c565d1c20bfa5220c2601"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a3d5e7421d26c565d1c20bfa5220c2601">◆ </a></span>deleted()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void PIObject::deleted </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Raise before object delete. </p>
|
|
<dl class="section note"><dt>Note</dt><dd>This event raised from destructor, so use only <a class="el" href="class_p_i_object.html#a0bbc8d56e4f910c05e17ade5b9a0232f" title="Returns PIObject* which has raised an event. This value is correct only in definition of some event h...">emitter()</a> value, don`t try to cast deleted object to some subclass! </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
</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="class_p_i_object.html">PIObject</a></li>
|
|
<li class="footer">Generated on Fri Sep 28 2018 21:06:37 for PIP by
|
|
<a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.14 </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|