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

Tidied some docs, made VC++ 6 DLL compilation work with wxvc_dll.dsp,

Browse Source 
removed wxvc6.dsp, updated projgen, small fixes for OGL


git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@4286 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Julian Smart
1999-11-01 20:36:43 +00:00
parent fc9c7c09bd
commit 36edded90c
35 changed files with 972 additions and 1553 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -82,7 +82,7 @@ MyDialog::MyDialog(wxFrame *parent, wxWindowID id, const wxString &title ) :
\wxheading{Derived from}
\helpref{wxSizer}{wxsizer}
\helpref{wxSizer}{wxsizer}\\
\helpref{wxObject}{wxobject}
\membersection{wxBoxSizer::wxBoxSizer}\label{wxboxsizerwxboxsizer}

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

@@ -9,15 +9,15 @@
\input array.tex
\input arrstrng.tex
\input autoobj.tex
\input bitmap.tex
\input bbutton.tex
\input bmpdatob.tex
\input boxsizer.tex
\input brush.tex
\input busycurs.tex
\input busyinfo.tex
\input button.tex
\input strmbfrd.tex
\input bitmap.tex
\input bbutton.tex
\input bmpdatob.tex
\input brush.tex
\input calclevt.tex
\input checkbox.tex
\input checklst.tex

3
docs/latex/wx/conditn.tex
View File

@@ -1,6 +1,6 @@
\section{\class{wxCondition}}\label{wxcondition}
TODO
Condition class for code protection in multithreaded applications.
\wxheading{Derived from}
@@ -62,4 +62,3 @@ Waits until a signal is raised or the timeout has elapsed.
The second form returns if the signal was raised, or FALSE if there was a timeout.

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

@@ -1,6 +1,6 @@
\section{\class{wxCriticalSection}}\label{wxcriticalsection}
A critical section object is used exactly for the same purpose as
A critical section object is used for the same exactly purpose as
\helpref{mutexes}{wxMutex}. The only difference is that under Windows platform
critical sections are only visible inside one process, while mutexes may be
shared between processes, so using critical sections is slightly more

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

@@ -31,6 +31,10 @@ For example:
See also \helpref{wxDataOutputStream}{wxdataoutputstream}.
\wxheading{Derived from}
None
\wxheading{Include files}
<wx/datstrm.h>
@@ -114,6 +118,10 @@ usage and caveats.
See also \helpref{wxDataInputStream}{wxdatainputstream}.
\wxheading{Derived from}
None
\latexignore{\rtfignore{\wxheading{Members}}}
\membersection{wxDataOutputStream::wxDataOutputStream}\label{wxdataoutputstreamconstr}

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

@@ -5,9 +5,9 @@
\section{\class{wxFileSystem}}\label{wxfilesystem}
This class provides interface for opening files on different
This class provides an interface for opening files on different
file systems. It can handle absolute and/or local filenames.
It uses system of \helpref{handlers}{wxfilesystemhandler} to
It uses a system of \helpref{handlers}{wxfilesystemhandler} to
provide access to user-defined virtual file systems.
\wxheading{Derived from}
@@ -16,8 +16,8 @@ wxObject
\wxheading{See Also}
\helpref{wxFileSystemHandler}{wxfilesystemhandler},
\helpref{wxFSFile}{wxfsfile},
\helpref{wxFileSystemHandler}{wxfilesystemhandler},
\helpref{wxFSFile}{wxfsfile},
\helpref{Overview}{fs}
\latexignore{\rtfignore{\wxheading{Members}}}

54
docs/latex/wx/filesysh.tex
View File

