From b82827dd43caa489eade15cc02edef7fb79e8c20 Mon Sep 17 00:00:00 2001 From: Julian Smart Date: Sun, 17 Jan 1999 19:25:06 +0000 Subject: [PATCH] VC++ compilation correction; doc file corrections git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@1418 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775 --- docs/latex/wx/app.tex | 2 - docs/latex/wx/critsect.tex | 7 +++- docs/latex/wx/crtslock.tex | 5 ++- docs/latex/wx/droptrgt.tex | 1 + docs/latex/wx/function.tex | 1 - docs/latex/wx/protocol.tex | 8 +--- docs/latex/wx/stream.tex | 84 ++++++++++++++++++++++++++------------ docs/latex/wx/textfile.tex | 12 +++--- docs/latex/wx/tfile.tex | 4 +- docs/latex/wx/tthreads.tex | 5 ++- docs/latex/wx/txtdrptg.tex | 1 + docs/latex/wx/url.tex | 3 +- docs/latex/wx/window.tex | 2 + src/msw/app.cpp | 3 +- src/msw/dummy.cpp | 2 +- 15 files changed, 87 insertions(+), 53 deletions(-) diff --git a/docs/latex/wx/app.tex b/docs/latex/wx/app.tex index 495ee3f4c0..4581eabe5d 100644 --- a/docs/latex/wx/app.tex +++ b/docs/latex/wx/app.tex @@ -307,8 +307,6 @@ Under Windows, OnQueryEndSession is called in response to the WM\_QUERYENDSESSIO \helpref{wxCloseEvent}{wxcloseevent},\rtfsp \helpref{wxApp::OnEndSession}{wxapponendsession} -\membersection{wxWindow::OnScroll}\label{wxwindowonscroll} - \membersection{wxApp::ProcessMessage}\label{wxappprocessmessage} \func{bool}{ProcessMessage}{\param{MSG *}{msg}} diff --git a/docs/latex/wx/critsect.tex b/docs/latex/wx/critsect.tex index 884c3ed19c..2bc984a077 100644 --- a/docs/latex/wx/critsect.tex +++ b/docs/latex/wx/critsect.tex @@ -20,22 +20,25 @@ None. \wxheading{See also} -\helpref{wxThread}{wxthread}, \helpref{wxCondition}{wxcondition}, +\helpref{wxThread}{wxthread}, \helpref{wxCondition}{wxcondition}, \helpref{wxMutexLocker}{wxmutexlocker}, \helpref{wxCriticalSection}{wxcriticalsection} \latexignore{\rtfignore{\wxheading{Members}}} \membersection{wxCriticalSection::wxCriticalSection}\label{wxcriticalsectionctor} + \func{}{wxCriticalSection}{\void} Default constructor initializes critical section object. \membersection{wxCriticalSection::\destruct{wxCriticalSection}}\label{wxcriticalsectiondtor} + \func{}{\destruct{wxCriticalSection}}{\void} Destructor frees the ressources. \membersection{wxCriticalSection::Enter}\label{wxcriticalsectionenter} + \func{void }{Enter}{\void} Enter the critical section (same as locking a mutex). There is no error return @@ -43,7 +46,9 @@ for this function. After entering the critical section protecting some global data the thread running in critical section may safely use/modify it. \membersection{wxCriticalSection::Leave}\label{wxcriticalsectionleave} + \func{void }{Leave}{\void} Leave the critical section allowing other threads use the global data protected by it. There is no error return for this function. + diff --git a/docs/latex/wx/crtslock.tex b/docs/latex/wx/crtslock.tex index 6a62153d4b..b4212b2577 100644 --- a/docs/latex/wx/crtslock.tex +++ b/docs/latex/wx/crtslock.tex @@ -12,18 +12,21 @@ None. \wxheading{See also} -\helpref{wxCriticalSection}{wxcriticalsection}, +\helpref{wxCriticalSection}{wxcriticalsection}, \helpref{wxMutexLocker}{wxmutexlocker} \latexignore{\rtfignore{\wxheading{Members}}} \membersection{wxCriticalSectionLocker::wxCriticalSectionLocker}\label{wxcriticalsectionlockerctor} + \func{}{wxCriticalSectionLocker}{\param{wxCriticalSection *}{criticalsection}} Constructs a wxCriticalSectionLocker object associated with given criticalsection which must be non NULL and enters it. \membersection{wxCriticalSectionLocker::\destruct{wxCriticalSectionLocker}}\label{wxcriticalsectionlockerdtor} + \func{}{\destruct{wxCriticalSectionLocker}}{\void} Destuctor leaves the criticalsection. + diff --git a/docs/latex/wx/droptrgt.tex b/docs/latex/wx/droptrgt.tex index 0198dda34e..3d38cc476c 100644 --- a/docs/latex/wx/droptrgt.tex +++ b/docs/latex/wx/droptrgt.tex @@ -70,3 +70,4 @@ Return TRUE to accept the data, FALSE to veto the operation. \func{virtual void}{OnLeave}{\void} Called when the mouse leaves the drop target. + diff --git a/docs/latex/wx/function.tex b/docs/latex/wx/function.tex index 2b39374d3a..3a161eeab5 100644 --- a/docs/latex/wx/function.tex +++ b/docs/latex/wx/function.tex @@ -1719,4 +1719,3 @@ This check is done even in release mode. Checks that the condition is true, returns with the given return value if not (FAILs in debug mode). This check is done even in release mode. - diff --git a/docs/latex/wx/protocol.tex b/docs/latex/wx/protocol.tex index c7ae36ef16..730514b43f 100644 --- a/docs/latex/wx/protocol.tex +++ b/docs/latex/wx/protocol.tex @@ -11,7 +11,6 @@ % ---------------------------------------------------------------------------- % Members % ---------------------------------------------------------------------------- - \latexignore{\rtfignore{\membersection{Members}}} \membersection{wxProtocol::Reconnect}\label{wxprotoreconnect} @@ -25,7 +24,6 @@ Tries to reestablish a previous opened connection (close and renegotiate connect TRUE, if the connection is established, else FALSE. % ---------------------------------------------------------------------------- - \membersection{wxProtocol::GetInputStream}\label{wxprotogetinput} \func{wxInputStream *}{GetInputStream}{\param{const wxString\&}{ path}} @@ -39,7 +37,6 @@ http or ftp streams doesn't deal with it. Returns the initialized stream. You will have to delete it yourself. % ---------------------------------------------------------------------------- - \membersection{wxProtocol::Abort}\label{wxprotoabort} \func{bool}{Abort}{\void} @@ -53,7 +50,6 @@ Abort the current stream. Returns TRUE, if successful, else FALSE. % ---------------------------------------------------------------------------- - \membersection{wxProtocol::GetError} \func{wxProtocolError}{GetError}{\void} @@ -72,10 +68,9 @@ Returns the last occured error. \twocolitem{{\bf wxPROTO\_ABRT}}{Last action aborted.} \twocolitem{{\bf wxPROTO\_RCNCT}}{An error occured during reconnection.} \twocolitem{{\bf wxPROTO\_STREAM}}{Someone tried to send a command during a transfer.} -\end{twocollist}% +\end{twocollist} % ---------------------------------------------------------------------------- - \membersection{wxProtocol::GetContentType} \func{wxString}{GetContentType}{\void} @@ -83,7 +78,6 @@ Returns the last occured error. Returns the type of the content of the last opened stream. It is a mime-type. % ---------------------------------------------------------------------------- - \membersection{wxProtocol::SetUser} \func{void }{SetUser}{\param{const wxString\&}{ user}} diff --git a/docs/latex/wx/stream.tex b/docs/latex/wx/stream.tex index e464875640..cd2abb12bf 100644 --- a/docs/latex/wx/stream.tex +++ b/docs/latex/wx/stream.tex @@ -1,37 +1,44 @@ \section{\class{wxStreamBuffer}}\label{wxstreambuf} +\wxheading{Derived from} + +None + \wxheading{See also} + \helpref{wxStreamBase}{wxstreambase} % --------------------------------------------------------------------------- % Members % --------------------------------------------------------------------------- - \latexignore{\rtfignore{\wxheading{Members}}} % ----------- % ctor & dtor % ----------- - \membersection{wxStreamBuffer::wxStreamBuffer} -\func{}{wxStreamBuffer}{\param{wxStreamBase&}{ stream}, \param{BufMode}{ mode}} + +\func{}{wxStreamBuffer}{\param{wxStreamBase\&}{ stream}, \param{BufMode}{ mode}} Constructor, creates a new stream buffer using \it{stream} as a parent stream and \it{mode} as the IO mode. \it{mode} can be: wxStreamBuffer::read, -wxStreamBuffer::write, wxStreamBuffer::read_write. +wxStreamBuffer::write, wxStreamBuffer::read\_write. \membersection{wxStreamBuffer::wxStreamBuffer} + \func{}{wxStreamBuffer}{\param{BufMode}{ mode}} Constructor, creates a new empty stream buffer which won't flush any datas -to a stream. \it{mode} specifies the type of the buffer (read,write,read_write). +to a stream. \it{mode} specifies the type of the buffer (read, write, read\_write). \membersection{wxStreamBuffer::wxStreamBuffer} -\func{}{wxStreamBuffer}{\param{const wxStreamBase&}{ buffer}} + +\func{}{wxStreamBuffer}{\param{const wxStreamBase\&}{ buffer}} Constructor, creates a new stream buffer from the specified stream \it{buffer}. -\membersection{wxStreamBuffer::~wxStreamBuffer} +\membersection{wxStreamBuffer::\destruct{wxStreamBuffer}} + \func{}{\destruct{wxStreamBuffer}} Destructor, destroys the stream buffer. @@ -39,150 +46,173 @@ Destructor, destroys the stream buffer. % ----------- % Filtered IO % ----------- - \membersection{wxStreamBuffer::Read}\label{wxstreambufread} -\func{size_t}{Read}{\param{void *}{buffer}, \param{size_t }{size}} + +\func{size\_t}{Read}{\param{void *}{buffer}, \param{size\_t }{size}} Reads a block of the specified \it{size} and stores datas in \it{buffer}. \wxheading{Return value} -It returns the real read size. If returned size is different of the specified -\it{size}, an error occured and should be tested using +It returns the real read size. If returned size is different of the specified +\it{size}, an error occured and should be tested using \helpref{GetError}{wxstreambasegeterror}. \membersection{wxStreamBuffer::Read}\label{wxstreambufreadbuf} -\func{size_t}{Read}{\param{wxStreamBuffer *}{buffer}} + +\func{size\_t}{Read}{\param{wxStreamBuffer *}{buffer}} Reads a \it{buffer}. The function returns when \it{buffer} is full or when there aren't datas anymore in the current buffer. \membersection{wxStreamBuffer::Write} -\func{size_t}{Write}{\param{const void *}{buffer}, \param{size_t }{size}} + +\func{size\_t}{Write}{\param{const void *}{buffer}, \param{size\_t }{size}} Writes a block of the specified \it{size} using datas of \it{buffer}. \membersection{wxStreamBuffer::Write} -\func{size_t}{Write}{\param{wxStreamBuffer *}{buffer}} + +\func{size\_t}{Write}{\param{wxStreamBuffer *}{buffer}} See \helpref{Read}{wxstreambufreadbuf} \membersection{wxStreamBuffer::WriteBack} -\func{size_t}{WriteBack}{\param{const char *}{buffer}, \param{size_t}{ size}} + +\func{size\_t}{WriteBack}{\param{const char *}{buffer}, \param{size\_t}{ size}} This function is only useful in ``read'' mode. It puts the specified \it{buffer} in the input queue of the stream buf. By this way, the next \helpref{Read}{wxstreambufread} call will first use these datas. \membersection{wxStreamBuffer::WriteBack} -\func{size_t}{WriteBack}{\param{char }{c}} + +\func{size\_t}{WriteBack}{\param{char }{c}} As for the previous function, it puts the specified byte in the input queue of the stream buffer. \membersection{wxStreamBuffer::GetChar} + \func{char}{GetChar}{\void} Gets a single char from the stream buffer. \membersection{wxStreamBuffer::PutChar} + \func{void}{PutChar}{\param{char }{c}} Puts a single char to the stream buffer. \membersection{wxStreamBuffer::Tell} -\constfunc{off_t}{Tell}{\void} + +\constfunc{off\_t}{Tell}{\void} Gets the current position in the \it{stream}. \membersection{wxStreamBuffer::Seek} -\func{off_t}{Seek}{\param{off_t }{pos}, \param{wxSeekMode }{mode}} + +\func{off\_t}{Seek}{\param{off\_t }{pos}, \param{wxSeekMode }{mode}} Changes the current position. (TODO) % -------------- % Buffer control % -------------- - \membersection{wxStreamBuffer::ResetBuffer} + \func{void}{ResetBuffer}{\void} Frees all internal buffers and resets to initial state all variables. \membersection{wxStreamBuffer::SetBufferIO} - \func{void}{SetBufferIO}{\param{char *}{ buffer_start}, \param{char *}{ buffer_end}} + +\func{void}{SetBufferIO}{\param{char *}{ buffer\_start}, \param{char *}{ buffer\_end}} Specifies which pointers to use for stream buffering. You need to pass a pointer on the start of the buffer end and another on the end. \membersection{wxStreamBuffer::SetBufferIO} -\func{void}{SetBufferIO}{\param{size_t}{ bufsize}} + +\func{void}{SetBufferIO}{\param{size\_t}{ bufsize}} Changes the size of the current IO buffer. \membersection{wxStreamBuffer::GetBufferStart} + \constfunc{char *}{GetBufferStart}{\void} Returns a pointer on the start of the stream buffer. \membersection{wxStreamBuffer::GetBufferEnd} + \constfunc{char *}{GetBufferEnd}{\void} Returns a pointer on the end of the stream buffer. \membersection{wxStreamBuffer::GetBufferPos} + \constfunc{char *}{GetBufferPos}{\void} Returns a pointer on the current position of the stream buffer. \membersection{wxStreamBuffer::GetIntPosition} -\constfunc{off_t}{GetIntPosition}{\void} + +\constfunc{off\_t}{GetIntPosition}{\void} Returns the current position in the stream buffer. \membersection{wxStreamBuffer::SetIntPosition} + \func{void}{SetIntPosition}{\void} Sets the current position in the stream buffer. \membersection{wxStreamBuffer::GetLastAccess} -\constfunc{size_t}{GetLastAccess}{\void} + +\constfunc{size\_t}{GetLastAccess}{\void} Returns the amount of bytes read during the last IO call to the parent stream. \membersection{wxStreamBuffer::Fixed} + \func{void}{Fixed}{\param{bool}{ fixed}} -Toggles the fixed flag. Usually this flag is toggled at the same time that -\it{flushable}. This flag allows (when it is false) or not (when it is true) +Toggles the fixed flag. Usually this flag is toggled at the same time as +\it{flushable}. This flag allows (when it is FALSE) or forbids (when it is TRUE) the stream buffer to resize dynamically the IO buffer. \membersection{wxStreamBuffer::Flushable} + \func{void}{Flushable}{\param{bool}{ flushable}} Toggles the flushable flag. If \it{flushable} is disabled, no datas are sent to the parent stream. \membersection{wxStreamBuffer::FlushBuffer} + \func{bool}{FlushBuffer}{\void} Flushes the IO buffer. \membersection{wxStreamBuffer::FillBuffer} + \func{bool}{FillBuffer}{\void} Fill the IO buffer. \membersection{wxStreamBuffer::GetDataLeft} -\func{size_t}{GetDataLeft}{\void} + +\func{size\_t}{GetDataLeft}{\void} Returns the amount of available datas in the buffer. % -------------- % Administration % -------------- - \membersection{wxStreamBuffer::Stream} + \func{wxStreamBase *}{Stream}{\void} Returns the stream parent of the stream buffer. + diff --git a/docs/latex/wx/textfile.tex b/docs/latex/wx/textfile.tex index 713b05bab9..a6ca12687f 100644 --- a/docs/latex/wx/textfile.tex +++ b/docs/latex/wx/textfile.tex @@ -1,4 +1,3 @@ -% automatically generated by HelpGen from textfile.tex at 10/Jan/99 18:47:37 \section{\class{wxTextFile}}\label{wxtextfile} The wxTextFile is a simple class which allows to work with text files on line by @@ -42,10 +41,6 @@ nothing discards them! To save the chanegs you must explicitly call termination type if you wish. \end{itemize} -\wxheading{See also:} - -\helpref{wxFile}{wxfile} - \wxheading{Derived from} No base class @@ -60,12 +55,17 @@ enum wxTextFileType wxTextFileType_Unix, // line is terminated with 'LF' = 0xA = 10 = '\n' wxTextFileType_Dos, // 'CR' 'LF' wxTextFileType_Mac // 'CR' = 0xD = 13 = '\r' -} +}; \end{verbatim} +\wxheading{See also} + +\helpref{wxFile}{wxfile} + \latexignore{\rtfignore{\wxheading{Members}}} \membersection{wxTextFile::wxTextFile}\label{wxtextfilectordef} + \constfunc{}{wxTextFile}{\void} Default constructor, use Open(string) to initialize the object. diff --git a/docs/latex/wx/tfile.tex b/docs/latex/wx/tfile.tex index 44b5028aa7..52c7f65e36 100644 --- a/docs/latex/wx/tfile.tex +++ b/docs/latex/wx/tfile.tex @@ -1,7 +1,6 @@ \section{File classes and functions overview}\label{wxfileoverview} -Classes: \helpref{wxFile}{wxfile}\\ -\helpref{wxTempFile}{wxtempfile}\\ +Classes: \helpref{wxFile}{wxfile}, \helpref{wxTempFile}{wxtempfile}, \helpref{wxTextFile}{wxtextfile} Functions: see \helpref{file functions}{filefunctions}. @@ -25,3 +24,4 @@ by line basis. It is especially well suited for working with configuration files and program source files. It can be also used to work with files with "non native" line termination characters and write them as "native" files if needed (in fact, the files may be written in any format). + diff --git a/docs/latex/wx/tthreads.tex b/docs/latex/wx/tthreads.tex index eff2022d33..42234f0ad9 100644 --- a/docs/latex/wx/tthreads.tex +++ b/docs/latex/wx/tthreads.tex @@ -1,7 +1,8 @@ \section{Multithreading overview}\label{wxthreadoverview} -Classes: \helpref{wxThread}{wxthread}, \helpref{wxMutex}{wxmutex}, -\helpref{wxCriticalSection}{wxcriticalsection}, +Classes: \helpref{wxThread}{wxthread}, \helpref{wxMutex}{wxmutex}, +\helpref{wxCriticalSection}{wxcriticalsection}, \helpref{wxCondition}{wxcondition} TODO + diff --git a/docs/latex/wx/txtdrptg.tex b/docs/latex/wx/txtdrptg.tex index 18c4f53421..7fb0d64000 100644 --- a/docs/latex/wx/txtdrptg.tex +++ b/docs/latex/wx/txtdrptg.tex @@ -57,3 +57,4 @@ Override this function to receive dropped text. \wxheading{Return value} Return TRUE to accept the data, FALSE to veto the operation. + diff --git a/docs/latex/wx/url.tex b/docs/latex/wx/url.tex index 66c49c7aad..91e6ceff73 100644 --- a/docs/latex/wx/url.tex +++ b/docs/latex/wx/url.tex @@ -86,7 +86,8 @@ Returns the initialized stream. You will have to delete it yourself. \wxheading{See also} -\helpref{wxInputStream}{wxinputstream} +%\helpref{wxInputStream}{wxinputstream} +wxInputStream % % SetDefaultProxy diff --git a/docs/latex/wx/window.tex b/docs/latex/wx/window.tex index 011a13f2fa..f086ccca6a 100644 --- a/docs/latex/wx/window.tex +++ b/docs/latex/wx/window.tex @@ -1292,6 +1292,8 @@ void MyWindow::OnPaint(wxPaintEvent& event) \helpref{wxPaintDC}{wxpaintdc},\rtfsp \helpref{Event handling overview}{eventhandlingoverview} +\membersection{wxWindow::OnScroll}\label{wxwindowonscroll} + \func{void}{OnScroll}{\param{wxScrollEvent\& }{event}} Called when a scroll event is received from one of the window's built-in scrollbars. diff --git a/src/msw/app.cpp b/src/msw/app.cpp index 864ab459f4..de414f743c 100644 --- a/src/msw/app.cpp +++ b/src/msw/app.cpp @@ -248,8 +248,7 @@ bool wxApp::Initialize() // This is to foil optimizations in Visual C++ that // throw out dummy.obj. -// #if (_MSC_VER >= 800) && !defined(WXMAKINGDLL) -#if defined(_MSC_VER) && defined(__WIN16__) && !defined(WXMAKINGDLL) +#if defined(_MSC_VER) && !defined(WXMAKINGDLL) extern char wxDummyChar; if (wxDummyChar) wxDummyChar++; #endif diff --git a/src/msw/dummy.cpp b/src/msw/dummy.cpp index e03022c6f5..83850c956c 100644 --- a/src/msw/dummy.cpp +++ b/src/msw/dummy.cpp @@ -41,7 +41,7 @@ // Foils optimizations in Visual C++ (see also app.cpp). Without it, // dummy.obj isn't linked and we get a linker error. -#if defined(_MSC_VER) && defined(__WIN16__) +#if defined(_MSC_VER) char wxDummyChar=0; #endif -- 2.45.2