diff --git a/docs/doxygen/extra_stylesheet.css b/docs/doxygen/extra_stylesheet.css index 48658c3ca8..b8ecca53f6 100644 --- a/docs/doxygen/extra_stylesheet.css +++ b/docs/doxygen/extra_stylesheet.css @@ -1,5 +1,25 @@ /* wxWidgets Custom Styles */ +html, body { + margin: 0; + padding: 0; + height: 100%; +} + +#page_container { + position: relative; + margin: 0; + padding: 0; + height: auto !important; + height: 100%; + min-height: 100%; +} + +div.contents { + margin-right: 12px; + padding-bottom: 70px; +} + #projectlogo { text-align: left; padding: 0.5em; @@ -38,11 +58,26 @@ h4 { margin-top: 0.5em; } +div.toc h3 { + font-size: 14px; +} + +div.toc li { + font-size: 12px; + line-height: 1.3; + padding-left: 14px; +} + img.logo { float: right; margin: 20px; } +div.logo { + float: right; + margin: 20px; +} + div.appearance { margin: 1em 0em; } @@ -105,9 +140,18 @@ code { color: #444444; } -hr.footer { - margin-top: 2em; -} address.footer { - margin: 0.75em; + position: absolute; + bottom: 0; + margin: 0; + padding: 10px 0; + width: 100%; + border-top: 1px solid #0043CC; + background-image: url('nav_h.png'); + background-repeat: repeat-x; + background-color: #F4F8FF; +} + +address.footer small { + padding: 0 10px; } \ No newline at end of file diff --git a/docs/doxygen/images/no.gif b/docs/doxygen/images/no.gif deleted file mode 100644 index 65fc311b1d013805d43158ffb7c1a1674bc896e4..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 298 zcmZ?wbhEHb6k!lyxXQ_Z2OKzX0FUe-ky8B0!pOkD$)E#r56DjrZ0-kI3OsbA+PPYS zCVD8%IR5O@j25?EKkcxSSL4=m4OyyNfe8 SiXwy3s;c5zi+fxg8LR<3{3^)+ diff --git a/docs/doxygen/images/somewhat.gif b/docs/doxygen/images/somewhat.gif deleted file mode 100644 index 11dd29b01839f13e3cf48595ebaaa7c3ca1dc896..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 290 zcmZ?wbhEHb6k!lyxXQ_Z3;h4jaNxj!bLWzADHtT;ia%Kx85lSjbU^L_`N@IJ{yZ0ir)0I8i6Nm^hBLjg{-=pwlIvvjI+;f{=F?x8gc6DvUfz~g-E^p`f0c9 Q+efoQ>T8?w+#MOL0Ry@whX4Qo diff --git a/docs/doxygen/images/tab_b.gif b/docs/doxygen/images/tab_b.gif deleted file mode 100644 index 0d623483ffdf5f9f96900108042a7ab0643fe2a3..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 35 ncmZ?wbhEHbWMp7uXkcJy*>IeJfk6j|fqX^=1|}vKMh0sDa2W*H diff --git a/docs/doxygen/images/tab_l.gif b/docs/doxygen/images/tab_l.gif deleted file mode 100644 index 9b1e6337c9299a700401a2a78a2c6ffced475216..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 706 zcmZ?wbhEHbZT`}F1e&(Gg}Y(8=I;HA5#Z$3JI=gGB)FQ#odI(O&E^@q;x zK6mr*m3xOS-#u~t!I@i+u0DKm^U160k6t`|^WpV}&n+8{U%dD9&a>B#U%!9-@yol< zU%&tQ{rk_K|NsC0`}dE5ET99@1@a36+kb~?0UJ*yc&I3X_m z!ND^5$O7$#8OFRuDhG}!?8z?cdZK&!`PWjdR;Aj^wZ` zeK{IEYHBJ)6K8VIp1`BVt++swf6j+=L{p1*nO(VhE`pFexG@5$|>uaCcd z`0m=9m+yak{QmXN#Sc$^{$X9h9&q2jiKAI|&T)a;PPx2K9p`YIdw8HtR5k2Q$2-O2 z*;3y{MQ-RnJTgJfI&R5|O)AHxDf_00XbPvDZPy4t=hHd)nfLPvms&O`Ok(sD()5v$ z5U@&h;a=#xbxVbo2~X&Xj0Ie(f{v>vERH+qC+nTG=B8Nca=wU-O$?1&vUgV~9=!H; zx>3p9Yn%*<>t~sk+&0xfyS8RsPfYBd<~wWK%j-LmpU>O7yX^h#UCp1x-p#i7@bE;py8XI6 zmY<)m>~)W~yIWcMVoiPg{duuf<*)9qZ9l$m*Ph&W&$jlv*Vpa+{pH@n=IQ$L?0$ax ec60Ul|8o2P|NVbd{6P)#weSbE3}s?04AuZvx_~SI diff --git a/docs/doxygen/images/tab_r.gif b/docs/doxygen/images/tab_r.gif deleted file mode 100644 index ce9dd9f533cb5486d6941844f442b59d4a9e9175..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 2585 zcmbV}`9Bkk1ILFF--w5zJc=ZZT(zjE=;2|_S)Qm~rCWz1Pc)KPl;jv%A#&v2*x}yc zmf2~Jm~&=xjJY?PqwIN}f8qQ2{r$uH{c*nJbmr{cR5??*egHrs-B=MzCF`3%e{FAW z{oL5xTHn~5TM{jaB;@|_Ue5F&Zb@p(kMyG{*;gWDg zyeL|eZf7Qd8=#bXzSiR{yzRgLSj-fJS8>lBjVHN z^o-0eS=nE6a`W;LChBs=`+QAJP~{b93>H^eRb5kCSC1zUNezun%`L5M?RDzv#%jk7 zYVRX=vATPD`+oEfum^{RM@GjuP?-r=yh0!p;Vx^T9G7~`7%5ydH%70=jyJ;;`d;hv92x3R=z{xp+Lg2!*@OK*K15-t&okoPtSED)h&$RLxdbA zseWm^C3d%-yRNi-ryk^!ek+C`n&~cd$#ZWct_cUL{l~i+Nzx^5d!n94(>bW-iL~Rl z&8r)?q|1DIo=0=judQ{FaGcfLERz8gfn3-Qt<2lksh{mzpT}DXxUuR^z=^key&q4! z+wWI45vL0k$R^(F#{qfqhUsN@WA+w-V?LPH33!Q?WFSB3)WBojE@hK41Nb?KfS+Qo zXgrzfsP$wr4Qzy*{OD>uJBjdgGM@VMml5)2f~_}lD*YyOb}Hjeobhz#4c`w(l^>KK zr?Ud;W~Z}*w;%hZ|2^p^+f06gJDJQD zeIhGADbDmm&6arh(q>EZ<7mjzg7l|z$hRL8=1>)Nv=S7CY$B}iYJ&*T_-T_OG*L1q ztZ3Lana33?y3AKnyq^YCF|4x%Rb5WU&2qcl{TFKey%QJeMxn^SdT!hZ5+0i1zeusiYVp-phBl7b5+Px-X&LhByq z0F&<;K0l2+v>qiHlXb#$jXMv$uK-dEGE9L~qtdU(XeRXmvu*K2Q&6!fD**JxYP4b4BR7FdJ$Qx9G9`J%-_X!a#LGpp3g9)VWytGCa;7`S1_e8F~!R+aSJ zOF17p2`H?2kPs8Q`_;U}+D%3p zs2-0BTqFwpUoBk`?P;iPQ(IbEA|JmMx!P&YYG|R@S=5Mnw;-?A6rEEVyV%d7{iU4a zNk`i!%F(Ykpm`}#oH;BjY->@b8vQedv;pza2FL&*6ufjd+*3Ute&>kes~TU?^KkojsTh(o~(3tk1Y6>4(yn( z#U*ID9@eg-beKo1B;HXe+}{Z%n@7m0+yxivuqk9~;!1LGQlah)xYK4>wgL}l6dsaN zIxlRlq`*`j9PG4*0hD6YV_b_2w5b#)o7J?`q#{GjvvKlD`T*dWcZx<-s(ZvLB44E# z=!|sw!?)@%y$oRNL#25WS3lzdii}TuQ3?CLnvQ1_n};2sT_;Y;#d3=+-(O% zMN$>O!3;ke(UuLR%h_&)N zs^!-@A>QR}4yB1bPp`9S19ikTbZ~O{&FF-yHK{En;mmShDUIEw03`j(DBIsM}Rjki2J#SQa3gFZTKBPDeIiLt9Z z%bL3(B@Qw%(B`wSMS~dPh$=R`(}lBoFXKy(s|*{#ru$wjsBc_O#zxNk9w+UUHmx(U zmJ8+M+ndtnZ<7|VU9Mbt61zpo9T&3%Wx&XII=#QJxjR`CZf22ac3d51Z?GD%LEe_&*t46Qf;4`bZ7p2K(Ab5>GfT^}4! zBT&HZD`^PEgWoI&{~o-ID0F?O`75sm(87x%A{(}Ch1)QlzdJ)1B-eqe5a(weg0`4lQIf1evjvbBY50DVbzO7CLf|vP z2#0(U-|jZ`H{y5N^o7%iK6H>_HEGN->U6^!)1{XpJV!!4(Ig7wzZQ*9WYF4X1rG0x z=1uA@i`rIAciubDC{;~b(|&|A@xkjRP5aRcvRU9tvIm}jDB6J eQ0-6-y)mpwdT=ayS0tBxKDA*~;EWmo diff --git a/docs/doxygen/images/yes.gif b/docs/doxygen/images/yes.gif deleted file mode 100644 index 759fc9e8e9d51eacd30fe15cd4771d5f6821d5ed..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 290 zcmZ?wbhEHb6k!lyxXQ_Z3!GtLIdI^>ACnYZ3I>U|;!hSv1_n+B9gurKesW;5KhRR( zp(EAr%*xcLqBs4lM&L;sJyEAsA*=4DEevBZ>W{gAyO~De%dYj Q_R;K+`r4*EcSi -@li @ref page_class_cat_basicwnd -@li @ref page_class_cat_winlayout -@li @ref page_class_cat_managedwnd -@li @ref page_class_cat_menus -@li @ref page_class_cat_ctrl -@li @ref page_class_cat_validator -@li @ref page_class_cat_pickers -@li @ref page_class_cat_aui -@li @ref page_class_cat_cmndlg -@li @ref page_class_cat_html -@li @ref page_class_cat_miscwnd - -@li @ref page_class_cat_dc -@li @ref page_class_cat_gdi -@li @ref page_class_cat_gc -@li @ref page_class_cat_image -@li @ref page_class_cat_events -@li @ref page_class_cat_appmanagement -@li @ref page_class_cat_printing -@li @ref page_class_cat_dvf -@li @ref page_class_cat_dnd -@li @ref page_class_cat_vfs -@li @ref page_class_cat_threading - -@li @ref page_class_cat_rtti -@li @ref page_class_cat_debugging -@li @ref page_class_cat_logging -@li @ref page_class_cat_data -@li @ref page_class_cat_conv -@li @ref page_class_cat_containers -@li @ref page_class_cat_smartpointers -@li @ref page_class_cat_file -@li @ref page_class_cat_streams -@li @ref page_class_cat_xml -@li @ref page_class_cat_xrc - -@li @ref page_class_cat_net -@li @ref page_class_cat_archive -@li @ref page_class_cat_ipc -@li @ref page_class_cat_help -@li @ref page_class_cat_media -@li @ref page_class_cat_gl -@li @ref page_class_cat_misc - -@endTable - - -