@@ -5,12 +5,12 @@
\section{\class{wxFileSystemHandler}}\label{wxfilesystemhandler}
wxFileSystemHandler (or derived classes to be exact) is used
to access virtual file systems. It's public interface consists
from two methods: \helpref{CanOpen}{wxfilesystemhandlercanopen}
Classes derived from wxFileSystemHandler are used
to access virtual file systems. Its public interface consists
of two methods: \helpref{CanOpen}{wxfilesystemhandlercanopen}
and \helpref{OpenFile}{wxfilesystemhandleropenfile}.
It provides additional protected methods to simplify process
of opening the file : GetProtocol, GetLeftLocation, GetRightLocation,
It provides additional protected methods to simplify the process
of opening the file: GetProtocol, GetLeftLocation, GetRightLocation,
GetAnchor, GetMimeTypeFromExt.
Please have a look at \helpref{overview}{fs} if you don't know how locations
@@ -18,13 +18,11 @@ are constructed.
\wxheading{Notes}
\begin{itemize}
\begin{itemize}\itemsep=0pt
\item The handlers are shared by all instances of wxFileSystem.
\item wxHTML library provides handlers for local files and HTTP or FTP protocol
\item The {\it location} parameter passed to OpenFile or CanOpen methods
is always {\bf absolute} path. You don't need to check the FS's current path!
is always an {\bf absolute} path. You don't need to check the FS's current path.
\end{itemize}
\wxheading{Derived from}
@@ -33,8 +31,8 @@ wxObject
\wxheading{See also}
\helpref{wxFileSystem}{wxfilesystem},
\helpref{wxFSFile}{wxfsfile},
\helpref{wxFileSystem}{wxfilesystem},
\helpref{wxFSFile}{wxfsfile},
\helpref{Overview}{fs}
\membersection{wxFileSystemHandler::wxFileSystemHandler}\label{wxfilesystemhandlerwxfilesystemhandler}
@@ -47,8 +45,8 @@ Constructor.
\func{virtual bool}{CanOpen}{\param{const wxString\& }{location}}
Returns TRUE if the handler is able to open this file (this function doesn't
check whether the file exists or not, it only checks if it knows the protocol).
Returns TRUE if the handler is able to open this file. This function doesn't
check whether the file exists or not, it only checks if it knows the protocol.
Example:
\begin{verbatim}
@@ -58,24 +56,24 @@ bool MyHand::CanOpen(const wxString& location)
}
\end{verbatim}
Must be overwriten in derived handlers.
Must be overridden in derived handlers.
\membersection{wxFileSystemHandler::GetAnchor}\label{wxfilesystemhandlergetanchor}
\constfunc{wxString}{GetAnchor}{\param{const wxString\& }{location}}
Returns anchor if present in the location.
Returns the anchor if present in the location.
See \helpref{wxFSFile}{wxfsfilegetanchor} for details.
Example : GetAnchor("index.htm\#chapter2") == "chapter2"
Example: GetAnchor("index.htm\#chapter2") == "chapter2"
{\bf Note:} anchor is NOT part of left location.
{\bf Note:} the anchor is NOT part of the left location.
\membersection{wxFileSystemHandler::GetLeftLocation}\label{wxfilesystemhandlergetleftlocation}
\constfunc{wxString}{GetLeftLocation}{\param{const wxString\& }{location}}
Returns left location string extracted from {\it location}.
Returns the left location string extracted from {\it location}.
Example: GetLeftLocation("file:myzipfile.zip\#zip:index.htm") == "file:myzipfile.zip"
@@ -83,8 +81,8 @@ Example: GetLeftLocation("file:myzipfile.zip\#zip:index.htm") == "file:myzipfile
\func{wxString}{GetMimeTypeFromExt}{\param{const wxString\& }{location}}
Returns MIME type based on {\bf extension} of {\it location}. (While wxFSFile::GetMimeType
returns real MIME type - either extension-based or queried from HTTP)
Returns the MIME type based on {\bf extension} of {\it location}. (While wxFSFile::GetMimeType
returns real MIME type - either extension-based or queried from HTTP.)
Example : GetMimeTypeFromExt("index.htm") == "text/html"
@@ -92,7 +90,7 @@ Example : GetMimeTypeFromExt("index.htm") == "text/html"
\constfunc{wxString}{GetProtocol}{\param{const wxString\& }{location}}
Returns protocol string extracted from {\it location}.
Returns the protocol string extracted from {\it location}.
Example: GetProtocol("file:myzipfile.zip\#zip:index.htm") == "zip"
@@ -100,14 +98,10 @@ Example: GetProtocol("file:myzipfile.zip\#zip:index.htm") == "zip"
\constfunc{wxString}{GetRightLocation}{\param{const wxString\& }{location}}
Returns right location string extracted from {\it location}.
Returns the right location string extracted from {\it location}.
Example : GetRightLocation("file:myzipfile.zip\#zip:index.htm") == "index.htm"
\membersection{wxFileSystemHandler::FindFirst}\label{wxfilesystemfindfirst}
\func{virtual wxString}{FindFirst}{\param{const wxString\& }{wildcard}, \param{int }{flags = 0}}
@@ -125,9 +119,7 @@ This method is only called if \helpref{CanOpen}{wxfilesystemhandlercanopen} retu
Returns next filename that matches parameters passed to \helpref{FindFirst}{wxfilesystemfindfirst}.
This method is only called if \helpref{CanRead}{wxfilesystemhandlercanread} returns TRUE and FindFirst
returned non-empty string.
returned a non-empty string.
\membersection{wxFileSystemHandler::OpenFile}\label{wxfilesystemhandleropenfile}
@@ -135,12 +127,12 @@ returned non-empty string.
Opens the file and returns wxFSFile pointer or NULL if failed.
Must be overwriten in derived handlers.
Must be overridden in derived handlers.
\wxheading{Parameters}
\docparam{fs}{Parent FS (the FS from that OpenFile was called). See ZIP handler
for details how to use it.}
for details of how to use it.}
\docparam{location}{The {\bf absolute} location of file.}

