/usr/share/doc/python-qtawesome-doc/html/_modules/qtawesome.html is in python-qtawesome-doc 0.4.4+ds1-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 | <!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/html; charset=utf-8" />
<title>qtawesome — qtawesome 0.4.4 documentation</title>
<link rel="stylesheet" href="../_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../',
VERSION: '0.4.4',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="top" title="qtawesome 0.4.4 documentation" href="../index.html" />
<link rel="up" title="Module code" href="index.html" />
<link rel="stylesheet" href="../_static/custom.css" type="text/css" />
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
</head>
<body role="document">
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<h1>Source code for qtawesome</h1><div class="highlight"><pre>
<span></span><span class="sa">r</span><span class="sd">"""</span>
<span class="sd">qtawesome</span>
<span class="sd">=========</span>
<span class="sd">Font-Awesome and other iconic fonts for PyQt / PySide applications.</span>
<span class="sd">.. currentmodule:: qtawesome</span>
<span class="sd">.. autosummary::</span>
<span class="sd"> :toctree: _generate</span>
<span class="sd"> icon</span>
<span class="sd"> load_font</span>
<span class="sd"> charmap</span>
<span class="sd"> font</span>
<span class="sd"> set_defaults</span>
<span class="sd">"""</span>
<span class="kn">from</span> <span class="nn">.iconic_font</span> <span class="k">import</span> <span class="n">IconicFont</span><span class="p">,</span> <span class="n">set_global_defaults</span>
<span class="kn">from</span> <span class="nn">.animation</span> <span class="k">import</span> <span class="n">Pulse</span><span class="p">,</span> <span class="n">Spin</span>
<span class="kn">from</span> <span class="nn">._version</span> <span class="k">import</span> <span class="n">version_info</span><span class="p">,</span> <span class="n">__version__</span>
<span class="n">_resource</span> <span class="o">=</span> <span class="p">{</span> <span class="s1">'iconic'</span><span class="p">:</span> <span class="kc">None</span> <span class="p">}</span>
<span class="k">def</span> <span class="nf">_instance</span><span class="p">():</span>
<span class="sd">"""</span>
<span class="sd"> Return the singleton instance of IconicFont.</span>
<span class="sd"> Functions ``icon``, ``load_font``, ``charmap``, ``font`` and</span>
<span class="sd"> ``set_defaults`` all rebind to methods of the singleton instance of IconicFont.</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="n">_resource</span><span class="p">[</span><span class="s1">'iconic'</span><span class="p">]</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">_resource</span><span class="p">[</span><span class="s1">'iconic'</span><span class="p">]</span> <span class="o">=</span> <span class="n">IconicFont</span><span class="p">(</span>
<span class="p">(</span><span class="s1">'fa'</span><span class="p">,</span> <span class="s1">'fontawesome-webfont.ttf'</span><span class="p">,</span> <span class="s1">'fontawesome-webfont-charmap.json'</span><span class="p">),</span>
<span class="p">(</span><span class="s1">'ei'</span><span class="p">,</span> <span class="s1">'elusiveicons-webfont.ttf'</span><span class="p">,</span> <span class="s1">'elusiveicons-webfont-charmap.json'</span><span class="p">)</span>
<span class="p">)</span>
<span class="k">return</span> <span class="n">_resource</span><span class="p">[</span><span class="s1">'iconic'</span><span class="p">]</span>
<div class="viewcode-block" id="icon"><a class="viewcode-back" href="../_generate/qtawesome.icon.html#qtawesome.icon">[docs]</a><span class="k">def</span> <span class="nf">icon</span><span class="p">(</span><span class="o">*</span><span class="n">names</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Return a QIcon object corresponding to the provided icon name(s).</span>
<span class="sd"> This function is the main interface of qtawesome. </span>
<span class="sd"> It can be used to create a QIcon instance from a single glyph </span>
<span class="sd"> or from a list of glyphs that are displayed on the top of each other.</span>
<span class="sd"> Such icon stacks are generally used to combine multiple glyphs to make</span>
<span class="sd"> more complex icons.</span>
<span class="sd"> Glyph names are specified by strings, of the form ``prefix.name``.</span>
<span class="sd"> The ``prefix`` corresponds to the font to be used and ``name`` is the</span>
<span class="sd"> name of the icon.</span>
<span class="sd"> - The prefix corresponding to Font-Awesome is 'fa'</span>
<span class="sd"> - The prefix corresponding to Elusive-Icons is 'ei'</span>
<span class="sd"> When requesting a single glyph, options (such as color or positional offsets)</span>
<span class="sd"> can be passed as keyword arguments::</span>
<span class="sd"> import qtawesome as qta</span>
<span class="sd"> music_icon = qta.icon('fa.music', color='blue', color_active='orange')</span>
<span class="sd"> When requesting multiple glyphs, the `options` keyword argument contains the</span>
<span class="sd"> list of option dictionaries to be used for each glyph::</span>
<span class="sd"> camera_ban = qta.icon('fa.camera', 'fa.ban', options=[{</span>
<span class="sd"> 'scale_factor': 0.5,</span>
<span class="sd"> 'active': 'fa.legal'</span>
<span class="sd"> }, {</span>
<span class="sd"> 'color': 'red',</span>
<span class="sd"> 'opacity': 0.7</span>
<span class="sd"> }])</span>
<span class="sd"> Qt's ``QIcon`` object has four modes</span>
<span class="sd"> - ``Normal``: The user is not interacting with the icon, but the</span>
<span class="sd"> functionality represented by the icon is available.</span>
<span class="sd"> - ``Disabled``: The functionality corresponding to the icon is not</span>
<span class="sd"> available.</span>
<span class="sd"> - ``Active``: The functionality corresponding to the icon is available.</span>
<span class="sd"> The user is interacting with the icon, for example, moving the mouse</span>
<span class="sd"> over it or clicking it.</span>
<span class="sd"> - ``Selected``: The item represented by the icon is selected.</span>
<span class="sd"> </span>
<span class="sd"> The glyph for the Normal mode is the one specified with the main positional</span>
<span class="sd"> argument.</span>
<span class="sd"> - ``color``: icon color in the ``Normal`` mode.</span>
<span class="sd"> The following four options will apply to the icon regardless of the mode.</span>
<span class="sd"> - ``offset``: tuple (x, y) corresponding to the horizontal and vertical</span>
<span class="sd"> offsets for the glyph, specified as a proportion of the icon size.</span>
<span class="sd"> - ``animation``: animation object for the icon.</span>
<span class="sd"> - ``scale_factor``: multiplicative scale factor to be used for the glyph. </span>
<span class="sd"> The following options apply to the different modes of the icon</span>
<span class="sd"> - ``active``: name of the glyph to be used when the icon is ``Active``.</span>
<span class="sd"> - ``color_active``: the corresponding icon color.</span>
<span class="sd"> - ``disabled``: name of the glyph to be used when the icon is ``Disabled``.</span>
<span class="sd"> - ``color_disabled``: the corresponding icon color.</span>
<span class="sd"> - ``selected``: name of the glyph to be used when the icon is ``Selected``.</span>
<span class="sd"> - ``color_selected``: the corresponding icon color.</span>
<span class="sd"> Default values for these options can be specified via the function</span>
<span class="sd"> ``set_defaults``. If unspecified, the default defaults are::</span>
<span class="sd"> {</span>
<span class="sd"> 'opacity': 1.0,</span>
<span class="sd"> 'scale_factor': 1.0</span>
<span class="sd"> 'color': QColor(50, 50, 50),</span>
<span class="sd"> 'color_disabled': QColor(150, 150, 150),</span>
<span class="sd"> }</span>
<span class="sd"> If no default value is provided for ``active``, ``disabled`` or ``selected``</span>
<span class="sd"> the glyph specified for the ``Normal`` mode will be used.</span>
<span class="sd"> """</span>
<span class="k">return</span> <span class="n">_instance</span><span class="p">()</span><span class="o">.</span><span class="n">icon</span><span class="p">(</span><span class="o">*</span><span class="n">names</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span></div>
<div class="viewcode-block" id="load_font"><a class="viewcode-back" href="../_generate/qtawesome.load_font.html#qtawesome.load_font">[docs]</a><span class="k">def</span> <span class="nf">load_font</span><span class="p">(</span><span class="n">prefix</span><span class="p">,</span> <span class="n">ttf_filename</span><span class="p">,</span> <span class="n">charmap_filename</span><span class="p">,</span> <span class="n">directory</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Loads a font file and the associated charmap.</span>
<span class="sd"> If ``directory`` is None, the files will be looked for in ``./fonts/``.</span>
<span class="sd"> Parameters</span>
<span class="sd"> ----------</span>
<span class="sd"> prefix: str</span>
<span class="sd"> Prefix string to be used when accessing a given font set</span>
<span class="sd"> ttf_filename: str</span>
<span class="sd"> Ttf font filename</span>
<span class="sd"> charmap_filename: str</span>
<span class="sd"> Character map filename</span>
<span class="sd"> directory: str or None, optional</span>
<span class="sd"> Directory for font and charmap files</span>
<span class="sd"> Example</span>
<span class="sd"> -------</span>
<span class="sd"> The spyder ide uses qtawesome and uses a custom font for spyder-specific</span>
<span class="sd"> icons::</span>
<span class="sd"> qta.load_font('spyder', 'spyder.ttf', 'spyder-charmap.json')</span>
<span class="sd"> """</span>
<span class="k">return</span> <span class="n">_instance</span><span class="p">()</span><span class="o">.</span><span class="n">load_font</span><span class="p">(</span><span class="n">prefix</span><span class="p">,</span> <span class="n">ttf_filename</span><span class="p">,</span> <span class="n">charmap_filename</span><span class="p">,</span> <span class="n">directory</span><span class="p">)</span></div>
<div class="viewcode-block" id="charmap"><a class="viewcode-back" href="../_generate/qtawesome.charmap.html#qtawesome.charmap">[docs]</a><span class="k">def</span> <span class="nf">charmap</span><span class="p">(</span><span class="n">prefixed_name</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Return the character map used for a given font.</span>
<span class="sd"> Returns</span>
<span class="sd"> -------</span>
<span class="sd"> return_value: dict</span>
<span class="sd"> The dictionary mapping the icon names to the corresponding unicode character.</span>
<span class="sd"> """</span>
<span class="n">prefix</span><span class="p">,</span> <span class="n">name</span> <span class="o">=</span> <span class="n">prefixed_name</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s1">'.'</span><span class="p">)</span>
<span class="k">return</span> <span class="n">_instance</span><span class="p">()</span><span class="o">.</span><span class="n">charmap</span><span class="p">[</span><span class="n">prefix</span><span class="p">][</span><span class="n">name</span><span class="p">]</span></div>
<div class="viewcode-block" id="font"><a class="viewcode-back" href="../_generate/qtawesome.font.html#qtawesome.font">[docs]</a><span class="k">def</span> <span class="nf">font</span><span class="p">(</span><span class="n">prefix</span><span class="p">,</span> <span class="n">size</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Return the font corresponding to the specified prefix.</span>
<span class="sd"> This can be used to render text using the iconic font directly::</span>
<span class="sd"> import qtawesome as qta</span>
<span class="sd"> from qtpy import QtWidgets</span>
<span class="sd"> label = QtWidgets.QLabel(unichr(0xf19c) + ' ' + 'Label')</span>
<span class="sd"> label.setFont(qta.font('fa', 16))</span>
<span class="sd"> Parameters</span>
<span class="sd"> ----------</span>
<span class="sd"> prefix: str</span>
<span class="sd"> prefix string of the loaded font</span>
<span class="sd"> size: int</span>
<span class="sd"> size for the font</span>
<span class="sd"> """</span>
<span class="k">return</span> <span class="n">_instance</span><span class="p">()</span><span class="o">.</span><span class="n">font</span><span class="p">(</span><span class="n">prefix</span><span class="p">,</span> <span class="n">size</span><span class="p">)</span></div>
<div class="viewcode-block" id="set_defaults"><a class="viewcode-back" href="../_generate/qtawesome.set_defaults.html#qtawesome.set_defaults">[docs]</a><span class="k">def</span> <span class="nf">set_defaults</span><span class="p">(</span><span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Set default options for icons.</span>
<span class="sd"> The valid keyword arguments are:</span>
<span class="sd"> 'active', 'animation', 'color', 'color_active', 'color_disabled',</span>
<span class="sd"> 'color_selected', 'disabled', 'offset', 'scale_factor', 'selected'.</span>
<span class="sd"> """</span>
<span class="k">return</span> <span class="n">set_global_defaults</span><span class="p">(</span><span class="o">**</span><span class="n">kwargs</span><span class="p">)</span></div>
</pre></div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper"><div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="../index.html">Documentation overview</a><ul>
<li><a href="index.html">Module code</a><ul>
</ul></li>
</ul></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<form class="search" action="../search.html" method="get">
<div><input type="text" name="q" /></div>
<div><input type="submit" value="Go" /></div>
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
©2017, The Spyder Development Team.
|
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.4.9</a>
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.8</a>
</div>
</body>
</html>
|