]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/latex/wx/filesysh.tex
removing corrupted files
[wxWidgets.git] / docs / latex / wx / filesysh.tex
index 04159d5e942d44c22d3bf52c618872cc090774e5..1bc86552579786ceca9b75eceff29c729c609f0e 100644 (file)
@@ -3,7 +3,6 @@
 % filesystemhandler.tex at 21/Mar/99 23:00:52
 %
 
-
 \section{\class{wxFileSystemHandler}}\label{wxfilesystemhandler}
 
 wxFileSystemHandler (or derived classes to be exact) is used
@@ -17,7 +16,6 @@ GetAnchor, GetMimeTypeFromExt.
 Please have a look at \helpref{overview}{fs} if you don't know how locations
 are constructed.
 
-
 \wxheading{Notes}
 
 \begin{itemize}
@@ -39,7 +37,6 @@ wxObject
 \helpref{wxFSFile}{wxfsfile},
 \helpref{Overview}{fs}
 
-
 \membersection{wxFileSystemHandler::wxFileSystemHandler}\label{wxfilesystemhandlerwxfilesystemhandler}
 
 \func{}{wxFileSystemHandler}{\void}
@@ -63,30 +60,16 @@ bool MyHand::CanOpen(const wxString& location)
 
 Must be overwriten in derived handlers.
 
-\membersection{wxFileSystemHandler::OpenFile}\label{wxfilesystemhandleropenfile}
-
-\func{virtual wxFSFile*}{OpenFile}{\param{wxFileSystem\& }{fs}, \param{const wxString\& }{location}}
-
-Opens the file and returns wxFSFile pointer or NULL if failed.
-
-Must be overwriten 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.}
-
-\docparam{location}{The {\bf absolute} location of file.}
-
-
+\membersection{wxFileSystemHandler::GetAnchor}\label{wxfilesystemhandlergetanchor}
 
-\membersection{wxFileSystemHandler::GetProtocol}\label{wxfilesystemhandlergetprotocol}
+\constfunc{wxString}{GetAnchor}{\param{const wxString\& }{location}}
 
-\constfunc{wxString}{GetProtocol}{\param{const wxString\& }{location}}
+Returns anchor if present in the location.
+See \helpref{wxFSFile}{wxfsfilegetanchor} for details.
 
-Returns protocol string extracted from {\it location}. 
+Example : GetAnchor("index.htm\#chapter2") == "chapter2"
 
-Example : GetProtocol("file:myzipfile.zip\#zip:index.htm") == "zip"
+{\bf Note:} anchor is NOT part of left location.
 
 \membersection{wxFileSystemHandler::GetLeftLocation}\label{wxfilesystemhandlergetleftlocation}
 
@@ -94,19 +77,24 @@ Example : GetProtocol("file:myzipfile.zip\#zip:index.htm") == "zip"
 
 Returns left location string extracted from {\it location}. 
 
-Example : GetLeftLocation("file:myzipfile.zip\#zip:index.htm") == "file:myzipfile.zip"
+Example: GetLeftLocation("file:myzipfile.zip\#zip:index.htm") == "file:myzipfile.zip"
 
+\membersection{wxFileSystemHandler::GetMimeTypeFromExt}\label{wxfilesystemhandlergetmimetypefromext}
 
-\membersection{wxFileSystemHandler::GetAnchor}\label{wxfilesystemhandlergetanchor}
+\func{wxString}{GetMimeTypeFromExt}{\param{const wxString\& }{location}}
 
-\constfunc{wxString}{GetAnchor}{\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 anchor if present in the location.
-See \helpref{wxFSFile}{wxfsfilegetanchor} for details.
+Example : GetMimeTypeFromExt("index.htm") == "text/html"
 
-Example : GetAnchor("index.htm\#chapter2") == "chapter2"
+\membersection{wxFileSystemHandler::GetProtocol}\label{wxfilesystemhandlergetprotocol}
 
-{\bf Note:} anchor is NOT part of left location.
+\constfunc{wxString}{GetProtocol}{\param{const wxString\& }{location}}
+
+Returns protocol string extracted from {\it location}. 
+
+Example: GetProtocol("file:myzipfile.zip\#zip:index.htm") == "zip"
 
 \membersection{wxFileSystemHandler::GetRightLocation}\label{wxfilesystemhandlergetrightlocation}
 
@@ -116,13 +104,18 @@ Returns right location string extracted from {\it location}.
 
 Example : GetRightLocation("file:myzipfile.zip\#zip:index.htm") == "index.htm"
 
+\membersection{wxFileSystemHandler::OpenFile}\label{wxfilesystemhandleropenfile}
 
-\membersection{wxFileSystemHandler::GetMimeTypeFromExt}\label{wxfilesystemhandlergetmimetypefromext}
+\func{virtual wxFSFile*}{OpenFile}{\param{wxFileSystem\& }{fs}, \param{const wxString\& }{location}}
 
-\func{wxString}{GetMimeTypeFromExt}{\param{const wxString\& }{location}}
+Opens the file and returns wxFSFile pointer or NULL if failed.
 
-Returns MIME type based on {\bf extension} of {\it location}. (While wxFSFile::GetMimeType
-returns real MIME type - either extension-based or queried from HTTP)
+Must be overwriten in derived handlers.
 
-Example : GetMimeTypeFromExt("index.htm") == "text/html"
+\wxheading{Parameters}
+
+\docparam{fs}{Parent FS (the FS from that OpenFile was called). See ZIP handler
+for details how to use it.}
+
+\docparam{location}{The {\bf absolute} location of file.}