14
docs/latex/wx/filetype.tex
View File

@@ -1,6 +1,6 @@
\section{\class{wxFileType}}\label{wxfiletype}
This class holds information about a given "file type". File type is the same as
This class holds information about a given {\it file type}. File type is the same as
MIME type under Unix, but under Windows it corresponds more to an extension than
to MIME type (in fact, several extensions may correspond to a file type). This
object may be created in several different ways: the program might know the file
@@ -13,14 +13,14 @@ will be returned if the corresponding information couldn't be found.
The objects of this class are never created by the application code but are
returned by \helpref{wxMimeTypesManager::GetFileTypeFromMimeType}{wxmimetypesmanagergetfiletypefrommimetype} and
\helpref{wxMimeTypesManager::GetFileTypeFromExtension}{wxmimetypesmanagergetfiletypefromextension} methods.
But it's your responsability to delete the returned pointer when you're done
But it's your responsibility to delete the returned pointer when you're done
with it!
% TODO describe MIME types better than this...
A brief remainder about what the MIME types are (see the RFC 1341 for more
information): basicly, it is just a pair category/type (for example,
"text/plain") where the category is a basic indication of what a file is
(examples of categories are "application", "image", "text", "binary"...) and
A brief reminder about what the MIME types are (see the RFC 1341 for more
information): basically, it is just a pair category/type (for example,
"text/plain") where the category is a basic indication of what a file is.
Examples of categories are "application", "image", "text", "binary", and
type is a precise definition of the document format: "plain" in the example
above means just ASCII text without any formatting, while "text/html" is the
HTML document source.
@@ -31,7 +31,7 @@ typically correspond to the extension ".txt", but may as well be associated with
\wxheading{Derived from}
No base class.
None
\wxheading{Include files}

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

@@ -3,6 +3,10 @@
% -----------------------------------------------------------------------------
\section{\class{wxFilterInputStream}}\label{wxfilterinputstream}
A filter stream has the capability of a normal stream but it can be placed on top
of another stream. So, for example, it can uncompress, uncrypt the datas which are read
from another stream and pass it to the requester.
\wxheading{Derived from}
\helpref{wxInputStream}{wxinputstream}\\
@@ -24,8 +28,5 @@ differs and it is documented below.
\func{}{wxFilterInputStream}{\param{wxInputStream\&}{ stream}}
Initializes a "filter" stream. A filter stream has the capability of a normal
stream but it can be placed on the top of another stream. So, for example, it
can uncompress, uncrypt the datas which are read from another stream and pass it
to the requester.
Initializes a "filter" stream.

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

@@ -3,6 +3,11 @@
% -----------------------------------------------------------------------------
\section{\class{wxFilterOutputStream}}\label{wxfilteroutputstream}
A filter stream has the capability of a normal
stream but it can be placed on top of another stream. So, for example, it
can compress, encrypt the data which are passed to it and write them to another
stream.
\wxheading{Derived from}
\helpref{wxOutputStream}{wxoutputstream}\\
@@ -24,8 +29,5 @@ differs and it is documented below.
\func{}{wxFilterOutputStream}{\param{wxOutputStream\&}{ stream}}
Initializes a "filter" stream. A filter stream has the capability of a normal
stream but it can be placed on the top of another stream. So, for example, it
can compress, crypt the datas which are passed to it and write them to another
stream.
Initializes a "filter" stream.

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

