AuroraMiddleware/wxWidgets
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Corrected some doc problems

Browse Source 
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@3292 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Julian Smart 1999-08-05 15:51:32 +00:00
parent fb39c7ecd7
commit d7cb14cec9
17 changed files with 59 additions and 41 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
distrib/msw/generic.rsp
View File

@ -1,3 +1,21 @@
*.spec
BuildCVS.txt
acconfig.h
*.m4
autogen.sh
config.guess
config.sub
configure.in
install-sh
ltconfig
ltmain.sh
missing
mkinstalldirs
modules
template.mak
wx-config.in
makefile.unx.in
distrib/msw/*.rsp distrib/msw/*.rsp
distrib/msw/*.bat distrib/msw/*.bat
distrib/msw/tardist distrib/msw/tardist

12
distrib/msw/gtk.rsp
View File

@ -1,20 +1,10 @@
install-sh
Makefile
template.mak
configure
configure.in
config.guess
config.sub
wx-config.in
mkinstalldirs
wxGTK.spec
distrib/gtk/copy_src distrib/gtk/copy_src
distrib/gtk/README.txt distrib/gtk/README.txt
distrib/gtk/Setup distrib/gtk/Setup
docs/gtk/*.html docs/gtk/*.html
docs/gtk/*.txt docs/gtk/*.txt
docs/gtk/COPYING.LIB
docs/gtk/makewxgtk docs/gtk/makewxgtk
include/wx/gtk/*.h include/wx/gtk/*.h

2
distrib/msw/motif.rsp
View File

@ -48,6 +48,8 @@ include/wx/install-sh
docs/motif/*.txt docs/motif/*.txt
docs/motif/makewxmotif docs/motif/makewxmotif
docs/motif2/*.txt
docs/motif2/COPYING.LIB
lib/dummy lib/dummy

4
distrib/msw/msw.rsp
View File

@ -1,5 +1,7 @@
docs/msw/*.txt
docs/licence.txt docs/licence.txt
docs/msw/*.txt
docs/wine/*.txt
docs/wine/COPYING.LIB
distrib/msw/*.rsp distrib/msw/*.rsp
distrib/msw/*.bat distrib/msw/*.bat

2
docs/latex/wx/category.tex
View File

@ -278,7 +278,7 @@ based on DDE.
\twocolitem{\helpref{wxTCPConnection}{wxtcpconnection}}{Represents the connection between a client and a server} \twocolitem{\helpref{wxTCPConnection}{wxtcpconnection}}{Represents the connection between a client and a server}
\twocolitem{\helpref{wxTCPServer}{wxtcpserver}}{Represents a server} \twocolitem{\helpref{wxTCPServer}{wxtcpserver}}{Represents a server}
\twocolitem{\helpref{wxSocketClient}{wxsocketclient}}{Represents a socket client} \twocolitem{\helpref{wxSocketClient}{wxsocketclient}}{Represents a socket client}
\twocolitem{\helpref{wxSocketHandler}{wxsockethandler}}{Represents a socket handler} %\twocolitem{\helpref{wxSocketHandler}{wxsockethandler}}{Represents a socket handler}
\twocolitem{\helpref{wxSocketServer}{wxsocketserver}}{Represents a socket server} \twocolitem{\helpref{wxSocketServer}{wxsocketserver}}{Represents a socket server}
\end{twocollist} \end{twocollist}

1
docs/latex/wx/classes.tex
View File

@ -217,6 +217,7 @@
\input thread.tex \input thread.tex
\input time.tex \input time.tex
\input timer.tex \input timer.tex
\input tipprov.tex
\input toolbar.tex \input toolbar.tex
\input treectrl.tex \input treectrl.tex
\input treeevt.tex \input treeevt.tex

10
docs/latex/wx/datstrm.tex
View File

@ -54,9 +54,9 @@ be available.
Destroys the wxDataInputStream object. Destroys the wxDataInputStream object.
\membersection{wxDataInputStream::BidEndianOrdered} \membersection{wxDataInputStream::BigEndianOrdered}
\func{void}{BidEndianOrdered}{\param{bool}{ be_order}} \func{void}{BigEndianOrdered}{\param{bool}{ be_order}}
If {\it be_order} is TRUE, all data will be read in big-endian If {\it be_order} is TRUE, all data will be read in big-endian
order, such as written by programs on a big endian architecture order, such as written by programs on a big endian architecture
@ -118,7 +118,7 @@ See also \helpref{wxDataInputStream}{wxdatainputstream}.
\membersection{wxDataOutputStream::wxDataOutputStream}\label{wxdataoutputstreamconstr} \membersection{wxDataOutputStream::wxDataOutputStream}\label{wxdataoutputstreamconstr}
\func{}{wxDataInputStream}{\param{wxOutputStream\&}{ stream}} \func{}{wxDataOutputStream}{\param{wxOutputStream\&}{ stream}}
Constructs a datastream object from an output stream. Only write methods will Constructs a datastream object from an output stream. Only write methods will
be available. be available.
@ -133,9 +133,9 @@ be available.
Destroys the wxDataOutputStream object. Destroys the wxDataOutputStream object.
\membersection{wxDataOutputStream::BidEndianOrdered} \membersection{wxDataOutputStream::BigEndianOrdered}
\func{void}{BidEndianOrdered}{\param{bool}{ be_order}} \func{void}{BigEndianOrdered}{\param{bool}{ be_order}}
If {\it be_order} is TRUE, all data will be written in big-endian If {\it be_order} is TRUE, all data will be written in big-endian
order, e.g. for reading on a Sparc or from Java-Streams (which order, e.g. for reading on a Sparc or from Java-Streams (which

8
docs/latex/wx/dialog.tex
View File

@ -303,7 +303,7 @@ a code to the application. The function \helpref{wxDialog::EndModal}{wxdialogend
\wxheading{See also} \wxheading{See also}
\helpref{wxWindow::GetReturnCode}{wxwindowgetreturncode}, \helpref{wxDialog::ShowModal}{wxdialogshowmodal},\rtfsp \helpref{wxDialog::GetReturnCode}{wxdialoggetreturncode}, \helpref{wxDialog::ShowModal}{wxdialogshowmodal},\rtfsp
\helpref{wxDialog::EndModal}{wxdialogendmodal} \helpref{wxDialog::EndModal}{wxdialogendmodal}
\membersection{wxDialog::SetTitle}\label{wxdialogsettitle} \membersection{wxDialog::SetTitle}\label{wxdialogsettitle}
@ -341,12 +341,12 @@ Shows a modal dialog. Program flow does not return until the dialog has been dis
\wxheading{Return value} \wxheading{Return value}
The return value is the value set with \helpref{wxWindow::SetReturnCode}{wxwindowsetreturncode}. The return value is the value set with \helpref{wxDialog::SetReturnCode}{wxdialogsetreturncode}.
\wxheading{See also} \wxheading{See also}
\helpref{wxDialog::EndModal}{wxdialogendmodal},\rtfsp \helpref{wxDialog::EndModal}{wxdialogendmodal},\rtfsp
\helpref{wxWindow::GetReturnCode}{wxwindowgetreturncode},\rtfsp \helpref{wxDialog:GetReturnCode}{wxdialoggetreturncode},\rtfsp
\helpref{wxWindow::SetReturnCode}{wxwindowsetreturncode} \helpref{wxDialog::SetReturnCode}{wxdialogsetreturncode}

4
docs/latex/wx/htcell.tex
View File

@ -222,11 +222,11 @@ that it calls \helpref{wxHtmlWindow::LoadPage}{wxhtmlwindowloadpage}.
\wxheading{Note} \wxheading{Note}
If you need more "advanced" behaviour (for example you'd like to catch mouse movement events or If you need more "advanced" behaviour (for example you'd like to catch mouse movement events or
key events or whatsooever) you should use \helpref{wxHtmlBinderCell}{wxhtmlbindercell} instead. key events or whatsoever) you should use wxHtmlBinderCell instead.
\wxheading{Parameters} \wxheading{Parameters}
\docparam{parent}{parent window (always wxHtmlWindow!!)} \docparam{parent}{parent window (always wxHtmlWindow!)}
\docparam{x, y}{coordinates of mouse click (this is relative to cell's origin} \docparam{x, y}{coordinates of mouse click (this is relative to cell's origin}

11
docs/latex/wx/htmlcell.tex
View File

@ -22,10 +22,12 @@ on number and sizes of its sub-cells (and also depends on width of window).
See \helpref{wxHtmlContainerCell}{wxhtmlcontainercell}, See \helpref{wxHtmlContainerCell}{wxhtmlcontainercell},
\helpref{wxHtmlCell::Layout}{wxhtmlcelllayout}. \helpref{wxHtmlCell::Layout}{wxhtmlcelllayout}.
\begin{comment}
% Bitmap is corrupt!
This image shows you cells\ &\ containers: This image shows you cells\ &\ containers:
\image{}{contbox.bmp} \image{}{contbox.bmp}
\end{comment}
\wxheading{Using Containers in Tag Handler} \wxheading{Using Containers in Tag Handler}
\helpref{wxHtmlWinParser}{wxhtmlwinparser} provides user-friendly way \helpref{wxHtmlWinParser}{wxhtmlwinparser} provides user-friendly way
@ -40,10 +42,12 @@ Use \helpref{CloseContaier}{wxhtmlwinparserclosecontainer} to close the
container. This doesn't create new container with same depth level but container. This doesn't create new container with same depth level but
it returns "control" to the parent container. it returns "control" to the parent container.
\begin{comment}
% Bitmap corrupt!
See explanation: See explanation:
\image{}{cont.bmp} \image{}{cont.bmp}
\end{comment}
It's clear there must be same number of calls to It's clear there must be same number of calls to
OpenContainer as to CloseContainer... OpenContainer as to CloseContainer...
@ -63,9 +67,12 @@ m_WParser -> CloseContainer();
m_WParser -> OpenContainer(); m_WParser -> OpenContainer();
\end{verbatim} \end{verbatim}
\begin{comment}
% Bitmap corrupt!
and here is image of the situation: and here is image of the situation:
\image{}{hello.bmp} \image{}{hello.bmp}
\end{comment}
You can see that there was opened container before running the code. We closed You can see that there was opened container before running the code. We closed
it, created our own container, then closed our container and opened it, created our own container, then closed our container and opened

2
docs/latex/wx/htmlhand.tex
View File

@ -95,7 +95,7 @@ Never used in wxHTML :-)
{\bf TAG_HANDLER_PROC}({\it varib}) {\bf TAG_HANDLER_PROC}({\it varib})
This is very important macro. It defines \helpref{HandleTag}{wxhtmlparserhandletag} This is very important macro. It defines \helpref{HandleTag}{wxhtmltaghandlerhandletag}
method. {\it varib} is name of parameter passed to the method, usually method. {\it varib} is name of parameter passed to the method, usually
{\it tag}. Body of method follows after this macro. {\it tag}. Body of method follows after this macro.
Note than you must use { and } ! Example: Note than you must use { and } ! Example:

4
docs/latex/wx/scrolwin.tex
View File

@ -6,7 +6,7 @@ scroll positions, thumb sizes and ranges according to the area in view.
As with all windows, an application can draw onto a wxScrolledWindow using a \helpref{device context}{dcoverview}. As with all windows, an application can draw onto a wxScrolledWindow using a \helpref{device context}{dcoverview}.
You have the option of handling the \helpref{OnPaint}{wxscrolledwindowonpaint} handler You have the option of handling the OnPaint handler
or overriding the \helpref{OnDraw}{wxscrolledwindowondraw} function, which is passed or overriding the \helpref{OnDraw}{wxscrolledwindowondraw} function, which is passed
a pre-scrolled device context (prepared by \helpref{PrepareDC}{wxscrolledwindowpreparedc}). a pre-scrolled device context (prepared by \helpref{PrepareDC}{wxscrolledwindowpreparedc}).
@ -207,7 +207,7 @@ Motif only: TRUE if the window has a backing bitmap.
Call this function to prepare the device context for drawing a scrolled image. It Call this function to prepare the device context for drawing a scrolled image. It
sets the device origin according to the current scroll position. sets the device origin according to the current scroll position.
PrepareDC is called automatically within the default \helpref{wxScrolledWindow::OnPaint}{wxscrolledwindowonpaint} event PrepareDC is called automatically within the default wxScrolledWindow::OnPaint event
handler, so your \helpref{wxScrolledWindow::OnDraw}{wxscrolledwindowondraw} override handler, so your \helpref{wxScrolledWindow::OnDraw}{wxscrolledwindowondraw} override
will be passed a 'pre-scrolled' device context. However, if you wish to draw from will be passed a 'pre-scrolled' device context. However, if you wish to draw from
outside of OnDraw (via OnPaint), or you wish to implement OnPaint yourself, you must outside of OnDraw (via OnPaint), or you wish to implement OnPaint yourself, you must

9
docs/latex/wx/socket.tex
View File

@ -10,7 +10,7 @@
\wxheading{See also} \wxheading{See also}
\helpref{GSocket for wxWindows}{gsocketforwx} GSocket for wxWindows
% --------------------------------------------------------------------------- % ---------------------------------------------------------------------------
% Event handling % Event handling
@ -81,13 +81,12 @@ Destroys the wxSocketBase object.
\func{void}{SetNotify}{\param{GSocketEventFlags}{ event_flags}} \func{void}{SetNotify}{\param{GSocketEventFlags}{ event_flags}}
SetNotify setups which socket events are to be sent to the event handler. SetNotify setups which socket events are to be sent to the event handler.
For more information on socket events see For more information on socket events see GSocket events.
\helpref{GSocket events}{gsocketforwxevents}.
% %
% Notify % Notify
% %
\membersection{wxSocketBase::Notify}\label{wxsocketbasesetnotify} \membersection{wxSocketBase::Notify}\label{wxsocketbasenotify}
\func{void}{Notify}{\param{bool}{ notify}} \func{void}{Notify}{\param{bool}{ notify}}
@ -145,7 +144,7 @@ Returns the number of bytes read or written by the last IO call.
\constfunc{GSocketError}{LastError}{\void} \constfunc{GSocketError}{LastError}{\void}
Returns an error in the GSocket format. See \helpref{GSocket errors}{gsocketforwxerrs}. Returns an error in the GSocket format. See GSocket errors.
% --------------------------------------------------------------------------- % ---------------------------------------------------------------------------
% IO calls % IO calls

2
docs/latex/wx/stream.tex
View File

@ -114,7 +114,7 @@ It returns the real read size. If returned size is different of the specified
\wxheading{See also} \wxheading{See also}
\helpref{wxStreamBuffer::WriteBack}{wxstreambufferwriteback} \helpref{wxStreamBuffer::Write}{wxstreambufferwrite}
\func{size\_t}{Read}{\param{wxStreamBuffer *}{buffer}} \func{size\_t}{Read}{\param{wxStreamBuffer *}{buffer}}

7
docs/latex/wx/tipprov.tex
View File

@ -7,8 +7,7 @@ current tip from it (different tip each time it is called).
You will never use this class yourself, but you need it to show startup tips You will never use this class yourself, but you need it to show startup tips
with wxShowTip. Also, if you want to get the tips text from elsewhere than a with wxShowTip. Also, if you want to get the tips text from elsewhere than a
simple text file, you will want to derive a new class from wxTipProvider and simple text file, you will want to derive a new class from wxTipProvider and
use it instead of the one returned by use it instead of the one returned by \helpref{wxCreateFileTipProvider}{wxcreatefiletipprovider}.
\helpref{wxCreateFileTipProvider}{wxcreatefiletipprovider}.
\wxheading{Derived from} \wxheading{Derived from}
@ -32,14 +31,14 @@ Constructor.
\docparam{currentTip}{The starting tip index.} \docparam{currentTip}{The starting tip index.}
\membersection{wxTipProvider::GetTip}{wxtipprovidergettip} \membersection{wxTipProvider::GetTip}\label{wxtipprovidergettip}
\func{wxString}{GetTip}{\void} \func{wxString}{GetTip}{\void}
Return the text of the current tip and pass to the next one. This function is Return the text of the current tip and pass to the next one. This function is
pure virtual, it should be implemented in the derived classes. pure virtual, it should be implemented in the derived classes.
\membersection{wxCurrentTipProvider::GetCurrentTip}{wxtipprovidergetcurrenttip} \membersection{wxCurrentTipProvider::GetCurrentTip}\label{wxtipprovidergetcurrenttip}
\constfunc{size\_t}{GetCurrentTip}{\void} \constfunc{size\_t}{GetCurrentTip}{\void}

2
docs/latex/wx/txtstrm.tex
View File

@ -106,7 +106,7 @@ and Unix in their native formats (concerning the line ending).
\latexignore{\rtfignore{\wxheading{Members}}} \latexignore{\rtfignore{\wxheading{Members}}}
\membersection{wxTextOutputStream::wxTextOutputStream}\label{wxdataoutputstreamconstr} \membersection{wxTextOutputStream::wxTextOutputStream}\label{wxtextoutputstreamconstr}
\func{}{wxTextOutputStream}{\param{wxOutputStream\&}{ stream}} \func{}{wxTextOutputStream}{\param{wxOutputStream\&}{ stream}}

2
docs/latex/wx/wx.hpj
View File

@ -1,5 +1,5 @@
[OPTIONS] [OPTIONS]
BMROOT=d:\wx2\wxWindows\docs\latex\wx ; Assume that bitmaps are where the source is BMROOT=d:\wx2\wxWind~1\docs/latex/wx ; Assume that bitmaps are where the source is
TITLE=wxWindows Manual TITLE=wxWindows Manual
CONTENTS=Contents CONTENTS=Contents
COMPRESS=HIGH COMPRESS=HIGH