@section page_class_cat_basicwnd Basic Windows diff --git a/docs/doxygen/mainpages/const_cpp.h b/docs/doxygen/mainpages/const_cpp.h index 69257230ab..2581eda5b3 100644 --- a/docs/doxygen/mainpages/const_cpp.h +++ b/docs/doxygen/mainpages/const_cpp.h @@ -9,24 +9,16 @@ /** -@page page_cppconst Preprocessor symbols defined by wxWidgets +@page page_cppconst Preprocessor Symbols -These are preprocessor symbols used in the wxWidgets source, grouped -by category (and sorted by alphabetical order inside each category). -All of these macros except for the @c wxUSE_XXX variety is defined if the -corresponding condition is @true and undefined if it isn't, so they should be -always tested using @ifdef_ and not @if_. +@tableofcontents -@li @ref page_cppconst_guisystem -@li @ref page_cppconst_os -@li @ref page_cppconst_cpu -@li @ref page_cppconst_hardware -@li @ref page_cppconst_compiler -@li @ref page_cppconst_featuretests -@li @ref page_cppconst_msvc_setup_h -@li @ref page_cppconst_miscellaneous +These are preprocessor symbols used in the wxWidgets source, grouped by +category (and sorted by alphabetical order inside each category). All of these +macros except for the @c wxUSE_XXX variety is defined if the corresponding +condition is @true and undefined if it isn't, so they should be always tested +using @ifdef_ and not @if_. -

@section page_cppconst_guisystem GUI system @@ -81,7 +73,8 @@ The convention is to use the @c __WX prefix for these symbols, although this has not always been followed. -@section page_cppconst_os Operating systems + +@section page_cppconst_os Operating Systems @beginDefList @itemdef{__APPLE__, any Mac OS version} @@ -117,7 +110,7 @@ symbols, although this has not always been followed. -@section page_cppconst_cpu Hardware architectures (CPU) +@section page_cppconst_cpu Hardware Architectures (CPU) Note that not all of these symbols are always defined, it depends on the compiler used. @@ -131,7 +124,7 @@ compiler used. -@section page_cppconst_hardware Hardware type +@section page_cppconst_hardware Hardware Type @beginDefList @itemdef{__SMARTPHONE__, Generic mobile devices with phone buttons and a small display} @@ -173,7 +166,7 @@ compiler used. -@section page_cppconst_featuretests Feature tests +@section page_cppconst_featuretests Feature Tests Some library features may not be always available even if they were selected by the user. To make it possible to check if this is the case, the library @@ -224,7 +217,7 @@ Currently the following symbols exist: -@section page_cppconst_msvc_setup_h Libraries selection for MSVC setup.h +@section page_cppconst_msvc_setup_h Library Selection for MSVC Microsoft Visual C++ users may use the special @c wx/setup.h file for this compiler in @c include/msvc subdirectory. This file implicitly links in all the @@ -234,6 +227,7 @@ configurations. However sometimes linking with all the libraries is not desirable, for example because some of them were not built and this is where the symbols in this section can be helpful: defining them allows to not link with the corresponding library. The following symbols are honoured: + - wxNO_ADV_LIB - wxNO_AUI_LIB - wxNO_HTML_LIB diff --git a/docs/doxygen/mainpages/const_stdevtid.h b/docs/doxygen/mainpages/const_stdevtid.h index b439cb9a3b..92fa90e552 100644 --- a/docs/doxygen/mainpages/const_stdevtid.h +++ b/docs/doxygen/mainpages/const_stdevtid.h @@ -9,7 +9,7 @@ /** -@page page_stdevtid Standard event identifiers +@page page_stdevtid Standard Event Identifiers wxWidgets defines a special identifier value @c wxID_ANY which is used in the following two situations: diff --git a/docs/doxygen/mainpages/const_stockitems.h b/docs/doxygen/mainpages/const_stockitems.h index c4172a5f5b..54960cf3e7 100644 --- a/docs/doxygen/mainpages/const_stockitems.h +++ b/docs/doxygen/mainpages/const_stockitems.h @@ -9,12 +9,14 @@ /** -@page page_stockitems Stock items +@page page_stockitems Stock Items + +The following is the list of the window IDs for which stock buttons and menu +items are created. -The following is the list of the window IDs for which stock buttons and menu items -are created. See the wxButton constructor and the wxMenuItem constructor for classes which automatically add stock bitmaps when using stock IDs. + Also note that you can retrieve stock bitmaps using wxArtProvider. @beginDefList @@ -93,7 +95,7 @@ Also note that you can retrieve stock bitmaps using wxArtProvider. @stock{wxID_ZOOM_OUT,zoom-out,Zoom &Out} @endDefList -Note that some of the IDs listed above also have a stock accelerator -and an associated help string. +Note that some of the IDs listed above also have a stock accelerator and an +associated help string. */ diff --git a/docs/doxygen/mainpages/const_wxusedef.h b/docs/doxygen/mainpages/const_wxusedef.h index 2cbc3639d4..d38f5c3a6b 100644 --- a/docs/doxygen/mainpages/const_wxusedef.h +++ b/docs/doxygen/mainpages/const_wxusedef.h @@ -9,31 +9,20 @@ /** -@page page_wxusedef wxUSE preprocessor symbols defined by wxWidgets +@page page_wxusedef wxUSE Preprocessor Symbols + +@tableofcontents This section documents the wxUSE preprocessor symbols used in the wxWidgets source, grouped by category (and sorted by alphabetical order inside each category). These symbols are always defined and whether the given feature is active or not depends on their value: if defined as @c 1, feature is active, -otherwise it is disabled. Because of this these symbols should be always tested +otherwise it is disabled. Because of this these symbols should always be tested using @if_ and not @ifdef_. -@li @ref page_wxusedef_important -@li @ref page_wxusedef_multi -@li @ref page_wxusedef_unix -@li @ref page_wxusedef_x11 -@li @ref page_wxusedef_gtk -@li @ref page_wxusedef_mac -@li @ref page_wxusedef_motif -@li @ref page_wxusedef_cocoa -@li @ref page_wxusedef_os2 -@li @ref page_wxusedef_msw -@li @ref page_wxusedef_univ - -

-@section page_wxusedef_important Most important wxUSE symbols +@section page_wxusedef_important Most Important Symbols This table summarizes some of the global build features affecting the entire library: @@ -60,7 +49,7 @@ library: @endDefList -@section page_wxusedef_multi Generic wxUSE preprocessor symbols +@section page_wxusedef_multi Generic Symbols @beginDefList @itemdef{wxUSE_ABOUTDLG, Use wxAboutDialogInfo class.} @@ -269,7 +258,7 @@ library: @endDefList -@section page_wxusedef_unix wxUSE preprocessor symbols used only under Unix platforms +@section page_wxusedef_unix Unix Platform Symbols @beginDefList @itemdef{wxUSE_EPOLL_DISPATCHER, Use wxEpollDispatcher class. See also wxUSE_SELECT_DISPATCHER.} @@ -281,7 +270,7 @@ library: @endDefList -@section page_wxusedef_x11 wxUSE preprocessor symbols used only in wxX11 Platform +@section page_wxusedef_x11 wxX11 Symbols @beginDefList @itemdef{wxUSE_NANOX, Use NanoX.} @@ -289,7 +278,7 @@ library: @endDefList -@section page_wxusedef_gtk wxUSE preprocessor symbols used only in wxGTK port +@section page_wxusedef_gtk wxGTK Symbols @beginDefList @itemdef{wxUSE_DETECT_SM, Use code to detect X11 session manager.} @@ -300,7 +289,7 @@ library: @endDefList -@section page_wxusedef_mac wxUSE preprocessor symbols used only in wxMac port +@section page_wxusedef_mac wxMac Symbols @beginDefList @itemdef{wxUSE_MAC_CRITICAL_REGION_MUTEX, See src/osx/carbon/thread.cpp file.} @@ -310,7 +299,7 @@ library: @endDefList -@section page_wxusedef_motif wxUSE preprocessor symbols used only in wxMotif port +@section page_wxusedef_motif wxMotif Symbols @beginDefList @itemdef{wxUSE_GADGETS, Use xmCascadeButtonGadgetClass, xmLabelGadgetClass, xmPushButtonGadgetClass and xmToggleButtonGadgetClass classes.} @@ -318,14 +307,14 @@ library: @endDefList -@section page_wxusedef_cocoa wxUSE preprocessor symbols used only in Cocoa port +@section page_wxusedef_cocoa Cocoa Symbols @beginDefList @itemdef{wxUSE_OBJC_UNIQUIFYING, Enable Objective-C class name uniquifying.} @endDefList -@section page_wxusedef_os2 wxUSE preprocessor symbols used only in OS2 port +@section page_wxusedef_os2 OS2 Symbols @beginDefList @itemdef{wxUSE_CONSOLEDEBUG, See src/os2/app.cpp file.} @@ -337,7 +326,7 @@ library: @endDefList -@section page_wxusedef_msw wxUSE preprocessor symbols used only in wxMSW port +@section page_wxusedef_msw wxMSW Symbols @beginDefList @itemdef{wxUSE_ACCESSIBILITY, Enable accessibility support} @@ -373,7 +362,7 @@ library: @endDefList -@section page_wxusedef_univ wxUSE preprocessor symbols used only in wxUniversal +@section page_wxusedef_univ wxUniversal Symbols @beginDefList @itemdef{wxUSE_ALL_THEMES, Use all themes in wxUniversal; See wx/univ/theme.h file.} diff --git a/docs/doxygen/mainpages/copyright.h b/docs/doxygen/mainpages/copyright.h index 004edc8df1..31c298f3dd 100644 --- a/docs/doxygen/mainpages/copyright.h +++ b/docs/doxygen/mainpages/copyright.h @@ -10,7 +10,7 @@ @page page_copyright Copyrights and Licenses -Copyright (c) 1992-2008 Julian Smart, Robert Roebling, Vadim Zeitlin and other +Copyright (c) 1992-2012 Julian Smart, Robert Roebling, Vadim Zeitlin and other members of the wxWidgets team Portions (c) 1996 Artificial Intelligence Applications Institute @@ -34,4 +34,3 @@ recognition of the new name by OSI. @verbinclude "lgpl.txt" */ - diff --git a/docs/doxygen/mainpages/devtips.h b/docs/doxygen/mainpages/devtips.h index e85350cc5c..68879200c3 100644 --- a/docs/doxygen/mainpages/devtips.h +++ b/docs/doxygen/mainpages/devtips.h @@ -10,24 +10,10 @@ @page page_multiplatform General Cross-Platform Development Tips +@tableofcontents + This chapter describes some tips related to cross-platform development. -@li @ref page_multiplatform_includefiles -@li @ref page_multiplatform_libraries -@li @ref page_multiplatform_configuration -@li @ref page_multiplatform_makefiles -@li @ref page_multiplatform_winresources -@li @ref page_multiplatform_allocatingobjects -@li @ref page_multiplatform_architecturedependency -@li @ref page_multiplatform_conditionalcompilation -@li @ref page_multiplatform_cpp -@li @ref page_multiplatform_filehandling -@li @ref page_multiplatform_reducingerr -@li @ref page_multiplatform_gui -@li @ref page_multiplatform_debug - - -

