From 528e0faf1c50e475528de3711061ce9d5f6f8f7d Mon Sep 17 00:00:00 2001 From: Julian Smart Date: Sat, 18 Mar 2000 09:20:21 +0000 Subject: [PATCH] Doc tweaks git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@6818 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775 --- docs/latex/wx/app.tex | 4 ++-- docs/latex/wx/function.tex | 12 ++---------- docs/latex/wx/splitter.bmp | Bin 9232 -> 56958 bytes docs/latex/wx/tdocview.tex | 2 +- docs/latex/wx/ti18n.tex | 3 +-- docs/latex/wx/tnoneng.tex | 2 +- docs/latex/wx/tsamples.tex | 28 ++++++++++++++-------------- 7 files changed, 21 insertions(+), 30 deletions(-) diff --git a/docs/latex/wx/app.tex b/docs/latex/wx/app.tex index ac6b3fb0a8..55249bf1cd 100644 --- a/docs/latex/wx/app.tex +++ b/docs/latex/wx/app.tex @@ -240,7 +240,7 @@ If you use this member, you can selectively consume keypress events by calling\r This function may be called if something fatal happens: an unhandled exception under Win32 or a a fatal signal under Unix, for example. However, this will not happen by default: you have to explicitly call -\helpref{wxHandleFatalExcetions}{wxhandlefatalexcetions} to enable this. +\helpref{wxHandleFatalExceptions}{wxhandlefatalexceptions} to enable this. Generally speaking, this function should only show a message to the user and return. You may attempt to save unsaved data but this is not guaranteed to @@ -248,7 +248,7 @@ work and, in fact, probably won't. \wxheading{See also} -\helpref{wxHandleFatalExcetions}{wxhandlefatalexcetions} +\helpref{wxHandleFatalExcetions}{wxhandlefatalexceptions} \membersection{wxApp::OnIdle}\label{wxapponidle} diff --git a/docs/latex/wx/function.tex b/docs/latex/wx/function.tex index ddfd220486..5f3f54b8ee 100644 --- a/docs/latex/wx/function.tex +++ b/docs/latex/wx/function.tex @@ -953,7 +953,7 @@ Sets the translation (from the top left corner) for PostScript output. The defau \section{Clipboard functions}\label{clipsboard} These clipboard functions are implemented for Windows only. The use of these functions -is deprecated and the code is no longer maintained. Use the \helpref{wxClipboard}{wxclipboard} +is deprecated and the code is no longer maintained. Use the \helpref{wxClipboard}{wxclipboard} class instead. \wxheading{Include files} @@ -1057,14 +1057,6 @@ The clipboard must have previously been opened for this call to succeed. \section{Miscellaneous functions}\label{miscellany} -\membersection{wxHandleFatalExcetions}\label{wxhandlefatalexcetions} - -\func{bool}{wxHandleFatalExcetions}{\param{bool }{doIt = TRUE}} - -Enables or disables handling of fatal program exceptions. If {\it doIt} is -TRUE, \helpref{wxApp::OnFatalException}{wxapponfatalexception} will be called -before the program crashes. Otherwise, the default behaviour will be restored. - \membersection{::wxNewId} \func{long}{wxNewId}{\void} @@ -1186,7 +1178,7 @@ Gets the physical size of the display in pixels. \func{void}{wxEnableTopLevelWindow}{\param{bool}{ enable = TRUE}} -This function enables or disables all top level windows. It is used by +This function enables or disables all top level windows. It is used by \helpref{::wxSafeYield}{wxsafeyield}. \wxheading{Include files} diff --git a/docs/latex/wx/splitter.bmp b/docs/latex/wx/splitter.bmp index d37562d7a2ca5925f7f31fc8e03d1daaa7bc9f2b..d5d50d0096510307296f451934df3ff7207fb4b3 100644 GIT binary patch literal 56958 zcmeI5y>1*g5XWgikmA@7f;>X1JcbY)(gk{jRB3%x)>X8f-T4YP*QHLCK8*^Od4@nw zaBv|&?k@islDo^j{UG;)o;irRyZt8T&)*D}yLU_d^vfUr8BV|B^GCejzcA(pykD3L zUjGfYfB(w9zrz}O+f*8Zmnlm-!6#rCqvaQB}6isDqmc40}OhN~rW|MHIhbZcM`PQ%s|g)xOG zuJE@tR|UO_tL+vu+ropv6fbN_OT+=kP;PX%p#o42l}UwAxjxHkCbk5^@MJkqmIcb7 zyipL9Mhjdlm&|#xhI%o!9M*vBtOk@&y-*Yip#p7Q)l6*GMGy~M-N>@i!1-G-Tzjah zr8U4(l4cbcFi6)>G~)rjV?D`pAUO+ia8Th=&mcgxDBjLF#>Xs}JwtmrN?Vz_hmF0LUXhNrbO2;hKDCaYJGdRkCfl4GLVInW?+~4?qxa0PqwBsVYIw+CS$q+$ z`pThJ(9g ziRB;>Lm~%}7!o;%#E`}z#9+*5_~h9kDINk057!UDavpoTN=a##LJWt46b+Fa$XxOr zeiH$#Fh&;#nEYU@?aj|FviaA=b08GtKh3}V_I8yR84twa8pp$zj@RZ&(-6r)Sk2eRl!EyZ!T7G`y5P80{(7~-zuWMhbm2jLi^I0(lO z!$CTR7!J}gL~sy~A%cT=4C5T+V;JWkAHygI1sFy-D8MkrK?8;{4jM3wa8Q9^go6qU z!yI&A80Me@!ypGG7zQ~g!7#)@3x**MS}+W7P=jHBgBlF|9Q0u5=b#5eF9$^!dO0Y< z(8oa&hCU9OFyMcY^iK^KNj4azWd{zg|BhOXb}YQxag zwra!B(YC6?&=J$>Fq~@8hv8I%J`5)s6k<5hpb!Hz1kcB5!~hM!bBY=Y!%F@*hAcX6$B!uJH$9RhIm+@Hr792+J{+nbsC&9lOZc8)&EoJ(=!QS;u;G_Aai$|A0Kp zl&wF*vApNUkLw)fs=SR0}k`Y zN%U2eWomB*w0wyc=f!m9cp!Th*N~eL=K`bOynR6!!!=EFihhh3&SK1 z!Z1wYAPmD44$?48;UEpe1PrF^Tt>*V;YlzD9sy_i`63uVvwQzA5)LLJa%86b+Fa$XxOreiH$# zFh&;#n7lLA_U7j}=Nx;)bFiM%RAATSuyVMJ$ao+Q!Ari$Ubb8U_1fL|1FOC(Q2 zG>2W&c0Zr1riaUk=0NQb`;wv9w)4u`rTUyKC6a44(HyEn$d9T85i@b|K)(>G&6TDh zl7q0Cuj`ZM;yAQ>N?{&fdnt~CXbf>2WMhcCj+2ccii2BL-*)#%j@sfqbbRD}JvMLn|IsVhA4fhIOdG*i%u&x{#oGa2zWyi1YEhrgM+2H9#Wc=`1I9hwZVQ7hl*VK^ zu!b#-YOFB@8Z-)k%}otj1KVjZS6c*xeqYib(^?@k<3Ya$V-OBnlZ|Pu)?2%uHOS!i z%s~u?&5G$~q~BIf)L&Xr0`gD)nYP-rAcr^Zg!aVKx0im|X@CHvN`o_={1lJ)@C)h1*c(24*1Fh zSIgxSCg!TGVe{|(Yx4>k=>Lpts1B_PYZ}!yH1IZOtDRsCb|n_KgoO5X+v}iMl!Mm* z5Uc_BVoXt54xc{VzrO#cUjwLj$V9r^VVO?>kS_Ib{vot1Y-V4e+J=ze$5P z1MxtC!PRQ3xbiPr%j0sQVDK6~e%!q@--3fnWEv$n1UWh<%fZf5 zcvPwO8o#Q!H5-SIo12%rznU7X8BGmrs<*dkrC;Y2a05^;EO(x+g7 zpfl9*_}Na5mv8LMXV)&RV0@M3VjOxi>g~5yHq4t@ki(z`_AkvJ=W#vlVnp$z)a*pg G_U-=;J1YqQ literal 9232 zcmb`N-)j_E7RQfGlkW6{rU@b;1QAz6M1qJ&5D6g^L1cCu1_>dENDvVT(ui0=hUsP) zX2LS;^n))g%dp5WEX%UY`-=GB!y>ZJGEeyn8Xp4fQ}=$(xz*iO_uj-s*8Y*Ib3Wg5 z?ytIaZJ@+0F|@Y~hkC?^mzww*$gfyRJA>WlyCu+4Ymh!qi$_v!rT-b0(wD6LV~rA| zO-WOcRMHBsrc_dWrSLnr52vuE>K_uBxWO2>>>fXpm|c)oG{-nzB^3QRZr7 z*_2F?ssz0T(G!ctaXcG@%Z6zDMvYEm%+Ly|rF1jnHrmp1YB7~?b+c?Hb7`&kR3%rt z^H#e^zACZRoHjYC3vD#YNDWv*3<+pNK<4~ zKYFA#?mMfWHM%ySW~4y&9Xwig)(K4#v!&Iu-2(MW`NP}@b&u5_+wV_^( znq)n%%B&aarX~3qGpg26SgOonr9A|_s}Vhcde+5f zD9BkyG14_cD{|fb`_t{r7jJi^{8Rd7SEhcl*ayukgW=CZDNkmGLHewaw=I8_cl`#f zIW8sRuDvru{Pxa|%vtYRCC*B1k7&^|<#y{w=Bs!85@&}IzkkFZi7-bgT6&Q(=UJBD zTQt3%Qkh&?GEPU(s5IJ(3;_%wr(-@J&(6bmI(of$1pM@Pj7L9SynG+6ulCOWqwN_L zw8Jp#J^tp}%El|>y!mH7?^=4~dpCQfy+LoW$2~GPy4!-iu67+WQl$smk`WuGIN#H; z5_r(WJnN>p5Yga46Z70K&BdM^V-zsm&|FpsS5Ca>GOz38ocAl!UNSA0w5P?3)_JK_ zr5O23(=J8IiU(cH^Mz?HM>KfQ#5|vy=89^D#dgGl=1Pxww%W|K{54Z7_Zt0TUtxz| z?#;F)Geldi8od(G*r8WEdd=w7fW{8J>d}eONkC(VPCRj))q48 zoeea2>vKJ+?$!6up7FHHXpf_HKEIt9EsJ~gUQZk{I}7O=rw}v z)uq~#g*+ZB=_oqI(emW+gQ725QAJA}^2NS)(f9IEN5_Xm*Osu-h}PL1AJ8)8J(Cxwmz8TQip>KNhS)*?SG+X0Oo`nE@(HhL?du|scp^eLn71T=Q& zJ05+~=(_=p9r~_EpD_AfKx2o#=h4TFz8}!oq3?V2g3;RnjU9U1qvwr&5YX76A9(bf z(anIy4&C(VV@5v=?v>b~A4cw#M@{i4a$mrMCgzzn&Etp$51N>#VVa%Dy#x=Mo#0+l zH^q~nF4*CpMCvkQimxN(!hweca@&p>(xr^ z-Jov<@@%piV~;S{{mY^IgUOyje}VX)b_%UScMAQF?G!#?AK|E#xT z>-EVx-0df9n-H%5bsy`k|J9IN1-rbteL@yb7mc4DFSk!PynK^=!U6UDSi5=t$PUaA z<9z}xf7mWTf4K^F30vLL^q_mX>+ce7cT1f?_e?k3CE!7UC)g$2GR@hz2Tja#(=_KI z8a!yub>q8)P17wpZ+l?5daf(g&U6Ru8Be>6_BdMS^R*Ydve=pKc15y}2EiaQEn%#T?ueuE-$qBG z*9g{`mTFfP@_4MIqv#Yz%ag|simqkna?%oqd~wXW=$(Aj(eWYCHN2HZw9fAMfR-tD zWHxK(aP*R$9>AaVl7Ed{=(3B+)Zul-6-&?F@OqYOpZRh<7!TN?*FBoq1$rZ(u|sco z^rF$50gWAc)1#S7iG4Gmu|wbVXy#<-TLFz7`j$sC>qFlTXzb9pJ^HlKTLFz7dds6v z8GR?9u|wbS=#xg@4QTApcRl)q(f0xxJM=w|K5q2=fW{7e-=i0d-VSK&(Ayq8Z}fwJ z#t!|!qvwon1~hi)rbiz$`eAS{#}554axXt>ibs*V6CN}%&#Y-4M>KfQ#5@ht?5M`O z*Wp346Wr_Srg#$61v~tcNL^-3@pYtJc+kW=HPd_((cnQ7^HfdKK4A5L7oGDKRvx-f zVJ_`3zkM67S~9QBW|`OD#ULGYzblqhcQM^A`8>PsRxH!^Mc(Y1!?Wu;lIXiiPx?o# z#NG}1=F@jEll@Go#gn)xZWl60pL$PQ&1X+-nym5%>7Oz`3TNfvR>8`%Jsy2wM!$?Y8ki8C#B&wajx&bNlG8=36XwJwUZBGzxF#3<0c_s zt;qN7d69m@_w~7Dwe9$SY8l?Xl~?kaB*{=;*Y~dv_mkmp|N6e2bBNh|=ERL*n858P z2`3I5?xP%<53jsT)Dml+?M*zmfU%>$mb&{x!**CDcGf)mI@i?vb6$ zn%#kxSz-0QNMvb}Svy)Y>oY0gz?$}v=BDi}H$|oj`S7VZKI#nSx4AY+PWh( z>YNqZTH6K=nMlN2^I35;lNxwu87-?Btfvgq5f-*~q0ZU$C0+SD|F4AWXC{$4qeg2g z9M>$6H1Hg?E9)djuOm?leK@)*v#2sf6shJS*W9rdTI#XbQ;ZMcidYE7rNySLrg<<- ziDil|(%4fpgq}Ba%xfdgxVTjsYXA78)T7A$wZ^*o**64W?F% p+)V1j()&8UL%ioms_$K=7U!|T*#Yz6@HxL<=#2dfzf{PP{{n&$Pg(!~ diff --git a/docs/latex/wx/tdocview.tex b/docs/latex/wx/tdocview.tex index 05d29bd93a..af54462093 100644 --- a/docs/latex/wx/tdocview.tex +++ b/docs/latex/wx/tdocview.tex @@ -164,7 +164,7 @@ a single document template is constructed, and dialogs will be appropriately simplified. wxDocTemplate is part of the document/view framework supported by wxWindows, -and cooperates with the \helpref{wxView}{wxview}, \helpref{wxDocument}{wxdocument} +and cooperates with the \helpref{wxView}{wxview}, \helpref{wxDocument}{wxdocument} and \helpref{wxDocManager}{wxdocmanager} classes. See the example application in {\tt samples/docview}. diff --git a/docs/latex/wx/ti18n.tex b/docs/latex/wx/ti18n.tex index 0ad497c89c..77641c7457 100644 --- a/docs/latex/wx/ti18n.tex +++ b/docs/latex/wx/ti18n.tex @@ -49,7 +49,6 @@ given language: see \helpref{wxLocale}{wxlocale}. See also the GNU gettext documentation linked from {\tt docs/html/index.htm} in your wxWindows distribution. -See also -\helpref{Writing non-English applications.}{nonenglishoverview} +See also \helpref{Writing non-English applications}{nonenglishoverview}. It focuses on handling charsets related problems. diff --git a/docs/latex/wx/tnoneng.tex b/docs/latex/wx/tnoneng.tex index e4b22730be..e937c42010 100644 --- a/docs/latex/wx/tnoneng.tex +++ b/docs/latex/wx/tnoneng.tex @@ -97,7 +97,7 @@ runtime encoding conversion! \wxheading{Font mapping} -You can use \helpref{wxEncodingConverter}{wxencodingconverter} and +You can use \helpref{wxEncodingConverter}{wxencodingconverter} and \helpref{wxFontMapper}{wxfontmapper} to display text: \begin{verbatim} diff --git a/docs/latex/wx/tsamples.tex b/docs/latex/wx/tsamples.tex index 89a112ad3a..1fa01ecf41 100644 --- a/docs/latex/wx/tsamples.tex +++ b/docs/latex/wx/tsamples.tex @@ -140,7 +140,7 @@ until the program terminates) or asynchronously (notification will come later). \subsection{Scroll subwindow sample}\label{samplescrollsub} -This sample demonstrates the use of the \helpref{wxScrolledWindow}{wxscrolledwindow} +This sample demonstrates the use of the \helpref{wxScrolledWindow}{wxscrolledwindow} class including placing subwindows into it and drawing simple graphics. It uses the \helpref{SetTargetWindow}{wxscrolledwindowsettargetwindow} method and thus the effect of scrolling does not show in the scrolled window itself, but in one of its subwindows. @@ -213,7 +213,7 @@ TODO. Eight HTML samples (you can find them in directory {\tt samples/html}) cover all features of HTML sub-library. -{\bf Test} demonstrates how to create \helpref{wxHtmlWindow}{wxhtmlwindow} +{\bf Test} demonstrates how to create \helpref{wxHtmlWindow}{wxhtmlwindow} and also shows most of supported HTML tags. {\bf Widget} shows how you can embed ordinary controls or windows within @@ -229,7 +229,7 @@ in compressed archive as if they were ordinary files. {\bf Virtual} is yet another VFS demo. This one generates pages at run-time. You may find it useful if you need to display some reports in your application. -{\bf Printing} explains use of \helpref{wxHtmlEasyPrinting}{wxhtmleasyprinting} +{\bf Printing} explains use of \helpref{wxHtmlEasyPrinting}{wxhtmleasyprinting} class which serves as as-simple-as-possible interface for printing HTML documents without much work. In fact, only few function calls are sufficient. @@ -263,14 +263,14 @@ The layout sample demonstrates the two different layout systems offered by wxWindows. When starting the program, you will see a frame with some controls and some graphics. The controls will change their size whenever you resize the entire frame and the exact behaviour of the size changes -is determined using the \helpref{wxLayoutConstraints}{wxlayoutconstraints} -class. See also the \helpref{overview}{constraintsoverview} and the -\helpref{wxIndividualLayoutConstraint}{wxindividuallayoutconstraint} +is determined using the \helpref{wxLayoutConstraints}{wxlayoutconstraints} +class. See also the \helpref{overview}{constraintsoverview} and the +\helpref{wxIndividualLayoutConstraint}{wxindividuallayoutconstraint} class for further information. The menu in this sample offers two more tests, one showing how to use a \helpref{wxBoxSizer}{wxboxsizer} in a simple dialog and the other one -showing how to use sizers in connection with a \helpref{wxNotebook}{wxnotebook} +showing how to use sizers in connection with a \helpref{wxNotebook}{wxnotebook} class. See also \helpref{wxNotebookSizer}{wxnotebooksizer} and \helpref{wxSizer}{wxsizer}. @@ -287,7 +287,7 @@ The sample also provides some timings for adding/deleting/sorting a lot of The sockets sample demonstrates how to use the communication facilities provided by \helpref{wxSocket}{wxsocketbase}. There are two different -applications in this sample: a server, which is implemented using a +applications in this sample: a server, which is implemented using a \helpref{wxSocketServer}{wxsocketserver} object, and a client, which is implemented as a \helpref{wxSocketClient}{wxsocketclient}. @@ -298,7 +298,7 @@ sets up an event handler to be notified of incoming connection requests a new \helpref{wxSocketBase}{wxsocketbase} object is created. These socket objects are independent from the server that created them, so they set up their own event handler, and then request to be notified -of {\bf wxSOCKET\_INPUT} (incoming data) or {\bf wxSOCKET\_LOST} +of {\bf wxSOCKET\_INPUT} (incoming data) or {\bf wxSOCKET\_LOST} (connection closed at the remote end) events. In the sample, the event handler is the same for all connections; to find out which socket the event is addressed to, the \helpref{GetSocket}{wxsocketeventgetsocket} @@ -315,7 +315,7 @@ to specify the address of the server you are going to connect to (the TCP port number is hard-coded as 3000). Once connected, a number of tests are possible. Currently, three tests are implemented. They show how to use the basic IO calls in \helpref{wxSocketBase}{wxsocketbase}, -such as \helpref{Read}{wxsocketbaseread}, \helpref{Write}{wxsocketbasewrite}, +such as \helpref{Read}{wxsocketbaseread}, \helpref{Write}{wxsocketbasewrite}, \helpref{ReadMsg}{wxsocketbasereadmsg} and \helpref{WriteMsg}{wxsocketbasewritemsg}, and how to set up the correct IO flags depending on what you are going to do. See the comments in the code for more information. Note that because @@ -358,7 +358,7 @@ in a log window at the bottom of the main window. By pressing some of the functi keys, you can test some actions in the text ctrl as well as get statitics on the text ctrls, which is useful for testing if these statitics actually are correct. -Thirdly, on platforms which support it, the sample will offer to copy text to the +Thirdly, on platforms which support it, the sample will offer to copy text to the \helpref{wxClipboard}{wxclipboard} and to paste text from it. The GTK version will use the so called PRIMARY SELECTION, which is the pseudo clipboard under X and best known from pasting text to the XTerm program. @@ -375,12 +375,12 @@ is not multi-threading safe, i.e. that it might crash if two threads try to access the GUI class simultaneously. One way to prevent that is have a normal GUI program in the main thread and some worker threads which work in the background. In order to make communication between the main thread and the -worker threads possible, wxWindows offers the \helpref{wxPostEvent}{wxpostevent} +worker threads possible, wxWindows offers the \helpref{wxPostEvent}{wxpostevent} function and this sample makes use of this function. -The other way to use a so called Mutex (such as those offered in the \helpref{wxMutex}{wxmutex} +The other way to use a so called Mutex (such as those offered in the \helpref{wxMutex}{wxmutex} class) that prevent threads from accessing the GUI classes as long as any other -thread accesses them. For this, wxWindows has the \helpref{wxMutexGuiEnter}{wxmutexguienter} +thread accesses them. For this, wxWindows has the \helpref{wxMutexGuiEnter}{wxmutexguienter} and \helpref{wxMutexGuiLeave}{wxmutexguileave} functions, both of which are used and tested in the sample as well. -- 2.45.2