X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/5af3e35eb34815115325d9022202b0041f08a042..e7bdf0ac8d2f095062b054e1adffd283c1d507a4:/docs/doxygen/mainpages/libs.h diff --git a/docs/doxygen/mainpages/libs.h b/docs/doxygen/mainpages/libs.h index 432bd61e18..515e9b123c 100644 --- a/docs/doxygen/mainpages/libs.h +++ b/docs/doxygen/mainpages/libs.h @@ -2,20 +2,21 @@ // Name: libs.h // Purpose: Libraries page of the Doxygen manual // Author: wxWidgets team -// RCS-ID: $Id$ -// Licence: wxWindows license +// Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// -/*! +/** @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. wxWidgets library is divided into libraries briefly described below. This -diagram show dependencies between them: +diagram shows the dependencies between them: @dot digraph Dependancies @@ -33,33 +34,67 @@ digraph Dependancies wxGL [fillcolor = green, URL = "\ref page_libs_wxgl"]; wxHTML [fillcolor = green, URL = "\ref page_libs_wxhtml"]; wxMedia [fillcolor = green, URL = "\ref page_libs_wxmedia"]; + wxPropertyGrid [fillcolor = green, URL = "\ref page_libs_wxpropgrid"]; wxQA [fillcolor = green, URL = "\ref page_libs_wxqa"]; + wxRibbon [fillcolor = green, URL = "\ref page_libs_wxribbon"]; wxRichText [fillcolor = green, URL = "\ref page_libs_wxrichtext"]; wxSTC [fillcolor = green, URL = "\ref page_libs_wxstc"]; wxXRC [fillcolor = green, URL = "\ref page_libs_wxxrc"]; + wxWebView [fillcolor = green, URL = "\ref page_libs_wxwebview"]; wxCore -> wxBase; wxNet -> wxBase; wxXML -> wxBase; wxAdvanced -> wxCore; - wxAUI -> wxAdvanced; wxAUI -> wxHTML; wxAUI -> wxXML; + wxAUI -> wxAdvanced; wxAUI -> wxHTML; wxGL -> wxCore; wxHTML -> wxCore; wxMedia -> wxCore; + wxPropertyGrid -> wxAdvanced; wxQA -> wxCore; wxQA -> wxXML; + wxRibbon -> wxCore; wxRichText -> wxAdvanced; wxRichText -> wxHTML; wxRichText -> wxXML; wxSTC -> wxCore; wxXRC -> wxAdvanced; wxXRC -> wxHTML; wxXRC -> wxXML; + wxWebView -> wxCore; } @enddot Please note that arrows indicate the "depends from" relation and that all blue -boxes depend on the @ref page_libs_wxbase library (i.e. they are non-GUI -libraries), and all green boxes depend on the @ref page_libs_wxcore library +libraries depend on the @ref page_libs_wxbase library (i.e. they are non-GUI +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 @@ -78,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 @@ -99,73 +152,56 @@ Classes for network access: Requires @ref page_libs_wxbase. -@section page_libs_wxrichtext wxRichText - -This contains generic rich text control functionality. +@section page_libs_wxpropgrid wxPropertyGrid -Requires @ref page_libs_wxadv, @ref page_libs_wxhtml, @ref page_libs_wxxml, -@ref page_libs_wxcore, @ref page_libs_wxbase. +This contains the wxPropertyGrid control. +Requires @ref page_libs_wxadv, @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_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. -@section page_libs_wxadv wxAdvanced +Requires @ref page_libs_wxxml, @ref page_libs_wxcore, @ref page_libs_wxbase. -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 +@section page_libs_wxribbon wxRibbon -Requires @ref page_libs_wxcore and @ref page_libs_wxbase. +This contains the Ribbon User Interface components library. +Requires @ref page_libs_wxcore, @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. +@section page_libs_wxrichtext wxRichText -Requires @ref page_libs_wxcore and @ref page_libs_wxbase. +This contains generic rich text control functionality. +Requires @ref page_libs_wxadv, @ref page_libs_wxhtml, @ref page_libs_wxxml, +@ref page_libs_wxcore, @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 @@ -173,16 +209,7 @@ Requires @ref page_libs_wxxml, @ref page_libs_wxcore, @ref page_libs_wxbase. This library contains wxXmlResource class that provides access to XML resource files in XRC format. -Requires @ref page_libs_wxadv, @ref page_libs_wxhtml, @ref page_libs_wxxml, +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. - */ -