@section page_multiplatform_includefiles Include Files diff --git a/docs/doxygen/mainpages/introduction.h b/docs/doxygen/mainpages/introduction.h index 4b2c5baa09..35785c7938 100644 --- a/docs/doxygen/mainpages/introduction.h +++ b/docs/doxygen/mainpages/introduction.h @@ -6,19 +6,12 @@ // Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// - /** @page page_introduction Introduction -@li @ref page_introduction_whatis -@li @ref page_introduction_why -@li @ref page_introduction_requirements -@li @ref page_introduction_where -@li @ref page_introduction_acknowledgements - +@tableofcontents -

@section page_introduction_whatis What is wxWidgets? @@ -119,7 +112,7 @@ here are some of the benefits: @li Built-in support for many file formats (BMP, PNG, JPEG, GIF, XPM, PNM, PCX). -@section page_introduction_requirements wxWidgets requirements +@section page_introduction_requirements wxWidgets Requirements To make use of wxWidgets, you currently need one of the following setups. diff --git a/docs/doxygen/mainpages/libs.h b/docs/doxygen/mainpages/libs.h index a3c0dec689..2f85cffac2 100644 --- a/docs/doxygen/mainpages/libs.h +++ b/docs/doxygen/mainpages/libs.h @@ -10,6 +10,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. @@ -66,6 +68,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 +114,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 +160,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 +184,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 +213,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. - */ - diff --git a/docs/doxygen/mainpages/manual.h b/docs/doxygen/mainpages/manual.h index 86e1e70f6c..ad1deaf250 100644 --- a/docs/doxygen/mainpages/manual.h +++ b/docs/doxygen/mainpages/manual.h @@ -6,17 +6,18 @@ // Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// - /** @mainpage Documentation + @author Julian Smart, Robert Roebling, Vadim Zeitlin, Robin Dunn, Stefan Csomor, Francesco Montorsi, Bryan Petty, et al -@date July, 2012 + +@date September, 2012 @image html main_wxlogo.png -@section manual_user User Manual: +@section manual_user User Manual @li @subpage page_introduction @li @subpage page_copyright @@ -28,7 +29,7 @@ @li @subpage page_multiplatform @li @subpage page_port -@section manual_reference Reference Manual: +@section manual_reference Reference Manual @li @subpage page_constants @li @subpage page_translations diff --git a/docs/doxygen/mainpages/platdetails.h b/docs/doxygen/mainpages/platdetails.h index 075a858d39..da552ea568 100644 --- a/docs/doxygen/mainpages/platdetails.h +++ b/docs/doxygen/mainpages/platdetails.h @@ -11,118 +11,103 @@ @page page_port Platform Details +@tableofcontents + wxWidgets defines a common API across platforms, but uses the native graphical user interface (GUI) on each platform, so your program will take on the native look and feel that users are familiar with. Unfortunately native toolkits and hardware do not always support the functionality that the wxWidgets API -requires. This chapter collects notes about differences among supported platforms -and ports. - -@li @ref page_port_wxgtk -@li @ref page_port_wxosx -@li @ref page_port_wxos2 -@li @ref page_port_wxx11 -@li @ref page_port_wxmotif -@li @ref page_port_wxmsw -@li @ref page_port_nativedocs - - -

+requires. This chapter collects notes about differences among supported +platforms and ports. @section page_port_wxgtk wxGTK -@htmlonly -

-@endhtmlonly +@htmlonly

@endhtmlonly +@image html logo_gtk.png +@htmlonly

@endhtmlonly -wxGTK is a port of wxWidgets using the GTK+ library. -It makes use of GTK+'s native widgets wherever possible and uses -wxWidgets' generic controls when needed. GTK+ itself has been -ported to a number of systems, but so far only the original X11 -version is supported. Support for other GTK+ backends is planned, +wxGTK is a port of wxWidgets using the GTK+ library. It makes use of GTK+'s +native widgets wherever possible and uses wxWidgets' generic controls when +needed. GTK+ itself has been ported to a number of systems, but so far only the +original X11 version is supported. Support for other GTK+ backends is planned, such as the new DirectFB backend. -All work is being done on GTK+ version 2.0 and above. Support for -GTK+ 1.2 will be deprecated in a later release. +All work is being done on GTK+ version 2.0 and above. Support for GTK+ 1.2 will +be deprecated in a later release. You will need GTK+ 2.6 or higher which is available from: http://www.gtk.org -The newer version of GTK+ you use, the more native widgets and -features will be utilized. We have gone to great lengths to -allow compiling wxWidgets applications with the latest version of -GTK+, with the resulting binary working on systems even with a -much earlier version of GTK+. You will have to ensure that the -application is launched with lazy symbol binding for that. +The newer version of GTK+ you use, the more native widgets and features will be +utilized. We have gone to great lengths to allow compiling wxWidgets +applications with the latest version of GTK+, with the resulting binary working +on systems even with a much earlier version of GTK+. You will have to ensure +that the application is launched with lazy symbol binding for that. -In order to configure wxWidgets to compile wxGTK you will -need use the @c --with-gtk argument to the @c configure script. -This is the default for many systems. +In order to configure wxWidgets to compile wxGTK you will need use the +@c --with-gtk argument to the @c configure script. This is the default for many +systems. -GTK+ 1.2 can still be used, albeit discouraged. For that you can -pass @c --with-gtk=1 to the @c configure script. +GTK+ 1.2 can still be used, albeit discouraged. For that you can pass +@c --with-gtk=1 to the @c configure script. Support for GTK+ 3 is available starting with wxWidgets 2.9.4, use @c configure option @c --with-gtk=3 to enable it. It is still under development and may have significant bugs or missing features, and should be considered experimental. -For further information, please see the files in @c docs/gtk -in the distribution. +For further information, please see the files in @c docs/gtk in the +distribution. + @section page_port_wxosx wxOSX -@htmlonly -

-@endhtmlonly +@htmlonly

@endhtmlonly +@image html logo_osxleopard.png +@htmlonly

@endhtmlonly @subsection page_port_wxosx_carbon wxOSX/Carbon -wxOSX/Carbon is a port of wxWidgets for the Macintosh OS platform. -Currently MacOS X 10.5 or higher are supported. wxOSX/Carbon can -be compiled both using Apple's command line developer tools -as well as Apple's Xcode IDE. wxOSX/Carbon supports both the Intel -and PowerPC architectures and can be used to produce -"universal binaries" in order create application which can run -both architecture. Unfortunately, wxOSX/Carbon does not support any -64-bit architecture since Apple decided not to port its Carbon -API entirely to 64-bit. - -@note Carbon has been deprecated by Apple as of OS X 10.5 and will likely -be removed entirely in a future OS version. It's recommended you look into +wxOSX/Carbon is a port of wxWidgets for the Macintosh OS platform. Currently +MacOS X 10.5 or higher are supported. wxOSX/Carbon can be compiled both using +Apple's command line developer tools as well as Apple's Xcode IDE. wxOSX/Carbon +supports both the Intel and PowerPC architectures and can be used to produce +"universal binaries" in order create application which can run both +architecture. Unfortunately, wxOSX/Carbon does not support any 64-bit +architecture since Apple decided not to port its Carbon API entirely to 64-bit. + +@note Carbon has been deprecated by Apple as of OS X 10.5 and will likely be +removed entirely in a future OS version. It's recommended you look into switching your app over to wxOSX/Cocoa as soon as possible. -For further information, please see the files in @c docs/osx -in the distribution. +For further information, please see the files in @c docs/osx in the +distribution. @subsection page_port_wxosx_cocoa wxOSX/Cocoa -wxOSX/Cocoa is another port of wxWidgets for the Macintosh OS -platform. Currently MacOS X 10.5 or higher are supported. -In contrast to wxOSX/Carbon, it uses the Cocoa API -in place of Carbon. Much work has gone into this port and many -controls are functional, but the port has not reached the maturity -of the wxOSX/Carbon port yet. It is possible to use wxOSX/Cocoa -on 64-bit architectures. +wxOSX/Cocoa is another port of wxWidgets for the Macintosh OS platform. +Currently MacOS X 10.5 or higher are supported. In contrast to wxOSX/Carbon, +it uses the Cocoa API in place of Carbon. Much work has gone into this port +and many controls are functional, but the port has not reached the maturity of +the wxOSX/Carbon port yet. It is possible to use wxOSX/Cocoa on 64-bit +architectures. -In order to configure wxWidgets to compile wxOSX/Cocoa you will -need to type: +In order to configure wxWidgets to compile wxOSX/Cocoa you will need to type: @verbatim configure --with-osx_cocoa @endverbatim -For further information, please see the files in @c docs/osx -in the distribution. +For further information, please see the files in @c docs/osx in the +distribution. -@note There was a previous effort towards a Cocoa port called -wxCocoa, which was implemented totally with Cocoa API unlike the OSX/Cocoa port -which uses OS X C APIs to share code, and while it is no longer being actively -developed, docs for it are available in @c docs/cocoa in the distribution. +@note There was a previous effort towards a Cocoa port called wxCocoa, which +was implemented totally with Cocoa API unlike the OSX/Cocoa port which uses OS +X C APIs to share code, and while it is no longer being actively developed, +docs for it are available in @c docs/cocoa in the distribution. @@ -138,114 +123,113 @@ in the distribution. @section page_port_wxx11 wxX11 -@htmlonly -

