Amebis/wxWidgets
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Doc corrections

Browse Source 
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@31388 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Julian Smart
2005-01-16 13:33:19 +00:00
parent a77d6d2f9e
commit aea22172ef
4 changed files with 15 additions and 24 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -18,7 +18,7 @@ Its main methods are ChangePathTo() and OpenFile(). This class
is most often used by the end user. is most often used by the end user.
\item The \helpref{wxFileSystemHandler}{wxfilesystemhandler} is the core \item The \helpref{wxFileSystemHandler}{wxfilesystemhandler} is the core
of virtual file systems mechanism. You can derive your own handler and pass it to of virtual file systems mechanism. You can derive your own handler and pass it to
of the VFS mechanism. You can derive your own handler and pass it to the VFS mechanism. You can derive your own handler and pass it to
wxFileSystem's AddHandler() method. In the new handler you only need to wxFileSystem's AddHandler() method. In the new handler you only need to
override the OpenFile() and CanOpen() methods. override the OpenFile() and CanOpen() methods.
\end{itemize} \end{itemize}

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

@@ -163,9 +163,7 @@ the user clicks on the Open menu item, the file selector is displayed
with a list of possible file filters -- one for each wxDocTemplate. Selecting with a list of possible file filters -- one for each wxDocTemplate. Selecting
the filter selects the wxDocTemplate, and when the filter selects the wxDocTemplate, and when
a file is selected, that template will be used for creating a document a file is selected, that template will be used for creating a document
and view. Under non-Windows platforms, the user will be prompted for and view.
a list of templates before the file selector is shown, since most file selectors
do not allow a choice of file filters.
For the case where an application has one document type and one view type, For the case where an application has one document type and one view type,
a single document template is constructed, and dialogs will be appropriately a single document template is constructed, and dialogs will be appropriately

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

@@ -203,11 +203,10 @@ The following priorities are defined:
Returns \true if the thread is alive (i.e. started and not terminating). Returns \true if the thread is alive (i.e. started and not terminating).
Note that this function can only be safely used with joinable threads, not Note that this function can only safely be used with joinable threads, not
detached ones as the latter delete themselves and so when the real thread is detached ones as the latter delete themselves and so when the real thread is
not alive any longer it is not possible to call this function neither because no longer alive, it is not possible to call this function because
the wxThread object doesn't exist any more as well. the wxThread object no longer exists.
\membersection{wxThread::IsDetached}\label{wxthreadisdetached} \membersection{wxThread::IsDetached}\label{wxthreadisdetached}

26
docs/latex/wx/tstream.tex
View File

@@ -8,15 +8,15 @@ Classes: \helpref{wxStreamBase}{wxstreambase},
\wxheading{Purpose of wxStream} \wxheading{Purpose of wxStream}
We had troubles with standard C++ streams on several platforms: Standard C++ streams can cause problems on several platforms:
they react quite well in most cases, but in the multi-threaded case, for example, they work quite well in most cases, but in the multi-threaded case, for example,
they have many problems. Some Borland Compilers refuse to work at all they have many problems. Some Borland compilers refuse to work at all
with them and using iostreams on Linux makes writing programs, that are with them and using iostreams on Linux makes writing programs that are
binary compatible across different Linux distributions, impossible. binary compatible across different Linux distributions, impossible.
Therefore, wxStreams have been added to wxWidgets because an application should Therefore, wxStreams have been added to wxWidgets so that applications can
compile and run on all supported platforms and we don't want users to depend on release reliably compile and run on all supported platforms without dependence on a
X.XX of libg++ or some other compiler to run the program. particular release of libg++.
wxStreams is divided in two main parts: wxStreams is divided in two main parts:
@@ -31,8 +31,8 @@ the API of OnSysRead, OnSysWrite, OnSysSeek and OnSysTell. These functions
are really implemented by the "IO" classes. are really implemented by the "IO" classes.
wxInputStream and wxOutputStream inherit from it. wxInputStream and wxOutputStream inherit from it.
wxStreamBuffer is a cache manager for wxStreamBase (it manages a stream buffer wxStreamBuffer is a cache manager for wxStreamBase: it manages a stream buffer
linked to a stream). One stream can have multiple stream buffers but one stream linked to a stream. One stream can have multiple stream buffers but one stream
have always one autoinitialized stream buffer. have always one autoinitialized stream buffer.
wxInputStream is the base class for read-only streams. It implements Read, wxInputStream is the base class for read-only streams. It implements Read,
@@ -82,12 +82,6 @@ code:
// What is my current position ? // What is my current position ?
off_t position = in_stream.TellI(); off_t position = in_stream.TellI();
// wxFileInputStream will close the file descriptor on the destruction. // wxFileInputStream will close the file descriptor on destruction.
\end{verbatim} \end{verbatim}
\wxheading{Compatibility with C++ streams}
As I said previously, we could add a filter stream so it takes an istream
argument and builds a wxInputStream from it: I don't think it should
be difficult to implement it and it may be available in the fix of wxWidgets 2.0.