@@ -5,8 +5,8 @@
\section{\class{wxFSFile}}\label{wxfsfile}
This class represents single file opened by \helpref{wxFileSystem}{wxfilesystem}.
It provides more information than wx's input stream
This class represents a single file opened by \helpref{wxFileSystem}{wxfilesystem}.
It provides more information than wxWindow's input stream
(stream, filename, mime type, anchor).
{\bf Note:} Any pointer returned by wxFSFile's member is valid

3
docs/latex/wx/hthelpct.tex
View File

@@ -19,7 +19,8 @@ wxHTML uses Microsoft's HTML Help Workshop project files (.hhp, .hhk, .hhc) as i
native format. The file format is described \helpref{here}{helpformat}.
Have a look at docs/html/ directory where sample project files are stored.
You can use tex2rtf to generate MHHW projects (see wxHTML homepage for details).
You can use Tex2RTF to produce these files when generating HTML, if you set {\bf htmlWorkshopFiles} to {\bf true} in
your tex2rtf.ini file.
In order to use the controller in your application under Windows you must
have the following line in your .rc file:

12
docs/latex/wx/htmlhlpf.tex
View File

@@ -1,6 +1,8 @@
\membersection{Help Files Format}\label{helpformat}
wxHTML library uses a reduced version of MS HTML Workshop format.
Tex2RTF can produce these files when generating HTML, if you set {\bf htmlWorkshopFiles} to {\bf true} in
your tex2rtf.ini file.
(See \helpref{wxHtmlHelpController}{wxhtmlhelpcontroller} for help controller description.)
@@ -17,15 +19,15 @@ Title=@title of your book@
Default topic=@default page to be displayed.htm@
\end{verbatim}
All filenames (including Default topic) are relative to the location of .hhp file.
All filenames (including the Default topic) are relative to the location of .hhp file.
For larger projects I recommend storing everything but .hhp file into one .zip archive. (E.g. contents file
would then be reffered as myhelp.zip\#zip:contents.hhc)
For larger projects I recommend storing everything but .hhp file into one .zip archive. (The contents file
would then be referred to as myhelp.zip\#zip:contents.hhc)
\wxheading{Contents file (.hhc)}
Contents file has HTML syntax and it can be parsed by regular HTML parser. It contains exactly one list
(<ul>....</ul> statement):
(\verb$<ul>$....\verb$</ul>$ statement):
\begin{verbatim}
<ul>
@@ -49,7 +51,7 @@ You can modify value attributes of param tags. {\it topic name} is name of chapt
contents, {\it filename.htm} is HTML page name (relative to .hhp file) and {\it numeric_id} is optional
- it is used only when you use \helpref{wxHtmlHelpController::Display(int)}{wxhtmlhelpcontrollerdisplay}
Items in the list may be nested - one \<li\> statement may contain \<ul\> sub-statement:
Items in the list may be nested - one \verb$<li>$ statement may contain a \verb$<ul>$ sub-statement:
\begin{verbatim}
<ul>

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

@@ -64,5 +64,5 @@ borders (space between border of window and displayed HTML). Related functions:
\end{itemize}
The last two functions are used to store user customization info wxConfig stuff
(for example registry under Windows or dotfile under Unix).
(for example in the registry under Windows, or in a dotfile under Unix).

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

@@ -1,7 +1,7 @@
\section{\class{wxSizer}}\label{wxsizer}
wxSizer is the abstract base class used for laying out subwindows in a window. You
cannot use wxSizer directly; instead, you'll have to use \helpref{wxBoxSizer}{wxboxsizer}
cannot use wxSizer directly; instead, you'll have to use \helpref{wxBoxSizer}{wxboxsizer}
or \helpref{wxStaticBoxSizer}{wxstaticboxsizer}.
The layout algorithm used by sizers in wxWindows closely related to layout

22
docs/latex/wx/strmbfrd.tex
View File

@@ -3,6 +3,10 @@
% -----------------------------------------------------------------------------
\section{\class{wxBufferedInputStream}}\label{wxbufferedinputstream}
This stream acts as a cache. It caches the bytes read from the specified
input stream (See \helpref{wxFilterInputStream}{wxfilterinputstream}).
It uses wxStreamBuffer and sets the default in-buffer size to 1024 bytes.
\wxheading{Derived from}
\helpref{wxFilterInputStream}{wxfilterinputstream}
@@ -15,17 +19,16 @@
\helpref{wxStreamBuffer}{wxstreamBuffer}, \helpref{wxInputStream}{wxinputstream}
\wxheading{Short description}
This stream acts as a cache. It caches the bytes read from the specified
input stream (See \helpref{wxFilterInputStream}{wxfilterinputstream}).
It uses wxStreamBuffer and sets the default in-buffer size to 1024 bytes.
% -----------------------------------------------------------------------------
% wxBufferedOutputStream
% -----------------------------------------------------------------------------
\section{\class{wxBufferedOutputStream}}\label{wxbufferedoutputstream}
This stream acts as a cache. It caches the bytes to be written to the specified
output stream (See \helpref{wxFilterOutputStream}{wxfilteroutputstream}). The
datas are only written when the cache is full or when the buffered stream is
destroyed.
\wxheading{Derived from}
\helpref{wxFilterOutputStream}{wxfilteroutputstream}
@@ -38,10 +41,3 @@ It uses wxStreamBuffer and sets the default in-buffer size to 1024 bytes.
\helpref{wxStreamBuffer}{wxstreamBuffer}, \helpref{wxOutputStream}{wxoutputstream}
\wxheading{Short description}
This stream acts as a cache. It caches the bytes to be written to the specified
output stream (See \helpref{wxFilterOutputStream}{wxfilteroutputstream}). The
datas are only written when the cache is full or when the buffered stream is
destroyed.

13
docs/latex/wx/strmfile.tex
View File

@@ -3,7 +3,7 @@
% -----------------------------------------------------------------------------
\section{\class{wxFileInputStream}}\label{wxfileinputstream}
This classes represent data streams to and from a file. There are actually
This class represents data read in from a file. There are actually
two such groups of classes: those documented here, and another group called
wxFFileInputStream, wxFFileOutputStream and wxFFileStream which are not
based on file descriptors (and their wxWindows equivalent wxFile) but the
@@ -20,7 +20,7 @@ instead if "int fd") their interface is identical.
\wxheading{See also}
\helpref{wxStreamBuffer}{wxstreamBuffer}
\helpref{wxStreamBuffer}{wxstreamBuffer}, \helpref{wxFileOutputStream}{wxfileoutputstream}
% ----------
% Members
@@ -58,6 +58,13 @@ Returns TRUE if the stream is initialized and ready.
% -----------------------------------------------------------------------------
\section{\class{wxFileOutputStream}}\label{wxfileoutputstream}
This class represents data written to a file. There are actually
two such groups of classes: those documented here, and another group called
wxFFileInputStream, wxFFileOutputStream and wxFFileStream which are not
based on file descriptors (and their wxWindows equivalent wxFile) but the
FILE* type (and wxFFile). Apart from the different constructor ("FILE *file"
instead if "int fd") their interface is identical.
\wxheading{Derived from}
\helpref{wxOutputStream}{wxoutputstream}
@@ -68,7 +75,7 @@ Returns TRUE if the stream is initialized and ready.
\wxheading{See also}
\helpref{wxStreamBuffer}{wxstreamBuffer}
\helpref{wxStreamBuffer}{wxstreamBuffer}, \helpref{wxFileInputStream}{wxfileinputstream}
% ----------
% Members

16
docs/latex/wx/strmzlib.tex
View File

@@ -3,6 +3,9 @@
% -----------------------------------------------------------------------------
\section{\class{wxZlibInputStream}}\label{wxzlibinputstream}
This stream uncompresses all data read from it. It uses the "filtered"
stream to get new compressed data.
\wxheading{Derived from}
\helpref{wxFilterInputStream}{wxfilterinputstream}
@@ -15,16 +18,14 @@
\helpref{wxStreamBuffer}{wxstreamBuffer}, \helpref{wxInputStream}{wxinputstream}
\wxheading{Short description}
This stream uncompresses all data read from it. It uses the "filtered"
stream to get new compressed data.
% -----------------------------------------------------------------------------
% wxZlibOutputStream
% -----------------------------------------------------------------------------
\section{\class{wxZlibOutputStream}}\label{wxzliboutputstream}
This stream compresses all data written to it, and passes the compressed data
to the ``filtered'' stream.
\wxheading{Derived from}
\helpref{wxFilterOutputStream}{wxfilteroutputstream}
@@ -37,8 +38,3 @@ stream to get new compressed data.
\helpref{wxStreamBuffer}{wxstreamBuffer}, \helpref{wxOutputStream}{wxoutputstream}
\wxheading{Short description}
This stream compresses all data written to it, and passes the compressed data
to the ``filtered'' stream.