-@endhtmlonly +@htmlonly

@endhtmlonly +@image html logo_x11.png +@htmlonly

@endhtmlonly -wxX11 is a port of wxWidgets using X11 (The X Window System) -as the underlying graphics backend. wxX11 draws its widgets -using the wxUniversal widget set which is now part of wxWidgets. -wxX11 is well-suited for a number of special applications such -as those running on systems with few resources (PDAs) or for +wxX11 is a port of wxWidgets using X11 (The X Window System) as the underlying +graphics backend. wxX11 draws its widgets using the wxUniversal widget set +which is now part of wxWidgets. wxX11 is well-suited for a number of special +applications such as those running on systems with few resources (PDAs) or for applications which need to use a special themed look. -In order to configure wxWidgets to compile wxX11 you will -need to type: +In order to configure wxWidgets to compile wxX11 you will need to type: @verbatim configure --with-x11 --with-universal @endverbatim -For further information, please see the files in @c docs/x11 -in the distribution. There is also a page on the use of -wxWidgets for embedded applications on the wxWidgets web site. +For further information, please see the files in @c docs/x11 in the +distribution. There is also a page on the use of wxWidgets for embedded +applications on the wxWidgets web site. @section page_port_wxmotif wxMotif -@htmlonly -

-@endhtmlonly +@htmlonly

@endhtmlonly +@image html logo_motif.png +@htmlonly

@endhtmlonly -wxMotif is a port of wxWidgets for X11 systems using Motif libraries. -Motif libraries provide a clean and fast user interface at the expense -of the beauty and candy of newer interfaces like GTK. - -For further information, please see the files in @c docs/motif -in the distribution. +wxMotif is a port of wxWidgets for X11 systems using Motif libraries. Motif +libraries provide a clean and fast user interface at the expense of the beauty +and candy of newer interfaces like GTK. +For further information, please see the files in @c docs/motif in the +distribution. @section page_port_wxmsw wxMSW -@htmlonly -

-@endhtmlonly +@htmlonly

@endhtmlonly +@image html logo_win.png +@htmlonly

