Subversion-Projekte lars-tiefland.ci

<!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" xml:lang="en" lang="en">

	<head>

		<meta http-equiv="content-type" content="text/html; charset=utf-8" />

		<meta name="generator" content="JsDoc Toolkit" />

		<title>JsDoc Reference - PubSub</title>

		<style type="text/css">

			/* default.css */

body

{

	font: 12px "Lucida Grande", Tahoma, Arial, Helvetica, sans-serif;

	width: 800px;

}

.header

{

	clear: both;

	background-color: #ccc;

	padding: 8px;

}

h1

{

	font-size: 150%;

	font-weight: bold;

	padding: 0;

	margin: 1em 0 0 .3em;

}

hr

{

	border: none 0;

	border-top: 1px solid #7F8FB1;

	height: 1px;

}

pre.code

{

	display: block;

	padding: 8px;

	border: 1px dashed #ccc;

}

#index

{

	margin-top: 24px;

	float: left;

	width: 160px;

	position: absolute;

	left: 8px;

	background-color: #F3F3F3;

	padding: 8px;

}

#content

{

	margin-left: 190px;

	width: 600px;

}

.classList

{

	list-style-type: none;

	padding: 0;

	margin: 0 0 0 8px;

	font-family: arial, sans-serif;

	font-size: 1em;

	overflow: auto;

}

.classList li

{

	padding: 0;

	margin: 0 0 8px 0;

}

.summaryTable { width: 100%; }

h1.classTitle

{

	font-size:170%;

	line-height:130%;

}

h2 { font-size: 110%; }

caption, div.sectionTitle

{

	background-color: #7F8FB1;

	color: #fff;

	font-size:130%;

	text-align: left;

	padding: 2px 6px 2px 6px;

	border: 1px #7F8FB1 solid;

}

div.sectionTitle { margin-bottom: 8px; }

.summaryTable thead { display: none; }

.summaryTable td

{

	vertical-align: top;

	padding: 4px;

	border-bottom: 1px #7F8FB1 solid;

	border-right: 1px #7F8FB1 solid;

}

/*col#summaryAttributes {}*/

.summaryTable td.attributes

{

	border-left: 1px #7F8FB1 solid;

	width: 140px;

	text-align: right;

}

td.attributes, .fixedFont

{

	line-height: 15px;

	color: #002EBE;

	font-family: "Courier New",Courier,monospace;

	font-size: 13px;

}

.summaryTable td.nameDescription

{

	text-align: left;

	font-size: 13px;

	line-height: 15px;

}

.summaryTable td.nameDescription, .description

{

	line-height: 15px;

	padding: 4px;

	padding-left: 4px;

}

.summaryTable { margin-bottom: 8px; }

ul.inheritsList

{

	list-style: square;

	margin-left: 20px;

	padding-left: 0;

}

.detailList {

	margin-left: 20px;

	line-height: 15px;

}

.detailList dt { margin-left: 20px; }

.detailList .heading

{

	font-weight: bold;

	padding-bottom: 6px;

	margin-left: 0;

}

.light, td.attributes, .light a:link, .light a:visited

{

	color: #777;

	font-style: italic;

}

.fineprint

{

	text-align: right;

	font-size: 10px;

}

		</style>

	</head>

	<body>

<!-- ============================== header ================================= -->

		<!-- begin static/header.html -->

		<div id="header">

</div>

		<!-- end static/header.html -->

<!-- ============================== classes index ============================ -->

		<div id="index">

			<!-- begin publish.classesIndex -->

			<div align="center"><a href="../index.html">Class Index</a>

| <a href="../files.html">File Index</a></div>

<hr />

<h2>Classes</h2>

<ul class="classList">

	<li><i><a href="../symbols/_global_.html">_global_</a></i></li>

	<li><a href="../symbols/FontObject.html">FontObject</a></li>

	<li><a href="../symbols/jsPDF.html">jsPDF</a></li>

	<li><a href="../symbols/PubSub.html">PubSub</a></li>

</ul>

<hr />

			<!-- end publish.classesIndex -->

		</div>

		<div id="content">

<!-- ============================== class title ============================ -->

			<h1 class="classTitle">

				Class PubSub

			</h1>

<!-- ============================== class summary ========================== -->

			<p class="description">

					<br /><i>Defined in: </i> <a href="../symbols/src/c__work_jsPDF_jspdf.js.html">jspdf.js</a>.

			</p>

