cstd
Version:
CoffeeScript Standart Library
266 lines • 5.74 kB
HTML
<html>
<head>
<meta charset='UTF-8'>
<title>CoffeeScript standarts</title>
<script src='../javascript/application.js'></script>
<script src='../javascript/search.js'></script>
<link rel='stylesheet' href='../stylesheets/application.css' type='text/css'>
</head>
<body>
<div id='base' data-path='../'></div>
<div id='header'>
<div id='menu'>
<a href='../extra/README.md.html' title='CSTD'>
CSTD
</a>
»
<a href='../alphabetical_index.html' title='Index'>
Index
</a>
»
<span class='title'>CSEvent</span>
</div>
</div>
<div id='content'>
<h1>
Class:
CSEvent
</h1>
<table class='box'>
<tr>
<td>Defined in:</td>
<td>lib/emitter.coffee</td>
</tr>
<tr>
<td>Inherits:</td>
<td>
<a href='../class/CSObject.html'>CSObject</a>
</td>
</tr>
</table>
<h2>Overview</h2>
<div class='docstring'>
<p>Class <code>CSEvent</code> is object to throw when event call.</p>
</div>
<div class='tags'>
</div>
<h2>Property Summary</h2>
<dl class='properties'>
<dt id='name-property'>
<span class='signature'>
(String)
<b>
name
</b>
</span>
</dt>
<dd class='desc'>
name of a event
</dd>
<dt id='ts-property'>
<span class='signature'>
(Number)
<b>
ts
</b>
</span>
</dt>
<dd class='desc'>
timestamp in milliseconds
</dd>
<dt id='value-property'>
<span class='signature'>
(*)
<b>
value
</b>
</span>
</dt>
<dd class='desc'>
optional parameter
</dd>
<dt id='target-property'>
<span class='signature'>
(CSEmitter)
<b>
target
</b>
</span>
</dt>
<dd class='desc'>
link to object, when fire event
</dd>
</dl>
<h2>Instance Method Summary</h2>
<ul class='summary'>
<li>
<span class='signature'>
<a href='#destructor-dynamic'>
#
(null)
<b>destructor</b><span>()</span>
</a>
</span>
<span class='desc'>
kill all links
</span>
</li>
</ul>
<h2>
<small>Inherited Method Summary</small>
<h3 class='inherited'>
Methods inherited from
<a href='../class/CSObject.html'>CSObject</a>
</h3>
<p class='inherited'>
<a href='../class/CSObject.html#destructor-dynamic'>#destructor</a>
</p>
</h2>
<h2>Constructor Details</h2>
<div class='methods'>
<div class='method_details'>
<p class='signature' id='constructor-dynamic'>
#
(void)
<b>constructor</b><span>(name, target, value)</span>
<br>
</p>
<div class='docstring'>
<p>Create event with name <code>name</code> by object <code>target</code> with
optionally any data <code>value</code></p>
</div>
<div class='tags'>
<h3>Parameters:</h3>
<ul class='param'>
<li>
<span class='name'>name</span>
<span class='type'>
(
<tt>String</tt>
)
</span>
—
<span class='desc'>is name of event </span>
</li>
<li>
<span class='name'>target</span>
<span class='type'>
(
<tt><a href='../class/CSEmitter.html'>CSEmitter</a></tt>
)
</span>
—
<span class='desc'>is link to CSEmitter child object </span>
</li>
<li>
<span class='name'>value</span>
<span class='type'>
(
<tt>*</tt>
)
</span>
—
<span class='desc'>data for transmit to event handler </span>
</li>
</ul>
</div>
</div>
</div>
<h2>Instance Method Details</h2>
<div class='methods'>
<div class='method_details'>
<p class='signature' id='destructor-dynamic'>
#
(null)
<b>destructor</b><span>()</span>
<br>
</p>
<div class='docstring'>
<p>kill all links</p>
</div>
<div class='tags'>
<h3>Returns:</h3>
<ul class='return'>
<li>
<span class='type'></span>
<tt>null</tt>
</li>
</ul>
</div>
</div>
</div>
</div>
<div id='footer'>
By
<a href='https://github.com/coffeedoc/codo' title='CoffeeScript API documentation generator'>
Codo
</a>
2.1.0
✲
Press H to see the keyboard shortcuts
✲
<a href='http://twitter.com/netzpirat' target='_parent'>@netzpirat</a>
✲
<a href='http://twitter.com/_inossidabile' target='_parent'>@_inossidabile</a>
</div>
<iframe id='search_frame'></iframe>
<div id='fuzzySearch'>
<input type='text'>
<ol></ol>
</div>
<div id='help'>
<p>
Quickly fuzzy find classes, mixins, methods, file:
</p>
<ul>
<li>
<span>T</span>
Open fuzzy finder dialog
</li>
</ul>
<p>
Control the navigation frame:
</p>
<ul>
<li>
<span>L</span>
Toggle list view
</li>
<li>
<span>C</span>
Show class list
</li>
<li>
<span>I</span>
Show mixin list
</li>
<li>
<span>F</span>
Show file list
</li>
<li>
<span>M</span>
Show method list
</li>
<li>
<span>E</span>
Show extras list
</li>
</ul>
<p>
You can focus and blur the search input:
</p>
<ul>
<li>
<span>S</span>
Focus search input
</li>
<li>
<span>Esc</span>
Blur search input
</li>
</ul>
</div>
</body>
</html>