@endhtmlonly wxMSW is a port of wxWidgets for the Windows platforms including Windows 95, -98, ME, 2000, NT, XP and Vista in ANSI and Unicode modes (for Windows 9x and -ME through the MSLU extension library). wxMSW ensures native look and feel for -XP when using wxWidgets version 2.3.3 or higher.wxMSW can be compiled with a +98, ME, 2000, NT, XP and Vista in ANSI and Unicode modes (for Windows 9x and ME +through the MSLU extension library). wxMSW ensures native look and feel for XP +when using wxWidgets version 2.3.3 or higher. wxMSW can be compiled with a great variety of compilers including Microsoft Studio VC++, Borland 5.5, MinGW32, Cygwin and Watcom as well as cross-compilation with a Linux-hosted MinGW32 tool chain. -For further information, please see the files in docs/msw -in the distribution. - -@subsection page_port_wxmsw_themedborders Themed borders on Windows - -Starting with wxWidgets 2.8.5, you can specify the @c wxBORDER_THEME style to have wxWidgets -use a themed border. Using the default XP theme, this is a thin 1-pixel blue border, -with an extra 1-pixel border in the window client background colour (usually white) to -separate the client area's scrollbars from the border. - -If you don't specify a border style for a wxTextCtrl in rich edit mode, wxWidgets now gives -the control themed borders automatically, where previously they would take the Windows 95-style -sunken border. Other native controls such as wxTextCtrl in non-rich edit mode, and wxComboBox -already paint themed borders where appropriate. To use themed borders on other windows, such -as wxPanel, pass the @c wxBORDER_THEME style, or (apart from wxPanel) pass no border style. - -In general, specifying @c wxBORDER_THEME will cause a border of some kind to be used, chosen by the platform -and control class. To leave the border decision entirely to wxWidgets, pass @c wxBORDER_DEFAULT. -This is not to be confused with specifying @c wxBORDER_NONE, which says that there should -definitely be @e no border. - -@subsubsection page_port_wxmsw_themedborders_details More detail on border implementation - -The way that wxMSW decides whether to apply a themed border is as follows. -The theming code calls wxWindow::GetBorder() to obtain a border. If no border style has been -passed to the window constructor, GetBorder() calls GetDefaultBorder() for this window. -If wxBORDER_THEME was passed to the window constructor, GetBorder() calls GetDefaultBorderForControl(). - -The implementation of wxWindow::GetDefaultBorder() on wxMSW calls wxWindow::CanApplyThemeBorder() -which is a virtual function that tells wxWidgets whether a control can have a theme -applied explicitly (some native controls already paint a theme in which case we should not -apply it ourselves). Note that wxPanel is an exception to this rule because in many cases -we wish to create a window with no border (for example, notebook pages). So wxPanel -overrides GetDefaultBorder() in order to call the generic wxWindowBase::GetDefaultBorder(), -returning wxBORDER_NONE. +For further information, please see the files in docs/msw in the distribution. + +@subsection page_port_wxmsw_themedborders Themed Borders + +Starting with wxWidgets 2.8.5, you can specify the @c wxBORDER_THEME style to +have wxWidgets use a themed border. Using the default XP theme, this is a thin +1-pixel blue border, with an extra 1-pixel border in the window client +background colour (usually white) to separate the client area's scrollbars from +the border. + +If you don't specify a border style for a wxTextCtrl in rich edit mode, +wxWidgets now gives the control themed borders automatically, where previously +they would take the Windows 95-style sunken border. Other native controls such +as wxTextCtrl in non-rich edit mode, and wxComboBox already paint themed +borders where appropriate. To use themed borders on other windows, such as +wxPanel, pass the @c wxBORDER_THEME style, or (apart from wxPanel) pass no +border style. + +In general, specifying @c wxBORDER_THEME will cause a border of some kind to be +used, chosen by the platform and control class. To leave the border decision +entirely to wxWidgets, pass @c wxBORDER_DEFAULT. This is not to be confused +with specifying @c wxBORDER_NONE, which says that there should definitely be +@e no border. + +@subsubsection page_port_wxmsw_themedborders_details Internal Border Implementation + +The way that wxMSW decides whether to apply a themed border is as follows. The +theming code calls wxWindow::GetBorder() to obtain a border. If no border style +has been passed to the window constructor, GetBorder() calls GetDefaultBorder() +for this window. If wxBORDER_THEME was passed to the window constructor, +GetBorder() calls GetDefaultBorderForControl(). + +The implementation of wxWindow::GetDefaultBorder() on wxMSW calls +wxWindow::CanApplyThemeBorder() which is a virtual function that tells +wxWidgets whether a control can have a theme applied explicitly (some native +controls already paint a theme in which case we should not apply it ourselves). +Note that wxPanel is an exception to this rule because in many cases we wish to +create a window with no border (for example, notebook pages). So wxPanel +overrides GetDefaultBorder() in order to call the generic +wxWindowBase::GetDefaultBorder(), returning wxBORDER_NONE. @subsection page_port_wxmsw_wince wxWinCE -wxWinCE is the name given to wxMSW when compiled on Windows CE devices; -most of wxMSW is common to Win32 and Windows CE but there are -some simplifications, enhancements, and differences in -behaviour. +wxWinCE is the name given to wxMSW when compiled on Windows CE devices; most of +wxMSW is common to Win32 and Windows CE but there are some simplifications, +enhancements, and differences in behaviour. -For building instructions, see docs/msw/wince in the -distribution, also the section about Visual Studio 2005 project -files below. The rest of this section documents issues you -need to be aware of when programming for Windows CE devices. +For building instructions, see docs/msw/wince in the distribution, also the +section about Visual Studio 2005 project files below. The rest of this section +documents issues you need to be aware of when programming for Windows CE +devices. -@subsubsection page_port_wxmsw_wince_ General issues for wxWinCE programming +@subsubsection page_port_wxmsw_wince_ General Issues for wxWinCE -Mobile applications generally have fewer features and -simpler user interfaces. Simply omit whole sizers, static -lines and controls in your dialogs, and use comboboxes instead -of listboxes where appropriate. You also need to reduce -the amount of spacing used by sizers, for which you can -use a macro such as this: +Mobile applications generally have fewer features and simpler user interfaces. +Simply omit whole sizers, static lines and controls in your dialogs, and use +comboboxes instead of listboxes where appropriate. You also need to reduce the +amount of spacing used by sizers, for which you can use a macro such as this: @code #if defined(__WXWINCE__) @@ -258,34 +242,33 @@ use a macro such as this: topsizer->Add( CreateTextSizer( message ), 0, wxALL, wxLARGESMALL(10,0) ); @endcode -There is only ever one instance of a Windows CE application running, -and wxWidgets will take care of showing the current instance and -shutting down the second instance if necessary. +There is only ever one instance of a Windows CE application running, and +wxWidgets will take care of showing the current instance and shutting down the +second instance if necessary. -You can test the return value of wxSystemSettings::GetScreenType() -for a qualitative assessment of what kind of display is available, -or use wxGetDisplaySize() if you need more information. +You can test the return value of wxSystemSettings::GetScreenType() for a +qualitative assessment of what kind of display is available, or use +wxGetDisplaySize() if you need more information. -You can also use wxGetOsVersion to test for a version of Windows CE at -run-time (see the next section). However, because different builds -are currently required to target different kinds of device, these -values are hard-wired according to the build, and you cannot -dynamically adapt the same executable for different major Windows CE -platforms. This would require a different approach to the way -wxWidgets adapts its behaviour (such as for menubars) to suit the -style of device. +You can also use wxGetOsVersion to test for a version of Windows CE at run-time +(see the next section). However, because different builds are currently +required to target different kinds of device, these values are hard-wired +according to the build, and you cannot dynamically adapt the same executable +for different major Windows CE platforms. This would require a different +approach to the way wxWidgets adapts its behaviour (such as for menubars) to +suit the style of device. -See the "Life!" example (demos/life) for an example of -an application that has been tailored for PocketPC and Smartphone use. +See the "Life!" example (demos/life) for an example of an application that has +been tailored for PocketPC and Smartphone use. -@note don't forget to have this line in your .rc file, as for - desktop Windows applications: +@note Don't forget to have this line in your .rc file, + as for desktop Windows applications: @verbatim #include "wx/msw/wx.rc" @endverbatim @subsubsection page_port_wxmsw_wince_sdk Testing for WinCE SDKs -Use these preprocessor symbols to test for the different types of device or SDK: +Use these preprocessor symbols to test for the different types of devices: @li @b __SMARTPHONE__ Generic mobile devices with phone buttons and a small display @li @b __PDA__ Generic mobile devices with no phone @@ -296,68 +279,72 @@ Use these preprocessor symbols to test for the different types of device or SDK: @li @b __WINCE_STANDARDSDK__ Microsoft-powered Windows CE devices, for generic Windows CE applications @li @b __WINCE_NET__ Microsoft-powered Windows CE .NET devices (_WIN32_WCE is 400 or greater) -wxGetOsVersion will return these values: +wxGetOsVersion() will return these values: @li @b wxWINDOWS_POCKETPC The application is running under PocketPC. @li @b wxWINDOWS_SMARTPHONE The application is running under Smartphone. @li @b wxWINDOWS_CE The application is running under Windows CE (built with the Standard SDK). - @subsubsection page_port_wxmsw_wince_sizing Window sizing in wxWinCE -Top level windows (dialogs, frames) are created always full-screen. Fit() of sizers will not rescale top -level windows but instead will scale window content. +Top level windows (dialogs, frames) are created always full-screen. Fit() of +sizers will not rescale top level windows but instead will scale window +content. -If the screen orientation changes, the windows will automatically be resized -so no further action needs to be taken (unless you want to change the layout -according to the orientation, which you could detect in idle time, for example). -When input panel (SIP) is shown, top level windows (frames and dialogs) resize -accordingly (see wxTopLevelWindow::HandleSettingChange()). +If the screen orientation changes, the windows will automatically be resized so +no further action needs to be taken (unless you want to change the layout +according to the orientation, which you could detect in idle time, for +example). When input panel (SIP) is shown, top level windows (frames and +dialogs) resize accordingly (see wxTopLevelWindow::HandleSettingChange()). -@subsubsection page_port_wxmsw_wince_toplevel Closing top-level windows in wxWinCE +@subsubsection page_port_wxmsw_wince_toplevel Closing Top-level Windows in wxWinCE -You won't get a wxCloseEvent when the user clicks on the X in the titlebar -on Smartphone and PocketPC; the window is simply hidden instead. However the system may send the -event to force the application to close down. +You won't get a wxCloseEvent when the user clicks on the X in the titlebar on +Smartphone and PocketPC; the window is simply hidden instead. However the +system may send the event to force the application to close down. @subsubsection page_port_wxmsw_wince_hibernation Hibernation in wxWinCE -Smartphone and PocketPC will send a @c wxEVT_HIBERNATE to the application object in low -memory conditions. Your application should release memory and close dialogs, -and wake up again when the next @c wxEVT_ACTIVATE or @c wxEVT_ACTIVATE_APP message is received. -(@c wxEVT_ACTIVATE_APP is generated whenever a @c wxEVT_ACTIVATE event is received -in Smartphone and PocketPC, since these platforms do not support @c WM_ACTIVATEAPP.) +Smartphone and PocketPC will send a @c wxEVT_HIBERNATE to the application +object in low memory conditions. Your application should release memory and +close dialogs, and wake up again when the next @c wxEVT_ACTIVATE or +@c wxEVT_ACTIVATE_APP message is received. (@c wxEVT_ACTIVATE_APP is generated +whenever a @c wxEVT_ACTIVATE event is received in Smartphone and PocketPC, +since these platforms do not support @c WM_ACTIVATEAPP.) -@subsubsection page_port_wxmsw_wince_hwbutt Hardware buttons in wxWinCE +@subsubsection page_port_wxmsw_wince_hwbutt Hardware Buttons in wxWinCE Special hardware buttons are sent to a window via the @c wxEVT_HOTKEY event -under Smartphone and PocketPC. You should first register each required button with -wxWindow::RegisterHotKey(), and unregister the button when you're done with it. For example: +under Smartphone and PocketPC. You should first register each required button +with wxWindow::RegisterHotKey(), and unregister the button when you're done +with it. For example: @code win->RegisterHotKey(0, wxMOD_WIN, WXK_SPECIAL1); win->UnregisterHotKey(0); @endcode -You may have to register the buttons in a @c wxEVT_ACTIVATE event handler -since other applications will grab the buttons. +You may have to register the buttons in a @c wxEVT_ACTIVATE event handler since +other applications will grab the buttons. -There is currently no method of finding out the names of the special -buttons or how many there are. +There is currently no method of finding out the names of the special buttons or +how many there are. @subsubsection page_port_wxmsw_wince_dialogs Dialogs in wxWinCE PocketPC dialogs have an OK button on the caption, and so you should generally -not repeat an OK button on the dialog. You can add a Cancel button if necessary, but some dialogs -simply don't offer you the choice (the guidelines recommend you offer an Undo facility -to make up for it). When the user clicks on the OK button, your dialog will receive -a @c wxID_OK event by default. If you wish to change this, call wxDialog::SetAffirmativeId() -with the required identifier to be used. Or, override wxDialog::DoOK() (return @false to -have wxWidgets simply call Close to dismiss the dialog). +not repeat an OK button on the dialog. You can add a Cancel button if +necessary, but some dialogs simply don't offer you the choice (the guidelines +recommend you offer an Undo facility to make up for it). When the user clicks +on the OK button, your dialog will receive a @c wxID_OK event by default. If +you wish to change this, call wxDialog::SetAffirmativeId() with the required +identifier to be used. Or, override wxDialog::DoOK() (return @false to have +wxWidgets simply call Close to dismiss the dialog). Smartphone dialogs do @e not have an OK button on the caption, and are closed -using one of the two menu buttons. You need to assign these using wxTopLevelWindow::SetLeftMenu -and wxTopLevelWindow::SetRightMenu(), for example: +using one of the two menu buttons. You need to assign these using +wxTopLevelWindow::SetLeftMenu and wxTopLevelWindow::SetRightMenu(), for +example: @code #ifdef __SMARTPHONE__ @@ -370,11 +357,12 @@ and wxTopLevelWindow::SetRightMenu(), for example: #endif @endcode -For implementing property sheets (flat tabs), use a wxNotebook with @c wxNB_FLAT|wxNB_BOTTOM -and have the notebook left, top and right sides overlap the dialog by about 3 pixels -to eliminate spurious borders. You can do this by using a negative spacing in your -sizer Add() call. The cross-platform property sheet dialog wxPropertySheetDialog is -provided, to show settings in the correct style on PocketPC and on other platforms. +For implementing property sheets (flat tabs), use a wxNotebook with +@c wxNB_FLAT|wxNB_BOTTOM and have the notebook left, top and right sides +overlap the dialog by about 3 pixels to eliminate spurious borders. You can do +this by using a negative spacing in your sizer Add() call. The cross-platform +property sheet dialog wxPropertySheetDialog is provided, to show settings in +the correct style on PocketPC and on other platforms. Notifications (bubble HTML text with optional buttons and links) will also be implemented in the future for PocketPC. @@ -383,100 +371,100 @@ Modeless dialogs probably don't make sense for PocketPC and Smartphone, since frames and dialogs are normally full-screen, and a modeless dialog is normally intended to co-exist with the main application frame. -@subsubsection page_port_wxmsw_wince_ppc Menubars and toolbars in PocketPC +@subsubsection page_port_wxmsw_wince_ppc Menubars and Toolbars in PocketPC -On PocketPC, a frame must always have a menubar, even if it's empty. -An empty menubar/toolbar is automatically provided for dialogs, to hide -any existing menubar for the duration of the dialog. +On PocketPC, a frame must always have a menubar, even if it's empty. An empty +menubar/toolbar is automatically provided for dialogs, to hide any existing +menubar for the duration of the dialog. -Menubars and toolbars are implemented using a combined control, -but you can use essentially the usual wxWidgets API; wxWidgets will combine the menubar -and toolbar. However, there are some restrictions: +Menubars and toolbars are implemented using a combined control, but you can use +essentially the usual wxWidgets API; wxWidgets will combine the menubar and +toolbar. However, there are some restrictions: @li You must create the frame's primary toolbar with wxFrame::CreateToolBar(), -because this uses the special wxToolMenuBar class (derived from wxToolBar) -to implement the combined toolbar and menubar. Otherwise, you can create and manage toolbars -using the wxToolBar class as usual, for example to implement an optional -formatting toolbar above the menubar as Pocket Word does. But don't assign -a wxToolBar to a frame using SetToolBar - you should always use CreateToolBar -for the main frame toolbar. -@li Deleting and adding tools to wxToolMenuBar after Realize is called is not supported. -@li For speed, colours are not remapped to the system colours as they are -in wxMSW. Provide the tool bitmaps either with the correct system button background, -or with transparency (for example, using XPMs). -@li Adding controls to wxToolMenuBar is not supported. However, wxToolBar supports -controls. - -Unlike in all other ports, a wxDialog has a wxToolBar automatically created -for you. You may either leave it blank, or access it with wxDialog::GetToolBar() +because this uses the special wxToolMenuBar class (derived from wxToolBar) to +implement the combined toolbar and menubar. Otherwise, you can create and +manage toolbars using the wxToolBar class as usual, for example to implement an +optional formatting toolbar above the menubar as Pocket Word does. But don't +assign a wxToolBar to a frame using SetToolBar - you should always use +CreateToolBar for the main frame toolbar. +@li Deleting and adding tools to wxToolMenuBar after Realize is called is not +@supported. +@li For speed, colours are not remapped to the system colours as they are in +wxMSW. Provide the tool bitmaps either with the correct system button +background, or with transparency (for example, using XPMs). +@li Adding controls to wxToolMenuBar is not supported. However, wxToolBar +supports controls. + +Unlike in all other ports, a wxDialog has a wxToolBar automatically created for +you. You may either leave it blank, or access it with wxDialog::GetToolBar() and add buttons, then calling wxToolBar::Realize(). You cannot set or recreate the toolbar. -@subsubsection page_port_wxmsw_wince_smart Menubars and toolbars in Smartphone +@subsubsection page_port_wxmsw_wince_smart Menubars and Toolbars in Smartphone -On Smartphone, there are only two menu buttons, so a menubar is simulated -using a nested menu on the right menu button. Any toolbars are simply ignored on +On Smartphone, there are only two menu buttons, so a menubar is simulated using +a nested menu on the right menu button. Any toolbars are simply ignored on Smartphone. -@subsubsection page_port_wxmsw_wince_closing Closing windows in wxWinCE +@subsubsection page_port_wxmsw_wince_closing Closing Windows in wxWinCE -The guidelines state that applications should not have a Quit menu item, -since the user should not have to know whether an application is in memory -or not. The close button on a window does not call the window's -close handler; it simply hides the window. However, the guidelines say that -the Ctrl+Q accelerator can be used to quit the application, so wxWidgets -defines this accelerator by default and if your application handles -wxID_EXIT, it will do the right thing. +The guidelines state that applications should not have a Quit menu item, since +the user should not have to know whether an application is in memory or not. +The close button on a window does not call the window's close handler; it +simply hides the window. However, the guidelines say that the Ctrl+Q +accelerator can be used to quit the application, so wxWidgets defines this +accelerator by default and if your application handles wxID_EXIT, it will do +the right thing. -@subsubsection page_port_wxmsw_wince_ctx Context menus in wxWinCE +@subsubsection page_port_wxmsw_wince_ctx Context Menus in wxWinCE -To enable context menus in PocketPC, you currently need to call wxWindow::EnableContextMenu(), -a wxWinCE-only function. Otherwise the context menu event (wxContextMenuEvent) will -never be sent. This API is subject to change. +To enable context menus in PocketPC, you currently need to call +wxWindow::EnableContextMenu(), a wxWinCE-only function. Otherwise the context +menu event (wxContextMenuEvent) will never be sent. This API is subject to +change. Context menus are not supported in Smartphone. -@subsubsection page_port_wxmsw_wince_ctrl Control differences on wxWinCE +@subsubsection page_port_wxmsw_wince_ctrl Control Differences on wxWinCE These controls and styles are specific to wxWinCE: -@li wxTextCtrl The @c wxTE_CAPITALIZE style causes a CAPEDIT control to -be created, which capitalizes the first letter. +@li wxTextCtrl The @c wxTE_CAPITALIZE style causes a CAPEDIT control to be +created, which capitalizes the first letter. These controls are missing from wxWinCE: @li MDI classes MDI is not supported under Windows CE. @li wxMiniFrame Not supported under Windows CE. -Tooltips are not currently supported for controls, since on PocketPC controls with -tooltips are distinct controls, and it will be hard to add dynamic -tooltip support. +Tooltips are not currently supported for controls, since on PocketPC controls +with tooltips are distinct controls, and it will be hard to add dynamic tooltip +support. Control borders on PocketPC and Smartphone should normally be specified with @c wxBORDER_SIMPLE instead of @c wxBORDER_SUNKEN. Controls will usually adapt -appropriately by virtue of their GetDefaultBorder() function, but if you -wish to specify a style explicitly you can use @c wxDEFAULT_CONTROL_BORDER -which will give a simple border on PocketPC and Smartphone, and the sunken border on +appropriately by virtue of their GetDefaultBorder() function, but if you wish +to specify a style explicitly you can use @c wxDEFAULT_CONTROL_BORDER which +will give a simple border on PocketPC and Smartphone, and the sunken border on other platforms. -@subsubsection page_port_wxmsw_wince_help Online help in wxWinCE +@subsubsection page_port_wxmsw_wince_help Online Help in wxWinCE -You can use the help controller wxWinceHelpController which controls -simple @c .htm files, usually installed in the Windows directory. -See the Windows CE reference for how to format the HTML files. +You can use the help controller wxWinceHelpController which controls simple +@c .htm files, usually installed in the Windows directory. See the Windows CE +reference for how to format the HTML files. -@subsubsection page_port_wxmsw_wince_install Installing your PocketPC and Smartphone applications +@subsubsection page_port_wxmsw_wince_install Installing your PocketPC and Smartphone Applications -To install your application, you need to build a CAB file using -the parameters defined in a special .inf file. The CabWiz program -in your SDK will compile the CAB file from the .inf file and -files that it specifies. +To install your application, you need to build a CAB file using the parameters +defined in a special .inf file. The CabWiz program in your SDK will compile the +CAB file from the .inf file and files that it specifies. -For delivery, you can simply ask the user to copy the CAB file to the -device and execute the CAB file using File Explorer. Or, you can -write a program for the desktop PC that will find the ActiveSync -Application Manager and install the CAB file on the device, -which is obviously much easier for the user. +For delivery, you can simply ask the user to copy the CAB file to the device +and execute the CAB file using File Explorer. Or, you can write a program for +the desktop PC that will find the ActiveSync Application Manager and install +the CAB file on the device, which is obviously much easier for the user. Here are some links that may help. @@ -495,29 +483,27 @@ Here are some links that may help. @li Troubleshooting WinCE application installations: http://support.microsoft.com/default.aspx?scid=KB;en-us;q181007 -You may also check out demos/life/setup/wince which contains -scripts to create a PocketPC installation for ARM-based -devices. In particular, @c build.bat builds the distribution and -copies it to a directory called @c Deliver. +You may also check out demos/life/setup/wince which contains scripts +to create a PocketPC installation for ARM-based devices. In particular, +@c build.bat builds the distribution and copies it to a directory called +@c Deliver. @subsubsection page_port_wxmsw_wince_filedlg wxFileDialog in PocketPC -Allowing the user to access files on memory cards, or on arbitrary -parts of the filesystem, is a pain; the standard file dialog only -shows folders under My Documents or folders on memory cards -(not the system or card root directory, for example). This is -a known problem for PocketPC developers. +Allowing the user to access files on memory cards, or on arbitrary parts of the +filesystem, is a pain; the standard file dialog only shows folders under My +Documents or folders on memory cards (not the system or card root directory, +for example). This is a known problem for PocketPC developers. -If you need a file dialog that allows access to all folders, -you can use wxGenericFileDialog instead. You will need to include -@c wx/generic/filedlgg.h. +If you need a file dialog that allows access to all folders, you can use +wxGenericFileDialog instead. You will need to include @c wx/generic/filedlgg.h. @subsubsection page_port_wxmsw_wince_evc Embedded Visual C++ Issues Run-time type information -If you wish to use runtime type information (RTTI) with eVC++ 4, you need to download -an extra library, @c ccrtrtti.lib, and link with it. At the time of +If you wish to use runtime type information (RTTI) with eVC++ 4, you need to +download an extra library, @c ccrtrtti.lib, and link with it. At the time of writing you can get it from here: @verbatim @@ -532,17 +518,18 @@ wxwince26d.lib(control.obj) : error LNK2001: unresolved external symbol "const t Windows Mobile 5.0 emulator -Note that there is no separate emulator configuration for Windows Mobile 5.0: the -emulator runs the ARM code directly. +Note that there is no separate emulator configuration for Windows Mobile 5.0: +the emulator runs the ARM code directly. Visual Studio 2005 project files -Unfortunately, Visual Studio 2005, required to build Windows Mobile 5.0 applications, -doesn't do a perfect job of converting the project files from eVC++ format. +Unfortunately, Visual Studio 2005, required to build Windows Mobile 5.0 +applications, doesn't do a perfect job of converting the project files from +eVC++ format. -When you have converted the wxWidgets workspace, edit the configuration properties -for each configuration and in the Librarian, add a relative path ..\\..\\lib to -each library path. For example: +When you have converted the wxWidgets workspace, edit the configuration +properties for each configuration and in the Librarian, add a relative path +..\\..\\lib to each library path. For example: ..\\$(PlatformName)\\$(ConfigurationName)\\wx_mono.lib. Then, for a sample you want to compile, edit the configuration properties @@ -557,7 +544,7 @@ Also change the Linker/Input/Additional Dependencies property to something like Alternately, you could edit all the names to be identical to the original eVC++ names, but this will probably be more fiddly. -@subsubsection page_port_wxmsw_wince_issues Remaining issues +@subsubsection page_port_wxmsw_wince_issues Remaining Issues These are some of the remaining problems to be sorted out, and features to be supported. @@ -615,7 +602,8 @@ should be catered for, either by hard-wiring the capability into all dialogs and or by providing a standard component and sizer. -@section page_port_nativedocs Documentation for the native toolkits + +@section page_port_nativedocs Native Toolkit Documentation It's sometimes useful to interface directly with the underlying toolkit used by wxWidgets to e.g. use toolkit-specific features. diff --git a/docs/doxygen/mainpages/samples.h b/docs/doxygen/mainpages/samples.h index 68314151aa..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, @@ -43,108 +42,6 @@ may find the following samples showing the corresponding controls: @li wxDataViewCtrl: @ref page_samples_dataview @li wxWebView: @ref page_samples_webview -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{webview} -@li @sample{widgets} -@li @sample{wizard} -@li @sample{wrapsizer} -@li @sample{xrc} - -@endTable - - -

