From 36edded90cf3d4d11dc55362b332733b79e8f54d Mon Sep 17 00:00:00 2001 From: Julian Smart Date: Mon, 1 Nov 1999 20:36:43 +0000 Subject: [PATCH] Tidied some docs, made VC++ 6 DLL compilation work with wxvc_dll.dsp, 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 --- distrib/msw/vc.rsp | 4 +- docs/latex/wx/boxsizer.tex | 2 +- docs/latex/wx/classes.tex | 8 +- docs/latex/wx/conditn.tex | 3 +- docs/latex/wx/critsect.tex | 2 +- docs/latex/wx/datstrm.tex | 8 + docs/latex/wx/filesys.tex | 8 +- docs/latex/wx/filesysh.tex | 54 +- docs/latex/wx/filetype.tex | 14 +- docs/latex/wx/fltinstr.tex | 9 +- docs/latex/wx/fltoutst.tex | 10 +- docs/latex/wx/fsfile.tex | 4 +- docs/latex/wx/hthelpct.tex | 3 +- docs/latex/wx/htmlhlpf.tex | 12 +- docs/latex/wx/htmlstrt.tex | 2 +- docs/latex/wx/sizer.tex | 2 +- docs/latex/wx/strmbfrd.tex | 22 +- docs/latex/wx/strmfile.tex | 13 +- docs/latex/wx/strmzlib.tex | 16 +- docs/msw/install.txt | 2 +- src/common/imagall.cpp | 2 +- src/msw/app.cpp | 7 + src/wxvc.dsp | 30 +- src/wxvc.dsw | 2 +- src/wxvc6.dsp | 1375 --------------------------- src/wxvc6.dsw | 29 - src/wxvc_dll.dsp | 792 ++++++++++++++- src/wxvc_dll.dsw | 2 +- utils/ogl/samples/studio/studio.cpp | 8 +- utils/projgen/makeproj.cpp | 77 +- utils/projgen/makeproj.ncb | 1 - utils/projgen/makeproj.obj | Bin 2236 -> 0 bytes utils/projgen/makeproj.opt | 1 - utils/projgen/makeproj.pdb | 1 - utils/projgen/makeproj.res | Bin 12288 -> 0 bytes 35 files changed, 972 insertions(+), 1553 deletions(-) delete mode 100644 src/wxvc6.dsp delete mode 100644 src/wxvc6.dsw delete mode 100644 utils/projgen/makeproj.ncb delete mode 100644 utils/projgen/makeproj.obj delete mode 100644 utils/projgen/makeproj.opt delete mode 100644 utils/projgen/makeproj.pdb delete mode 100644 utils/projgen/makeproj.res diff --git a/distrib/msw/vc.rsp b/distrib/msw/vc.rsp index 84ed489963..4771750290 100644 --- a/distrib/msw/vc.rsp +++ b/distrib/msw/vc.rsp @@ -139,8 +139,8 @@ utils/dialoged/src/DialogEdVC.dsw utils/tex2rtf/src/Tex2RTFVC.dsp utils/tex2rtf/src/Tex2RTFVC.dsw -utils/glcanvas/win/GlcanvasVC.dsp -utils/glcanvas/win/GlcanvasVC.dsw +utils/glcanvas/win/Glcanvas*.dsp +utils/glcanvas/win/Glcanvas*.dsw utils/glcanvas/samples/cube/CubeVC.dsp utils/glcanvas/samples/cube/CubeVC.dsw utils/glcanvas/samples/isosurf/IsosurfVC.dsp diff --git a/docs/latex/wx/boxsizer.tex b/docs/latex/wx/boxsizer.tex index 1e10ddc109..f00db53148 100644 --- a/docs/latex/wx/boxsizer.tex +++ b/docs/latex/wx/boxsizer.tex @@ -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} diff --git a/docs/latex/wx/classes.tex b/docs/latex/wx/classes.tex index 8092cfb7db..bcc41dae7f 100644 --- a/docs/latex/wx/classes.tex +++ b/docs/latex/wx/classes.tex @@ -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 diff --git a/docs/latex/wx/conditn.tex b/docs/latex/wx/conditn.tex index e900499e26..47cc257e81 100644 --- a/docs/latex/wx/conditn.tex +++ b/docs/latex/wx/conditn.tex @@ -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. - diff --git a/docs/latex/wx/critsect.tex b/docs/latex/wx/critsect.tex index 74c987e7f8..0851745cd8 100644 --- a/docs/latex/wx/critsect.tex +++ b/docs/latex/wx/critsect.tex @@ -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 diff --git a/docs/latex/wx/datstrm.tex b/docs/latex/wx/datstrm.tex index c8da9fd39e..037a730d16 100644 --- a/docs/latex/wx/datstrm.tex +++ b/docs/latex/wx/datstrm.tex @@ -31,6 +31,10 @@ For example: See also \helpref{wxDataOutputStream}{wxdataoutputstream}. +\wxheading{Derived from} + +None + \wxheading{Include files} @@ -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} diff --git a/docs/latex/wx/filesys.tex b/docs/latex/wx/filesys.tex index 3289835ec2..6ff0524b18 100644 --- a/docs/latex/wx/filesys.tex +++ b/docs/latex/wx/filesys.tex @@ -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}}} diff --git a/docs/latex/wx/filesysh.tex b/docs/latex/wx/filesysh.tex index 397cbd6ccd..03d37300be 100644 --- a/docs/latex/wx/filesysh.tex +++ b/docs/latex/wx/filesysh.tex @@ -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.} diff --git a/docs/latex/wx/filetype.tex b/docs/latex/wx/filetype.tex index be2b621f19..364850400f 100644 --- a/docs/latex/wx/filetype.tex +++ b/docs/latex/wx/filetype.tex @@ -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} diff --git a/docs/latex/wx/fltinstr.tex b/docs/latex/wx/fltinstr.tex index 2032317f9e..29a526a419 100644 --- a/docs/latex/wx/fltinstr.tex +++ b/docs/latex/wx/fltinstr.tex @@ -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. diff --git a/docs/latex/wx/fltoutst.tex b/docs/latex/wx/fltoutst.tex index 02b283b69c..a6b0eea02d 100644 --- a/docs/latex/wx/fltoutst.tex +++ b/docs/latex/wx/fltoutst.tex @@ -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. diff --git a/docs/latex/wx/fsfile.tex b/docs/latex/wx/fsfile.tex index 14b54ccd7d..0085ae2a62 100644 --- a/docs/latex/wx/fsfile.tex +++ b/docs/latex/wx/fsfile.tex @@ -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 diff --git a/docs/latex/wx/hthelpct.tex b/docs/latex/wx/hthelpct.tex index f7a1378b5b..2bd32b5b7a 100644 --- a/docs/latex/wx/hthelpct.tex +++ b/docs/latex/wx/hthelpct.tex @@ -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: diff --git a/docs/latex/wx/htmlhlpf.tex b/docs/latex/wx/htmlhlpf.tex index 37c129e20b..03c206e6e3 100644 --- a/docs/latex/wx/htmlhlpf.tex +++ b/docs/latex/wx/htmlhlpf.tex @@ -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 -( statement): +(\verb$$ statement): \begin{verbatim}