libs.h 6.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215
  1. /////////////////////////////////////////////////////////////////////////////
  2. // Name: libs.h
  3. // Purpose: Libraries page of the Doxygen manual
  4. // Author: wxWidgets team
  5. // Licence: wxWindows licence
  6. /////////////////////////////////////////////////////////////////////////////
  7. /**
  8. @page page_libs Library List
  9. @tableofcontents
  10. wxWidgets can be built either as a single large library (this is called a
  11. <em>monolithic build</em>) or as several smaller libraries
  12. (<em>multilib build</em>). Multilib build is the default.
  13. wxWidgets library is divided into libraries briefly described below. This
  14. diagram shows the dependencies between them:
  15. @dot
  16. digraph Dependencies
  17. {
  18. node [shape = ellipse, fontname = "Courier", fontsize = 10, style = filled];
  19. wxBase [URL = "\ref page_libs_wxbase"];
  20. wxCore [fillcolor = deepskyblue, URL = "\ref page_libs_wxcore"];
  21. wxNet [fillcolor = deepskyblue, URL = "\ref page_libs_wxnet"];
  22. wxXML [fillcolor = deepskyblue, URL = "\ref page_libs_wxxml"];
  23. wxAdvanced [fillcolor = green, URL = "\ref page_libs_wxadv"];
  24. wxAUI [fillcolor = green, URL = "\ref page_libs_wxaui"];
  25. wxGL [fillcolor = green, URL = "\ref page_libs_wxgl"];
  26. wxHTML [fillcolor = green, URL = "\ref page_libs_wxhtml"];
  27. wxMedia [fillcolor = green, URL = "\ref page_libs_wxmedia"];
  28. wxPropertyGrid [fillcolor = green, URL = "\ref page_libs_wxpropgrid"];
  29. wxQA [fillcolor = green, URL = "\ref page_libs_wxqa"];
  30. wxRibbon [fillcolor = green, URL = "\ref page_libs_wxribbon"];
  31. wxRichText [fillcolor = green, URL = "\ref page_libs_wxrichtext"];
  32. wxSTC [fillcolor = green, URL = "\ref page_libs_wxstc"];
  33. wxXRC [fillcolor = green, URL = "\ref page_libs_wxxrc"];
  34. wxWebView [fillcolor = green, URL = "\ref page_libs_wxwebview"];
  35. wxCore -> wxBase;
  36. wxNet -> wxBase;
  37. wxXML -> wxBase;
  38. wxAdvanced -> wxCore;
  39. wxAUI -> wxAdvanced; wxAUI -> wxHTML;
  40. wxGL -> wxCore;
  41. wxHTML -> wxCore;
  42. wxMedia -> wxCore;
  43. wxPropertyGrid -> wxAdvanced;
  44. wxQA -> wxCore; wxQA -> wxXML;
  45. wxRibbon -> wxCore;
  46. wxRichText -> wxAdvanced; wxRichText -> wxHTML; wxRichText -> wxXML;
  47. wxSTC -> wxCore;
  48. wxXRC -> wxAdvanced; wxXRC -> wxHTML; wxXRC -> wxXML;
  49. wxWebView -> wxCore;
  50. }
  51. @enddot
  52. Please note that arrows indicate the "depends from" relation and that all blue
  53. libraries depend on the @ref page_libs_wxbase library (i.e. they are non-GUI
  54. libraries), and all green libraries depend on the @ref page_libs_wxcore library
  55. (i.e. they are GUI libraries).
  56. @section page_libs_wxadv wxAdvanced
  57. Advanced or rarely used GUI classes:
  58. @li wxCalendarCtrl
  59. @li wxGrid classes
  60. @li wxJoystick
  61. @li wxLayoutAlgorithm
  62. @li wxSplashScreen
  63. @li wxTaskBarIcon
  64. @li wxSound
  65. @li wxWizard
  66. @li wxSashLayoutWindow
  67. @li wxSashWindow
  68. @li ...others
  69. Requires @ref page_libs_wxcore and @ref page_libs_wxbase.
  70. @section page_libs_wxaui wxAui
  71. This contains the Advanced User Interface docking library.
  72. Requires @ref page_libs_wxadv, @ref page_libs_wxhtml, @ref page_libs_wxxml,
  73. @ref page_libs_wxcore, @ref page_libs_wxbase.
  74. @section page_libs_wxbase wxBase
  75. Every wxWidgets application must link against this library. It contains
  76. mandatory classes that any wxWidgets code depends on (e.g. wxString) and
  77. portability classes that abstract differences between platforms. wxBase can be
  78. used to develop console mode applications, it does not require any GUI
  79. libraries or running X Window System on Unix.
  80. @section page_libs_wxcore wxCore
  81. Basic GUI classes such as GDI classes or controls are in this library. All
  82. wxWidgets GUI applications must link against this library, only console mode
  83. applications don't.
  84. Requires @ref page_libs_wxbase.
  85. @section page_libs_wxgl wxGL
  86. This library contains wxGLCanvas class for integrating OpenGL library with
  87. wxWidgets. Unlike all others, this library is @b not part of the monolithic
  88. library, it is always built as separate library.
  89. Requires @ref page_libs_wxcore and @ref page_libs_wxbase.
  90. @section page_libs_wxhtml wxHTML
  91. Simple HTML renderer and other @ref overview_html are contained in this
  92. library, as well as wxHtmlHelpController, wxBestHelpController and
  93. wxHtmlListBox.
  94. Requires @ref page_libs_wxcore and @ref page_libs_wxbase.
  95. @section page_libs_wxmedia wxMedia
  96. Miscellaneous classes related to multimedia. Currently this library only
  97. contains wxMediaCtrl but more classes will be added in the future.
  98. Requires @ref page_libs_wxcore and @ref page_libs_wxbase.
  99. @section page_libs_wxnet wxNet
  100. Classes for network access:
  101. @li wxSocket classes (wxSocketClient, wxSocketServer and related classes)
  102. @li wxSocketOutputStream and wxSocketInputStream
  103. @li sockets-based IPC classes (wxTCPServer, wxTCPClient and wxTCPConnection)
  104. @li wxURL
  105. @li wxInternetFSHandler (a wxFileSystem handler)
  106. Requires @ref page_libs_wxbase.
  107. @section page_libs_wxpropgrid wxPropertyGrid
  108. This contains the wxPropertyGrid control.
  109. Requires @ref page_libs_wxadv, @ref page_libs_wxcore, @ref page_libs_wxbase.
  110. @section page_libs_wxqa wxQA
  111. This is the library containing extra classes for quality assurance. Currently
  112. it only contains wxDebugReport and related classes, but more will be added to
  113. it in the future.
  114. Requires @ref page_libs_wxxml, @ref page_libs_wxcore, @ref page_libs_wxbase.
  115. @section page_libs_wxribbon wxRibbon
  116. This contains the Ribbon User Interface components library.
  117. Requires @ref page_libs_wxcore, @ref page_libs_wxbase.
  118. @section page_libs_wxrichtext wxRichText
  119. This contains generic rich text control functionality.
  120. Requires @ref page_libs_wxadv, @ref page_libs_wxhtml, @ref page_libs_wxxml,
  121. @ref page_libs_wxcore, @ref page_libs_wxbase.
  122. @section page_libs_wxstc wxSTC
  123. STC (Styled Text Control) is a wrapper around Scintilla, a syntax-highlighting
  124. text editor. See <http://www.scintilla.org/> for more info about Scintilla.
  125. Requires @ref page_libs_wxcore, @ref page_libs_wxbase.
  126. @section page_libs_wxwebview wxWebView
  127. The wxWebView library contains the wxWebView control and its associated classes.
  128. Requires @ref page_libs_wxcore, @ref page_libs_wxbase.
  129. @section page_libs_wxxml wxXML
  130. This library contains simple classes for parsing XML documents.
  131. Requires @ref page_libs_wxbase.
  132. @section page_libs_wxxrc wxXRC
  133. This library contains wxXmlResource class that provides access to XML resource
  134. files in XRC format.
  135. Requires @ref page_libs_wxadv, @ref page_libs_wxhtml, @ref page_libs_wxxml,
  136. @ref page_libs_wxcore, @ref page_libs_wxbase.
  137. */