- 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 below, its sources can be found in @c samples/foobar directory of your @@ -158,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 diff --git a/docs/doxygen/mainpages/topics.h b/docs/doxygen/mainpages/topics.h index abdedbcfac..8a3fdffb84 100644 --- a/docs/doxygen/mainpages/topics.h +++ b/docs/doxygen/mainpages/topics.h @@ -10,20 +10,12 @@ @page page_topics Topic Overviews -This chapter contains a selection of topic overviews. -The following is a basic categorization of them: +@tableofcontents -@li @ref page_topics_starting -@li @ref page_topics_programming -@li @ref page_topics_nongui -@li @ref page_topics_drawing -@li @ref page_topics_gui -@li @ref page_topics_indivctrl -@li @ref page_topics_other +The guides here cover all high level details of a full range of development +topics related to building applications with wxWidgets. -

- @section page_topics_starting Starting with wxWidgets @@ -111,4 +103,3 @@ The following is a basic categorization of them: @li @subpage overview_customwidgets */ - diff --git a/docs/doxygen/mainpages/translations.h b/docs/doxygen/mainpages/translations.h index c8c1caca73..b0711fa748 100644 --- a/docs/doxygen/mainpages/translations.h +++ b/docs/doxygen/mainpages/translations.h @@ -11,28 +11,26 @@ @page page_translations Translations +@tableofcontents + wxWidgets uses a certain number of user-readable strings such as -"help" or "Load file" which should be translated to the -users language if it is different from English. wxWidgets has built in support -for internationalization (@e i18n from now on) which allows for this to happen +"help" or "Load file" which should be translated to the users +language if it is different from English. wxWidgets has built in support for +internationalization (@e i18n from now on) which allows for this to happen automatically if the translations to the current language are available. You may find here the list of all existing translations with the addresses of the official translators whom you should contact if you would like to submit any corrections to the translations for your language. -Also, please see @ref page_translations_howtohelp if you would like to translate -wxWidgets to your language if it is not mentioned here (or to help with one which -already is - it is quite helpful to have several translators for one language at -least for proof reading). - -@li @ref page_translations_avail -@li @ref page_translations_howtohelp +Also, please see @ref page_translations_howtohelp if you would like to +translate wxWidgets to your language if it is not mentioned here (or to help +with one which already is - it is quite helpful to have several translators for +one language at least for proof reading). -

