/usr/share/makehuman-doc/html/module_managed_file.html is in makehuman-doc 1.1.1-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 | <!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>The Managed_file Module — MakeHuman 1.0 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: '1.0',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</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="shortcut icon" href="_static/favicon.ico"/>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="The Module3D Module" href="module_module3d.html" />
<link rel="prev" title="The Guicommon Module" href="module_guicommon.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">
<div class="section" id="module-managed_file">
<span id="the-managed-file-module"></span><span id="modulemanaged-file"></span><h1>The Managed_file Module<a class="headerlink" href="#module-managed_file" title="Permalink to this headline">¶</a></h1>
<div class="section" id="file-class-definition">
<h2>File class definition<a class="headerlink" href="#file-class-definition" title="Permalink to this headline">¶</a></h2>
<p><strong>Project Name:</strong> MakeHuman</p>
<p><strong>Product Home Page:</strong> <a class="reference external" href="http://www.makehuman.org/">http://www.makehuman.org/</a></p>
<p><strong>Code Home Page:</strong> <a class="reference external" href="https://bitbucket.org/MakeHuman/makehuman/">https://bitbucket.org/MakeHuman/makehuman/</a></p>
<p><strong>Authors:</strong> Thanasis Papoutsidakis</p>
<p><strong>Copyright(c):</strong> MakeHuman Team 2001-2017</p>
<p><strong>Licensing:</strong> AGPL3</p>
<blockquote>
<div><p>This file is part of MakeHuman (www.makehuman.org).</p>
<p>This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as
published by the Free Software Foundation, either version 3 of the
License, or (at your option) any later version.</p>
<p>This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Affero General Public License for more details.</p>
<p>You should have received a copy of the GNU Affero General Public License
along with this program. If not, see <<a class="reference external" href="http://www.gnu.org/licenses/">http://www.gnu.org/licenses/</a>>.</p>
</div></blockquote>
<div class="section" id="abstract">
<h3>Abstract<a class="headerlink" href="#abstract" title="Permalink to this headline">¶</a></h3>
<p>This module defines the File class, an object that represents a file that
is being edited inside MakeHuman.</p>
<dl class="class">
<dt id="managed_file.File">
<em class="property">class </em><code class="descclassname">managed_file.</code><code class="descname">File</code><a class="reference internal" href="_modules/managed_file.html#File"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#managed_file.File" title="Permalink to this definition">¶</a></dt>
<dd><p>Object class representing a file that is being opened and edited
from inside the application.</p>
<p>It can be used for managing project files, and handling the currently
opened files in a Graphical User Interface using an organized structure.</p>
<dl class="method">
<dt id="managed_file.File.changed">
<code class="descname">changed</code><span class="sig-paren">(</span><em>reason=None</em>, <em>data=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/managed_file.html#File.changed"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#managed_file.File.changed" title="Permalink to this definition">¶</a></dt>
<dd><p>Method to be called when the File’s associated data is modified.</p>
<p>Without arguments, it is equivalent to File.modified = True.
Extra arguments are passed to the FileModifiedEvent constructor.</p>
</dd></dl>
<dl class="method">
<dt id="managed_file.File.closed">
<code class="descname">closed</code><span class="sig-paren">(</span><em>reason=None</em>, <em>data=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/managed_file.html#File.closed"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#managed_file.File.closed" title="Permalink to this definition">¶</a></dt>
<dd><p>Method to be called after closing the file.</p>
</dd></dl>
<dl class="attribute">
<dt id="managed_file.File.dir">
<code class="descname">dir</code><a class="headerlink" href="#managed_file.File.dir" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the directory of the associated file.</p>
</dd></dl>
<dl class="attribute">
<dt id="managed_file.File.extension">
<code class="descname">extension</code><a class="headerlink" href="#managed_file.File.extension" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the extension of the associated file.</p>
</dd></dl>
<dl class="method">
<dt id="managed_file.File.getModified">
<code class="descname">getModified</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/managed_file.html#File.getModified"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#managed_file.File.getModified" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the state of the modified flag.</p>
</dd></dl>
<dl class="method">
<dt id="managed_file.File.loaded">
<code class="descname">loaded</code><span class="sig-paren">(</span><em>path</em>, <em>reason=None</em>, <em>data=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/managed_file.html#File.loaded"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#managed_file.File.loaded" title="Permalink to this definition">¶</a></dt>
<dd><p>Method to be called after loading the file from a path.</p>
</dd></dl>
<dl class="attribute">
<dt id="managed_file.File.modified">
<code class="descname">modified</code><a class="headerlink" href="#managed_file.File.modified" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the state of the modified flag.</p>
</dd></dl>
<dl class="attribute">
<dt id="managed_file.File.name">
<code class="descname">name</code><a class="headerlink" href="#managed_file.File.name" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the filename of the associated file.</p>
</dd></dl>
<dl class="attribute">
<dt id="managed_file.File.path">
<code class="descname">path</code><a class="headerlink" href="#managed_file.File.path" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the full path of the associated file.</p>
</dd></dl>
<dl class="method">
<dt id="managed_file.File.saved">
<code class="descname">saved</code><span class="sig-paren">(</span><em>path</em>, <em>reason=None</em>, <em>data=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/managed_file.html#File.saved"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#managed_file.File.saved" title="Permalink to this definition">¶</a></dt>
<dd><p>Method to be called after saving the file to a path.</p>
</dd></dl>
<dl class="method">
<dt id="managed_file.File.setModified">
<code class="descname">setModified</code><span class="sig-paren">(</span><em>value</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/managed_file.html#File.setModified"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#managed_file.File.setModified" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the value of the modified flag and emit an event.</p>
</dd></dl>
<dl class="attribute">
<dt id="managed_file.File.title">
<code class="descname">title</code><a class="headerlink" href="#managed_file.File.title" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the title of the associated file,
which is the filename without the extension.</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="managed_file.FileModifiedEvent">
<em class="property">class </em><code class="descclassname">managed_file.</code><code class="descname">FileModifiedEvent</code><span class="sig-paren">(</span><em>file</em>, <em>value</em>, <em>oldvalue</em>, <em>reason=None</em>, <em>data=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/managed_file.html#FileModifiedEvent"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#managed_file.FileModifiedEvent" title="Permalink to this definition">¶</a></dt>
<dd><p>Event class to be emitted upon modification of a managed File object.</p>
<p>It contains information about the state of the modified flag and
possibly about the reason that the event was triggered.</p>
<dl class="method">
<dt id="managed_file.FileModifiedEvent.addReason">
<code class="descname">addReason</code><span class="sig-paren">(</span><em>reason</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/managed_file.html#FileModifiedEvent.addReason"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#managed_file.FileModifiedEvent.addReason" title="Permalink to this definition">¶</a></dt>
<dd><p>Add the given reason to the event’s reason list.</p>
</dd></dl>
<dl class="classmethod">
<dt id="managed_file.FileModifiedEvent.fromObjectAssignment">
<em class="property">classmethod </em><code class="descname">fromObjectAssignment</code><span class="sig-paren">(</span><em>newfileobj</em>, <em>oldfileobj</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/managed_file.html#FileModifiedEvent.fromObjectAssignment"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#managed_file.FileModifiedEvent.fromObjectAssignment" title="Permalink to this definition">¶</a></dt>
<dd><p>Class method that returns a new FileModifiedEvent object
properly modified to inform about a modification event,
in the case that the change was done with the use of
assignment (instead of the standard object’s methods
e.g. load() etc.).</p>
</dd></dl>
<dl class="attribute">
<dt id="managed_file.FileModifiedEvent.objectWasChanged">
<code class="descname">objectWasChanged</code><a class="headerlink" href="#managed_file.FileModifiedEvent.objectWasChanged" title="Permalink to this definition">¶</a></dt>
<dd><p>Return whether the cause that triggered the event has altered
the associated object’s data.</p>
<p>This method can be used by external classes for invoking
update routines.</p>
</dd></dl>
<dl class="attribute">
<dt id="managed_file.FileModifiedEvent.pathWasChanged">
<code class="descname">pathWasChanged</code><a class="headerlink" href="#managed_file.FileModifiedEvent.pathWasChanged" title="Permalink to this definition">¶</a></dt>
<dd><p>Return whether the cause that triggered the event has changed
the location of the associated file.</p>
<p>This method can be used by external classes for updating path
inspectors like path explorers / tree views.</p>
</dd></dl>
</dd></dl>
</div>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h3><a href="index.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">The Managed_file Module</a><ul>
<li><a class="reference internal" href="#file-class-definition">File class definition</a><ul>
<li><a class="reference internal" href="#abstract">Abstract</a></li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="index.html">Documentation overview</a><ul>
<li>Previous: <a href="module_guicommon.html" title="previous chapter">The Guicommon Module</a></li>
<li>Next: <a href="module_module3d.html" title="next chapter">The Module3D Module</a></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, MHteam.
|
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.5.6</a>
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.8</a>
</div>
</body>
</html>
|