Corrected some doc problems
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@3292 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
parent
fb39c7ecd7
commit
d7cb14cec9
@ -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/*.bat
|
||||
distrib/msw/tardist
|
||||
|
@ -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/README.txt
|
||||
distrib/gtk/Setup
|
||||
|
||||
docs/gtk/*.html
|
||||
docs/gtk/*.txt
|
||||
docs/gtk/COPYING.LIB
|
||||
docs/gtk/makewxgtk
|
||||
|
||||
include/wx/gtk/*.h
|
||||
|
@ -48,6 +48,8 @@ include/wx/install-sh
|
||||
|
||||
docs/motif/*.txt
|
||||
docs/motif/makewxmotif
|
||||
docs/motif2/*.txt
|
||||
docs/motif2/COPYING.LIB
|
||||
|
||||
lib/dummy
|
||||
|
||||
|
@ -1,5 +1,7 @@
|
||||
docs/msw/*.txt
|
||||
docs/licence.txt
|
||||
docs/msw/*.txt
|
||||
docs/wine/*.txt
|
||||
docs/wine/COPYING.LIB
|
||||
|
||||
distrib/msw/*.rsp
|
||||
distrib/msw/*.bat
|
||||
|
@ -278,7 +278,7 @@ based on DDE.
|
||||
\twocolitem{\helpref{wxTCPConnection}{wxtcpconnection}}{Represents the connection between a client and a server}
|
||||
\twocolitem{\helpref{wxTCPServer}{wxtcpserver}}{Represents a server}
|
||||
\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}
|
||||
\end{twocollist}
|
||||
|
||||
|
@ -217,6 +217,7 @@
|
||||
\input thread.tex
|
||||
\input time.tex
|
||||
\input timer.tex
|
||||
\input tipprov.tex
|
||||
\input toolbar.tex
|
||||
\input treectrl.tex
|
||||
\input treeevt.tex
|
||||
|
@ -54,9 +54,9 @@ be available.
|
||||
|
||||
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
|
||||
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}
|
||||
|
||||
\func{}{wxDataInputStream}{\param{wxOutputStream\&}{ stream}}
|
||||
\func{}{wxDataOutputStream}{\param{wxOutputStream\&}{ stream}}
|
||||
|
||||
Constructs a datastream object from an output stream. Only write methods will
|
||||
be available.
|
||||
@ -133,9 +133,9 @@ be available.
|
||||
|
||||
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
|
||||
order, e.g. for reading on a Sparc or from Java-Streams (which
|
||||
|
@ -303,7 +303,7 @@ a code to the application. The function \helpref{wxDialog::EndModal}{wxdialogend
|
||||
|
||||
\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}
|
||||
|
||||
\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}
|
||||
|
||||
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}
|
||||
|
||||
\helpref{wxDialog::EndModal}{wxdialogendmodal},\rtfsp
|
||||
\helpref{wxWindow::GetReturnCode}{wxwindowgetreturncode},\rtfsp
|
||||
\helpref{wxWindow::SetReturnCode}{wxwindowsetreturncode}
|
||||
\helpref{wxDialog:GetReturnCode}{wxdialoggetreturncode},\rtfsp
|
||||
\helpref{wxDialog::SetReturnCode}{wxdialogsetreturncode}
|
||||
|
||||
|
||||
|
@ -222,11 +222,11 @@ that it calls \helpref{wxHtmlWindow::LoadPage}{wxhtmlwindowloadpage}.
|
||||
\wxheading{Note}
|
||||
|
||||
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}
|
||||
|
||||
\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}
|
||||
|
||||
|
@ -22,10 +22,12 @@ on number and sizes of its sub-cells (and also depends on width of window).
|
||||
See \helpref{wxHtmlContainerCell}{wxhtmlcontainercell},
|
||||
\helpref{wxHtmlCell::Layout}{wxhtmlcelllayout}.
|
||||
|
||||
\begin{comment}
|
||||
% Bitmap is corrupt!
|
||||
This image shows you cells\ &\ containers:
|
||||
|
||||
\image{}{contbox.bmp}
|
||||
|
||||
\end{comment}
|
||||
\wxheading{Using Containers in Tag Handler}
|
||||
|
||||
\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
|
||||
it returns "control" to the parent container.
|
||||
|
||||
\begin{comment}
|
||||
% Bitmap corrupt!
|
||||
See explanation:
|
||||
|
||||
\image{}{cont.bmp}
|
||||
|
||||
\end{comment}
|
||||
It's clear there must be same number of calls to
|
||||
OpenContainer as to CloseContainer...
|
||||
|
||||
@ -63,9 +67,12 @@ m_WParser -> CloseContainer();
|
||||
m_WParser -> OpenContainer();
|
||||
\end{verbatim}
|
||||
|
||||
\begin{comment}
|
||||
% Bitmap corrupt!
|
||||
and here is image of the situation:
|
||||
|
||||
\image{}{hello.bmp}
|
||||
\end{comment}
|
||||
|
||||
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
|
||||
|
@ -95,7 +95,7 @@ Never used in wxHTML :-)
|
||||
|
||||
{\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
|
||||
{\it tag}. Body of method follows after this macro.
|
||||
Note than you must use { and } ! Example:
|
||||
|
@ -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}.
|
||||
|
||||
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
|
||||
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
|
||||
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
|
||||
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
|
||||
|
@ -10,7 +10,7 @@
|
||||
|
||||
\wxheading{See also}
|
||||
|
||||
\helpref{GSocket for wxWindows}{gsocketforwx}
|
||||
GSocket for wxWindows
|
||||
|
||||
% ---------------------------------------------------------------------------
|
||||
% Event handling
|
||||
@ -81,13 +81,12 @@ Destroys the wxSocketBase object.
|
||||
\func{void}{SetNotify}{\param{GSocketEventFlags}{ event_flags}}
|
||||
|
||||
SetNotify setups which socket events are to be sent to the event handler.
|
||||
For more information on socket events see
|
||||
\helpref{GSocket events}{gsocketforwxevents}.
|
||||
For more information on socket events see GSocket events.
|
||||
|
||||
%
|
||||
% Notify
|
||||
%
|
||||
\membersection{wxSocketBase::Notify}\label{wxsocketbasesetnotify}
|
||||
\membersection{wxSocketBase::Notify}\label{wxsocketbasenotify}
|
||||
|
||||
\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}
|
||||
|
||||
Returns an error in the GSocket format. See \helpref{GSocket errors}{gsocketforwxerrs}.
|
||||
Returns an error in the GSocket format. See GSocket errors.
|
||||
|
||||
% ---------------------------------------------------------------------------
|
||||
% IO calls
|
||||
|
@ -114,7 +114,7 @@ It returns the real read size. If returned size is different of the specified
|
||||
|
||||
\wxheading{See also}
|
||||
|
||||
\helpref{wxStreamBuffer::WriteBack}{wxstreambufferwriteback}
|
||||
\helpref{wxStreamBuffer::Write}{wxstreambufferwrite}
|
||||
|
||||
\func{size\_t}{Read}{\param{wxStreamBuffer *}{buffer}}
|
||||
|
||||
|
@ -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
|
||||
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
|
||||
use it instead of the one returned by
|
||||
\helpref{wxCreateFileTipProvider}{wxcreatefiletipprovider}.
|
||||
use it instead of the one returned by \helpref{wxCreateFileTipProvider}{wxcreatefiletipprovider}.
|
||||
|
||||
\wxheading{Derived from}
|
||||
|
||||
@ -32,14 +31,14 @@ Constructor.
|
||||
|
||||
\docparam{currentTip}{The starting tip index.}
|
||||
|
||||
\membersection{wxTipProvider::GetTip}{wxtipprovidergettip}
|
||||
\membersection{wxTipProvider::GetTip}\label{wxtipprovidergettip}
|
||||
|
||||
\func{wxString}{GetTip}{\void}
|
||||
|
||||
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.
|
||||
|
||||
\membersection{wxCurrentTipProvider::GetCurrentTip}{wxtipprovidergetcurrenttip}
|
||||
\membersection{wxCurrentTipProvider::GetCurrentTip}\label{wxtipprovidergetcurrenttip}
|
||||
|
||||
\constfunc{size\_t}{GetCurrentTip}{\void}
|
||||
|
||||
|
@ -106,7 +106,7 @@ and Unix in their native formats (concerning the line ending).
|
||||
|
||||
\latexignore{\rtfignore{\wxheading{Members}}}
|
||||
|
||||
\membersection{wxTextOutputStream::wxTextOutputStream}\label{wxdataoutputstreamconstr}
|
||||
\membersection{wxTextOutputStream::wxTextOutputStream}\label{wxtextoutputstreamconstr}
|
||||
|
||||
\func{}{wxTextOutputStream}{\param{wxOutputStream\&}{ stream}}
|
||||
|
||||
|
@ -1,5 +1,5 @@
|
||||
[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
|
||||
CONTENTS=Contents
|
||||
COMPRESS=HIGH
|
||||
|
Loading…
Reference in New Issue
Block a user