-@section page_translations_avail Available translations +@section page_translations_avail Available Translations Below is the table containing the list of languages supported by wxWidgets. The columns of this table have the obvious meaning: in each row you will see @@ -349,7 +347,8 @@ to foil spam robots, remove one \@ from them.
-@section page_translations_howtohelp How to help + +@section page_translations_howtohelp How to Help wxWidgets uses the standard GNU gettext tools for i18n so if you are already familiar with them you diff --git a/docs/doxygen/mainpages/utilities.h b/docs/doxygen/mainpages/utilities.h index a332e15577..a9bd199587 100644 --- a/docs/doxygen/mainpages/utilities.h +++ b/docs/doxygen/mainpages/utilities.h @@ -10,6 +10,8 @@ @page page_utils Utilities Overview +@tableofcontents + In addition to the wxWidgets libraries (see @ref page_libs), some utilities are available to the users in the @c utils hierarchy (even if some of them are explicitly conceived for wxWidgets maintainance and will probably be of @@ -21,14 +23,6 @@ There are lots of other user-contributed and user-maintained packages; see the wxWidgets download page: http://www.wxwidgets.org/downloads or directly http://wxcode.sourceforge.net or http://www.wxcommunity.com/ . -@li @ref page_utils_emulator -@li @ref page_utils_helpview -@li @ref page_utils_hhp2cached -@li @ref page_utils_ifacecheck -@li @ref page_utils_wxrc - - -

@section page_utils_emulator Emulator @@ -60,7 +54,7 @@ of the help viewer. See wxHtmlHelpController for more details. You can find HHP2Cached in @c utils/hhp2cached. -@section page_utils_ifacecheck Interface checker +@section page_utils_ifacecheck Interface Checker This utility compares the wxWidgets real interface contained in the @c include hierarchy with the wxWidgets interface used for documentation purposes and @@ -77,6 +71,14 @@ use for anything else than wxWidgets docs reviewing. You can find it in @c utils/ifacecheck. +@section page_utils_screenshotgen Screenshot Generator + +This utility automates the process of taking screenshots of various GUI +components for use in the HTML documentation of wxWidgets. + +You can find it in @c utils/screenshotgen. + + @section page_utils_wxrc wxWidgets XML Resource Compiler This utility allows the user to compile @e binary versions of their XRC files, diff --git a/docs/doxygen/overviews/app.h b/docs/doxygen/overviews/app.h index 261aa5efbf..443e4dd0ed 100644 --- a/docs/doxygen/overviews/app.h +++ b/docs/doxygen/overviews/app.h @@ -10,13 +10,8 @@ @page overview_app wxApp Overview -Classes: wxApp +@tableofcontents -@li @ref overview_app_intro -@li @ref overview_app_shutdown - - -

@section overview_app_intro Introduction @@ -75,6 +70,7 @@ function which returns a reference to the application object. Otherwise you can only use the global @c wxTheApp pointer which is of type @c wxApp*. + @section overview_app_shutdown Application Shutdown The application normally shuts down when the last of its top level windows is diff --git a/docs/doxygen/overviews/archive.h b/docs/doxygen/overviews/archive.h index 6be6b783c3..f789ff78cf 100644 --- a/docs/doxygen/overviews/archive.h +++ b/docs/doxygen/overviews/archive.h @@ -10,6 +10,8 @@ @page overview_archive Archive Formats +@tableofcontents + The archive classes handle archive formats such as zip, tar, rar and cab. Currently wxZip, wxTar and wxZlib classes are included. @@ -30,17 +32,6 @@ The classes are designed to handle archives on both seekable streams such as disk files, or non-seekable streams such as pipes and sockets (see @ref overview_archive_noseek). -See also wxFileSystem. - -@li @ref overview_archive_create -@li @ref overview_archive_extract -@li @ref overview_archive_modify -@li @ref overview_archive_byname -@li @ref overview_archive_generic -@li @ref overview_archive_noseek - - -

@section overview_archive_create Creating an Archive diff --git a/docs/doxygen/overviews/aui.h b/docs/doxygen/overviews/aui.h index ed857ec3f2..beccf3ed5f 100644 --- a/docs/doxygen/overviews/aui.h +++ b/docs/doxygen/overviews/aui.h @@ -10,17 +10,7 @@ @page overview_aui wxAUI Overview -Classes: -@li wxAuiManager -@li wxAuiPaneInfo -@li wxAuiNotebook -@li wxAuiDockArt -@li wxAuiTabArt -@li wxAuiDefaultTabArt -@li wxAuiToolBar -@li wxAuiToolBarArt -@li wxAuiTabContainer -@li wxAuiTabContainerButton +@tableofcontents wxAUI stands for Advanced User Interface. It aims to give the user a cutting edge interface with floatable windows, and a user-customizable layout. The @@ -28,15 +18,8 @@ original wxAUI sources have kindly been made available under the wxWindows licence by Kirix Corp. and they have since then been integrated into wxWidgets and further improved. -wxAUI attempts to encapsulate the following aspects of the user interface: +@see @ref group_class_aui -@li @ref overview_aui_frame -@li @ref overview_aui_toolbar -@li @ref overview_aui_modeless -@li @ref overview_aui_lnf - - -

@section overview_aui_frame Frame Management @@ -46,6 +29,7 @@ are needed to interact with the document, and allow these configurations to be saved into different perspectives and loaded at a later time. + @section overview_aui_toolbar Toolbars Toolbars are a specialized subset of the frame management system and should @@ -54,6 +38,7 @@ additional functionality, such as "spring-loaded" rebar support, "chevron" buttons and end-user customizability. + @section overview_aui_modeless Modeless Controls Modeless controls expose a tool palette or set of options that float above the @@ -62,6 +47,7 @@ toolbar, these controls disappear when an option is selected, but may also be "torn off" the toolbar into a floating frame of their own. + @section overview_aui_lnf Look and Feel Look and feel encompasses the way controls are drawn, both when shown @@ -75,4 +61,3 @@ possible, such as sizer implementation for frame management. Use classes included in @ref page_libs_wxcore and @ref page_libs_wxbase only. */ - diff --git a/docs/doxygen/overviews/backwardcompatibility.h b/docs/doxygen/overviews/backwardcompatibility.h index 41e2083eb5..90939c936b 100644 --- a/docs/doxygen/overviews/backwardcompatibility.h +++ b/docs/doxygen/overviews/backwardcompatibility.h @@ -10,6 +10,8 @@ @page overview_backwardcompat Backwards Compatibility +@tableofcontents + Many of the GUIs and platforms supported by wxWidgets are continuously evolving, and some of the new platforms wxWidgets now supports were quite unimaginable even a few years ago. In this environment wxWidgets must also @@ -20,13 +22,6 @@ interface across many platforms, but also to provide an interface that is reasonably stable over time, to help protect its users from some of the uncertainty of the future. -@li @ref overview_backwardcompat_versionnumbering -@li @ref overview_backwardcompat_sourcecompat -@li @ref overview_backwardcompat_libbincompat -@li @ref overview_backwardcompat_appbincompat - - -

@section overview_backwardcompat_versionnumbering The Version Numbering Scheme @@ -170,4 +165,3 @@ numbers. It won't, for example, help you write code compatible with 2.6.x using wxWidgets 2.8.x. */ - diff --git a/docs/doxygen/overviews/bitmap.h b/docs/doxygen/overviews/bitmap.h index f7229d2c8c..6b22d1a051 100644 --- a/docs/doxygen/overviews/bitmap.h +++ b/docs/doxygen/overviews/bitmap.h @@ -10,11 +10,7 @@ @page overview_bitmap Bitmaps and Icons -Classes: -@li wxBitmap -@li wxBitmapHandler -@li wxIcon -@li wxCursor +@tableofcontents The wxBitmap class encapsulates the concept of a platform-dependent bitmap, either monochrome or colour. Platform-specific methods for creating a wxBitmap @@ -90,12 +86,9 @@ PNG files embedded in resources (meaning either Windows resource section of the executable file or OS X "Resource" subdirectory of the application bundle) or arrays containing PNG data included into the program code itself. -@li @ref overview_bitmap_supportedformats -@li @ref overview_bitmap_handlers +@see @ref group_class_gdi -

- @section overview_bitmap_supportedformats Supported Bitmap File Formats diff --git a/docs/doxygen/overviews/bookctrl.h b/docs/doxygen/overviews/bookctrl.h index 9b4677e4ee..d711755651 100644 --- a/docs/doxygen/overviews/bookctrl.h +++ b/docs/doxygen/overviews/bookctrl.h @@ -10,25 +10,7 @@ @page overview_bookctrl wxBookCtrl Overview -Classes: - -@li wxChoicebook -@li wxListbook -@li wxNotebook -@li wxSimplebook -@li wxTreebook -@li wxToolbook - -Sections: - -@li @ref overview_bookctrl_intro -@li @ref overview_bookctrl_bestbookctrl - - -

- - -@section overview_bookctrl_intro Introduction +@tableofcontents A book control is a convenient way of displaying multiple pages of information, displayed one page at a time. wxWidgets has five variants of this control: @@ -46,6 +28,10 @@ Notice that wxSimplebook is special in that it only allows the program to change the selection, thus it's usually used in slightly different circumstances than the other variants. +@see @ref group_class_bookctrl + + + @section overview_bookctrl_bestbookctrl Best Book ::wxBookCtrl is mapped to the class best suited for a given platform. Currently diff --git a/docs/doxygen/overviews/bufferclasses.h b/docs/doxygen/overviews/bufferclasses.h index f8727c6727..d44c911e8b 100644 --- a/docs/doxygen/overviews/bufferclasses.h +++ b/docs/doxygen/overviews/bufferclasses.h @@ -10,6 +10,8 @@ @page overview_bufferclasses Buffer Classes +@tableofcontents + wxWidgets uses two classes of classes for dealing with buffers in memory. The first is one for dealing with character buffers, namely wxCharBuffer for @@ -19,10 +21,6 @@ wide character c strings. Secondly, wxWidgets uses, although only rarely currently, wxMemoryBuffer for dealing with raw buffers in memory. -@li @ref overview_bufferclasses_xcb - - -

@section overview_bufferclasses_xcb wxXCharBuffer @@ -46,4 +44,3 @@ the buffer and don't want wxCharBuffer to delete it on destruction, use the member function release to do so. */ - diff --git a/docs/doxygen/overviews/commondialogs.h b/docs/doxygen/overviews/commondialogs.h index bcffd07687..b956bafd15 100644 --- a/docs/doxygen/overviews/commondialogs.h +++ b/docs/doxygen/overviews/commondialogs.h @@ -10,18 +10,7 @@ @page overview_cmndlg Common Dialogs -Classes: - -@li wxColourDialog -@li wxFontDialog -@li wxPrintDialog -@li wxFileDialog -@li wxDirDialog -@li wxTextEntryDialog -@li wxPasswordEntryDialog -@li wxMessageDialog -@li wxSingleChoiceDialog -@li wxMultiChoiceDialog +@tableofcontents Common dialog classes and functions encapsulate commonly-needed dialog box requirements. They are all 'modal', grabbing the flow of control until the user @@ -36,20 +25,9 @@ and a macro defines wxColourDialog to be the same as wxGenericColourDialog on non-MS Windows platforms. However, under MS Windows, the generic dialog can also be used, for testing or other purposes. -@li @ref overview_cmndlg_colour -@li @ref overview_cmndlg_font -@li @ref overview_cmndlg_print -@li @ref overview_cmndlg_file -@li @ref overview_cmndlg_dir -@li @ref overview_cmndlg_textentry -@li @ref overview_cmndlg_password -@li @ref overview_cmndlg_msg -@li @ref overview_cmndlg_singlechoice -@li @ref overview_cmndlg_multichoice +@see @ref group_class_cmndlg -

- @section overview_cmndlg_colour wxColourDialog Overview @@ -109,6 +87,7 @@ if (dialog.ShowModal() == wxID_OK) @endcode + @section overview_cmndlg_font wxFontDialog Overview Classes: wxFontDialog, wxFontData @@ -155,6 +134,7 @@ if (dialog.ShowModal() == wxID_OK) @endcode + @section overview_cmndlg_print wxPrintDialog Overview Classes: wxPrintDialog, wxPrintData @@ -166,6 +146,7 @@ The samples/printing example shows how to use it: see @ref overview_printing for an excerpt from this example. + @section overview_cmndlg_file wxFileDialog Overview Classes: wxFileDialog @@ -197,6 +178,7 @@ description for each, such as: @endverbatim + @section overview_cmndlg_dir wxDirDialog Overview Classes: wxDirDialog @@ -205,6 +187,7 @@ This dialog shows a directory selector dialog, allowing the user to select a single directory. + @section overview_cmndlg_textentry wxTextEntryDialog Overview Classes: wxTextEntryDialog @@ -213,6 +196,7 @@ This is a dialog with a text entry field. The value that the user entered is obtained using wxTextEntryDialog::GetValue(). + @section overview_cmndlg_password wxPasswordEntryDialog Overview Classes: wxPasswordEntryDialog @@ -221,6 +205,7 @@ This is a dialog with a password entry field. The value that the user entered is obtained using wxTextEntryDialog::GetValue(). + @section overview_cmndlg_msg wxMessageDialog Overview Classes: wxMessageDialog @@ -233,6 +218,7 @@ The return value of wxMessageDialog::ShowModal() indicates which button the user pressed. + @section overview_cmndlg_singlechoice wxSingleChoiceDialog Overview Classes: wxSingleChoiceDialog @@ -242,6 +228,7 @@ can select one of them. The selection can be obtained from the dialog as an index, a string or client data. + @section overview_cmndlg_multichoice wxMultiChoiceDialog Overview Classes: wxMultiChoiceDialog @@ -250,4 +237,3 @@ This dialog shows a list of choices, plus OK and (optionally) Cancel. The user can select one or more of them. */ - diff --git a/docs/doxygen/overviews/container.h b/docs/doxygen/overviews/container.h index eaf176e733..023ab9d77b 100644 --- a/docs/doxygen/overviews/container.h +++ b/docs/doxygen/overviews/container.h @@ -10,7 +10,11 @@ @page overview_container Container Classes -Classes: wxList, wxArray, wxVector, wxStack, wxHashMap, wxHashSet +@tableofcontents + +@see @ref group_class_containers + + @section overview_container_intro Overview @@ -47,6 +51,7 @@ wxList when you must, i.e. when you use a wxWidgets function taking or returning a container of such type. + @section overview_container_legacy Legacy Classes The list classes in wxWidgets are doubly-linked lists which may either own the @@ -91,6 +96,7 @@ wxArrayString is somewhat special: it is an optimized version of wxArray which uses its knowledge about wxString reference counting schema. + @section overview_container_std STL Build To build wxWidgets with the standard containers you need to set @@ -125,6 +131,4 @@ default one. Here are the most important differences: class. Please either use std::vector directly or use an integer array instead. - */ - diff --git a/docs/doxygen/regen.bat b/docs/doxygen/regen.bat index 3492e24e3c..fe9e4a94ac 100644 --- a/docs/doxygen/regen.bat +++ b/docs/doxygen/regen.bat @@ -16,8 +16,6 @@ REM These not automatically copied by Doxygen because they're not REM used in doxygen documentation, only in our html footer and by our REM custom aliases copy images\powered-by-wxwidgets.png out\html 2>&1 >NUL -copy images\logo_*.png out\html 2>&1 >NUL -copy images\tab_*.gif out\html 2>&1 >NUL copy images\generic\*.png out\html\generic 2>&1 >NUL copy images\wxgtk\*.png out\html\wxgtk 2>&1 >NUL copy images\wxmsw\*.png out\html\wxmsw 2>&1 >NUL diff --git a/docs/doxygen/regen.sh b/docs/doxygen/regen.sh index 5e2757a57a..4abb91d4af 100755 --- a/docs/doxygen/regen.sh +++ b/docs/doxygen/regen.sh @@ -47,8 +47,6 @@ mkdir -p out/html/generic out/html/wxmsw out/html/wxgtk out/html/wxmac # used in doxygen documentation, only in our html footer and by our # custom aliases cp images/powered-by-wxwidgets.png out/html -cp images/logo_*.png out/html -cp images/tab_*.gif out/html cp images/wxmsw/*png out/html/wxmsw cp images/wxmac/*png out/html/wxmac cp images/wxgtk/*png out/html/wxgtk diff --git a/docs/doxygen/wxwidgets.js b/docs/doxygen/wxwidgets.js index db0f6dba85..714c971dfc 100644 --- a/docs/doxygen/wxwidgets.js +++ b/docs/doxygen/wxwidgets.js @@ -44,13 +44,4 @@ $(function() { setCookie('sectionDiv.style.display', display); }); - list_of_members_link = $('a[href$="-members.html"]:first'); - if(list_of_members_link.length) { - summary_div = $('div.header div.summary:first'); - if(summary_div.length) { - summary_div.append(' | '); - summary_div.append(list_of_members_link.clone().text('List of All Members')); - } - } - }); diff --git a/utils/screenshotgen/src/autocapture.cpp b/utils/screenshotgen/src/autocapture.cpp index b3b74db03e..1ad9723dbb 100644 --- a/utils/screenshotgen/src/autocapture.cpp +++ b/utils/screenshotgen/src/autocapture.cpp @@ -141,7 +141,8 @@ void AutoCaptureMechanism::Save(wxBitmap* screenshot, const wxString& fileName) if (!wxDirExists(default_dir)) wxMkdir(default_dir); - wxFileName fullFileName(default_dir, fileName + ".png"); + wxFileName fullFileName(default_dir, "appear-" + fileName + + "-" + wxPlatformInfo::Get().GetPortIdShortName() + ".png"); // do not overwrite already existing files with this name while (fullFileName.FileExists()) diff --git a/utils/screenshotgen/src/autocapture.h b/utils/screenshotgen/src/autocapture.h index 32dab8836f..36477c3a54 100644 --- a/utils/screenshotgen/src/autocapture.h +++ b/utils/screenshotgen/src/autocapture.h @@ -146,9 +146,7 @@ enum AdjustFlags By default, screenshots are generated under the subdirectory "screenshots" of current working directory. During updating or adding new screenshots, first make sure screenshots are generated correctly, and then copy them to - the following subdirectory of docs/doxygen/images: - - "wxmsw" for MS Windows, "wxgtk" for Linux and "wxmac" for Mac OS. + the "docs/doxygen/images" folder directly. @section tag_gui_assumption The Assumption of GUI -- 2.45.2