research/transmission_spectroscopy/simulator/pgu-0.18/docs/gui.app.html

   1 <html>
   2 <head>
   3 <title>gui.app</title>
   4 <style type='text/css'><!--
   5 .sections {
   6         border: 1px solid black;
   7         background: #fef790;
   8         margin-left: 8px;
   9         }
  10
  11 .sections th {
  12         background: #fde42d;
  13         }
  14
  15 .sections .h1 {
  16         padding: 2px;
  17         padding-left: 0px;
  18         }
  19 .sections .h2 {
  20         padding: 2px;
  21         padding-left: 16px;
  22         }
  23 .sections .h3 {
  24         padding: 2px;
  25         padding-left: 32px;
  26         }
  27 .sections .h4 {
  28         padding: 2px;
  29         padding-left: 48px;
  30         }
  31
  32 .sections .h5 {
  33         padding: 2px;
  34         padding-left: 64px;
  35         }
  36 .sections .h6 {
  37         padding: 2px;
  38         padding-left: 72px;
  39         }
  40
  41 .wiki h1, .wiki h2, .wiki h3, .wiki h4, .wiki h5, .wiki h6 {
  42         border: 0px;
  43         padding: 0px;
  44         background: none;
  45         border-bottom: 1px solid #bbbbbb;
  46
  47         }
  48
  49 .wiki div.h1 {
  50     }
  51 .wiki div.h2 {
  52     }
  53
  54 .wiki dt {
  55     font-style: italic;
  56     }
  57
  58 .wiki dd,dd,p.dd {
  59     font-style: normal;
  60     margin-left: 48px;
  61     margin-top: 0px;
  62     margin-bottom: 8px;
  63     display: block;
  64     }
  65
  66 .wiki h3 {
  67     margin-left: 48px;
  68     }
  69 .wiki div.h3 {
  70     margin-left: 48px;
  71     }
  72
  73 .wiki code, .wiki pre {
  74     background: #eeeeee;
  75     padding: 4px;
  76     border: 1px dashed #888888;
  77     }
  78
  79
  80 .wiki table {
  81     border-top: 1px solid #888888;
  82     border-left: 1px solid #888888;
  83     border-spacing: 0px; border-collapse: collapse;
  84     }
  85 .wiki td {
  86     border-bottom: 1px solid #888888;
  87     border-right: 1px solid #888888;
  88     padding: 3px;
  89     }
  90 .wiki th {
  91     background: #eeeeee;
  92     border-bottom: 1px solid #888888;
  93     border-right: 1px solid #888888;
  94     padding: 3px;
  95     }
  96
  97 -->
  98 </style>
  99
 100 </head>
 101 <body>
 102 <div align='center'>
 103
 104 <table cellpadding=8><tr><td>
 105 <a href='http://www.imitationpickles.org/pgu/'><img src='skin/logo.gif' alt="Phil's pyGame Utilities" border=0></a>
 106 <td style='font-size:48px'>Documentation
 107 </table>
 108
 109 </div>
 110
 111 <hr width=500 align=center>
 112
 113 <table width='100%'><tr><td valign=top width=120 style='padding-right:6px;border-right: 1px solid black;'>
 114 <a href='index.html'>Overview</a><br><br>
 115 <strong>Scripts</strong><br>
 116 <a href="tileedit.html">tileedit</a>
 117  | <a href="leveledit.html">leveledit</a>
 118  | <a href="tganew.html">tganew</a>
 119  | <a href="levelfancy.html">levelfancy</a>
 120 <br><br>
 121 <strong>Reference</strong><br>
 122 <a href="algo.html">algo</a>
 123  | <a href="ani.html">ani</a>
 124  | <a href="engine.html">engine</a>
 125  | <a href="fonts.html">fonts</a>
 126  | <a href="high.html">high</a>
 127  | <a href="html.html">html</a>
 128  | <a href="layout.html">layout</a>
 129  | <a href="text.html">text</a>
 130  | <a href="timer.html">timer</a>
 131  | <a href="vid.html">vid</a>
 132 <br><br>
 133 <strong>Tutorials</strong><br>
 134 <a href="tilevid1.html">1</a>
 135  | <a href="tilevid2.html">2</a>
 136  | <a href="tilevid3.html">3</a>
 137  | <a href="tilevid4.html">4</a>
 138  | <a href="tilevid5.html">5</a>
 139 <br><br>
 140 <strong>GUI&nbsp;Ref.</strong><br>
 141 <a href="gui.theme.html">theme</a>
 142  | <a href="gui.style.html">style</a>
 143  | <a href="gui.widget.html">widget</a>
 144  | <a href="gui.surface.html">surface</a>
 145  | <a href="gui.const.html">const</a>
 146 <br><br>
 147 <strong>Containers</strong><br>
 148 <a href="gui.container.html">container</a>
 149  | <a href="gui.app.html">app</a>
 150  | <a href="gui.table.html">table</a>
 151  | <a href="gui.document.html">document</a>
 152  | <a href="gui.area.html">area</a>
 153 <br><br>
 154 <strong>Forms</strong><br>
 155 <a href="gui.form.html">form</a>
 156  | <a href="gui.group.html">group</a>
 157 <br><br>
 158 <strong>Widgets</strong><br>
 159 <a href="gui.basic.html">basic</a>
 160  | <a href="gui.button.html">button</a>
 161  | <a href="gui.input.html">input</a>
 162  | <a href="gui.keysym.html">keysym</a>
 163  | <a href="gui.slider.html">slider</a>
 164  | <a href="gui.select.html">select</a>
 165  | <a href="gui.misc.html">misc</a>
 166 <br><br>
 167 <strong>Other</strong><br>
 168 <a href="gui.menus.html">menus</a>
 169  | <a href="gui.dialog.html">dialog</a>
 170 <br><br>
 171 <strong>Tutorials</strong><br>
 172 <a href="gui1.html">1</a>
 173  | <a href="gui2.html">2</a>
 174  | <a href="gui3.html">3</a>
 175  | <a href="gui4.html">4</a>
 176  | <a href="gui5.html">5</a>
 177  | <a href="gui6.html">6</a>
 178  | <a href="gui7.html">7</a>
 179  | <a href="gui8.html">8</a>
 180  | <a href="gui9.html">9</a>
 181  | <a href="gui10.html">10</a>
 182 <br><br>
 183
 184 <td valign=top style='padding-left:6px;'>
 185
 186 <h1>gui.app</h1>
 187 <table class='sections' align=right>
 188 <tr><th>sections</th>
 189 <tr><td class='h1'><a href='#App'>App</a>
 190 <tr><td class='h2'><a href='#App.__init__'>App.__init__</a>
 191 <tr><td class='h2'><a href='#App.set_global_app'>App.set_global_app</a>
 192 <tr><td class='h2'><a href='#App.init'>App.init</a>
 193 <tr><td class='h2'><a href='#App.event'>App.event</a>
 194 <tr><td class='h2'><a href='#App.loop'>App.loop</a>
 195 <tr><td class='h2'><a href='#App.paint'>App.paint</a>
 196 <tr><td class='h2'><a href='#App.update'>App.update</a>
 197 <tr><td class='h2'><a href='#App.run'>App.run</a>
 198 <tr><td class='h2'><a href='#App.open'>App.open</a>
 199 <tr><td class='h2'><a href='#App.close'>App.close</a>
 200 <tr><td class='h1'><a href='#Desktop'>Desktop</a>
 201 </table>
 202
 203 <div class='wiki'>
 204 <a name="">
 205 <div class="h1">
 206 Defines the top-level application widget
 207 </div>
 208 <a name="App">
 209 <h2>App</h2>
 210 <div class="h2">
 211 The top-level widget for an application.
 212
 213 Example:
 214     import pygame
 215     from pgu import gui
 216
 217     widget = gui.Button("Testing")
 218
 219     app = gui.App()
 220     app.init(widget=widget)
 221     app.run()
 222
 223
 224 </div>
 225 <a name="App.__init__">
 226 <h3>App.__init__</h3>
 227 <div class="h3">
 228 Create a new application given the (optional) theme instance.
 229 </div>
 230 <a name="App.set_global_app">
 231 <h3>App.set_global_app</h3>
 232 <div class="h3">
 233 Registers this app as _the_ global PGU application. You
 234 generally shouldn't need to call this function.
 235 </div>
 236 <a name="App.init">
 237 <h3>App.init</h3>
 238 <div class="h3">
 239 Initialize the application.
 240
 241 Keyword arguments:
 242     widget -- the top-level widget in the application
 243     screen -- the pygame surface to render to
 244     area -- the rectangle (within 'screen') to use for rendering
 245
 246 </div>
 247 <a name="App.event">
 248 <h3>App.event</h3>
 249 <div class="h3">
 250 Pass an event to the main widget. If you are managing your own
 251 mainloop, this function should be called periodically when you are
 252 processing pygame events.
 253
 254 </div>
 255 <a name="App.loop">
 256 <h3>App.loop</h3>
 257 <div class="h3">
 258 Performs one iteration of the PGU application loop, which
 259 processes events and update the pygame display.
 260 </div>
 261 <a name="App.paint">
 262 <h3>App.paint</h3>
 263 <div class="h3">
 264 Renders the application onto the given pygame surface
 265 </div>
 266 <a name="App.update">
 267 <h3>App.update</h3>
 268 <div class="h3">
 269 Update the screen in a semi-efficient manner, and returns
 270 a list of pygame rects to be updated.
 271 </div>
 272 <a name="App.run">
 273 <h3>App.run</h3>
 274 <div class="h3">
 275 Run an application.
 276
 277 Automatically calls App.init and then forever loops while
 278 calling App.event and App.update
 279
 280 Keyword arguments:
 281     widget -- the top-level widget to use
 282     screen -- the pygame surface to render to
 283     delay -- the delay between updates (in milliseconds)
 284
 285 </div>
 286 <a name="App.open">
 287 <h3>App.open</h3>
 288 <div class="h3">
 289 Opens the given PGU window and positions it on the screen
 290 </div>
 291 <a name="App.close">
 292 <h3>App.close</h3>
 293 <div class="h3">
 294 Closes the previously opened PGU window
 295 </div>
 296 <a name="Desktop">
 297 <h2>Desktop</h2>
 298 <div class="h2">
 299 Create an App using the desktop theme class.
 300 </div>
 301
 302 </div>
 303
 304 </table>
 305
 306 <hr width=500 align=center>
 307 <div align='center'>all content (c) 2006 Phil Hassey - <a href='http://www.imitationpickles.org/pgu/'>Phil's pyGame Utilities</a></div>
 308 </body>
 309 </html>