3 <title>gui.button</title>
4 <style type='text/css'><!--
6 border: 1px solid black;
41 .wiki h1, .wiki h2, .wiki h3, .wiki h4, .wiki h5, .wiki h6 {
45 border-bottom: 1px solid #bbbbbb;
73 .wiki code, .wiki pre {
76 border: 1px dashed #888888;
81 border-top: 1px solid #888888;
82 border-left: 1px solid #888888;
83 border-spacing: 0px; border-collapse: collapse;
86 border-bottom: 1px solid #888888;
87 border-right: 1px solid #888888;
92 border-bottom: 1px solid #888888;
93 border-right: 1px solid #888888;
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
111 <hr width=500 align=center>
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>
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>
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>
140 <strong>GUI 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>
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>
154 <strong>Forms</strong><br>
155 <a href="gui.form.html">form</a>
156 | <a href="gui.group.html">group</a>
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>
167 <strong>Other</strong><br>
168 <a href="gui.menus.html">menus</a>
169 | <a href="gui.dialog.html">dialog</a>
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>
184 <td valign=top style='padding-left:6px;'>
187 <table class='sections' align=right>
188 <tr><th>sections</th>
189 <tr><td class='h1'><a href='#Button'>Button</a>
190 <tr><td class='h2'><a href='#Button.__init__'>Button.__init__</a>
191 <tr><td class='h1'><a href='#Switch'>Switch</a>
192 <tr><td class='h1'><a href='#Checkbox'>Checkbox</a>
193 <tr><td class='h2'><a href='#Checkbox.__init__'>Checkbox.__init__</a>
194 <tr><td class='h1'><a href='#Radio'>Radio</a>
195 <tr><td class='h2'><a href='#Radio.__init__'>Radio.__init__</a>
196 <tr><td class='h1'><a href='#Tool'>Tool</a>
197 <tr><td class='h2'><a href='#Tool.__init__'>Tool.__init__</a>
198 <tr><td class='h1'><a href='#Icon'>Icon</a>
199 <tr><td class='h1'><a href='#Link'>Link</a>
205 Contains various types of button widgets.
210 A button, buttons can be clicked, they are usually used to set up callbacks.
213 w = gui.Button("Click Me")
214 w.connect(gui.CLICK, fnc, value)
218 <a name="Button.__init__">
219 <h3>Button.__init__</h3>
221 Button constructor, which takes either a string label or widget.
223 See Widget documentation for additional style parameters.
230 A switch can have two states, on or off.
235 A type of switch that can be grouped with other checkboxes.
238 # The 'value' parameter indicates which checkboxes are on by default
239 g = gui.Group(name='colors',value=['r','b'])
243 t.td(gui.Label('Red'))
244 t.td(gui.Checkbox(g,'r'))
246 t.td(gui.Label('Green'))
247 t.td(gui.Checkbox(g,'g'))
249 t.td(gui.Label('Blue'))
250 t.td(gui.Checkbox(g,'b'))
254 <a name="Checkbox.__init__">
255 <h3>Checkbox.__init__</h3>
257 Checkbox constructor.
260 group -- the Group that this checkbox belongs to
261 value -- the initial value (True or False)
263 See Widget documentation for additional style parameters.
270 A type of switch that can be grouped with other radio buttons, except
271 that only one radio button can be active at a time.
274 g = gui.Group(name='colors',value='g')
278 t.td(gui.Label('Red'))
279 t.td(gui.Radio(g,'r'))
281 t.td(gui.Label('Green'))
282 t.td(gui.Radio(g,'g'))
284 t.td(gui.Label('Blue'))
285 t.td(gui.Radio(g,'b'))
289 <a name="Radio.__init__">
290 <h3>Radio.__init__</h3>
295 group -- the Group this radio button belongs to
296 value -- the initial value (True or False)
303 Within a Group of Tool widgets only one may be selected at a time.
306 g = gui.Group(name='colors',value='g')
310 t.td(gui.Tool(g,'Red','r'))
312 t.td(gui.Tool(g,'Green','g'))
314 t.td(gui.Tool(g,'Blue','b'))
318 <a name="Tool.__init__">
319 <h3>Tool.__init__</h3>
324 group -- a gui.Group for the Tool to belong to
325 widget -- a widget to appear on the Tool (similar to a Button)
333 TODO - might be deprecated
339 A link, links can be clicked, they are usually used to set up callbacks.
340 Basically the same as the button widget, just text only with a different cls.
341 Made for convenience.
344 w = gui.Link("Click Me")
345 w.connect(gui.CLICK,fnc,value)
354 <hr width=500 align=center>
355 <div align='center'>all content (c) 2006 Phil Hassey - <a href='http://www.imitationpickles.org/pgu/'>Phil's pyGame Utilities</a></div>