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

Doc corrections

Browse Source 
filelist.txt correction and filedlgg.cpp inclusion for wxUniv/MSW


git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@18307 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Julian Smart
2002-12-17 22:22:19 +00:00
parent 4a69b0600a
commit ba7fe276d4
4 changed files with 77 additions and 70 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -59,28 +59,28 @@ Sets the current location. {\it location} parameter passed to
\helpref{OpenFile}{wxfilesystemopenfile} is relative to this path.
{\bf Caution! } Unless {\it is\_dir} is TRUE the {\it location} parameter
is not directory name but the name of the file in this directory!! All these
commands change path to "dir/subdir/" :
is not the directory name but the name of the file in this directory. All these
commands change the path to "dir/subdir/":
\begin{verbatim}
ChangePathTo("dir/subdir/xh.htm");
ChangePathTo("dir/subdir", TRUE);
ChangePathTo("dir/subdir/", TRUE);
ChangePathTo("dir/subdir/xh.htm");
ChangePathTo("dir/subdir", TRUE);
C hangePathTo("dir/subdir/", TRUE);
\end{verbatim}
\wxheading{Parameters}
\docparam{location}{the new location. Its meaning depends on value of {\it is\_dir}}
\docparam{location}{the new location. Its meaning depends on the value of {\it is\_dir}}
\docparam{is\_dir}{if TRUE {\it location} is new directory. If FALSE (default)
\docparam{is\_dir}{if TRUE {\it location} is new directory. If FALSE (default)
{\it location} is {\bf file in} the new directory.}
\wxheading{Example}
\begin{verbatim}
f = fs -> OpenFile("hello.htm"); // opens file 'hello.htm'
fs -> ChangePathTo("subdir/folder", TRUE);
f = fs -> OpenFile("hello.htm"); // opens file 'subdir/folder/hello.htm' !!
f = fs -> OpenFile("hello.htm"); // opens file 'hello.htm'
fs -> ChangePathTo("subdir/folder", TRUE);
f = fs -> OpenFile("hello.htm"); // opens file 'subdir/folder/hello.htm' !!
\end{verbatim}
\membersection{wxFileSystem::GetPath}\label{wxfilesystemgetpath}
@@ -112,14 +112,13 @@ wxFILE (only files), wxDIR (only directories) or 0 (both).
\func{wxString}{FindNext}{\void}
Returns next filename that matches parameters passed to \helpref{FindFirst}{wxfilesystemfindfirst}.
Returns the next filename that matches parameters passed to \helpref{FindFirst}{wxfilesystemfindfirst}.
\membersection{wxFileSystem::OpenFile}\label{wxfilesystemopenfile}
\func{wxFSFile*}{OpenFile}{\param{const wxString\& }{location}}
Opens file and returns pointer to \helpref{wxFSFile}{wxfsfile} object
Opens the file and returns a pointer to a \helpref{wxFSFile}{wxfsfile} object
or NULL if failed. It first tries to open the file in relative scope
(based on value passed to ChangePathTo() method) and then as an
absolute path.
@@ -128,10 +127,11 @@ absolute path.
\func{static wxFileName}{URLToFileName}{\param{const wxString& }{url}}
Converts URL into well-formed filename. The URL must use {\tt file}
Converts URL into a well-formed filename. The URL must use the {\tt file}
protocol.
\wxheading{See also}
\helpref{wxFileSystem::FileNameToURL}{wxfilesystemfilenametourl},
\helpref{wxFileSystem::FileNameToURL}{wxfilesystemfilenametourl},
\helpref{wxFileName}{wxfilename}