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
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
|
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Interface Utilities — ARTv2 2.0.1 documentation</title>
<script type="text/javascript" src="../../../_static/js/modernizr.min.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="../../../" src="../../../_static/documentation_options.js"></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>
<script type="text/javascript" src="../../../_static/language_data.js"></script>
<script type="text/javascript" src="../../../_static/js/theme.js"></script>
<link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
<link rel="index" title="Index" href="../../../genindex.html" />
<link rel="search" title="Search" href="../../../search.html" />
<link rel="next" title="Joint Mover Utilities" href="joint_mover_utils.html" />
<link rel="prev" title="Error Utilities" href="error_utils.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="../../../index.html" class="icon icon-home"> ARTv2
</a>
<div class="version">
2.0
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../../../installing.html">Installing ARTv2</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../using_rigging_tools.html">Using the Rigging Tools</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../using_anim_tools.html">Using the Animation Tools</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="../../../technical_documentation.html">Technical Documentation</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="../useful_scripting_commands.html">Useful Scripting Commands</a></li>
<li class="toctree-l2"><a class="reference internal" href="../components/components.html">Components</a></li>
<li class="toctree-l2 current"><a class="reference internal" href="utilities.html">Utilities</a><ul class="current">
<li class="toctree-l3"><a class="reference internal" href="general_utils.html">General Utilities</a></li>
<li class="toctree-l3"><a class="reference internal" href="component_utils.html">Component Utilities</a></li>
<li class="toctree-l3"><a class="reference internal" href="error_utils.html">Error Utilities</a></li>
<li class="toctree-l3 current"><a class="current reference internal" href="#">Interface Utilities</a></li>
<li class="toctree-l3"><a class="reference internal" href="joint_mover_utils.html">Joint Mover Utilities</a></li>
<li class="toctree-l3"><a class="reference internal" href="control_utilities.html">Control Utilities</a></li>
<li class="toctree-l3"><a class="reference internal" href="rigging_utilities.html">Rigging Utilities</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../rigging_tools/rigging_tools.html">Rigging Tools</a></li>
<li class="toctree-l2"><a class="reference internal" href="../running_tests.html">Running Tests</a></li>
</ul>
</li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../../../index.html">ARTv2</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="../../../index.html">Docs</a> »</li>
<li><a href="../../../technical_documentation.html">Technical Documentation</a> »</li>
<li><a href="utilities.html">Utilities</a> »</li>
<li>Interface Utilities</li>
<li class="wy-breadcrumbs-aside">
<a href="../../../_sources/sections/tech_docs/utilities/interface_utils.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="interface-utilities">
<h1>Interface Utilities<a class="headerlink" href="#interface-utilities" title="Permalink to this headline">¶</a></h1>
<p>artv2.utilities.interface_utilities</p>
<span class="target" id="module-artv2.utilities.interface_utilities"></span><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">author:</th><td class="field-body">Jeremy Ernst</td>
</tr>
<tr class="field-even field"><th class="field-name">description:</th><td class="field-body">This module provides utilities for general QT functions and classes to be used as widgets or templates.</td>
</tr>
</tbody>
</table>
<dl class="class">
<dt id="artv2.utilities.interface_utilities.ARTv2Dialog">
<em class="property">class </em><code class="descname">ARTv2Dialog</code><span class="sig-paren">(</span><em>width</em>, <em>height</em>, <em>window_title</em>, <em>parent=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/utilities/interface_utilities.html#ARTv2Dialog"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.utilities.interface_utilities.ARTv2Dialog" title="Permalink to this definition">¶</a></dt>
<dd><p>Abstract class that adds some extra default functionality for things like grabbing settings, dealing with
different screen resolutions, styling the UI, and saving screen position. This class is not meant to be
instantiated on its own.</p>
</dd></dl>
<dl class="class">
<dt id="artv2.utilities.interface_utilities.ARTv2Message">
<em class="property">class </em><code class="descname">ARTv2Message</code><span class="sig-paren">(</span><em>width</em>, <em>height</em>, <em>title</em>, <em>critical=False</em>, <em>warning=False</em>, <em>info=False</em>, <em>question=False</em>, <em>parent=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/utilities/interface_utilities.html#ARTv2Message"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.utilities.interface_utilities.ARTv2Message" title="Permalink to this definition">¶</a></dt>
<dd><p>Abstract class that adds extra functionality onto QMessageBox. Depending on the message type (warning, error, etc),
different buttons and icons will be shown. This class is not meant to be instantiated on its own.</p>
</dd></dl>
<dl class="class">
<dt id="artv2.utilities.interface_utilities.ARTv2Window">
<em class="property">class </em><code class="descname">ARTv2Window</code><span class="sig-paren">(</span><em>width</em>, <em>height</em>, <em>window_title</em>, <em>parent=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/utilities/interface_utilities.html#ARTv2Window"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.utilities.interface_utilities.ARTv2Window" title="Permalink to this definition">¶</a></dt>
<dd><p>Abstract class that adds some extra default functionality for things like grabbing settings, dealing with
different screen resolutions, styling the UI, and saving screen position. This class is not meant to be
instantiated on its own.</p>
<dl class="method">
<dt id="artv2.utilities.interface_utilities.ARTv2Window.closeEvent">
<code class="descname">closeEvent</code><span class="sig-paren">(</span><em>event</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/utilities/interface_utilities.html#ARTv2Window.closeEvent"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.utilities.interface_utilities.ARTv2Window.closeEvent" title="Permalink to this definition">¶</a></dt>
<dd><p>Override QMainWindow’s close event to remember window position.</p>
</dd></dl>
<dl class="staticmethod">
<dt id="artv2.utilities.interface_utilities.ARTv2Window.launch_help_doc">
<em class="property">static </em><code class="descname">launch_help_doc</code><span class="sig-paren">(</span><em>path</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/utilities/interface_utilities.html#ARTv2Window.launch_help_doc"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.utilities.interface_utilities.ARTv2Window.launch_help_doc" title="Permalink to this definition">¶</a></dt>
<dd><p>Launches a html page from the artv2 help documents.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>path</strong> – The path of the html file to launch.</td>
</tr>
</tbody>
</table>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="artv2.utilities.interface_utilities.ConfirmWidget">
<em class="property">class </em><code class="descname">ConfirmWidget</code><span class="sig-paren">(</span><em>message</em>, <em>details</em>, <em>title</em>, <em>parent=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/utilities/interface_utilities.html#ConfirmWidget"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.utilities.interface_utilities.ConfirmWidget" title="Permalink to this definition">¶</a></dt>
<dd><p>Simple class that displays a QMessageBox widget with a question, a question icon, and Yes or Cancel buttons.
Takes in a string message to display, a string for any detailed text to display, and a string for the title.</p>
</dd></dl>
<dl class="class">
<dt id="artv2.utilities.interface_utilities.ErrorWidget">
<em class="property">class </em><code class="descname">ErrorWidget</code><span class="sig-paren">(</span><em>message</em>, <em>parent=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/utilities/interface_utilities.html#ErrorWidget"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.utilities.interface_utilities.ErrorWidget" title="Permalink to this definition">¶</a></dt>
<dd><p>Simple class that displays a QMessageBox widget with an error message, and error icon, and a simple “OK” button.
Takes in a string message to display.</p>
<img alt="../../../_images/errorWidget.png" src="../../../_images/errorWidget.png" />
</dd></dl>
<dl class="class">
<dt id="artv2.utilities.interface_utilities.InfoWidget">
<em class="property">class </em><code class="descname">InfoWidget</code><span class="sig-paren">(</span><em>message</em>, <em>details</em>, <em>parent=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/utilities/interface_utilities.html#InfoWidget"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.utilities.interface_utilities.InfoWidget" title="Permalink to this definition">¶</a></dt>
<dd><p>Simple class that displays a QMessageBox widget with an error message, and error icon, and a simple “OK” button.
This class takes in required arguments: A string message, and a string for details. The details string could be
empty if not required.</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">message</span> <span class="o">=</span> <span class="n">ui_utils</span><span class="o">.</span><span class="n">InfoWidget</span><span class="p">(</span><span class="s2">"this is an info widget"</span><span class="p">,</span> <span class="s2">"these are some details</span><span class="se">\n</span><span class="s2">as are these"</span><span class="p">)</span>
</pre></div>
</div>
<img alt="../../../_images/infoWidget.png" src="../../../_images/infoWidget.png" />
</dd></dl>
<dl class="function">
<dt id="artv2.utilities.interface_utilities.clear_layout">
<code class="descname">clear_layout</code><span class="sig-paren">(</span><em>layout</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/utilities/interface_utilities.html#clear_layout"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.utilities.interface_utilities.clear_layout" title="Permalink to this definition">¶</a></dt>
<dd><p>Clears the given layout of all child widgets.</p>
</dd></dl>
<dl class="function">
<dt id="artv2.utilities.interface_utilities.create_style_sheet">
<code class="descname">create_style_sheet</code><span class="sig-paren">(</span><em>data</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/utilities/interface_utilities.html#create_style_sheet"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.utilities.interface_utilities.create_style_sheet" title="Permalink to this definition">¶</a></dt>
<dd><p>Take in a read stylesheet, and replace any urls with actual file paths, then return the altered data.</p>
</dd></dl>
<dl class="function">
<dt id="artv2.utilities.interface_utilities.filter_list">
<code class="descname">filter_list</code><span class="sig-paren">(</span><em>list_widget</em>, <em>search_widget</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/utilities/interface_utilities.html#filter_list"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.utilities.interface_utilities.filter_list" title="Permalink to this definition">¶</a></dt>
<dd><p>Filters the list widget by the search term in the given search widget.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>list_widget</strong> – QListWidget widget to filter items in.</li>
<li><strong>search_widget</strong> – QLineEdit widget to grab text from for search term.</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="artv2.utilities.interface_utilities.get_items">
<code class="descname">get_items</code><span class="sig-paren">(</span><em>list_widget</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/utilities/interface_utilities.html#get_items"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.utilities.interface_utilities.get_items" title="Permalink to this definition">¶</a></dt>
<dd><p>Given a list widget, get and return the text and pointer to the list widget item in a dict.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>list_widget</strong> – List widget to query items from.</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Returns a dict of the listWidgetItems’ text and pointer to the items.</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="artv2.utilities.interface_utilities.get_maya_dpi">
<code class="descname">get_maya_dpi</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/utilities/interface_utilities.html#get_maya_dpi"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.utilities.interface_utilities.get_maya_dpi" title="Permalink to this definition">¶</a></dt>
<dd><p>Gets the DPI setting value in Maya and returns the multiplier.</p>
</dd></dl>
<dl class="function">
<dt id="artv2.utilities.interface_utilities.get_maya_window">
<code class="descname">get_maya_window</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/utilities/interface_utilities.html#get_maya_window"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.utilities.interface_utilities.get_maya_window" title="Permalink to this definition">¶</a></dt>
<dd><p>Return Maya’s main window as a QWidget</p>
</dd></dl>
<dl class="function">
<dt id="artv2.utilities.interface_utilities.get_style_sheet">
<code class="descname">get_style_sheet</code><span class="sig-paren">(</span><em>file_path</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/utilities/interface_utilities.html#get_style_sheet"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.utilities.interface_utilities.get_style_sheet" title="Permalink to this definition">¶</a></dt>
<dd><p>Read the style sheet data, and then replace any urls with proper file paths on the user’s drive.</p>
</dd></dl>
<dl class="function">
<dt id="artv2.utilities.interface_utilities.scale_by_dpi">
<code class="descname">scale_by_dpi</code><span class="sig-paren">(</span><em>value</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/utilities/interface_utilities.html#scale_by_dpi"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.utilities.interface_utilities.scale_by_dpi" title="Permalink to this definition">¶</a></dt>
<dd><p>Scales the given value by the dpi multiplier.</p>
</dd></dl>
<dl class="function">
<dt id="artv2.utilities.interface_utilities.search_list_widget">
<code class="descname">search_list_widget</code><span class="sig-paren">(</span><em>search_field</em>, <em>list_widget</em>, <em>*args</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/utilities/interface_utilities.html#search_list_widget"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.utilities.interface_utilities.search_list_widget" title="Permalink to this definition">¶</a></dt>
<dd><p>Searches the given list_widget for items with the search term in the given search_field. Items that do not match are
hidden in the list.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>search_field</strong> – The QLineEdit to grab the search term from</li>
<li><strong>list_widget</strong> – the QListWidget to manipulate</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="artv2.utilities.interface_utilities.toggle_group">
<code class="descname">toggle_group</code><span class="sig-paren">(</span><em>ctrl</em>, <em>args</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/utilities/interface_utilities.html#toggle_group"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.utilities.interface_utilities.toggle_group" title="Permalink to this definition">¶</a></dt>
<dd><p>Sets the given ctrl (groupbox) height based on the check state.</p>
</dd></dl>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="joint_mover_utils.html" class="btn btn-neutral float-right" title="Joint Mover Utilities" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="error_utils.html" class="btn btn-neutral float-left" title="Error Utilities" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
© Copyright 2018, Jeremy Ernst
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>
|