Difference between revisions of "Resources"

From WxWiki
Jump to navigation Jump to search
 
m
 
(42 intermediate revisions by 26 users not shown)
Line 1: Line 1:
= Resources =
 
 
 
This page aims to provide an overview what resources (documentation, communication channels, etc) are available to wxWidgets programmers. wxWidgets documentation is rather fragmented, so new users are encouraged to read this document to quickly find their way in the available channels.
 
This page aims to provide an overview what resources (documentation, communication channels, etc) are available to wxWidgets programmers. wxWidgets documentation is rather fragmented, so new users are encouraged to read this document to quickly find their way in the available channels.
  
 
== Reference material ==
 
== Reference material ==
  
The [http://wiki.wxwidgets.org/docs.cgi wxWidgets Documentation Browser] provides a nice frontend for searching though various resources.
+
* The [https://www.wxwidgets.org/search/ wxWidgets Online Search] provides a powerful engine for searching though various official wxWidgets resources.
 
+
* The [https://www.wxwidgets.org/docs/ 'Documentation'-section of wxwidgets.org] holds much valuable information. Especially the full [https://docs.wxwidgets.org/stable/ online documentation] is invaluable. The most important sections are:
* The [http://wxwidgets.org/docs.htm 'Documentation'-section of wxwidgets.org] holds much valuable information. Especially the full [http://wxwidgets.org/manuals/2.6.2/wx_contents.html online documentation] is invaluable. (There is also a [http://wiki.wxwidgets.org/docbrowse.cgi wiki version of the online documentation] which has some nice user contributed notes.) The most important sections are:
+
** The [https://docs.wxwidgets.org/stable/annotated.html class reference] is something most developers will want to have handy at all times while programming with wxWidgets.
** The [http://wxwidgets.org/manuals/2.6.2/wx_classref.html#classref Alphabetical class reference] is something most developers will want to have handy at all times while programming with wxWindows.
+
** The same goes for the [https://docs.wxwidgets.org/stable/group__group__funcmacro.html Functions and Macros] page.
** The same goes for the [http://www.wxwidgets.org/manuals/2.4.2/wx423.htm#functions Functions] and macros page.
+
** The [https://docs.wxwidgets.org/stable/page_topics.html Programming Guides] are very good articles on specific features/concepts.
** The [http://wxwidgets.org/manuals/2.6.2/wx_overviews.html#overviews Topic overviews] are very good articles on specific features/concepts.
+
* You can quickly access the documentation from your browser using [[Browser-Shortcuts For The Online Docs]]
* You can quickly access these docs from your browser using [[Browser-Shortcuts For The Online Docs]]
+
* This Wiki itself provides documentation, tips, pitfalls, warnings and plenty of links to relevant sections in the official documentation. Try a search on the left menu if you're looking for something specific.
* This wiki itself provides documentation, tips, gotcha's etc., and plenty of links to relevant sections in the official docs. See the [[Table Of Contents]] - and don't forget to try the 'search' function below.
+
* [[How To Become A WxWidgets Expert]] - Recommended reading, tips, and roadmaps to becoming an expert.
 +
* [[wxWidgets Source Code Overview]] provides a summary of the wxWidgets directory structure
 +
* In the 'docs/contributing' directory of the distribution, there is documentation for developers working on wxWidgets itself.
  
 
== Tutorials ==
 
== Tutorials ==
  
* The [http://wxwidgets.org/docs.htm 'Documentation'-section of wxwindows.org] lists some pretty decent ones, expecially [http://www.bzzt.net/~wxwidgets/icpp_wx1.html the one by David Beech], [http://www.bzzt.net/~wxwidgets/icpp_wx.pdf PDF version] thanks to Johannes Elsinghorst
+
* http://wxwidgets.info/ wxWidgets-related articles and tutorials in English and Russian, video tutorials etc.
* http://www.horstmann.com/ccc.html has a lecture slide download that contains a chapter on programming in wxWidgets. Download the slide.zip file and look in the ch18 folder.
+
* The [https://www.wxwidgets.org/docs/tutorials/ tutorials section of wxWidgets.org] lists some pretty decent ones.
* http://code.technoplaza.net/wx-sdl/ A tutorial on using wxWidgets and SDL together.
+
* http://begemotov.net/wxwidgets/ blog about programming with wxWidgets in Russian
* http://code.technoplaza.net/wxNibbles/ A tutorial on event-driven game programming using wxWidgets.
 
  
 
== Getting Help ==
 
== Getting Help ==
  
* The wxWidgets [http://www.wxwidgets.org/maillst2.htm mailinglists] are very active. Be sure to [http://lists.wxwidgets.org/cgi-bin/search.cgi search] the archives and read the [http://www.wxwidgets.org/mlhowto.htm mlhowto].
+
* The wxWidgets [https://www.wxwidgets.org/support/mailing-lists/ mailing lists] are very active. Be sure to search the archives and read the [https://www.wxwidgets.org/support/mailing-lists/guide/ mailing list posting guide].
** To subscribe to the wx-users list, send a blank email to: mailto:[email protected]
+
* The official [https://forums.wxwidgets.org/ wxWidgets Discussion Forum].
** To subscribe to the wx-users list in digest mode, email: mailto:wx-users-digest-subscribe@lists.wxwidgets.org
+
* The #wxwidgets IRC channel on [https://libera.chat/ Libera] is usually not very crowded, but the folks are generally well-tempered and helpful. Read [https://www.wxwidgets.org/support/irc/ this], then drop by and share the fun!
* The newsgroup news:comp.soft-sys.wxwindows (also [http://groups.google.com/group/comp.soft-sys.wxwindows/ via Google Groups]) should be a mirror of the wx-users mailing list - note that some messages don't seem to come though.
+
* [https://github.com/wxWidgets/wxWidgets/issues GitHub issues] - If you think you found a bug in the library and want to report it. See also [https://wxwidgets.org/develop/how-to-report-issues/ how to report an issue].
 
 
* The GMane [http://www.gmane.org/] group gmane.comp.lib.wxwindows.general is also a (two way) mirror of the wx-users mailing list.
 
* The official [http://wxforum.shadonet.com wxWidgets Discussion Forum].
 
* The '#wxwidgets' IRC channel on freenode (http://www.freenode.net/) is usually not very crowded, but the folks are generally well-tempered and helpful. Drop by, share the fun!
 
 
 
== Deeper tech docs ==
 
  
In 'docs/tech' directory of the distribution, there is documentation that is only interesting for people who make changes to wxWidgets itself.
+
== Other Resources ==
 +
* The [https://wxwidgets.org/develop/roadmap/ development roadmap] provides an overview of wxWidgets development process.
 +
* [[Graphics]] - Graphics to use in your programs.

Latest revision as of 13:54, 26 November 2022

This page aims to provide an overview what resources (documentation, communication channels, etc) are available to wxWidgets programmers. wxWidgets documentation is rather fragmented, so new users are encouraged to read this document to quickly find their way in the available channels.

Reference material

Tutorials

Getting Help

Other Resources