Spacing fixes

[wxWidgets.git] / docs / latex / wx / filename.tex

diff --git a/docs/latex/wx/filename.tex b/docs/latex/wx/filename.tex
index 6a79a412d5369d174f0fc85cacf50426bc16255c..ccffbd00cc82bb3edaff74aabe29125747a29d1b 100644 (file)
--- a/docs/latex/wx/filename.tex
+++ b/docs/latex/wx/filename.tex
@@ -56,7 +56,7 @@ enum wxPathFormat
 \latexignore{\rtfignore{\wxheading{Function groups}}}
 
 
 \latexignore{\rtfignore{\wxheading{Function groups}}}
 
 

-\membersection{File name format}
+\membersection{File name format}\label{filenameformat}

 
 wxFileName currently supports the file names in the Unix, DOS/Windows, Mac OS
 and VMS formats. Although these formats are quite different, wxFileName tries
 
 wxFileName currently supports the file names in the Unix, DOS/Windows, Mac OS
 and VMS formats. Although these formats are quite different, wxFileName tries


@@ -88,12 +88,12 @@ class are \helpref{GetVolumeSeparator}{wxfilenamegetvolumeseparator},\rtfsp
 \helpref{IsRelative}{wxfilenameisrelative}
 
 
 \helpref{IsRelative}{wxfilenameisrelative}
 
 

-\membersection{File name construction}
+\membersection{File name construction}\label{filenameconstruction}

 
 TODO.
 
 
 
 TODO.
 
 

-\membersection{File tests}
+\membersection{File tests}\label{filetests}

 
 Before doing the other tests you should use \helpref{IsOk}{wxfilenameisok} to
 verify that the filename is well defined. If it is, 
 
 Before doing the other tests you should use \helpref{IsOk}{wxfilenameisok} to
 verify that the filename is well defined. If it is, 


@@ -105,7 +105,7 @@ File names should be compared using \helpref{SameAs}{wxfilenamesameas} method
 or \helpref{$==$}{wxfilenameoperatorequal}.
 
 
 or \helpref{$==$}{wxfilenameoperatorequal}.
 
 

-\membersection{File name components}
+\membersection{File name components}\label{filenamecomponents}

 
 These functions allow to examine and modify the directories of the path:
 
 
 These functions allow to examine and modify the directories of the path:
 


@@ -129,7 +129,7 @@ following functions:
 \helpref{SetVolume}{wxfilenamesetvolume}\\
 
 
 \helpref{SetVolume}{wxfilenamesetvolume}\\
 
 

-\membersection{Operations}
+\membersection{Operations}\label{filenameoperations}

 
 These methods allow to work with the file creation, access and modification
 times. Note that not all filesystems under all platforms implement these times
 
 These methods allow to work with the file creation, access and modification
 times. Note that not all filesystems under all platforms implement these times


@@ -460,6 +460,15 @@ separators.
 \helpref{GetPathSeparator}{wxfilenamegetpathseparator}
 
 
 \helpref{GetPathSeparator}{wxfilenamegetpathseparator}
 
 

+\membersection{wxFileName::GetPathTerminators}\label{wxfilenamegetpathterminators}
+
+\func{static wxString}{GetPathTerminators}{\param{wxPathFormat }{format = wxPATH\_NATIVE}}
+
+Returns the string of characters which may terminate the path part. This is the
+same as \helpref{GetPathSeparators}{wxfilenamegetpathseparators} except for VMS
+path format where $]$ is used at the end of the path part.
+
+

 \membersection{wxFileName::GetShortPath}\label{wxfilenamegetshortpath}
 
 \constfunc{wxString}{GetShortPath}{\void}
 \membersection{wxFileName::GetShortPath}\label{wxfilenamegetshortpath}
 
 \constfunc{wxString}{GetShortPath}{\void}


@@ -491,7 +500,7 @@ needed.
 
 \constfunc{wxString}{GetVolume}{\void}
 
 
 \constfunc{wxString}{GetVolume}{\void}
 

-Returns the string containing the volume for this file name, mepty if it
+Returns the string containing the volume for this file name, empty if it

 doesn't have one or if the file system doesn't support volumes at all (for
 example, Unix).
 
 doesn't have one or if the file system doesn't support volumes at all (for
 example, Unix).
 


@@ -580,6 +589,23 @@ directory or file really exists, you should use
 \helpref{DirExists}{wxfilenamedirexists} or 
 \helpref{FileExists}{wxfilenamefileexists} for this.
 
 \helpref{DirExists}{wxfilenamedirexists} or 
 \helpref{FileExists}{wxfilenamefileexists} for this.
 

+\membersection{wxFileName::MacFindDefaultTypeAndCreator}\label{wxfilenamemacfinddefaulttypeandcreator}
+
+\func{static bool}{MacFindDefaultTypeAndCreator}{\param{const wxString\& }{ext}, \param{wxUint32* }{type}, \param{wxUint32* }{creator}}
+
+On Mac OS, gets the common type and creator for the given extension.
+
+\membersection{wxFileName::MacRegisterDefaultTypeAndCreator}\label{wxfilenamemacregisterdefaulttypeandcreator}
+
+\func{static void}{MacRegisterDefaultTypeAndCreator}{\param{const wxString\& }{ext}, \param{wxUint32 }{type}, \param{wxUint32 }{creator}}
+
+On Mac OS, registers application defined extensions and their default type and creator.
+
+\membersection{wxFileName::MacSetDefaultTypeAndCreator}\label{wxfilenamemacsetdefaulttypeandcreator}
+
+\func{bool}{MacSetDefaultTypeAndCreator}{\void}
+
+On Mac OS, looks up the appropriate type and creator from the registration and then sets it.

 
 \membersection{wxFileName::MakeAbsolute}\label{wxfilenamemakeabsolute}
 
 
 \membersection{wxFileName::MakeAbsolute}\label{wxfilenamemakeabsolute}
 


@@ -763,6 +789,18 @@ component is. The old contents of the strings pointed to by these parameters
 will be overwritten in any case (if the pointers are not {\tt NULL}).
 
 
 will be overwritten in any case (if the pointers are not {\tt NULL}).
 
 

+\membersection{wxFileName::SplitVolume}\label{wxfilenamesplitvolume}
+
+\func{static void}{SplitVolume}{\param{const wxString\& }{fullpath}, \param{wxString* }{volume}, \param{wxString* }{path}, \param{wxPathFormat }{format = wxPATH\_NATIVE}}
+
+Splits the given \arg{fullpath} into the volume part (which may be empty) and
+the pure path part, not containing any volume.
+
+\wxheading{See also}
+
+\helpref{SplitPath}{wxfilenamesplitpath}
+
+

 \membersection{wxFileName::Touch}\label{wxfilenametouch}
 
 \func{bool}{Touch}{\void}
 \membersection{wxFileName::Touch}\label{wxfilenametouch}
 
 \func{bool}{Touch}{\void}