<!-- ============================== constructor summary ==================== -->

			<table class="summaryTable" cellspacing="0" summary="A summary of the constructor documented in the class PubSub.">

				<caption>Class Summary</caption>

				<thead>

					<tr>

						<th scope="col">Constructor Attributes</th>

						<th scope="col">Constructor Name and Description</th>

					</tr>

				</thead>

				<tbody>

					<tr>

						<td class="attributes">&nbsp;</td>

						<td class="nameDescription" >

							<div class="fixedFont">

								<b><a href="../symbols/PubSub.html#constructor">PubSub</a></b>()

							</div>

							<div class="description">PubSub implementation</div>

						</td>

					</tr>

				</tbody>

			</table>

<!-- ============================== properties summary ===================== -->

<!-- ============================== methods summary ======================== -->

				<table class="summaryTable" cellspacing="0" summary="A summary of the methods documented in the class PubSub.">

					<caption>Method Summary</caption>

					<thead>

						<tr>

							<th scope="col">Method Attributes</th>

							<th scope="col">Method Name and Description</th>

						</tr>

					</thead>

					<tbody>

						<tr>

							<td class="attributes">&nbsp;</td>

							<td class="nameDescription">

								<div class="fixedFont"><b><a href="../symbols/PubSub.html#publish">publish</a></b>(topic, **args)

								</div>

								<div class="description">Allows caller to emit an event and pass arguments to event listeners.</div>

							</td>

						</tr>

						<tr>

							<td class="attributes">&nbsp;</td>

							<td class="nameDescription">

								<div class="fixedFont"><b><a href="../symbols/PubSub.html#subscribe">subscribe</a></b>(topic, callback, once)

								</div>

								<div class="description">Allows listener code to subscribe to channel and be called when data is available</div>

							</td>

						</tr>

						<tr>

							<td class="attributes">&nbsp;</td>

							<td class="nameDescription">

								<div class="fixedFont"><b><a href="../symbols/PubSub.html#unsubscribe">unsubscribe</a></b>(token)

								</div>

								<div class="description">Allows listener code to unsubscribe from a channel</div>

							</td>

						</tr>

					</tbody>

				</table>

<!-- ============================== events summary ======================== -->

<!-- ============================== constructor details ==================== -->

			<div class="details"><a name="constructor"> </a>

				<div class="sectionTitle">

					Class Detail

				</div>

				<div class="fixedFont">

						<b>PubSub</b>()

				</div>

				<div class="description">

					PubSub implementation

				</div>

			</div>

<!-- ============================== field details ========================== -->

<!-- ============================== method details ========================= -->

				<div class="sectionTitle">

					Method Detail

				</div>

					<a name="publish"> </a>

					<div class="fixedFont">

					<b>publish</b>(topic, **args)

					</div>

					<div class="description">

						Allows caller to emit an event and pass arguments to event listeners.

					</div>

							<dl class="detailList">

							<dt class="heading">Parameters:</dt>

								<dt>

									<b>topic</b>

								</dt>

								<dd>{String} Name of the channel on which to voice this event</dd>

								<dt>

									<b>**args</b>

								</dt>

								<dd>Any number of arguments you want to pass to the listeners of this event.</dd>

							</dl>

					<hr />

					<a name="subscribe"> </a>

					<div class="fixedFont">

					<span class="light">{Object}</span>

					<b>subscribe</b>(topic, callback, once)

					</div>

					<div class="description">

						Allows listener code to subscribe to channel and be called when data is available

					</div>

							<dl class="detailList">

							<dt class="heading">Parameters:</dt>

								<dt>

									<b>topic</b>

								</dt>

								<dd>{String} Name of the channel on which to voice this event</dd>

								<dt>

									<b>callback</b>

								</dt>

								<dd>{Function} Executable (function pointer) that will be ran when event is voiced on this channel.</dd>

								<dt>

									<b>once</b>

								</dt>

								<dd>{Boolean} (optional. False by default) Flag indicating if the function is to be triggered only once.</dd>

							</dl>

							<dl class="detailList">

							<dt class="heading">Returns:</dt>

								<dd><span class="light fixedFont">{Object}</span> A token object that cen be used for unsubscribing.</dd>

							</dl>

					<hr />

					<a name="unsubscribe"> </a>

					<div class="fixedFont">

					<b>unsubscribe</b>(token)

					</div>

					<div class="description">

						Allows listener code to unsubscribe from a channel

					</div>

							<dl class="detailList">

							<dt class="heading">Parameters:</dt>

								<dt>

									<b>token</b>

								</dt>

								<dd>{Object} A token object that was returned by `subscribe` method</dd>

							</dl>

<!-- ============================== event details ========================= -->

			<hr />

		</div>

<!-- ============================== footer ================================= -->

		<div class="fineprint" style="clear:both">

			Documentation generated by <a href="http://code.google.com/p/jsdoc-toolkit/" target="_blank">JsDoc Toolkit</a> 2.4.0 on Mon Oct 15 2012 22:41:49 GMT-0700 (PDT)

		</div>

	</body>

</html>