| 1 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> |
| 2 | <html> |
| 3 | <head> |
| 4 | <link rel="STYLESHEET" href="doc.css" type='text/css' /> |
| 5 | <link rel="SHORTCUT ICON" href="../icons/pyfav.png" type="image/png" /> |
| 6 | <link rel='start' href='../index.html' title='Python Documentation Index' /> |
| 7 | <link rel="first" href="doc.html" title='Documenting Python' /> |
| 8 | <link rel='contents' href='contents.html' title="Contents" /> |
| 9 | <link rel='last' href='about.html' title='About this document...' /> |
| 10 | <link rel='help' href='about.html' title='About this document...' /> |
| 11 | <link rel="prev" href="grammar-displays.html" /> |
| 12 | <link rel="parent" href="special-constructs.html" /> |
| 13 | <link rel="next" href="tools.html" /> |
| 14 | <meta name='aesop' content='information' /> |
| 15 | <title>6.13 Graphical Interface Components </title> |
| 16 | </head> |
| 17 | <body> |
| 18 | <DIV CLASS="navigation"> |
| 19 | <div id='top-navigation-panel' xml:id='top-navigation-panel'> |
| 20 | <table align="center" width="100%" cellpadding="0" cellspacing="2"> |
| 21 | <tr> |
| 22 | <td class='online-navigation'><a rel="prev" title="6.12 Grammar Production Displays" |
| 23 | href="grammar-displays.html"><img src='../icons/previous.png' |
| 24 | border='0' height='32' alt='Previous Page' width='32' /></A></td> |
| 25 | <td class='online-navigation'><a rel="parent" title="6 Special Markup Constructs" |
| 26 | href="special-constructs.html"><img src='../icons/up.png' |
| 27 | border='0' height='32' alt='Up One Level' width='32' /></A></td> |
| 28 | <td class='online-navigation'><a rel="next" title="7 Processing Tools" |
| 29 | href="tools.html"><img src='../icons/next.png' |
| 30 | border='0' height='32' alt='Next Page' width='32' /></A></td> |
| 31 | <td align="center" width="100%">Documenting Python</td> |
| 32 | <td class='online-navigation'><a rel="contents" title="Table of Contents" |
| 33 | href="contents.html"><img src='../icons/contents.png' |
| 34 | border='0' height='32' alt='Contents' width='32' /></A></td> |
| 35 | <td class='online-navigation'><img src='../icons/blank.png' |
| 36 | border='0' height='32' alt='' width='32' /></td> |
| 37 | <td class='online-navigation'><img src='../icons/blank.png' |
| 38 | border='0' height='32' alt='' width='32' /></td> |
| 39 | </tr></table> |
| 40 | <div class='online-navigation'> |
| 41 | <b class="navlabel">Previous:</b> |
| 42 | <a class="sectref" rel="prev" href="grammar-displays.html">6.12 Grammar Production Displays</A> |
| 43 | <b class="navlabel">Up:</b> |
| 44 | <a class="sectref" rel="parent" href="special-constructs.html">6 Special Markup Constructs</A> |
| 45 | <b class="navlabel">Next:</b> |
| 46 | <a class="sectref" rel="next" href="tools.html">7 Processing Tools</A> |
| 47 | </div> |
| 48 | <hr /></div> |
| 49 | </DIV> |
| 50 | <!--End of Navigation Panel--> |
| 51 | |
| 52 | <H2><A NAME="SECTION0007130000000000000000"></A><A NAME="gui-markup"></A> |
| 53 | <BR> |
| 54 | 6.13 Graphical Interface Components |
| 55 | </H2> |
| 56 | |
| 57 | <P> |
| 58 | The components of graphical interfaces will be assigned markup, but |
| 59 | most of the specifics have not been determined. |
| 60 | |
| 61 | <P> |
| 62 | |
| 63 | <dl class='macrodesc'> |
| 64 | <dt><b><tt class='macro'>\guilabel</tt></b> |
| 65 | <tt>{</tt><var>label</var><tt>}</tt></dt> |
| 66 | <dd> |
| 67 | Labels presented as part of an interactive user interface should |
| 68 | be marked using <tt class='macro'>\guilabel</tt>. This includes labels from |
| 69 | text-based interfaces such as those created using <code>curses</code> or |
| 70 | other text-based libraries. Any label used in the interface |
| 71 | should be marked with this macro, including button labels, window |
| 72 | titles, field names, menu and menu selection names, and even |
| 73 | values in selection lists. |
| 74 | </dd></dl> |
| 75 | |
| 76 | <P> |
| 77 | |
| 78 | <dl class='macrodesc'> |
| 79 | <dt><b><tt class='macro'>\menuselection</tt></b> |
| 80 | <tt>{</tt><var>menupath</var><tt>}</tt></dt> |
| 81 | <dd> |
| 82 | Menu selections should be marked using a combination of |
| 83 | <tt class='macro'>\menuselection</tt> and <tt class='macro'>\sub</tt>. This macro is used to mark |
| 84 | a complete sequence of menu selections, including selecting |
| 85 | submenus and choosing a specific operation, or any subsequence of |
| 86 | such a sequence. The names of individual selections should be |
| 87 | separated by occurrences of <tt class='macro'>\sub</tt>. |
| 88 | |
| 89 | <P> |
| 90 | For example, to mark the selection ``<span class="guilabel">Start </span> > <span class="guilabel"> |
| 91 | Programs</span>'', use this markup: |
| 92 | |
| 93 | <P> |
| 94 | <div class="verbatim"><pre> |
| 95 | \menuselection{Start \sub Programs} |
| 96 | </pre></div> |
| 97 | |
| 98 | <P> |
| 99 | When including a selection that includes some trailing indicator, |
| 100 | such as the ellipsis some operating systems use to indicate that |
| 101 | the command opens a dialog, the indicator should be omitted from |
| 102 | the selection name. |
| 103 | |
| 104 | <P> |
| 105 | Individual selection names within the <tt class='macro'>\menuselection</tt> should |
| 106 | not be marked using <tt class='macro'>\guilabel</tt> since that's implied by using |
| 107 | <tt class='macro'>\menuselection</tt>. |
| 108 | </dd></dl> |
| 109 | |
| 110 | <P> |
| 111 | |
| 112 | <dl class='macrodesc'> |
| 113 | <dt><b><tt class='macro'>\sub</tt></b> |
| 114 | </dt> |
| 115 | <dd> |
| 116 | Separator for menu selections that include multiple levels. This |
| 117 | macro is only defined within the context of the |
| 118 | <tt class='macro'>\menuselection</tt> macro. |
| 119 | </dd></dl> |
| 120 | |
| 121 | <P> |
| 122 | |
| 123 | <DIV CLASS="navigation"> |
| 124 | <div class='online-navigation'> |
| 125 | <p></p><hr /> |
| 126 | <table align="center" width="100%" cellpadding="0" cellspacing="2"> |
| 127 | <tr> |
| 128 | <td class='online-navigation'><a rel="prev" title="6.12 Grammar Production Displays" |
| 129 | href="grammar-displays.html"><img src='../icons/previous.png' |
| 130 | border='0' height='32' alt='Previous Page' width='32' /></A></td> |
| 131 | <td class='online-navigation'><a rel="parent" title="6 Special Markup Constructs" |
| 132 | href="special-constructs.html"><img src='../icons/up.png' |
| 133 | border='0' height='32' alt='Up One Level' width='32' /></A></td> |
| 134 | <td class='online-navigation'><a rel="next" title="7 Processing Tools" |
| 135 | href="tools.html"><img src='../icons/next.png' |
| 136 | border='0' height='32' alt='Next Page' width='32' /></A></td> |
| 137 | <td align="center" width="100%">Documenting Python</td> |
| 138 | <td class='online-navigation'><a rel="contents" title="Table of Contents" |
| 139 | href="contents.html"><img src='../icons/contents.png' |
| 140 | border='0' height='32' alt='Contents' width='32' /></A></td> |
| 141 | <td class='online-navigation'><img src='../icons/blank.png' |
| 142 | border='0' height='32' alt='' width='32' /></td> |
| 143 | <td class='online-navigation'><img src='../icons/blank.png' |
| 144 | border='0' height='32' alt='' width='32' /></td> |
| 145 | </tr></table> |
| 146 | <div class='online-navigation'> |
| 147 | <b class="navlabel">Previous:</b> |
| 148 | <a class="sectref" rel="prev" href="grammar-displays.html">6.12 Grammar Production Displays</A> |
| 149 | <b class="navlabel">Up:</b> |
| 150 | <a class="sectref" rel="parent" href="special-constructs.html">6 Special Markup Constructs</A> |
| 151 | <b class="navlabel">Next:</b> |
| 152 | <a class="sectref" rel="next" href="tools.html">7 Processing Tools</A> |
| 153 | </div> |
| 154 | </div> |
| 155 | <hr /> |
| 156 | <span class="release-info">Release 2.4.2, documentation updated on 28 September 2005.</span> |
| 157 | </DIV> |
| 158 | <!--End of Navigation Panel--> |
| 159 | <ADDRESS> |
| 160 | See <i><a href="about.html">About this document...</a></i> for information on suggesting changes. |
| 161 | </ADDRESS> |
| 162 | </BODY> |
| 163 | </HTML> |