File: classCEGUI_1_1Event_1_1ScopedConnection.html

package info (click to toggle)
cegui-mk2 0.7.6-3.3
  • links: PTS
  • area: main
  • in suites: jessie, jessie-kfreebsd
  • size: 105,388 kB
  • ctags: 82,178
  • sloc: cpp: 142,729; ansic: 27,984; sh: 11,010; makefile: 2,275; python: 916; xml: 17
file content (134 lines) | stat: -rw-r--r-- 8,805 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
<!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>Crazy Eddies GUI System: CEGUI::Event::ScopedConnection Class Reference</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.4 -->
<script type="text/javascript">
function hasClass(ele,cls) {
  return ele.className.match(new RegExp('(\\s|^)'+cls+'(\\s|$)'));
}

function addClass(ele,cls) {
  if (!this.hasClass(ele,cls)) ele.className += " "+cls;
}

function removeClass(ele,cls) {
  if (hasClass(ele,cls)) {
    var reg = new RegExp('(\\s|^)'+cls+'(\\s|$)');
    ele.className=ele.className.replace(reg,' ');
  }
}

function toggleVisibility(linkObj) {
 var base = linkObj.getAttribute('id');
 var summary = document.getElementById(base + '-summary');
 var content = document.getElementById(base + '-content');
 var trigger = document.getElementById(base + '-trigger');
 if ( hasClass(linkObj,'closed') ) {
   summary.style.display = 'none';
   content.style.display = 'block';
   trigger.src = 'open.png';
   removeClass(linkObj,'closed');
   addClass(linkObj,'opened');
 } else if ( hasClass(linkObj,'opened') ) {
   summary.style.display = 'block';
   content.style.display = 'none';
   trigger.src = 'closed.png';
   removeClass(linkObj,'opened');
   addClass(linkObj,'closed');
 }
 return false;
}
</script>
<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">Crazy Eddies GUI System&#160;<span id="projectnumber">0.7.6</span></div>
  </td>
 </tr>
 </tbody>
</table>
</div>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
  <div id="nav-path" class="navpath">
    <ul>
      <li class="navelem"><a class="el" href="namespaceCEGUI.html">CEGUI</a>      </li>
      <li class="navelem"><a class="el" href="classCEGUI_1_1Event.html">Event</a>      </li>
      <li class="navelem"><a class="el" href="classCEGUI_1_1Event_1_1ScopedConnection.html">ScopedConnection</a>      </li>
    </ul>
  </div>
</div>
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a>  </div>
  <div class="headertitle">
<div class="title">CEGUI::Event::ScopedConnection Class Reference</div>  </div>
</div>
<div class="contents">
<!-- doxytag: class="CEGUI::Event::ScopedConnection" --><!-- doxytag: inherits="RefCounted&lt; BoundSlot &gt;" -->
<p><a class="el" href="classCEGUI_1_1Event.html#a67bc40ba6d8f7fec9c2dff68a6c8cb09" title="Connection object. This is a thin &#39;smart pointer&#39; wrapper around the actual BoundSlot that represents...">Event::Connection</a> wrapper that automatically disconnects the connection when the object is deleted (or goes out of scope).  
 <a href="classCEGUI_1_1Event_1_1ScopedConnection.html#details">More...</a></p>
<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
  <img id="dynsection-0-trigger" src="closed.png"/> Inheritance diagram for CEGUI::Event::ScopedConnection:</div>
<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
<div class="center"><img src="classCEGUI_1_1Event_1_1ScopedConnection__inherit__graph.gif" border="0" usemap="#CEGUI_1_1Event_1_1ScopedConnection_inherit__map" alt="Inheritance graph"/></div>
<map name="CEGUI_1_1Event_1_1ScopedConnection_inherit__map" id="CEGUI_1_1Event_1_1ScopedConnection_inherit__map">
<area shape="rect" id="node2" href="classCEGUI_1_1RefCounted.html" title="Connection" alt="" coords="73,5,161,35"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<div id="dynsection-1" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
  <img id="dynsection-1-trigger" src="closed.png"/> Collaboration diagram for CEGUI::Event::ScopedConnection:</div>
<div id="dynsection-1-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-1-content" class="dyncontent" style="display:none;">
<div class="center"><img src="classCEGUI_1_1Event_1_1ScopedConnection__coll__graph.gif" border="0" usemap="#CEGUI_1_1Event_1_1ScopedConnection_coll__map" alt="Collaboration graph"/></div>
<map name="CEGUI_1_1Event_1_1ScopedConnection_coll__map" id="CEGUI_1_1Event_1_1ScopedConnection_coll__map">
<area shape="rect" id="node2" href="classCEGUI_1_1RefCounted.html" title="Connection" alt="" coords="17,101,105,131"/><area shape="rect" id="node4" href="classCEGUI_1_1BoundSlot.html" title="Class that tracks a SubscriberSlot, its group, and the Event to which it was subscribed. This is effectively what gets returned from the calls to the Event::subscribe members, though BoundSlot is always wrapped in a reference counted pointer. When a BoundSlot is deleted, the connection is unsubscribed and the SubscriberSlot is deleted." alt="" coords="97,5,231,35"/><area shape="rect" id="node6" href="classCEGUI_1_1RefCounted.html" title="CEGUI::RefCounted\&lt; BoundSlot \&gt;" alt="" coords="129,101,356,131"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>

<p><a href="classCEGUI_1_1Event_1_1ScopedConnection-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a63c7ff9679cec01ce966ad9699b717e1"></a><!-- doxytag: member="CEGUI::Event::ScopedConnection::ScopedConnection" ref="a63c7ff9679cec01ce966ad9699b717e1" args="(const Event::Connection &amp;connection)" -->
&#160;</td><td class="memItemRight" valign="bottom"><b>ScopedConnection</b> (const <a class="el" href="classCEGUI_1_1RefCounted.html">Event::Connection</a> &amp;connection)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a913cfb0522699d38e1ac723ef23d22d9"></a><!-- doxytag: member="CEGUI::Event::ScopedConnection::operator=" ref="a913cfb0522699d38e1ac723ef23d22d9" args="(const Event::Connection &amp;connection)" -->
<a class="el" href="classCEGUI_1_1Event_1_1ScopedConnection.html">ScopedConnection</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>operator=</b> (const <a class="el" href="classCEGUI_1_1RefCounted.html">Event::Connection</a> &amp;connection)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa0fa96b2a39f4a63f5092ebb54af8a04"></a><!-- doxytag: member="CEGUI::Event::ScopedConnection::connected" ref="aa0fa96b2a39f4a63f5092ebb54af8a04" args="() const " -->
bool&#160;</td><td class="memItemRight" valign="bottom"><b>connected</b> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad205c64d99ecf2d3000fa67d281b711d"></a><!-- doxytag: member="CEGUI::Event::ScopedConnection::disconnect" ref="ad205c64d99ecf2d3000fa67d281b711d" args="()" -->
void&#160;</td><td class="memItemRight" valign="bottom"><b>disconnect</b> ()</td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p><a class="el" href="classCEGUI_1_1Event.html#a67bc40ba6d8f7fec9c2dff68a6c8cb09" title="Connection object. This is a thin &#39;smart pointer&#39; wrapper around the actual BoundSlot that represents...">Event::Connection</a> wrapper that automatically disconnects the connection when the object is deleted (or goes out of scope). </p>
</div></div>
<hr class="footer"/><address class="footer"><small>Generated on Sun Jan 22 2012 16:07:40 for Crazy Eddies GUI System by&#160;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.4 </small></address>
</body>
</html>