<!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>EasyDialogs – Carbon dialogs for Mac OS X — Python Module of the Week</title>
<link rel="stylesheet" href="../_static/sphinxdoc.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.132',
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="author" title="About these documents" href="../about.html" />
<link rel="top" title="Python Module of the Week" href="../index.html" />
<link rel="up" title="Miscelaneous" href="../miscelaneous.html" />
<link rel="next" title="plistlib – Manipulate OS X property list files" href="../plistlib/index.html" />
<link rel="prev" title="Miscelaneous" href="../miscelaneous.html" />
</head>
<body>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="../plistlib/index.html" title="plistlib – Manipulate OS X property list files"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="../miscelaneous.html" title="Miscelaneous"
accesskey="P">previous</a> |</li>
<li><a href="../contents.html">PyMOTW</a> »</li>
<li><a href="../miscelaneous.html" accesskey="U">Miscelaneous</a> »</li>
</ul>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h3><a href="../contents.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">EasyDialogs – Carbon dialogs for Mac OS X</a><ul>
<li><a class="reference internal" href="#messages">Messages</a></li>
<li><a class="reference internal" href="#progressbar">ProgressBar</a></li>
<li><a class="reference internal" href="#simple-prompts">Simple Prompts</a></li>
<li><a class="reference internal" href="#passwords">Passwords</a></li>
<li><a class="reference internal" href="#files-and-directories">Files and Directories</a></li>
<li><a class="reference internal" href="#getargv">GetArgv</a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="../miscelaneous.html"
title="previous chapter">Miscelaneous</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="../plistlib/index.html"
title="next chapter">plistlib – Manipulate OS X property list files</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/EasyDialogs/index.txt"
rel="nofollow">Show Source</a></li>
</ul>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="../search.html" method="get">
<input type="text" name="q" size="18" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="module-EasyDialogs">
<span id="easydialogs-carbon-dialogs-for-mac-os-x"></span><h1>EasyDialogs – Carbon dialogs for Mac OS X<a class="headerlink" href="#module-EasyDialogs" title="Permalink to this headline">¶</a></h1>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Purpose:</th><td class="field-body">Provides simple interfaces to Carbon dialogs from Python.</td>
</tr>
<tr class="field"><th class="field-name">Python Version:</th><td class="field-body">At least 2.0, Macintosh-only (see References below for a Windows implementation)</td>
</tr>
</tbody>
</table>
<p>The EasyDialogs module includes classes and functions for working with
simple message and prompt dialogs, as well as stock dialogs for
querying the user for file or directory names. The dialogs use the
Carbon API. See Apple’s <a class="reference external" href="http://developer.apple.com/documentation/Carbon/Reference/Navigation_Services_Ref/Reference/reference.html">Navigation Services Reference</a> for more
details about some of the options not covered in detail here.</p>
<div class="section" id="messages">
<h2>Messages<a class="headerlink" href="#messages" title="Permalink to this headline">¶</a></h2>
<p>A simple Message function displays modal dialog containing a text message for
the user.</p>
<div class="highlight-python"><div class="highlight"><pre><span class="kn">import</span> <span class="nn">EasyDialogs</span>
<span class="n">EasyDialogs</span><span class="o">.</span><span class="n">Message</span><span class="p">(</span><span class="s">'This is a Message dialog'</span><span class="p">)</span>
</pre></div>
</div>
<img alt="../_images/MessageDialog.png" src="../_images/MessageDialog.png" />
<p>It is easy to change the label of the “OK” button using the <tt class="docutils literal"><span class="pre">ok</span></tt>
argument.</p>
<div class="highlight-python"><div class="highlight"><pre><span class="kn">import</span> <span class="nn">EasyDialogs</span>
<span class="n">EasyDialogs</span><span class="o">.</span><span class="n">Message</span><span class="p">(</span><span class="s">'The button label has changed'</span><span class="p">,</span> <span class="n">ok</span><span class="o">=</span><span class="s">'Continue'</span><span class="p">)</span>
</pre></div>
</div>
<img alt="../_images/MessageDialog_continue.png" src="../_images/MessageDialog_continue.png" />
</div>
<div class="section" id="progressbar">
<h2>ProgressBar<a class="headerlink" href="#progressbar" title="Permalink to this headline">¶</a></h2>
<p>The ProgressBar class manages a modeless dialog with a progress meter. It can
operate in determinate (when you know how much work there is to be done) or
indeterminate (when you want to show that your app is working, but do not know
how much work needs to be done) modes. The constructor takes arguments for the
dialog title, the maximum value, and a label to describe the current phase of
operation.</p>
<p>In determinate mode, set the maxval argument to the number of steps, amount of
data to download, etc. Then use the incr() method to step the progress from 0
to maxval.</p>
<div class="highlight-python"><div class="highlight"><pre><span class="kn">import</span> <span class="nn">EasyDialogs</span>
<span class="kn">import</span> <span class="nn">time</span>
<span class="n">meter</span> <span class="o">=</span> <span class="n">EasyDialogs</span><span class="o">.</span><span class="n">ProgressBar</span><span class="p">(</span><span class="s">'Making progress...'</span><span class="p">,</span>
<span class="n">maxval</span><span class="o">=</span><span class="mi">10</span><span class="p">,</span>
<span class="n">label</span><span class="o">=</span><span class="s">'Starting'</span><span class="p">,</span>
<span class="p">)</span>
<span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">xrange</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span> <span class="mi">11</span><span class="p">):</span>
<span class="n">phase</span> <span class="o">=</span> <span class="s">'Phase </span><span class="si">%d</span><span class="s">'</span> <span class="o">%</span> <span class="n">i</span>
<span class="k">print</span> <span class="n">phase</span>
<span class="n">meter</span><span class="o">.</span><span class="n">label</span><span class="p">(</span><span class="n">phase</span><span class="p">)</span>
<span class="n">meter</span><span class="o">.</span><span class="n">inc</span><span class="p">()</span>
<span class="n">time</span><span class="o">.</span><span class="n">sleep</span><span class="p">(</span><span class="mi">1</span><span class="p">)</span>
<span class="k">print</span> <span class="s">'Done with loop'</span>
<span class="n">time</span><span class="o">.</span><span class="n">sleep</span><span class="p">(</span><span class="mi">1</span><span class="p">)</span>
<span class="k">del</span> <span class="n">meter</span>
<span class="k">print</span> <span class="s">'The dialog should be gone now'</span>
<span class="n">time</span><span class="o">.</span><span class="n">sleep</span><span class="p">(</span><span class="mi">1</span><span class="p">)</span>
</pre></div>
</div>
<img alt="../_images/ProgressBar_partial.png" src="../_images/ProgressBar_partial.png" />
<div class="highlight-python"><pre>$ python EasyDialogs_ProgressBar.py
Phase 1
Phase 2
Phase 3
Phase 4
Phase 5
Phase 6
Phase 7
Phase 8
Phase 9
Phase 10
Done with loop</pre>
</div>
<img alt="../_images/ProgressBar_complete.png" src="../_images/ProgressBar_complete.png" />
<div class="highlight-python"><pre>The dialog should be gone now</pre>
</div>
<p>Explicitly deleting the ProgressBar instance using <tt class="docutils literal"><span class="pre">del</span></tt> removes it
from the screen.</p>
<p>If you are measuring progress in uneven steps, use <tt class="docutils literal"><span class="pre">set()</span></tt> to change
the progress meter instead of <tt class="docutils literal"><span class="pre">incr()</span></tt>.</p>
<div class="highlight-python"><div class="highlight"><pre><span class="kn">import</span> <span class="nn">EasyDialogs</span>
<span class="kn">import</span> <span class="nn">time</span>
<span class="n">meter</span> <span class="o">=</span> <span class="n">EasyDialogs</span><span class="o">.</span><span class="n">ProgressBar</span><span class="p">(</span><span class="s">'Making progress...'</span><span class="p">,</span>
<span class="n">maxval</span><span class="o">=</span><span class="mi">1000</span><span class="p">,</span>
<span class="n">label</span><span class="o">=</span><span class="s">'Starting'</span><span class="p">,</span>
<span class="p">)</span>
<span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">xrange</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span> <span class="mi">1001</span><span class="p">,</span> <span class="mi">123</span><span class="p">):</span>
<span class="n">msg</span> <span class="o">=</span> <span class="s">'Bytes: </span><span class="si">%d</span><span class="s">'</span> <span class="o">%</span> <span class="n">i</span>
<span class="n">meter</span><span class="o">.</span><span class="n">label</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span>
<span class="n">meter</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="n">i</span><span class="p">)</span>
<span class="n">time</span><span class="o">.</span><span class="n">sleep</span><span class="p">(</span><span class="mi">1</span><span class="p">)</span>
</pre></div>
</div>
<img alt="../_images/ProgressBar_set_partial.png" src="../_images/ProgressBar_set_partial.png" />
</div>
<div class="section" id="simple-prompts">
<h2>Simple Prompts<a class="headerlink" href="#simple-prompts" title="Permalink to this headline">¶</a></h2>
<p>EasyDialogs also lets you ask the user for information. Use AskString to
display a modal dialog to prompt the user for a simple string.</p>
<div class="highlight-python"><div class="highlight"><pre><span class="kn">import</span> <span class="nn">EasyDialogs</span>
<span class="n">response</span> <span class="o">=</span> <span class="n">EasyDialogs</span><span class="o">.</span><span class="n">AskString</span><span class="p">(</span><span class="s">'What is your favorite color?'</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="s">'blue'</span><span class="p">)</span>
<span class="k">print</span> <span class="s">'RESPONSE:'</span><span class="p">,</span> <span class="n">response</span>
</pre></div>
</div>
<img alt="../_images/AskString.png" src="../_images/AskString.png" />
<p>The return value depends on the user’s response. It is either the text they
enter:</p>
<div class="highlight-python"><pre>$ python EasyDialogs_AskString.py
RESPONSE: blue</pre>
</div>
<p>or None if they press the Cancel button.</p>
<div class="highlight-python"><pre>$ python EasyDialogs_AskString.py
RESPONSE: None</pre>
</div>
<p>The string response has a length limit of 254 characters. If the value entered
is longer than that, it is truncated.</p>
<div class="highlight-python"><div class="highlight"><pre><span class="kn">import</span> <span class="nn">EasyDialogs</span>
<span class="kn">import</span> <span class="nn">string</span>
<span class="n">default</span> <span class="o">=</span> <span class="n">string</span><span class="o">.</span><span class="n">ascii_letters</span> <span class="o">*</span> <span class="mi">10</span>
<span class="k">print</span> <span class="s">'len(default)='</span><span class="p">,</span> <span class="nb">len</span><span class="p">(</span><span class="n">default</span><span class="p">)</span>
<span class="n">response</span> <span class="o">=</span> <span class="n">EasyDialogs</span><span class="o">.</span><span class="n">AskString</span><span class="p">(</span><span class="s">'Enter a long string'</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="n">default</span><span class="p">)</span>
<span class="k">print</span> <span class="s">'len(response)='</span><span class="p">,</span> <span class="nb">len</span><span class="p">(</span><span class="n">response</span><span class="p">)</span>
</pre></div>
</div>
<img alt="../_images/AskString_too_long.png" src="../_images/AskString_too_long.png" />
<div class="highlight-python"><pre>$ python EasyDialogs_AskString_too_long.py
len(default)= 520
len(response)= 254</pre>
</div>
</div>
<div class="section" id="passwords">
<h2>Passwords<a class="headerlink" href="#passwords" title="Permalink to this headline">¶</a></h2>
<p>Use AskPassword to prompt the user for secret values that should not be echoed
back to the screen in clear-text.</p>
<div class="highlight-python"><div class="highlight"><pre><span class="kn">import</span> <span class="nn">EasyDialogs</span>
<span class="n">response</span> <span class="o">=</span> <span class="n">EasyDialogs</span><span class="o">.</span><span class="n">AskPassword</span><span class="p">(</span><span class="s">'Password:'</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="s">'s3cr3t'</span><span class="p">)</span>
<span class="k">print</span> <span class="s">'Shh!:'</span><span class="p">,</span> <span class="n">response</span>
</pre></div>
</div>
<img alt="../_images/AskPassword.png" src="../_images/AskPassword.png" />
<div class="highlight-python"><pre>$ python EasyDialogs_AskPassword.py
Shh!: s3cr3t</pre>
</div>
<p>The Ok/Cancel behavior for AskPassword is the same as AskString.</p>
</div>
<div class="section" id="files-and-directories">
<h2>Files and Directories<a class="headerlink" href="#files-and-directories" title="Permalink to this headline">¶</a></h2>
<p>There are special functions for requesting file or directory names. These use
the native file selector dialogs, so the user does not have to type in the
paths. For example, to ask the user which file to open, use AskFileForOpen.</p>
<div class="highlight-python"><div class="highlight"><pre><span class="kn">import</span> <span class="nn">EasyDialogs</span>
<span class="kn">import</span> <span class="nn">os</span>
<span class="n">filename</span> <span class="o">=</span> <span class="n">EasyDialogs</span><span class="o">.</span><span class="n">AskFileForOpen</span><span class="p">(</span>
<span class="n">message</span><span class="o">=</span><span class="s">'Select a Python source file'</span><span class="p">,</span>
<span class="n">defaultLocation</span><span class="o">=</span><span class="n">os</span><span class="o">.</span><span class="n">getcwd</span><span class="p">(),</span>
<span class="n">wanted</span><span class="o">=</span><span class="nb">unicode</span><span class="p">,</span>
<span class="p">)</span>
<span class="k">print</span> <span class="s">'Selected:'</span><span class="p">,</span> <span class="n">filename</span>
</pre></div>
</div>
<p>The wanted=unicode argument tells AskFileForOpen to return the name of the
file as a unicode string. The other possible return types include ASCII
string, and some Apple data structures for working with file references.</p>
<p>By specifing defaultLocation, this example initializes the dialog to the
current working directory. The user is still free to navigate around the
filesystem.</p>
<p>Other options to AskFileForOpen let you filter the values displayed, control
the type codes of files visible to the user, and interact with the dialog
through callbacks. Refer to the module documentation and Apple’s reference
guide for more details.</p>
<img alt="../_images/AskForFileOpen.png" src="../_images/AskForFileOpen.png" />
<div class="highlight-python"><pre>$ python EasyDialogs_AskFileForOpen.py
Selected: /Users/dhellmann/Documents/PyMOTW/in_progress/EasyDialogs/EasyDialogs_AskFileForOpen.py</pre>
</div>
<p>To prompt the user to provide a new filename when saving a file, use
AskFileForSave.</p>
<div class="highlight-python"><div class="highlight"><pre><span class="kn">import</span> <span class="nn">EasyDialogs</span>
<span class="kn">import</span> <span class="nn">os</span>
<span class="n">filename</span> <span class="o">=</span> <span class="n">EasyDialogs</span><span class="o">.</span><span class="n">AskFileForSave</span><span class="p">(</span>
<span class="n">message</span><span class="o">=</span><span class="s">'Name the destination'</span><span class="p">,</span>
<span class="n">defaultLocation</span><span class="o">=</span><span class="n">os</span><span class="o">.</span><span class="n">getcwd</span><span class="p">(),</span>
<span class="n">wanted</span><span class="o">=</span><span class="nb">unicode</span><span class="p">,</span>
<span class="p">)</span>
<span class="k">print</span> <span class="s">'Selected:'</span><span class="p">,</span> <span class="n">filename</span>
</pre></div>
</div>
<img alt="../_images/AskFileForSave.png" src="../_images/AskFileForSave.png" />
<div class="highlight-python"><pre>$ python EasyDialogs_AskFileForSave.py
Selected: /Users/dhellmann/Documents/PyMOTW/in_progress/EasyDialogs/new_file.py</pre>
</div>
<p>If you need the user to select a directory, existing or new, use AskFolder.
The dialog includes a button to let them create a new folder.</p>
<div class="highlight-python"><div class="highlight"><pre><span class="kn">import</span> <span class="nn">EasyDialogs</span>
<span class="kn">import</span> <span class="nn">os</span>
<span class="n">filename</span> <span class="o">=</span> <span class="n">EasyDialogs</span><span class="o">.</span><span class="n">AskFolder</span><span class="p">(</span>
<span class="n">message</span><span class="o">=</span><span class="s">'Name the destination'</span><span class="p">,</span>
<span class="n">defaultLocation</span><span class="o">=</span><span class="n">os</span><span class="o">.</span><span class="n">getcwd</span><span class="p">(),</span>
<span class="n">wanted</span><span class="o">=</span><span class="nb">unicode</span><span class="p">,</span>
<span class="p">)</span>
<span class="k">print</span> <span class="s">'Selected:'</span><span class="p">,</span> <span class="n">filename</span>
</pre></div>
</div>
<img alt="../_images/AskFolder.png" src="../_images/AskFolder.png" />
<div class="highlight-python"><pre>$ python EasyDialogs_AskFolder.py
Selected: /Users/dhellmann/Documents/PyMOTW/in_progress/EasyDialogs</pre>
</div>
</div>
<div class="section" id="getargv">
<h2>GetArgv<a class="headerlink" href="#getargv" title="Permalink to this headline">¶</a></h2>
<p>An unusually complex dialog, GetArgv lets the user build a command line string
by selecting options from menus. It uses a variation of the getopt syntax to
describe the valid options, and returns a list of strings that can be parsed
by getopt. In my research this week, I found some scripts that use GetArgv if
the user does not specify arguments on the command line.</p>
<p>Let’s look at an example that builds a command using the options supported by
the Python interpreter.</p>
<div class="highlight-python"><div class="highlight"><pre><span class="kn">import</span> <span class="nn">EasyDialogs</span>
<span class="n">arguments</span> <span class="o">=</span> <span class="n">EasyDialogs</span><span class="o">.</span><span class="n">GetArgv</span><span class="p">([</span>
<span class="p">(</span><span class="s">'c='</span><span class="p">,</span> <span class="s">'program passed in as string (terminates option list)'</span><span class="p">),</span>
<span class="p">(</span><span class="s">'d'</span><span class="p">,</span> <span class="s">'Debug'</span><span class="p">),</span>
<span class="p">(</span><span class="s">'E'</span><span class="p">,</span> <span class="s">'Ignore environment variables'</span><span class="p">),</span>
<span class="p">(</span><span class="s">'i'</span><span class="p">,</span> <span class="s">'Inspect interactively after running'</span><span class="p">),</span>
<span class="p">(</span><span class="s">'m='</span><span class="p">,</span> <span class="s">'run library module as a script (terminates option list)'</span><span class="p">),</span>
<span class="p">(</span><span class="s">'O'</span><span class="p">,</span> <span class="s">'Optimize generated bytecode'</span><span class="p">),</span>
<span class="p">(</span><span class="s">'Q='</span><span class="p">,</span> <span class="s">'division options: -Qold (default), -Qwarn, -Qwarnall, -Qnew'</span><span class="p">),</span>
<span class="p">(</span><span class="s">'S'</span><span class="p">,</span> <span class="s">"don't imply 'import site' on initialization"</span><span class="p">),</span>
<span class="p">(</span><span class="s">'t'</span><span class="p">,</span> <span class="s">'issue warnings about inconsistent tab usage'</span><span class="p">),</span>
<span class="p">(</span><span class="s">'tt'</span><span class="p">,</span> <span class="s">'issue errors about inconsistent tab usage'</span><span class="p">),</span>
<span class="p">(</span><span class="s">'u'</span><span class="p">,</span> <span class="s">'unbuffered binary stdout and stderr'</span><span class="p">),</span>
<span class="p">(</span><span class="s">'v'</span><span class="p">,</span> <span class="s">'verbose (trace import statements)'</span><span class="p">),</span>
<span class="p">(</span><span class="s">'V'</span><span class="p">,</span> <span class="s">'print the Python version number and exit'</span><span class="p">),</span>
<span class="p">(</span><span class="s">'W='</span><span class="p">,</span> <span class="s">'warning control (arg is action:message:category:module:lineno)'</span><span class="p">),</span>
<span class="p">(</span><span class="s">'x'</span><span class="p">,</span> <span class="s">'skip first line of source, allowing use of non-Unix forms of #!cmd'</span><span class="p">),</span>
<span class="p">],</span>
<span class="n">commandlist</span><span class="o">=</span><span class="p">[(</span><span class="s">'python'</span><span class="p">,</span> <span class="s">'Default Interpreter'</span><span class="p">),</span>
<span class="p">(</span><span class="s">'python2.5'</span><span class="p">,</span> <span class="s">'Python 2.5'</span><span class="p">),</span>
<span class="p">(</span><span class="s">'pyhton2.4'</span><span class="p">,</span> <span class="s">'Python 2.4'</span><span class="p">),</span>
<span class="p">],</span>
<span class="n">addoldfile</span><span class="o">=</span><span class="bp">True</span><span class="p">,</span>
<span class="n">addnewfile</span><span class="o">=</span><span class="bp">False</span><span class="p">,</span>
<span class="n">addfolder</span><span class="o">=</span><span class="bp">False</span><span class="p">,</span>
<span class="p">)</span>
<span class="k">print</span> <span class="n">arguments</span>
</pre></div>
</div>
<img alt="../_images/GetArgv_1.png" src="../_images/GetArgv_1.png" />
<p>The first argument is a list of tuples containing the option specifier and a
text description. The specifier can contain a single letter for simple boolean
switches; a letter followed by colon (”:”) or equals sign (“=”) for single
letter options that take an argument; several letters for long-form switches
(“opt” translates to “–opt”); or several letters followed by colon or equal
sign for long options taking an argument. The option description is a string
displayed in the dialog.</p>
<img alt="../_images/GetArgv_2.png" src="../_images/GetArgv_2.png" />
<p>The dialog is divided into 4 sections. At the top is the list of options you
specified. The user can select an option from the list. If the option takes an
argument, a text field is displayed so the user can provide a value. The Add
button inserts the selected option into the command line field at the bottom
of the dialog.</p>
<img alt="../_images/GetArgv_3.png" src="../_images/GetArgv_3.png" />
<p>The second argument to GetArgv is a list of commands and descriptions. The
user can select a command to be included in the argument list from the menu in
the middle of the dialog.</p>
<img alt="../_images/GetArgv_4.png" src="../_images/GetArgv_4.png" />
<p>The arguments addoldfile, addnewfile, and addfolder control the sensitivity of
the buttons in the third section of the dialog. In this example, only the Add
file... button is enabled because the Python interpreter does not take
directories or missing files as arguments.</p>
<p>At the bottom of the dialog is the command line being constructed by the user.
When they press OK, GetArgv returns a list of all of the options that looks
like sys.argv.</p>
<div class="highlight-python"><pre>$ python EasyDialogs_GetArgv.py
['python', '-d', '-v', '/Users/dhellmann/Documents/PyMOTW/in_progress/EasyDialogs/EasyDialogs_GetArgv.py']</pre>
</div>
<div class="admonition-see-also admonition seealso">
<p class="first admonition-title">See also</p>
<dl class="last docutils">
<dt><a class="reference external" href="http://docs.python.org/library/easydialogs.html">EasyDialogs</a></dt>
<dd>The standard library documentation for this module.</dd>
<dt><a class="reference external" href="http://developer.apple.com/documentation/Carbon/Reference/Navigation_Services_Ref/Reference/reference.html">Navigation Services Reference</a></dt>
<dd>Documentation for Apple’s API for working with file objects under Mac OS X.</dd>
<dt><a class="reference external" href="http://www.averdevelopment.com/python/EasyDialogs.html">EasyDialogs for Windows</a></dt>
<dd>A version of this module that runs under Windows.</dd>
<dt><a class="reference external" href="http://code.google.com/p/optparse-gui/">optparse-gui</a></dt>
<dd>A replacement for GetArgv that works with <a class="reference internal" href="../optparse/index.html#module-optparse" title="optparse: Command line option parser to replace :mod:`getopt`."><tt class="xref py py-mod docutils literal"><span class="pre">optparse</span></tt></a> instead.</dd>
<dt><a class="reference external" href="http://easygui.sourceforge.net/">EasyGui</a></dt>
<dd>A similar portable library for creating simple graphical user interfaces.</dd>
</dl>
</div>
</div>
</div>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="../plistlib/index.html" title="plistlib – Manipulate OS X property list files"
>next</a> |</li>
<li class="right" >
<a href="../miscelaneous.html" title="Miscelaneous"
>previous</a> |</li>
<li><a href="../contents.html">PyMOTW</a> »</li>
<li><a href="../miscelaneous.html" >Miscelaneous</a> »</li>
</ul>
</div>
<div class="footer">
© Copyright Doug Hellmann.
Last updated on Oct 24, 2010.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a>.
<br/><a href="http://creativecommons.org/licenses/by-nc-sa/3.0/us/" rel="license"><img alt="Creative Commons License" style="border-width:0" src="http://i.creativecommons.org/l/by-nc-sa/3.0/us/88x31.png"/></a>
</div>
</body>
</html>