[wxWidgets.git] / wxPython / docs / README.html

<?xml version="1.0" encoding="iso-8859-1" ?>
<!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" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
<meta name="generator" content="Docutils 0.4: http://docutils.sourceforge.net/" />
<title></title>
<style type="text/css">

/*
:Author: David Goodger
:Contact: goodger@users.sourceforge.net
:Date: $Date$
:Revision: $Revision$
:Copyright: This stylesheet has been placed in the public domain.

Default cascading style sheet for the HTML output of Docutils.

See http://docutils.sf.net/docs/howto/html-stylesheets.html for how to
customize this style sheet.
*/

/* used to remove borders from tables and images */
.borderless, table.borderless td, table.borderless th {
  border: 0 }

table.borderless td, table.borderless th {
  /* Override padding for "table.docutils td" with "! important".
     The right padding separates the table cells. */
  padding: 0 0.5em 0 0 ! important }

.first {
  /* Override more specific margin styles with "! important". */
  margin-top: 0 ! important }

.last, .with-subtitle {
  margin-bottom: 0 ! important }

.hidden {
  display: none }

a.toc-backref {
  text-decoration: none ;
  color: black }

blockquote.epigraph {
  margin: 2em 5em ; }

dl.docutils dd {
  margin-bottom: 0.5em }

/* Uncomment (and remove this text!) to get bold-faced definition list terms
dl.docutils dt {
  font-weight: bold }
*/

div.abstract {
  margin: 2em 5em }

div.abstract p.topic-title {
  font-weight: bold ;
  text-align: center }

div.admonition, div.attention, div.caution, div.danger, div.error,
div.hint, div.important, div.note, div.tip, div.warning {
  margin: 2em ;
  border: medium outset ;
  padding: 1em }

div.admonition p.admonition-title, div.hint p.admonition-title,
div.important p.admonition-title, div.note p.admonition-title,
div.tip p.admonition-title {
  font-weight: bold ;
  font-family: sans-serif }

div.attention p.admonition-title, div.caution p.admonition-title,
div.danger p.admonition-title, div.error p.admonition-title,
div.warning p.admonition-title {
  color: red ;
  font-weight: bold ;
  font-family: sans-serif }

/* Uncomment (and remove this text!) to get reduced vertical space in
   compound paragraphs.
div.compound .compound-first, div.compound .compound-middle {
  margin-bottom: 0.5em }

div.compound .compound-last, div.compound .compound-middle {
  margin-top: 0.5em }
*/

div.dedication {
  margin: 2em 5em ;
  text-align: center ;
  font-style: italic }

div.dedication p.topic-title {
  font-weight: bold ;
  font-style: normal }

div.figure {
  margin-left: 2em ;
  margin-right: 2em }

div.footer, div.header {
  clear: both;
  font-size: smaller }

div.line-block {
  display: block ;
  margin-top: 1em ;
  margin-bottom: 1em }

div.line-block div.line-block {
  margin-top: 0 ;
  margin-bottom: 0 ;
  margin-left: 1.5em }

div.sidebar {
  margin-left: 1em ;
  border: medium outset ;
  padding: 1em ;
  background-color: #ffffee ;
  width: 40% ;
  float: right ;
  clear: right }

div.sidebar p.rubric {
  font-family: sans-serif ;
  font-size: medium }

div.system-messages {
  margin: 5em }

div.system-messages h1 {
  color: red }

div.system-message {
  border: medium outset ;
  padding: 1em }

div.system-message p.system-message-title {
  color: red ;
  font-weight: bold }

div.topic {
  margin: 2em }

h1.section-subtitle, h2.section-subtitle, h3.section-subtitle,
h4.section-subtitle, h5.section-subtitle, h6.section-subtitle {
  margin-top: 0.4em }

h1.title {
  text-align: center }

h2.subtitle {
  text-align: center }

hr.docutils {
  width: 75% }

img.align-left {
  clear: left }

img.align-right {
  clear: right }

ol.simple, ul.simple {
  margin-bottom: 1em }

