<?xml version="1.0" encoding="iso-8859-1"?>
<!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>
<title>Class: IconArtist::Icon</title>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
<meta http-equiv="Content-Script-Type" content="text/javascript" />
<link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
<script type="text/javascript">
// <![CDATA[
function popupCode( url ) {
window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
}
function toggleCode( id ) {
if ( document.getElementById )
elem = document.getElementById( id );
else if ( document.all )
elem = eval( "document.all." + id );
else
return false;
elemStyle = elem.style;
if ( elemStyle.display != "block" ) {
elemStyle.display = "block"
} else {
elemStyle.display = "none"
}
return true;
}
// Make codeblocks hidden by default
document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
// ]]>
</script>
</head>
<body>
<div id="classHeader">
<table class="header-table">
<tr class="top-aligned-row">
<td><strong>Class</strong></td>
<td class="class-name-in-header">IconArtist::Icon</td>
</tr>
<tr class="top-aligned-row">
<td><strong>In:</strong></td>
<td>
<a href="../../files/lib/icon-artist/icon_rb.html">
lib/icon-artist/icon.rb
</a>
<br />
</td>
</tr>
<tr class="top-aligned-row">
<td><strong>Parent:</strong></td>
<td>
Object
</td>
</tr>
</table>
</div>
<!-- banner header -->
<div id="bodyContent">
<div id="contextContent">
</div>
<div id="method-list">
<h3 class="section-bar">Methods</h3>
<div class="name-list">
<a href="#M000007">add_symlinks</a>
<a href="#M000005">check</a>
<a href="#M000009">context</a>
<a href="#M000004">create</a>
<a href="#M000006">export</a>
<a href="#M000011">filename</a>
<a href="#M000010">iconname</a>
<a href="#M000003">new</a>
<a href="#M000008">symlinks</a>
</div>
</div>
</div>
<!-- if includes -->
<div id="section">
<!-- if method_list -->
<div id="methods">
<h3 class="section-bar">Public Class methods</h3>
<div id="method-M000005" class="method-detail">
<a name="M000005"></a>
<div class="method-heading">
<a href="Icon.src/M000005.html" target="Code" class="method-signature"
onclick="popupCode('Icon.src/M000005.html');return false;">
<span class="method-name">check</span><span class="method-args">(filename)</span>
</a>
</div>
<div class="method-description">
<p>
Check if icon in given file follows one-canvas standards
</p>
<table>
<tr><td valign="top"><a href="Icon.html#M000011">filename</a>:</td><td>path to the file with the icon
</td></tr>
</table>
</div>
</div>
<div id="method-M000004" class="method-detail">
<a name="M000004"></a>
<div class="method-heading">
<a href="Icon.src/M000004.html" target="Code" class="method-signature"
onclick="popupCode('Icon.src/M000004.html');return false;">
<span class="method-name">create</span><span class="method-args">(iconname, context, template="default")</span>
</a>
</div>
<div class="method-description">
<p>
Create <a href="Icon.html#M000003">new</a> icon with set name and <a
href="Icon.html#M000009">context</a> using selected template
</p>
<table>
<tr><td valign="top"><a href="Icon.html#M000010">iconname</a>:</td><td>name of the icon, preferably following freedesktop.org standards, to be
created
</td></tr>
<tr><td valign="top"><a href="Icon.html#M000009">context</a>:</td><td><a href="Icon.html#M000009">context</a> of the icon, see THEME_CONTEXTS
constant for more info
</td></tr>
<tr><td valign="top">template:</td><td>select custom template, either template name (without .svg extension) that
is located in your XDG User Dirs Templates dir or in
/usr/share/icon-artist/templates/#{template}.svg, or a <a
href="Icon.html#M000011">filename</a> of a custom template (with the .svg
extension)
</td></tr>
</table>
</div>
</div>
<div id="method-M000003" class="method-detail">
<a name="M000003"></a>
<div class="method-heading">
<a href="Icon.src/M000003.html" target="Code" class="method-signature"
onclick="popupCode('Icon.src/M000003.html');return false;">
<span class="method-name">new</span><span class="method-args">(filename,opts={})</span>
</a>
</div>
<div class="method-description">
<p>
Open <a href="Icon.html#M000003">new</a> icon from set file
</p>
<table>
<tr><td valign="top"><a href="Icon.html#M000011">filename</a>:</td><td>path to a file that contains the icon
</td></tr>
<tr><td valign="top">options:</td><td>:skip_check => don‘t <a href="Icon.html#M000005">check</a> if the
icon adheres one-canvas guidelines
</td></tr>
</table>
</div>
</div>
<h3 class="section-bar">Public Instance methods</h3>
<div id="method-M000007" class="method-detail">
<a name="M000007"></a>
<div class="method-heading">
<a href="Icon.src/M000007.html" target="Code" class="method-signature"
onclick="popupCode('Icon.src/M000007.html');return false;">
<span class="method-name">add_symlinks</span><span class="method-args">(symlinks)</span>
</a>
</div>
<div class="method-description">
<p>
Add <a href="Icon.html#M000008">symlinks</a> to the icon
</p>
<table>
<tr><td valign="top"><a href="Icon.html#M000008">symlinks</a>:</td><td>array of <a href="Icon.html#M000008">symlinks</a> to be added
</td></tr>
</table>
</div>
</div>
<div id="method-M000009" class="method-detail">
<a name="M000009"></a>
<div class="method-heading">
<a href="Icon.src/M000009.html" target="Code" class="method-signature"
onclick="popupCode('Icon.src/M000009.html');return false;">
<span class="method-name">context</span><span class="method-args">()</span>
</a>
</div>
<div class="method-description">
<p>
Accessor to icon contex
</p>
</div>
</div>
<div id="method-M000006" class="method-detail">
<a name="M000006"></a>
<div class="method-heading">
<a href="Icon.src/M000006.html" target="Code" class="method-signature"
onclick="popupCode('Icon.src/M000006.html');return false;">
<span class="method-name">export</span><span class="method-args">(dir=".",sizes=THEME_SIZES)</span>
</a>
</div>
<div class="method-description">
<p>
Export the PNGs and SVGs to selected directory using standard icon theme
directory structure
</p>
<table>
<tr><td valign="top">dir:</td><td><a href="Icon.html#M000006">export</a> directory
</td></tr>
<tr><td valign="top">sizes:</td><td>set sizes to <a href="Icon.html#M000006">export</a>
</td></tr>
</table>
</div>
</div>
<div id="method-M000011" class="method-detail">
<a name="M000011"></a>
<div class="method-heading">
<a href="Icon.src/M000011.html" target="Code" class="method-signature"
onclick="popupCode('Icon.src/M000011.html');return false;">
<span class="method-name">filename</span><span class="method-args">()</span>
</a>
</div>
<div class="method-description">
<p>
Accessor to icon <a href="Icon.html#M000011">filename</a>
</p>
</div>
</div>
<div id="method-M000010" class="method-detail">
<a name="M000010"></a>
<div class="method-heading">
<a href="Icon.src/M000010.html" target="Code" class="method-signature"
onclick="popupCode('Icon.src/M000010.html');return false;">
<span class="method-name">iconname</span><span class="method-args">()</span>
</a>
</div>
<div class="method-description">
<p>
Accessor to icon name
</p>
</div>
</div>
<div id="method-M000008" class="method-detail">
<a name="M000008"></a>
<div class="method-heading">
<a href="Icon.src/M000008.html" target="Code" class="method-signature"
onclick="popupCode('Icon.src/M000008.html');return false;">
<span class="method-name">symlinks</span><span class="method-args">()</span>
</a>
</div>
<div class="method-description">
<p>
Accessor to <a href="Icon.html#M000008">symlinks</a>. Returs a hash
containing :default and :optional <a href="Icon.html#M000008">symlinks</a>.
:default <a href="Icon.html#M000008">symlinks</a> are found using
icon-naming-utils.
</p>
</div>
</div>
</div>
</div>
<div id="validator-badges">
<p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
</div>
</body>
</html>
