X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/b2b31b87fbac61af6eb96f3f5fa960ee4479bb1d..e7bdf0ac8d2f095062b054e1adffd283c1d507a4:/docs/doxygen/mainpages/libs.h?ds=sidebyside diff --git a/docs/doxygen/mainpages/libs.h b/docs/doxygen/mainpages/libs.h index 897debd501..515e9b123c 100644 --- a/docs/doxygen/mainpages/libs.h +++ b/docs/doxygen/mainpages/libs.h @@ -2,7 +2,6 @@ // Name: libs.h // Purpose: Libraries page of the Doxygen manual // Author: wxWidgets team -// RCS-ID: $Id$ // Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// @@ -10,6 +9,8 @@ @page page_libs Library List +@tableofcontents + wxWidgets can be built either as a single large library (this is called a monolithic build) or as several smaller libraries (multilib build). Multilib build is the default. @@ -46,7 +47,7 @@ digraph Dependancies wxXML -> wxBase; wxAdvanced -> wxCore; - wxAUI -> wxAdvanced; wxAUI -> wxHTML; wxAUI -> wxXML; + wxAUI -> wxAdvanced; wxAUI -> wxHTML; wxGL -> wxCore; wxHTML -> wxCore; wxMedia -> wxCore; @@ -66,6 +67,34 @@ libraries), and all green libraries depend on the @ref page_libs_wxcore library (i.e. they are GUI libraries). + +@section page_libs_wxadv wxAdvanced + +Advanced or rarely used GUI classes: + +@li wxCalendarCtrl +@li wxGrid classes +@li wxJoystick +@li wxLayoutAlgorithm +@li wxSplashScreen +@li wxTaskBarIcon +@li wxSound +@li wxWizard +@li wxSashLayoutWindow +@li wxSashWindow +@li ...others + +Requires @ref page_libs_wxcore and @ref page_libs_wxbase. + + +@section page_libs_wxaui wxAui + +This contains the Advanced User Interface docking library. + +Requires @ref page_libs_wxadv, @ref page_libs_wxhtml, @ref page_libs_wxxml, +@ref page_libs_wxcore, @ref page_libs_wxbase. + + @section page_libs_wxbase wxBase Every wxWidgets application must link against this library. It contains @@ -84,12 +113,30 @@ applications don't. Requires @ref page_libs_wxbase. -@section page_libs_wxaui wxAui +@section page_libs_wxgl wxGL -This contains the Advanced User Interface docking library. +This library contains wxGLCanvas class for integrating OpenGL library with +wxWidgets. Unlike all others, this library is @b not part of the monolithic +library, it is always built as separate library. -Requires @ref page_libs_wxadv, @ref page_libs_wxhtml, @ref page_libs_wxxml, -@ref page_libs_wxcore, @ref page_libs_wxbase. +Requires @ref page_libs_wxcore and @ref page_libs_wxbase. + + +@section page_libs_wxhtml wxHTML + +Simple HTML renderer and other @ref overview_html are contained in this +library, as well as wxHtmlHelpController, wxBestHelpController and +wxHtmlListBox. + +Requires @ref page_libs_wxcore and @ref page_libs_wxbase. + + +@section page_libs_wxmedia wxMedia + +Miscellaneous classes related to multimedia. Currently this library only +contains wxMediaCtrl but more classes will be added in the future. + +Requires @ref page_libs_wxcore and @ref page_libs_wxbase. @section page_libs_wxnet wxNet @@ -112,6 +159,15 @@ This contains the wxPropertyGrid control. Requires @ref page_libs_wxadv, @ref page_libs_wxcore, @ref page_libs_wxbase. +@section page_libs_wxqa wxQA + +This is the library containing extra classes for quality assurance. Currently +it only contains wxDebugReport and related classes, but more will be added to +it in the future. + +Requires @ref page_libs_wxxml, @ref page_libs_wxcore, @ref page_libs_wxbase. + + @section page_libs_wxribbon wxRibbon This contains the Ribbon User Interface components library. @@ -127,65 +183,25 @@ Requires @ref page_libs_wxadv, @ref page_libs_wxhtml, @ref page_libs_wxxml, @ref page_libs_wxcore, @ref page_libs_wxbase. -@section page_libs_wxxml wxXML - -This library contains simple classes for parsing XML documents. - -Requires @ref page_libs_wxbase. - - -@section page_libs_wxadv wxAdvanced - -Advanced or rarely used GUI classes: - -@li wxCalendarCtrl -@li wxGrid classes -@li wxJoystick -@li wxLayoutAlgorithm -@li wxSplashScreen -@li wxTaskBarIcon -@li wxSound -@li wxWizard -@li wxSashLayoutWindow -@li wxSashWindow -@li ...others - -Requires @ref page_libs_wxcore and @ref page_libs_wxbase. - - -@section page_libs_wxmedia wxMedia - -Miscellaneous classes related to multimedia. Currently this library only -contains wxMediaCtrl but more classes will be added in the future. - -Requires @ref page_libs_wxcore and @ref page_libs_wxbase. - - -@section page_libs_wxgl wxGL - -This library contains wxGLCanvas class for integrating OpenGL library with -wxWidgets. Unlike all others, this library is @b not part of the monolithic -library, it is always built as separate library. +@section page_libs_wxstc wxSTC -Requires @ref page_libs_wxcore and @ref page_libs_wxbase. +STC (Styled Text Control) is a wrapper around Scintilla, a syntax-highlighting +text editor. See for more info about Scintilla. +Requires @ref page_libs_wxcore, @ref page_libs_wxbase. -@section page_libs_wxhtml wxHTML +@section page_libs_wxwebview wxWebView -Simple HTML renderer and other @ref overview_html are contained in this -library, as well as wxHtmlHelpController, wxBestHelpController and -wxHtmlListBox. +The wxWebView library contains the wxWebView control and its associated classes. -Requires @ref page_libs_wxcore and @ref page_libs_wxbase. +Requires @ref page_libs_wxcore, @ref page_libs_wxbase. -@section page_libs_wxqa wxQA +@section page_libs_wxxml wxXML -This is the library containing extra classes for quality assurance. Currently -it only contains wxDebugReport and related classes, but more will be added to -it in the future. +This library contains simple classes for parsing XML documents. -Requires @ref page_libs_wxxml, @ref page_libs_wxcore, @ref page_libs_wxbase. +Requires @ref page_libs_wxbase. @section page_libs_wxxrc wxXRC @@ -196,19 +212,4 @@ files in XRC format. Requires @ref page_libs_wxadv, @ref page_libs_wxhtml, @ref page_libs_wxxml, @ref page_libs_wxcore, @ref page_libs_wxbase. - -@section page_libs_wxstc wxSTC - -STC (Styled Text Control) is a wrapper around Scintilla, a syntax-highlighting -text editor. See for more info about Scintilla. - -Requires @ref page_libs_wxcore, @ref page_libs_wxbase. - -@section page_libs_wxwebview wxWebView - -The wxWebView library contains the wxWebView control and its associated classes. - -Requires @ref page_libs_wxcore, @ref page_libs_wxbase. - */ -