ol.arabic {
  list-style: decimal }

ol.loweralpha {
  list-style: lower-alpha }

ol.upperalpha {
  list-style: upper-alpha }

ol.lowerroman {
  list-style: lower-roman }

ol.upperroman {
  list-style: upper-roman }

p.attribution {
  text-align: right ;
  margin-left: 50% }

p.caption {
  font-style: italic }

p.credits {
  font-style: italic ;
  font-size: smaller }

p.label {
  white-space: nowrap }

p.rubric {
  font-weight: bold ;
  font-size: larger ;
  color: maroon ;
  text-align: center }

p.sidebar-title {
  font-family: sans-serif ;
  font-weight: bold ;
  font-size: larger }

p.sidebar-subtitle {
  font-family: sans-serif ;
  font-weight: bold }

p.topic-title {
  font-weight: bold }

pre.address {
  margin-bottom: 0 ;
  margin-top: 0 ;
  font-family: serif ;
  font-size: 100% }

pre.literal-block, pre.doctest-block {
  margin-left: 2em ;
  margin-right: 2em ;
  background-color: #eeeeee }

span.classifier {
  font-family: sans-serif ;
  font-style: oblique }

span.classifier-delimiter {
  font-family: sans-serif ;
  font-weight: bold }

span.interpreted {
  font-family: sans-serif }

span.option {
  white-space: nowrap }

span.pre {
  white-space: pre }

span.problematic {
  color: red }

span.section-subtitle {
  /* font-size relative to parent (h1..h6 element) */
  font-size: 80% }

table.citation {
  border-left: solid 1px gray;
  margin-left: 1px }

table.docinfo {
  margin: 2em 4em }

table.docutils {
  margin-top: 0.5em ;
  margin-bottom: 0.5em }

table.footnote {
  border-left: solid 1px black;
  margin-left: 1px }

table.docutils td, table.docutils th,
table.docinfo td, table.docinfo th {
  padding-left: 0.5em ;
  padding-right: 0.5em ;
  vertical-align: top }

table.docutils th.field-name, table.docinfo th.docinfo-name {
  font-weight: bold ;
  text-align: left ;
  white-space: nowrap ;
  padding-left: 0 }

h1 tt.docutils, h2 tt.docutils, h3 tt.docutils,
h4 tt.docutils, h5 tt.docutils, h6 tt.docutils {
  font-size: 100% }

tt.docutils {
  background-color: #eeeeee }

ul.auto-toc {
  list-style-type: none }

</style>
</head>
<body>
<div class="document">
<div class="section">
<h1><a id="wxpython-readme" name="wxpython-readme">wxPython README</a></h1>
<p>Welcome to the wonderful world of wxPython!</p>
<p>So where do you go from here?  The best thing to do is to run the demo
and use its source code to help you learn how to use wxPython.  Most
of the classes available are demonstrated there, and you can view the
sources directly in the demo so it is designed to help you learn.  If
you are on Windows or OS X then you can run the demo just by double
clicking it's icon.  If you are on Linux/Unix then change to the
directory containing the demo and type:</p>
<blockquote>
python demo.py</blockquote>
<p>There are also some sample mini applications available for you to run
and to play with as a learning exercise.</p>
<p>The next thing you should do is join the wxPython-users maillist where
you can interact with a community of other users and developers who
are willing to help you learn, answer questions and solve problems.
To join the mail list just go to this web page and follow the
instructions there:</p>
<blockquote>
<a class="reference" href="http://wxpython.org/maillist.php">http://wxpython.org/maillist.php</a></blockquote>
<p>There is also a good set of class reference documentation available
for wxPython, but currently it is geared for the C++ user.  This may
be a little daunting at first, but with a little practice you'll
easily be able to &quot;mentally translate&quot; from the C++ shown into Python.
(See <a class="reference" href="http://wiki.wxpython.org/index.cgi/C_2b_2bGuideForwxPythoneers">http://wiki.wxpython.org/index.cgi/C_2b_2bGuideForwxPythoneers</a>
for a little help on this process.) Not all classes documented are
available in Python, but most of the GUI related classes are.</p>
</div>
<div class="section">
<h1><a id="other-info" name="other-info">Other Info</a></h1>
<p>Please also see the following files:</p>
<blockquote>
<dl class="docutils">
<dt>docs/CHANGES.txt        Information about new features, fixes,</dt>
<dd>etc. in each release.</dd>
<dt>docs/BUILD.txt          Instructions for building wxPython on</dt>
<dd>various Unix-like platforms, OS X or
Windows.</dd>
<dt>docs/MigrationGuide.txt Information about some big changes from 2.4</dt>
<dd>to 2.5 that require changes to your
applications</dd>
</dl>
<p>licence/*               Text of the wxWidgets license.</p>
</blockquote>
<p>--
Robin Dunn
<a class="reference" href="mailto:robin&#64;alldunn.com">robin&#64;alldunn.com</a></p>
</div>
</div>
</body>
</html>
Commit	Line	Data
8eda5e35 RD	1	<?xml version="1.0" encoding="iso-8859-1" ?>
	2	<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
	3	<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
	4	<head>
	5	<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
974a50f1	6	<meta name="generator" content="Docutils 0.4: http://docutils.sourceforge.net/" />
c66cd08a	7	<title></title>
974a50f1 RD	8	<style type="text/css">
	9
	10	/*
	11	:Author: David Goodger
	12	:Contact: goodger@users.sourceforge.net
	13	:Date: $Date$
	14	:Revision: $Revision$
	15	:Copyright: This stylesheet has been placed in the public domain.
	16
	17	Default cascading style sheet for the HTML output of Docutils.
	18
	19	See http://docutils.sf.net/docs/howto/html-stylesheets.html for how to
	20	customize this style sheet.
	21	*/
	22
	23	/* used to remove borders from tables and images */
	24	.borderless, table.borderless td, table.borderless th {
	25	border: 0 }
	26
	27	table.borderless td, table.borderless th {
	28	/* Override padding for "table.docutils td" with "! important".
	29	The right padding separates the table cells. */
	30	padding: 0 0.5em 0 0 ! important }
	31
	32	.first {
	33	/* Override more specific margin styles with "! important". */
	34	margin-top: 0 ! important }
	35
	36	.last, .with-subtitle {
	37	margin-bottom: 0 ! important }
	38
	39	.hidden {
	40	display: none }
	41
	42	a.toc-backref {
	43	text-decoration: none ;
	44	color: black }
	45
	46	blockquote.epigraph {
	47	margin: 2em 5em ; }
	48
	49	dl.docutils dd {
	50	margin-bottom: 0.5em }
	51
	52	/* Uncomment (and remove this text!) to get bold-faced definition list terms
	53	dl.docutils dt {
	54	font-weight: bold }
	55	*/
	56
	57	div.abstract {
	58	margin: 2em 5em }
	59
	60	div.abstract p.topic-title {
	61	font-weight: bold ;
	62	text-align: center }
	63
	64	div.admonition, div.attention, div.caution, div.danger, div.error,
	65	div.hint, div.important, div.note, div.tip, div.warning {
	66	margin: 2em ;
	67	border: medium outset ;
	68	padding: 1em }
	69
	70	div.admonition p.admonition-title, div.hint p.admonition-title,
	71	div.important p.admonition-title, div.note p.admonition-title,
72	div.tip p.admonition-title {
73	font-weight: bold ;
74	font-family: sans-serif }
75
76	div.attention p.admonition-title, div.caution p.admonition-title,
77	div.danger p.admonition-title, div.error p.admonition-title,
78	div.warning p.admonition-title {
79	color: red ;
80	font-weight: bold ;
81	font-family: sans-serif }
82
83	/* Uncomment (and remove this text!) to get reduced vertical space in
84	compound paragraphs.
85	div.compound .compound-first, div.compound .compound-middle {
86	margin-bottom: 0.5em }
87
88	div.compound .compound-last, div.compound .compound-middle {
89	margin-top: 0.5em }
90	*/
91
92	div.dedication {
93	margin: 2em 5em ;
94	text-align: center ;
95	font-style: italic }
96
97	div.dedication p.topic-title {
98	font-weight: bold ;
99	font-style: normal }
100
101	div.figure {
102	margin-left: 2em ;
103	margin-right: 2em }
104
105	div.footer, div.header {
106	clear: both;
107	font-size: smaller }
108
109	div.line-block {
110	display: block ;
111	margin-top: 1em ;
112	margin-bottom: 1em }
113
114	div.line-block div.line-block {
115	margin-top: 0 ;
116	margin-bottom: 0 ;
117	margin-left: 1.5em }
118
119	div.sidebar {
120	margin-left: 1em ;
121	border: medium outset ;
122	padding: 1em ;
123	background-color: #ffffee ;
124	width: 40% ;
125	float: right ;
126	clear: right }
127
128	div.sidebar p.rubric {
129	font-family: sans-serif ;
130	font-size: medium }
131
132	div.system-messages {
133	margin: 5em }
134
135	div.system-messages h1 {
136	color: red }
137
138	div.system-message {
139	border: medium outset ;
140	padding: 1em }
141
142	div.system-message p.system-message-title {
143	color: red ;
144	font-weight: bold }
145
146	div.topic {
147	margin: 2em }
148
149	h1.section-subtitle, h2.section-subtitle, h3.section-subtitle,
150	h4.section-subtitle, h5.section-subtitle, h6.section-subtitle {
151	margin-top: 0.4em }
152
153	h1.title {
154	text-align: center }
155
156	h2.subtitle {
157	text-align: center }
158
159	hr.docutils {
160	width: 75% }
161
162	img.align-left {
163	clear: left }
164
165	img.align-right {
166	clear: right }
167
168	ol.simple, ul.simple {
169	margin-bottom: 1em }
170
171	ol.arabic {
172	list-style: decimal }
173
174	ol.loweralpha {
175	list-style: lower-alpha }
176
177	ol.upperalpha {
178	list-style: upper-alpha }
179
180	ol.lowerroman {
181	list-style: lower-roman }
182
183	ol.upperroman {
184	list-style: upper-roman }
185
186	p.attribution {
187	text-align: right ;
188	margin-left: 50% }
189
190	p.caption {
191	font-style: italic }
192
193	p.credits {
194	font-style: italic ;
195	font-size: smaller }
196
197	p.label {
198	white-space: nowrap }
199
200	p.rubric {
201	font-weight: bold ;
202	font-size: larger ;
203	color: maroon ;
204	text-align: center }
205
206	p.sidebar-title {
207	font-family: sans-serif ;
208	font-weight: bold ;
209	font-size: larger }
210
211	p.sidebar-subtitle {
212	font-family: sans-serif ;
213	font-weight: bold }
214
215	p.topic-title {
216	font-weight: bold }
217
218	pre.address {
219	margin-bottom: 0 ;
220	margin-top: 0 ;
221	font-family: serif ;
222	font-size: 100% }
223
224	pre.literal-block, pre.doctest-block {
225	margin-left: 2em ;
226	margin-right: 2em ;
227	background-color: #eeeeee }
228
229	span.classifier {
230	font-family: sans-serif ;
231	font-style: oblique }
232
233	span.classifier-delimiter {
234	font-family: sans-serif ;
235	font-weight: bold }
236
237	span.interpreted {
238	font-family: sans-serif }
239
240	span.option {
241	white-space: nowrap }
242
243	span.pre {
244	white-space: pre }
245
246	span.problematic {
247	color: red }
248
249	span.section-subtitle {
250	/* font-size relative to parent (h1..h6 element) */
251	font-size: 80% }
252
253	table.citation {
254	border-left: solid 1px gray;
255	margin-left: 1px }
256
257	table.docinfo {
258	margin: 2em 4em }
259
260	table.docutils {
261	margin-top: 0.5em ;
262	margin-bottom: 0.5em }
263
264	table.footnote {
265	border-left: solid 1px black;
266	margin-left: 1px }
267
268	table.docutils td, table.docutils th,
269	table.docinfo td, table.docinfo th {
270	padding-left: 0.5em ;
271	padding-right: 0.5em ;
272	vertical-align: top }
273
274	table.docutils th.field-name, table.docinfo th.docinfo-name {
275	font-weight: bold ;
276	text-align: left ;
277	white-space: nowrap ;
278	padding-left: 0 }
279
280	h1 tt.docutils, h2 tt.docutils, h3 tt.docutils,
281	h4 tt.docutils, h5 tt.docutils, h6 tt.docutils {
282	font-size: 100% }
283
284	tt.docutils {
285	background-color: #eeeeee }
286
287	ul.auto-toc {
288	list-style-type: none }
289
290	</style>
8eda5e35 RD	291	</head>
	292	<body>
	293	<div class="document">
974a50f1 RD	294	<div class="section">
974a50f1 RD	295	<h1><a id="wxpython-readme" name="wxpython-readme">wxPython README</a></h1>
8eda5e35 RD	296	<p>Welcome to the wonderful world of wxPython!</p>
	297	<p>So where do you go from here? The best thing to do is to run the demo
	298	and use its source code to help you learn how to use wxPython. Most
	299	of the classes available are demonstrated there, and you can view the
	300	sources directly in the demo so it is designed to help you learn. If
	301	you are on Windows or OS X then you can run the demo just by double
	302	clicking it's icon. If you are on Linux/Unix then change to the
	303	directory containing the demo and type:</p>
	304	<blockquote>
	305	python demo.py</blockquote>
	306	<p>There are also some sample mini applications available for you to run
	307	and to play with as a learning exercise.</p>
	308	<p>The next thing you should do is join the wxPython-users maillist where
	309	you can interact with a community of other users and developers who
	310	are willing to help you learn, answer questions and solve problems.
	311	To join the mail list just go to this web page and follow the
	312	instructions there:</p>
	313	<blockquote>
	314	<a class="reference" href="http://wxpython.org/maillist.php">http://wxpython.org/maillist.php</a></blockquote>
	315	<p>There is also a good set of class reference documentation available
	316	for wxPython, but currently it is geared for the C++ user. This may
	317	be a little daunting at first, but with a little practice you'll
	318	easily be able to "mentally translate" from the C++ shown into Python.
	319	(See <a class="reference" href="http://wiki.wxpython.org/index.cgi/C_2b_2bGuideForwxPythoneers">http://wiki.wxpython.org/index.cgi/C_2b_2bGuideForwxPythoneers</a>
	320	for a little help on this process.) Not all classes documented are
	321	available in Python, but most of the GUI related classes are.</p>
	322	</div>
974a50f1 RD	323	<div class="section">
974a50f1 RD	324	<h1><a id="other-info" name="other-info">Other Info</a></h1>
8eda5e35 RD	325	<p>Please also see the following files:</p>
8eda5e35 RD	326	<blockquote>
c66cd08a	327	<dl class="docutils">
8eda5e35 RD	328	<dt>docs/CHANGES.txt Information about new features, fixes,</dt>
	329	<dd>etc. in each release.</dd>
	330	<dt>docs/BUILD.txt Instructions for building wxPython on</dt>
	331	<dd>various Unix-like platforms, OS X or
	332	Windows.</dd>
	333	<dt>docs/MigrationGuide.txt Information about some big changes from 2.4</dt>
	334	<dd>to 2.5 that require changes to your
	335	applications</dd>
	336	</dl>
fc33e5e1	337	<p>licence/* Text of the wxWidgets license.</p>
8eda5e35 RD	338	</blockquote>
	339	<p>--
	340	Robin Dunn
	341	<a class="reference" href="mailto:robin@alldunn.com">robin@alldunn.com</a></p>
	342	</div>
	343	</div>
8eda5e35 RD	344	</body>
8eda5e35 RD	345	</html>