]> git.saurik.com Git - wxWidgets.git/blame - docs/html/index.htm
projects / wxWidgets.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
added missing #if wxUSE_STDPATHS
[wxWidgets.git] / docs / html / index.htm
CommitLineData
ddcc5f5b
JS		 1<HTML>
2
3<HEAD>
fc2171bd 4<TITLE>wxWidgets Documentation</TITLE>
ddcc5f5b
JS		 5
6</HEAD>
7
b59da6c2 8<BODY BGCOLOR=#FFFFFF TEXT=#000000 VLINK="#63659C" LINK="#313063" ALINK="#313063">
ddcc5f5b
JS		 9
10<font face="Arial, Lucida Sans, Helvetica">
11
12<a name="top"></a>
13
e492150d 14<IMG src="logo.gif" align=right hspace=10 vspace=0>
ddcc5f5b 15
5147354c 16<b>Welcome to wxWidgets, the premi&egrave;re cross-platform GUI C++ framework.</b><P>
7be6137a
JS		 17
18This is an index of
b69f1bd1 19the plain text, HTML, Windows Help and Acrobat documentation: availability depends on what you've
5147354c 20downloaded from the <a href="http://www.wxwidgets.org">wxWidgets Web site</a>.<br clear=all><P>
ddcc5f5b 21
7921cf2b
JS		 22<CENTER>
23<FONT size=-1>
24[<a href="#install">Install</a>]
25[<a href="#manuals">Manuals</a>]
66f55ec6 26[<a href="#technotes">Technical Notes</a>]
7921cf2b 27[<a href="#samples">Samples</a>]
1cf4526d 28[<a href="#demos">Demos</a>]
7921cf2b
JS		 29</FONT>
30</CENTER>
31
e492150d
JS		 32<P>
33
34<table width=100% border=0 cellpadding=3 cellspacing=0>
35<tr>
36<td bgcolor="#004080" align=left height=24 background="images/bluetitlegradient.gif">
37<font size=+1 face="Arial, Lucida Sans, Helvetica" color="#FFFFFF">
38<b><a name="install">Installation and release notes</a></b>
39</font>
40</td>
41</tr>
42</table>
43
44<P>
ddcc5f5b 45
fc2171bd
JS		 46Unless you installed a binary version of wxWidgets using RPMs,
47you will probably have to compile the wxWidgets library first.
7be6137a
JS		 48Please read the platform-specific readme.txt and install.txt
49for how to do this.
50
51<P>
52
ddcc5f5b 53<ul>
2dc5505e 54<li>ReadMe: <a href="../readme.txt"><b>General ReadMe</b></a>,
e492150d 55<a href="../msw/readme.txt">wxMSW</a>,
5147354c 56<a href="../gtk/readme.txt">wxGTK</a>,
e492150d 57<a href="../mac/readme.txt">wxMac</a>,
5147354c 58<a href="../cocoa/readme.txt">wxCocoa</a>,
e492150d 59<a href="../mgl/readme.txt">wxMGL</a>,
5147354c
JS		 60<a href="../motif/readme.txt">wxMotif</a>,
61<a href="../x11/readme.txt">wxX11</a>,
e492150d 62<a href="../univ/readme.txt">Univ</a>
5147354c
JS		 63<li>Installation:
64<a href="../msw/install.txt">wxMSW</a>,
65<a href="../gtk/install.txt">wxGTK</a>,
ddcc5f5b 66<a href="../motif/install.txt">wxMotif</a>,
69477ac4 67<a href="../x11/install.txt">wxX11</a>,
e492150d 68<a href="../mac/install.txt">wxMac</a>,
5147354c 69<a href="../cocoa/install.txt">wxCocoa</a>,
e492150d
JS		 70<a href="../mgl/install.txt">wxMGL</a>,
71<a href="../os2/install.txt">wxOS2</a>
5147354c 72<li><a href="../changes.txt"><b>General change log</b></a>
2dc5505e
JS		 73<li>Licence: <a href="../preamble.txt">Preamble</a>,
74<a href="../licence.txt">Licence</a>,
75<a href="../licendoc.txt">Documentation Licence</a>,
76<a href="../lgpl.txt">L-GPL</a>,
77<a href="../gpl.txt">GPL</a>
ce3ed50d
JS		 78<li><a href="faq.htm"><B>FAQ</B></a>:
79 <ul>
80 <li><a href="faqgen.htm">General questions</a>
5147354c
JS		 81 <li><a href="faqcmn.htm">Questions common to all platforms</a>
82 <li><a href="faqmsw.htm">wxWidgets for Windows</a>
83 <li><a href="faqgtk.htm">wxWidgets for GTK+</a>
84 <li><a href="faqmot.htm">wxWidgets for Motif</a>
85 <li><a href="faqx11.htm">wxWidgets for X11</a>
5147354c 86 <li><a href="faqmac.htm">wxWidgets for Mac</a>
ce3ed50d 87 </ul>
2dc5505e
JS		 88<li>ToDo: <a href="../todo.txt"><b>General ToDo</b></a>,
89<a href="../gtk/todo.txt">wxGTK</a>,
ddcc5f5b 90<a href="../motif/todo.txt">wxMotif</a>,
7be6137a 91<a href="../mac/todo.txt">wxMac</a>
ddcc5f5b
JS		 92</ul>
93
e492150d
JS		 94Further platform-specific notes:
95
96<ul>
97<li> wxMSW: <a href="../msw/winxp.txt">Windows XP</a>
98</ul>
99
100<P>
101
102<table width=100% border=0 cellpadding=3 cellspacing=0>
103<tr>
104<td bgcolor="#004080" align=left height=24 background="images/bluetitlegradient.gif">
105<font size=+1 face="Arial, Lucida Sans, Helvetica" color="#FFFFFF">
fc2171bd 106<b><a name="manuals">wxWidgets manuals</a></b>
e492150d
JS		 107</font>
108</td>
109</tr>
110</table>
111
112<P>
113
114To use manuals in wxHTML Help form (extension htb), you can use the <b>HelpView</b>
115application, either compiling it from utils/helpview in the distribution,
116or downloading a binary, for example from <a href="http://www.storylinescentral.com/helpview.htm">here</a>.<P>
117
e492150d 118<table border=0 cellpadding=5 cellspacing=0>
7921cf2b 119
b69f1bd1 120<tr>
e492150d 121<td align=center bgcolor="#E0E0E0">
b69f1bd1
JS		 122<B>HTML</B>
123</td>
e492150d 124<td align=center bgcolor="#E0E0E0">
b69f1bd1
JS		 125<B>WinHelp</B>
126</td>
e492150d 127<td align=center bgcolor="#E0E0E0">
f6bcfd97
BP		 128<B>MS HTML Help</B>
129</td>
e492150d
JS		 130<td align=center bgcolor="#E0E0E0">
131<B>wxHTML Help</B>
132</td>
133<td align=center bgcolor="#E0E0E0">
b69f1bd1
JS		 134<B>PDF</B>
135</td>
136</tr>
ddcc5f5b 137
b69f1bd1
JS		 138<tr>
139<td align=center>
85d525b1 140<a href="wx/wx_contents.html">wxWidgets Reference</a>
e492150d
JS		 141</td>
142
143<td align=center>
fc2171bd 144<a href="../winhelp/wx.hlp">wxWidgets Reference</a>
e492150d
JS		 145</td>
146
147<td align=center>
fc2171bd 148<a href="../htmlhelp/wx.chm">wxWidgets Reference</a>
e492150d
JS		 149</td>
150
151<td align=center>
fc2171bd 152<a href="../htb/wx.htb">wxWidgets Reference</a>
e492150d
JS		 153</td>
154
155<td align=center>
fc2171bd 156<a href="../pdf/wx.pdf">wxWidgets Reference</a>
e492150d
JS		 157</td>
158</tr>
159
b69f1bd1
JS		 160<tr>
161<td align=center>
e492150d 162<a href="tex2rtf/t2rtf.htm">Tex2RTF</a>
b69f1bd1
JS		 163</td>
164
165<td align=center>
e492150d 166<a href="../winhelp/tex2rtf.hlp">Tex2RTF</a>
b69f1bd1
JS		 167</td>
168
f6bcfd97 169<td align=center>
e492150d 170<a href="../htmlhelp/tex2rtf.chm">Tex2RTF</a>
f6bcfd97
BP		 171</td>
172
b69f1bd1 173<td align=center>
e492150d
JS		 174<a href="../htb/tex2rtf.htb">Tex2RTF</a>
175</td>
176
177<td align=center>
178<a href="../pdf/tex2rtf.pdf">Tex2RTF</a>
b69f1bd1
JS		 179</td>
180</tr>
181
b69f1bd1
JS		 182</table>
183
e492150d
JS		 184<P>
185
186<table width=100% border=0 cellpadding=3 cellspacing=0>
187<tr>
188<td bgcolor="#004080" align=left height=24 background="images/bluetitlegradient.gif">
189<font size=+1 face="Arial, Lucida Sans, Helvetica" color="#FFFFFF">
190<b><a name="technotes">Technical notes</a></b>
191</font>
192</td>
193</tr>
194</table>
195
196<P>
66f55ec6
JS		 197
198<ul>
9ba09ba5 199<li><a href="../tech/index.txt">Index of technical notes</a>
e492150d
JS		 200<li><a href="../tech/">Technical notes</a>
201<li><a href="platform.htm">Platforms supported</a>
fc2171bd 202<li><a href="i18n.htm">Languages supported by wxWidgets</a>
66f55ec6 203</ul>
b69f1bd1 204
e492150d
JS		 205<P>
206
e492150d
JS		 207<table width=100% border=0 cellpadding=3 cellspacing=0>
208<tr>
209<td bgcolor="#004080" align=left height=24 background="images/bluetitlegradient.gif">
210<font size=+1 face="Arial, Lucida Sans, Helvetica" color="#FFFFFF">
211<b><a name="samples">Samples</a></b>
212</font>
213</td>
214</tr>
215</table>
216
217<P>
7921cf2b 218
fc2171bd 219Each of the following samples demonstrates one or more aspect of wxWidgets.<P>
457e6c54 220
7921cf2b 221<ul>
5147354c 222<li><a href="../../samples/access">access</a>: Active Accessiblity sample (Windows only).
121640d5 223<li><a href="../../samples/animate">animate</a>: shows the wxAnimationCtrl class.
2a3476f2 224<li><a href="../../samples/artprov">artprov</a>: shows how you can customize the look of standard
fc2171bd 225wxWidgets dialogs by replacing default bitmaps/icons with your own versions.
b45ab290 226<li><a href="../../samples/aui">aui</a>: wxAui (docking subsystem) sample.
1cf4526d 227<li><a href="../../samples/calendar">calendar</a>: a sample to test the wxCalendarCtrl class.
edc26c4c 228<li><a href="../../samples/caret">caret</a>: a sample to test the wxCaret class.
7921cf2b
JS		 229<li><a href="../../samples/checklst">checklst</a>: demonstrates wxCheckListBox on
230supported platforms (currently Windows and GTK only).
121640d5 231<li><a href="../../samples/collpane">collpane</a>: shows the wxCollapsiblePane class.
7921cf2b 232<li><a href="../../samples/config">config</a>: demonstrates use of wxConfig, which
3a5bcc4d 233defaults to wxRegConfig on WIN32 (optionally wxIniConfig), and wxFileConfig on other platforms.
1a7f3062 234<li><a href="../../samples/console">console</a>: demonstrates a console application using
fc2171bd 235console-mode (no-GUI) compilation of wxWidgets.
7921cf2b
JS		 236<li><a href="../../samples/controls">controls</a>: sample showing a variety of controls, including
237wxNotebook.
5147354c
JS		 238<li><a href="../../samples/db">db</a>: wxODBC sample.
239<li><a href="../../samples/debugrpt">debugrpt</a>: wxDebugReport sample.
7921cf2b
JS		 240<li><a href="../../samples/dialogs">dialogs</a>: shows some of the common dialogs available -- wxFontDialog,
241wxColourDialog, wxFileDialog, wxDirDialog, wxMessageBox, wxTextEntryDialog, wxSingleChoiceDialog.
242For printing-related dialogs, see the printing sample.
7b28757f 243<li><a href="../../samples/dialup">dialup</a>: wxDialUpManager demo.
5147354c 244<li><a href="../../samples/display">display</a>: wxDisplay demo.
7921cf2b
JS		 245<li><a href="../../samples/dnd">dnd</a>: demonstrates drag and drop on supported platforms.
246<li><a href="../../samples/docview">docview</a>: demonstrates use of the document view classes,
247using wxFrame.
7b28757f 248<li><a href="../../samples/docvwmdi">docvwmdi</a>: demonstrates use of the document view classes,
7921cf2b 249using wxMDIParentFrame, wxMDIChildFrame.
2a3476f2 250<li><a href="../../samples/dragimag">dragimag</a>: wxDragImage demo.
25f47127 251<li><a href="../../samples/drawing">drawing</a>: tests device context drawing.
7921cf2b
JS		 252<li><a href="../../samples/dynamic">dynamic</a>: shows how to connect events to member functions
253dynamically.
121640d5 254<li><a href="../../samples/editlbox">erase</a>: shows the wxEditableListBox class.
5147354c 255<li><a href="../../samples/erase">erase</a>: Window erasing sample.
d35b028e 256<li><a href="../../samples/event">event</a>: demonstrates event handling.
5147354c 257<li><a href="../../samples/except">exept</a>: demonstrates exception handling.
76a4f50d 258<li><a href="../../samples/exec">exec</a>: demonstrates wxExecute.
ad556aa9 259<li><a href="../../samples/font">font</a>: tests fonts, font enumerator, font encodings.
4a9dba0e 260<li><a href="../../samples/grid">grid</a>: demonstrates the wxGrid class.
7921cf2b 261<li><a href="../../samples/help">help</a>: shows how to use wxHelpController.
edc26c4c
JS		 262<li><a href="../../samples/html">html</a>: a number of demos for the wxHTML class library, used inside
263applications and also as a help facility.
9ffdee80
JS		 264 <ul>
265 <li><a href="../../samples/html/about">about</a>: shows use of a wxHTML widget inside an About box.
266 <li><a href="../../samples/html/help">help</a>: shows use of wxHtmlHelpController to display wxHTML help.
0d3a69ec 267 <li><a href="../../samples/html/helpview">helpview</a>: a stand-alone wxHTML help viewer for any .htb book.
9ffdee80
JS		 268 <li><a href="../../samples/html/printing">printing</a>: shows how easy it is to preview and print HTML files.
269 <li><a href="../../samples/html/test">test</a>: general wxHTML test application.
270 <li><a href="../../samples/html/virtual">virtual</a>: demonstrates the virtual file system feature.
271 <li><a href="../../samples/html/widget">widget</a>: demonstrates the use of controls in HTML pages.
272 <li><a href="../../samples/html/zip">zip</a>: shows how help files can be packaged in zip archives.
273 </ul>
5147354c 274<li><a href="../../samples/htlbox">htlbox</a>: demonstrates wxHtmlListBox.
7921cf2b 275<li><a href="../../samples/image">image</a>: shows off the cross-platform wxImage class.
2a3476f2
JS		 276<li><a href="../../samples/ipc">ipc</a>: shows the DDE-like protocol in action, both using real
277DDE on Windows, and TCP/IP on all platforms. Edit <a href="../../samples/ipc/ddesetup.h">ddesetup.h</a>
278to switch between compilation modes.
fc2171bd 279<li><a href="../../samples/internat">internat</a>: use of wxWidgets' internationalization support.
7921cf2b 280<li><a href="../../samples/joytest">joytest</a>: tests the wxJoystick class (currently Windows and GTK only).
e492150d 281<li><a href="../../samples/keyboard">keyboard</a>: tests keyboard support.
7921cf2b
JS		 282<li><a href="../../samples/layout">layout</a>: shows the constraint layout system in action.
283<li><a href="../../samples/listctrl">listctrl</a>: demonstrates the wxListCtrl (implemented natively on
284WIN32, and using a generic version on other platforms).
ad556aa9 285<li><a href="../../samples/menu">menu</a>: tests menus.
5147354c 286<li><a href="../../samples/mediaplayer">mediaplayer</a>: demonstrates wxMediaCtrl, for playing movies and audio files in a window.
7921cf2b
JS		 287<li><a href="../../samples/mdi">mdi</a>: shows off the MDI (Multiple Document Interface) classes. On Windows, the regular MDI
288scheme is used whereby child windows have full sizing and moving rights within the main
289window. On other platforms, tabbed windows are used, where the children are always maximized.
290<li><a href="../../samples/memcheck">memcheck</a>: demonstrates the memory checking/debugging facilities.
fc2171bd
JS		 291<li><a href="../../samples/mfc">mfc</a>: shows how to use MFC and wxWidgets code in the same application (Windows only).
292To compile this, you must edit include/wx/wxprec.h, comment out the windows.h inclusion, and recompile wxWidgets.
7921cf2b
JS		 293<li><a href="../../samples/minifram">minifram</a>: demonstrates a frame with a small title bar. On
294platforms that don't support it, a normal-sized title bar is displayed.
295<li><a href="../../samples/minimal">minimal</a>: just shows a frame, a menubar, and a statusbar. About as
fc2171bd 296small a wxWidgets application as you can get.
e492150d 297<li><a href="../../samples/mobile">mobile</a>: mini applications for embedded platforms.
5147354c 298<li><a href="../../samples/multimon">multimon</a>: demo showing how to use multiple monitors.
fc2171bd
JS		 299<li><a href="../../samples/nativdlg">nativdlg</a>: shows how wxWidgets can load a standard Windows
300dialog resource, translating the controls into wxWidgets controls (Windows only).
7921cf2b
JS		 301<li><a href="../../samples/notebook">notebook</a>: shows the wxNotebook (tabbed window) control.
302<li><a href="../../samples/oleauto">oleauto</a>: a little OLE automation controller (Windows only; requires
303Excel to be present).
304<li><a href="../../samples/ownerdrw">ownerdrw</a>: demonstrates owner-draw menus and controls (Windows only).
305<li><a href="../../samples/png">png</a>: demonstrates PNG loading.
306<li><a href="../../samples/printing">printing</a>: shows printing and previewing.
c3b177ae 307<li><a href="../../samples/propsize">propsize</a>: demonstrates proportional sizer classes.
7921cf2b 308<li><a href="../../samples/regtest">regtest</a>: tests the low-level Windows registry functions (Windows only).
5147354c
JS		 309<li><a href="../../samples/render">render</a>: shows how to use wxRenderer to implement controls consistent with the
310platform's native look.
c1bf3a3e 311<li><a href="../../samples/richtext">richtext</a>: demonstrates wxRichTextCtrl.
457e6c54
JS		 312<li><a href="../../samples/rotate">rotate</a>: demonstrates interpolated and non-interpolated
313rotation of a wxImage.
7921cf2b
JS		 314<li><a href="../../samples/sashtest">sashtest</a>: demonstrates use of the wxSashWindow class to allow
315the user to resize subwindows.
ad556aa9
JS		 316<li><a href="../../samples/scroll">scroll</a>: demonstrates wxScrolledWindow.
317<li><a href="../../samples/scrollsub">scrollsub</a>: demonstrates the use of wxScrolledWindow to scroll
318an embedded window.
5147354c 319<li><a href="../../samples/shaped">shaped</a>: demonstrates non-rectangular windows using wxFrame::SetShape.
1cf4526d 320<li><a href="../../samples/sockets">sockets</a>: demonstrates the TCP/IP family of classes.
5147354c 321<li><a href="../../samples/sound">sound</a>: demonstrates use of wxSound.
daa9deb2 322<li><a href="../../samples/splash">splash</a>: demonstrates use of the wxSplashScreen class.
7921cf2b 323<li><a href="../../samples/splitter">splitter</a>: demonstrates the wxSplitterWindow class.
0d3a69ec 324<li><a href="../../samples/statbar">statbar</a>: demonstrates the wxStatusBar class.
7921cf2b
JS		 325<li><a href="../../samples/taskbar">taskbar</a>: demonstrates the wxTaskBarIcon class, for
326adding icons to the system tray. Windows only, but may eventually be implemented for other desktop
327environments that use this metaphor.
edc26c4c
JS		 328<li><a href="../../samples/text">text</a>: demonstrates single and multiline text controls,
329and clipboard operations.
7921cf2b
JS		 330<li><a href="../../samples/thread">thread</a>: tests the family of classes for doing thread
331programming.
332<li><a href="../../samples/toolbar">toolbar</a>: demonstrates wxToolBar.
333<li><a href="../../samples/treectrl">treectrl</a>: demonstrates wxTreeCtrl.
334<li><a href="../../samples/typetest">typetest</a>: tests various data type classes, including
335wxTime, wxDate and wxVariant.
336<li><a href="../../samples/validate">validate</a>: shows simple use of validation.
5147354c 337<li><a href="../../samples/vscroll">vscroll</a>: shows use of wxVScrolledWindow.
121640d5 338<li><a href="../../samples/widgets">widgets</a>: shows a lot of control classes.
2723cfeb 339<li><a href="../../samples/wizard">wizard</a>: demonstrates the wxWizard class.
2a3476f2 340<li><a href="../../samples/xrc">xrc</a>: demonstrates the XRC resource system.
1cf4526d
JS		 341</ul>
342
7c9955d1 343
e492150d
JS		 344<P>
345
346<table width=100% border=0 cellpadding=3 cellspacing=0>
347<tr>
348<td bgcolor="#004080" align=left height=24 background="images/bluetitlegradient.gif">
349<font size=+1 face="Arial, Lucida Sans, Helvetica" color="#FFFFFF">
350<b><a name="demos">Demos</a></b>
351</font>
352</td>
353</tr>
354</table>
355
356<P>
1cf4526d 357
457e6c54
JS		 358The following are fully-fledged applications.<P>
359
1cf4526d
JS		 360<ul>
361<li><a href="../../demos/bombs">bombs</a>: minesweeper-like game.
457e6c54
JS		 362<li><a href="../../demos/dbbrowse">dbbrowse</a>: ODBC database browser application.
363<li><a href="../../demos/forty">forty</a>: a great little card game by Chris Breeze.
1cf4526d 364<li><a href="../../demos/fractal">fractal</a>: fractal mountains by Andrew Davison.
fc2171bd 365<li><a href="../../demos/life">life</a>: the game of Life by J. H. Conway, implemented in wxWidgets by Guillermo Rodriguez Garcia.
1cf4526d 366<li><a href="../../demos/poem">poem</a>: a little poetry display program.
7921cf2b
JS		 367</ul>
368
ddcc5f5b
JS		 369</font>
370
371</BODY>
372
373</HTML>
374
wxWidgets (Impactor)