coffeescript-ui
Version:
Coffeescript User Interface System
352 lines (345 loc) • 9.79 kB
HTML
<html>
<head>
<meta charset='UTF-8'>
<title>Coffeescript-UI Documentation</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='../../alphabetical_index.html' title='Index'>
Index
</a>
»
<span class='title'>CUI</span>
»
<span class='title'>Icon</span>
</div>
</div>
<div id='content'>
<h1>
Class:
CUI.Icon
</h1>
<table class='box'>
<tr>
<td>Defined in:</td>
<td>base/Icon/Icon.coffee</td>
</tr>
<tr>
<td>Inherits:</td>
<td>
<a href='../../class/CUI/Element.html'>CUI.Element</a>
</td>
</tr>
</table>
<h2>Overview</h2>
<div class='docstring'>
<ul>
<li>coffeescript-ui - Coffeescript User Interface System (CUI)</li>
<li>Copyright (c) 2013 - 2016 Programmfabrik GmbH</li>
<li>MIT Licence</li>
<li><a href="https://github.com/programmfabrik/coffeescript-ui">https://github.com/programmfabrik/coffeescript-ui</a>, <a href="http://www.coffeescript-ui.org">http://www.coffeescript-ui.org</a></li>
</ul>
</div>
<div class='tags'>
</div>
<h2>Variables Summary</h2>
<dl class='constants'>
<dt id='icon_map-variable'>
icon_map
=
</dt>
<dd>
<pre><code class='coffeescript'>{
trash: "svg-trash",
reset: "svg-reset",
spinner: "svg-spinner cui-spin-stepped",
remove: "svg-close",
close: "svg-close",
folder: "svg-folder",
folder_shared: "svg-folder-shared",
folder_upload: "svg-folder-upload",
folder_shared_upload: "svg-folder-shared-upload",
info_circle: "svg-info-circle",
external_link: "svg-external-link",
crop: "fa-crop",
fullscreen: "fa-arrows-alt",
failed: "fa-warning",
no_right: "fa-slack",
file: "fa-file",
filter: "fa-filter",
refresh: "fa-refresh",
zip: "fa fa-file-archive-o",
rotate_right: "fa-rotate-right",
rotate_left: "fa-rotate-left",
rotate_vertical: "fa-arrows-v",
rotate_horizontal: "fa-arrows-h",
calendar: "fa-calendar",
show: "fa-question",
help: "fa-question",
question: "fa-question",
settings: "fa-cog",
download: "fa-download",
"export": "fa-download",
list: "fa-question",
upload: "fa-upload",
envelope: "fa-envelope-o",
envelope_active: "fa-envelope",
save: "fa-floppy-o",
heart: "fa-heart",
user: "fa-user",
clock: "fa-clock-o",
plus: "fa-plus",
edit: "fa-pencil",
copy: "fa-files-o",
search: "fa-search",
share: "fa-share",
play: "fa-play",
audio: "fa-music",
start: "fa-play",
stop: "fa-stop",
print: "fa-print",
minus: "fa-minus",
tree_open: "fa-caret-right",
tree_close: "fa-caret-down",
ellipsis_h: "fa-ellipsis-h",
ellipsis_v: "fa-ellipsis-v",
menu: "fa-bars",
info: "fa-info-circle",
bolt: "fa-bolt",
check: "fa-check",
warning: "fa-warning",
legal: "fa-legal",
cloud: "fa-cloud",
left: "fa-angle-left",
right: "fa-angle-right",
dive: "fa-angle-right",
zoom_in: "fa-search-plus",
zoom_out: "fa-search-minus",
resize_small: "fa-compress",
resize_full: "fa-expand",
email: "fa-envelope-o",
file_text_active: "fa-file-text",
file_text: "fa-file-text-o",
required: "fa-bullhorn",
west: "fa-angle-left",
east: "fa-angle-right",
south: "fa-angle-down",
north: "fa-angle-up",
up: "fa-caret-up",
down: "fa-caret-down",
camera: "fa-camera",
expert_search: "fa-list-ul",
image: "fa-picture-o"
}</code></pre>
</dd>
</dl>
<h3 class='inherited'>
Variable inherited from
<a href='../../class/CUI/Element.html'>CUI.Element</a>
</h3>
<p class='inherited'>
<a href='../../class/CUI/Element.html#uniqueId-variable'>uniqueId</a>
</p>
<h2>Instance Method Summary</h2>
<ul class='summary'>
<li>
<span class='signature'>
<a href='#initOpts-dynamic'>
#
(void)
<b>initOpts</b><span>()</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#copy-dynamic'>
#
(void)
<b>copy</b><span>()</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#hide-dynamic'>
#
(void)
<b>hide</b><span>()</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#show-dynamic'>
#
(void)
<b>show</b><span>()</span>
</a>
</span>
<span class='desc'>
</span>
</li>
</ul>
<h2>
<small>Inherited Method Summary</small>
<h3 class='inherited'>
Methods inherited from
<a href='../../class/CUI/Element.html'>CUI.Element</a>
</h3>
<p class='inherited'>
<a href='../../class/CUI/Element.html#getElementClass-dynamic'>#getElementClass</a>
<a href='../../class/CUI/Element.html#getUniqueId-dynamic'>#getUniqueId</a>
<a href='../../class/CUI/Element.html#getOpts-dynamic'>#getOpts</a>
<a href='../../class/CUI/Element.html#getOpt-dynamic'>#getOpt</a>
<a href='../../class/CUI/Element.html#hasOpt-dynamic'>#hasOpt</a>
<a href='../../class/CUI/Element.html#getSetOpt-dynamic'>#getSetOpt</a>
<a href='../../class/CUI/Element.html#hasSetOpt-dynamic'>#hasSetOpt</a>
<a href='../../class/CUI/Element.html#initOpts-dynamic'>#initOpts</a>
<a href='../../class/CUI/Element.html#copy-dynamic'>#copy</a>
<a href='../../class/CUI/Element.html#mergeOpt-dynamic'>#mergeOpt</a>
<a href='../../class/CUI/Element.html#removeOpt-dynamic'>#removeOpt</a>
<a href='../../class/CUI/Element.html#addOpt-dynamic'>#addOpt</a>
<a href='../../class/CUI/Element.html#addOpts-dynamic'>#addOpts</a>
<a href='../../class/CUI/Element.html#mergeOpts-dynamic'>#mergeOpts</a>
<a href='../../class/CUI/Element.html#__getCheckMap-dynamic'>#__getCheckMap</a>
<a href='../../class/CUI/Element.html#readOpts-dynamic'>#readOpts</a>
<a href='../../class/CUI/Element.html#readOptsFromAttr-dynamic'>#readOptsFromAttr</a>
<a href='../../class/CUI/Element.html#proxy-dynamic'>#proxy</a>
<a href='../../class/CUI/Element.html#destroy-dynamic'>#destroy</a>
<a href='../../class/CUI/Element.html#isDestroyed-dynamic'>#isDestroyed</a>
<a href='../../class/CUI/Element.html#getOptKeys-static'>.getOptKeys</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>(opts = {})</span>
<br>
</p>
</div>
</div>
<h2>Instance Method Details</h2>
<div class='methods'>
<div class='method_details'>
<p class='signature' id='initOpts-dynamic'>
#
(void)
<b>initOpts</b><span>()</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='copy-dynamic'>
#
(void)
<b>copy</b><span>()</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='hide-dynamic'>
#
(void)
<b>hide</b><span>()</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='show-dynamic'>
#
(void)
<b>show</b><span>()</span>
<br>
</p>
</div>
</div>
</div>
<div id='footer'>
By
<a href='https://github.com/coffeedoc/codo' title='CoffeeScript API documentation generator'>
Codo
</a>
2.1.2
✲
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>