X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/e4545e0183a7c117d9c745a165d1f57293d873e9..b387025d5d6ba9ca0d860b9962fdbbd5d0723dab:/docs/doxygen/mainpages/samples.h?ds=sidebyside diff --git a/docs/doxygen/mainpages/samples.h b/docs/doxygen/mainpages/samples.h index 30a2eccab5..51e54fb031 100644 --- a/docs/doxygen/mainpages/samples.h +++ b/docs/doxygen/mainpages/samples.h @@ -10,7 +10,7 @@ @page page_samples Samples Overview -@brief Overview of the examples provided with wxWidgets. +@tableofcontents Probably the best way to learn wxWidgets is by reading the source of some 80+ samples provided with it. Many aspects of wxWidgets programming can be learnt @@ -20,12 +20,11 @@ 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 features of wxWidgets are they supposed to test. -There are currently more than 80 different samples as part of wxWidgets: -the list in this page is not complete! -You should start your tour of wxWidgets with the @ref page_samples_minimal -which is the wxWidgets version of "Hello, world!". -It shows the basic structure of wxWidgets program and is the most commented -sample of all - looking at its source code is recommended. +There are currently more than 80 different samples as part of wxWidgets: the +list in this page is not complete! You should start your tour of wxWidgets with +the @ref page_samples_minimal which is the wxWidgets version of "Hello, +world!". 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 sample is @ref page_samples_widgets which shows many of wxWidgets controls, such as buttons, text entry zones, list boxes, check boxes, @@ -41,108 +40,7 @@ may find the following samples showing the corresponding controls: @li wxTreeCtrl: @ref page_samples_treectrl @li wxGrid: @ref page_samples_grid @li wxDataViewCtrl: @ref page_samples_dataview - - -Finally, here is the full list of samples: - - -@beginInvisibleTable - -@li @sample{access} -@li @sample{animate} -@li @sample{artprov} -@li @sample{aui} -@li @sample{calendar} -@li @sample{caret} -@li @sample{clipboard} -@li @sample{collpane} -@li @sample{combo} -@li @sample{config} -@li @sample{console} -@li @sample{controls} -@li @sample{dataview} -@li @sample{debugrpt} -@li @sample{dialogs} -@li @sample{dialup} -@li @sample{display} -@li @sample{dnd} -@li @sample{docview} -@li @sample{dragimag} -@li @sample{drawing} -@li @sample{erase} -@li @sample{event} -@li @sample{except} -@li @sample{exec} -@li @sample{flash} -@li @sample{font} - -@li @sample{grid} -@li @sample{help} -@li @sample{htlbox} -@li @sample{html} -@li @sample{image} -@li @sample{internat} -@li @sample{ipc} -@li @sample{joytest} -@li @sample{keyboard} -@li @sample{layout} -@li @sample{listctrl} -@li @sample{mdi} -@li @sample{mediaplayer} -@li @sample{memcheck} -@li @sample{menu} -@li @sample{mfc} -@li @sample{minimal} -@li @sample{nativdlg} -@li @sample{notebook} -@li @sample{oleauto} -@li @sample{opengl} -@li @sample{ownerdrw} -@li @sample{popup} -@li @sample{power} -@li @sample{printing} -@li @sample{propgrid} - -@li @sample{regtest} -@li @sample{render} -@li @sample{richtext} -@li @sample{sashtest} -@li @sample{scroll} -@li @sample{shaped} -@li @sample{sockets} -@li @sample{sound} -@li @sample{splash} -@li @sample{splitter} -@li @sample{statbar} -@li @sample{stc} -@li @sample{svg} -@li @sample{taborder} -@li @sample{taskbar} -@li @sample{text} -@li @sample{thread} -@li @sample{toolbar} -@li @sample{treectrl} -@li @sample{typetest} -@li @sample{uiaction} -@li @sample{validate} -@li @sample{vscroll} -@li @sample{widgets} -@li @sample{wizard} -@li @sample{wrapsizer} -@li @sample{xrc} - -@endTable - - -
+@li wxWebView: @ref page_samples_webview Notice that all wxWidgets samples mentioned above can be found in @c samples subdirectory of the library distribution. When a @c foobar sample is mentioned @@ -157,10 +55,11 @@ Final advice is to do a search in the entire samples directory if you can't find the sample showing the control you are interested in by name. Most classes contained in wxWidgets occur in at least one of the samples. - @todo Write descriptions for the samples who description started with "This sample demonstrates", they are semi-auto generated. + + @section page_samples_access Accessibility Sample This sample shows how you can use the wxAccessible classes in a @@ -538,10 +437,10 @@ The not very clearly named internat sample demonstrates the wxWidgets internationalization (i18n for short from now on) features. To be more precise, it only shows localization support, i.e. support for translating the program messages into another language while true i18n would also involve -changing the other aspects of the programs behaviour. +changing the other aspects of the program's behaviour. More information about this sample can be found in the @c readme.txt file in -its directory. Please also see the @ref overview_i18n. +its directory. Please also see the @ref overview_i18n overview. @sampledir{internat} @@ -664,9 +563,9 @@ a good starting point for learning how to use wxWidgets. This samples shows wxBookCtrl family of controls. Although initially it was written to demonstrate wxNotebook only, it can now be also used to see wxListbook, -wxChoicebook and wxTreebook in action. +wxChoicebook, wxTreebook and wxToolbook in action. Test each of the controls, their orientation, images and pages using -commands through menu. +commands through the menu. @sampledir{notebook} @@ -922,8 +821,8 @@ wxClipboard and to paste text from it. The GTK version will use the so called PRIMARY SELECTION, which is the pseudo clipboard under X and best known from pasting text to the XTerm program. -Last not least: some of the text controls have tooltips and the sample also shows -how tooltips can be centrally disabled and their latency controlled. +Last but not least: some of the text controls have tooltips and the sample also +shows how tooltips can be centrally disabled and their latency controlled. @sampledir{text} @@ -1001,7 +900,7 @@ demonstrated here as well - try the corresponding menu entries. @sampleabout{wxUIActionSimulator} This sample shows some features of wxUIActionSimulator class. When a simulation -is ran using its menu items, you can see that the button is pressed +is run using its menu items, you can see that the button is pressed programmatically and the characters generated by the program appear in the text control. @@ -1019,6 +918,15 @@ control. @sampledir{vscroll} +@section page_samples_webview wxWebView Sample + +The wxWebView sample demonstarates the various capabilities of the wxWebView +control. It is set up as a simple single window web broswer, but with support +for many of the more complex wxWebView features, including browsing through +archives. + +@sampledir{webview} + @section page_samples_widgets Widgets Sample The widgets sample is the main presentation program for most simple and advanced @@ -1062,7 +970,19 @@ features supported: @section page_samples_xrc XRC Sample -@sampleabout{@ref overview_xrc} +This sample shows how to use the various features of the @ref overview_xrc to +create the gui of your program. It starts by loading and showing a frame and +other resources. From its menu or toolbar you can then run the following dialogs: + +@li A non-derived wxDialog +@li A derived dialog +@li A dialog containing a large number of controls +@li An uncentred dialog +@li A dialog demonstrating the use of object references and ID ranges +@li A dialog that contains a custom class +@li A dialog with platform-specific features +@li A dialog demonstrating wxArtProvider +@li A dialog saying "VARIABLE EXPANSION ISN'T IMPLEMENTED CURRENTLY" :/ @sampledir{xrc}