add a list of the samples yet to document
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@52951 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
@@ -18,14 +18,15 @@ make it easier to find the relevant one if a simple grep through all sources
|
|||||||
didn't help. They also provide some notes about using the samples and what
|
didn't help. They also provide some notes about using the samples and what
|
||||||
features of wxWidgets are they supposed to test.
|
features of wxWidgets are they supposed to test.
|
||||||
|
|
||||||
There are currently more than 50 different samples as part of wxWidgets and
|
There are currently more than 70 different samples as part of wxWidgets:
|
||||||
this list is not complete. You should start your tour of wxWidgets with the
|
the list in this page is not complete!
|
||||||
minimal sample which is the wxWidgets version of
|
You should start your tour of wxWidgets with the @ref page_samples_minimal
|
||||||
"Hello, world!". It shows the basic structure of wxWidgets program and is the
|
which is the wxWidgets version of "Hello, world!".
|
||||||
most commented sample of all - looking at its source code is recommended.
|
It shows the basic structure of wxWidgets program and is the most commented
|
||||||
|
sample of all - looking at its source code is recommended.
|
||||||
|
|
||||||
The next most useful samples are probably widgets
|
The next most useful samples are probably @ref page_samples_widgets and
|
||||||
and controls which show many of wxWidgets native and
|
@ref page_samples_controls which show many of wxWidgets native and
|
||||||
generic controls, such as buttons, listboxes, checkboxes, comboboxes etc.
|
generic controls, such as buttons, listboxes, checkboxes, comboboxes etc.
|
||||||
|
|
||||||
Other, more complicated controls, have their own samples. In this category you
|
Other, more complicated controls, have their own samples. In this category you
|
||||||
@@ -42,9 +43,10 @@ name. Most classes contained in wxWidgets occur in at least one of the samples.
|
|||||||
|
|
||||||
@beginInvisibleTable
|
@beginInvisibleTable
|
||||||
<tr><td>
|
<tr><td>
|
||||||
@li @ref page_samples_minimal
|
@li @ref page_samples_access
|
||||||
@li @ref page_samples_animate
|
@li @ref page_samples_animate
|
||||||
@li @ref page_samples_artprovider
|
@li @ref page_samples_artprovider
|
||||||
|
@li @ref page_samples_aui
|
||||||
@li @ref page_samples_calendar
|
@li @ref page_samples_calendar
|
||||||
@li @ref page_samples_config
|
@li @ref page_samples_config
|
||||||
@li @ref page_samples_controls
|
@li @ref page_samples_controls
|
||||||
@@ -53,19 +55,21 @@ name. Most classes contained in wxWidgets occur in at least one of the samples.
|
|||||||
@li @ref page_samples_dialup
|
@li @ref page_samples_dialup
|
||||||
@li @ref page_samples_dnd
|
@li @ref page_samples_dnd
|
||||||
@li @ref page_samples_event
|
@li @ref page_samples_event
|
||||||
|
</td><td>
|
||||||
@li @ref page_samples_except
|
@li @ref page_samples_except
|
||||||
@li @ref page_samples_exec
|
@li @ref page_samples_exec
|
||||||
@li @ref page_samples_font
|
@li @ref page_samples_font
|
||||||
@li @ref page_samples_grid
|
@li @ref page_samples_grid
|
||||||
@li @ref page_samples_html
|
@li @ref page_samples_html
|
||||||
@li @ref page_samples_image
|
@li @ref page_samples_image
|
||||||
</td><td>
|
|
||||||
@li @ref page_samples_internat
|
@li @ref page_samples_internat
|
||||||
@li @ref page_samples_layout
|
@li @ref page_samples_layout
|
||||||
@li @ref page_samples_listctrl
|
@li @ref page_samples_listctrl
|
||||||
@li @ref page_samples_mediaplayer
|
@li @ref page_samples_mediaplayer
|
||||||
|
@li @ref page_samples_minimal
|
||||||
@li @ref page_samples_notebook
|
@li @ref page_samples_notebook
|
||||||
@li @ref page_samples_render
|
@li @ref page_samples_render
|
||||||
|
</td><td>
|
||||||
@li @ref page_samples_scrollsub
|
@li @ref page_samples_scrollsub
|
||||||
@li @ref page_samples_sockets
|
@li @ref page_samples_sockets
|
||||||
@li @ref page_samples_sound
|
@li @ref page_samples_sound
|
||||||
@@ -81,16 +85,69 @@ name. Most classes contained in wxWidgets occur in at least one of the samples.
|
|||||||
@endTable
|
@endTable
|
||||||
|
|
||||||
|
|
||||||
|
<!--
|
||||||
|
|
||||||
|
TODO: write descriptions for the samples:
|
||||||
|
|
||||||
|
aui
|
||||||
|
caret
|
||||||
|
collpane
|
||||||
|
combo
|
||||||
|
console
|
||||||
|
dataview
|
||||||
|
display
|
||||||
|
docview
|
||||||
|
docvwmdi
|
||||||
|
dragimag
|
||||||
|
drawing
|
||||||
|
editlbox
|
||||||
|
erase
|
||||||
|
event
|
||||||
|
except
|
||||||
|
help
|
||||||
|
htlbox
|
||||||
|
ipc
|
||||||
|
joytest
|
||||||
|
keyboard
|
||||||
|
mdi
|
||||||
|
memcheck
|
||||||
|
menu
|
||||||
|
mfc
|
||||||
|
mobile
|
||||||
|
nativdlg
|
||||||
|
oleauto
|
||||||
|
opengl
|
||||||
|
ownerdrw
|
||||||
|
popup
|
||||||
|
power
|
||||||
|
printing
|
||||||
|
regtest
|
||||||
|
richtext
|
||||||
|
sashtest
|
||||||
|
scroll
|
||||||
|
shaped
|
||||||
|
splash
|
||||||
|
splitter
|
||||||
|
stc
|
||||||
|
svg
|
||||||
|
taskbar
|
||||||
|
typetest
|
||||||
|
validate
|
||||||
|
vscroll
|
||||||
|
xrc
|
||||||
|
|
||||||
|
-->
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<hr>
|
<hr>
|
||||||
|
|
||||||
|
|
||||||
|
@section page_samples_access Accessibility sample
|
||||||
|
|
||||||
@section page_samples_minimal Minimal sample
|
The @c access sample shows how you can use the wxAccessible classes in a
|
||||||
|
simple GUI program.
|
||||||
The minimal sample is what most people will know under the term Hello World,
|
|
||||||
i.e. a minimal program that doesn't demonstrate anything apart from what is
|
|
||||||
needed to write a program that will display a "hello" dialog. This is usually
|
|
||||||
a good starting point for learning how to use wxWidgets.
|
|
||||||
|
|
||||||
|
|
||||||
@section page_samples_animate Animate sample
|
@section page_samples_animate Animate sample
|
||||||
@@ -378,6 +435,14 @@ and other files.
|
|||||||
It replaces the old dynamic sample.
|
It replaces the old dynamic sample.
|
||||||
|
|
||||||
|
|
||||||
|
@section page_samples_minimal Minimal sample
|
||||||
|
|
||||||
|
The minimal sample is what most people will know under the term Hello World,
|
||||||
|
i.e. a minimal program that doesn't demonstrate anything apart from what is
|
||||||
|
needed to write a program that will display a "hello" dialog. This is usually
|
||||||
|
a good starting point for learning how to use wxWidgets.
|
||||||
|
|
||||||
|
|
||||||
@section page_samples_notebook Notebook sample
|
@section page_samples_notebook Notebook sample
|
||||||
|
|
||||||
This samples shows wxBookCtrl family of controls.
|
This samples shows wxBookCtrl family of controls.
|
||||||
|
Reference in New Issue
Block a user