Documentedm, that the print setup dialog has been

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

diff --git a/docs/latex/wx/file.tex b/docs/latex/wx/file.tex
index 4f8ac4bafc4896c7d696ed4021da755bbff60cbe..78b5515dfc52a9d2af3121700ff20b57b61c2173 100644 (file)
--- a/docs/latex/wx/file.tex
+++ b/docs/latex/wx/file.tex
@@ -6,7 +6,7 @@
 %% Created:     14.01.02 (extracted from file.tex)
 %% RCS-ID:      $Id$
 %% Copyright:   (c) Vadim Zeitlin
 %% Created:     14.01.02 (extracted from file.tex)
 %% RCS-ID:      $Id$
 %% Copyright:   (c) Vadim Zeitlin

-%% License:     wxWindows license
+%% License:     wxWidgets license

 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
 \section{\class{wxFile}}\label{wxfile}
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
 \section{\class{wxFile}}\label{wxfile}


@@ -19,6 +19,10 @@ its destructor making it unnecessary to worry about forgetting to do it.
 wxFile is a wrapper around {\tt file descriptor.} - see also 
 \helpref{wxFFile}{wxffile} for a wrapper around {\tt FILE} structure.
 
 wxFile is a wrapper around {\tt file descriptor.} - see also 
 \helpref{wxFFile}{wxffile} for a wrapper around {\tt FILE} structure.
 

+{\tt wxFileOffset} is used by the wxFile functions which require offsets as 
+parameter or return them. If the platform supports it, wxFileOffset if a typedef
+for a native 64 bit integer, else a 32 bit integer is used for wxFileOffset.
+

 \wxheading{Derived from}
 
 None.
 \wxheading{Derived from}
 
 None.


@@ -70,7 +74,7 @@ Will fail if the file already exists, else create and open it atomically.  Usefu
 \end{twocollist}
 
 Other constants defined elsewhere but used by wxFile functions are wxInvalidOffset which represents an
 \end{twocollist}
 
 Other constants defined elsewhere but used by wxFile functions are wxInvalidOffset which represents an

-invalid value of type {\it off\_t} and is returned by functions returning {\it off\_t} on error and the seek
+invalid value of type {\it wxFileOffset} and is returned by functions returning {\it wxFileOffset} on error and the seek

 mode constants used with \helpref{Seek()}{wxfileseek}:
 
 \twocolwidtha{7cm}
 mode constants used with \helpref{Seek()}{wxfileseek}:
 
 \twocolwidtha{7cm}


@@ -82,7 +86,7 @@ mode constants used with \helpref{Seek()}{wxfileseek}:
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 

-\membersection{wxFile::wxFile}\label{wxfileconstr}
+\membersection{wxFile::wxFile}\label{wxfilector}

 
 \func{}{wxFile}{\void}
 
 
 \func{}{wxFile}{\void}
 


@@ -107,7 +111,7 @@ Associates the file with the given file descriptor, which has already been opene
 
 \docparam{fd}{An existing file descriptor (see \helpref{Attach()}{wxfileattach} for the list of predefined descriptors)}
 
 
 \docparam{fd}{An existing file descriptor (see \helpref{Attach()}{wxfileattach} for the list of predefined descriptors)}
 

-\membersection{wxFile::\destruct{wxFile}}
+\membersection{wxFile::\destruct{wxFile}}\label{wxfiledtor}

 
 \func{}{\destruct{wxFile}}{\void}
 
 
 \func{}{\destruct{wxFile}}{\void}
 


@@ -196,6 +200,23 @@ Note that wxFile::Flush is not implemented on some Windows compilers
 due to a missing fsync function, which reduces the usefulness of this function
 (it can still be called but it will do nothing on unsupported compilers).
 
 due to a missing fsync function, which reduces the usefulness of this function
 (it can still be called but it will do nothing on unsupported compilers).
 

+\membersection{wxFile::GetKind}\label{wxfilegetfilekind}
+
+\constfunc{wxFileKind}{GetKind}{\void}
+
+Returns the type of the file. Possible return values are:
+
+\begin{verbatim}
+enum wxFileKind
+{
+  wxFILE_KIND_UNKNOWN,
+  wxFILE_KIND_DISK,     // a file supporting seeking to arbitrary offsets
+  wxFILE_KIND_TERMINAL, // a tty
+  wxFILE_KIND_PIPE      // a pipe
+};
+
+\end{verbatim}
+

 \membersection{wxFile::IsOpened}\label{wxfileisopened}
 
 \constfunc{bool}{IsOpened}{\void}
 \membersection{wxFile::IsOpened}\label{wxfileisopened}
 
 \constfunc{bool}{IsOpened}{\void}


@@ -204,7 +225,7 @@ Returns true if the file has been opened.
 
 \membersection{wxFile::Length}\label{wxfilelength}
 
 
 \membersection{wxFile::Length}\label{wxfilelength}
 

-\constfunc{off\_t}{Length}{\void}
+\constfunc{wxFileOffset}{Length}{\void}

 
 Returns the length of the file.
 
 
 Returns the length of the file.
 


@@ -222,7 +243,7 @@ Opens the file, returning true if successful.
 
 \membersection{wxFile::Read}\label{wxfileread}
 
 
 \membersection{wxFile::Read}\label{wxfileread}
 

-\func{off\_t}{Read}{\param{void*}{ buffer}, \param{off\_t}{ count}}
+\func{size\_t}{Read}{\param{void*}{ buffer}, \param{size\_t}{ count}}

 
 Reads the specified number of bytes into a buffer, returning the actual number read.
 
 
 Reads the specified number of bytes into a buffer, returning the actual number read.
 


@@ -238,7 +259,7 @@ The number of bytes read, or the symbol {\bf wxInvalidOffset} (-1) if there was
 
 \membersection{wxFile::Seek}\label{wxfileseek}
 
 
 \membersection{wxFile::Seek}\label{wxfileseek}
 

-\func{off\_t}{Seek}{\param{off\_t }{ofs}, \param{wxSeekMode }{mode = wxFromStart}}
+\func{wxFileOffset}{Seek}{\param{wxFileOffset }{ofs}, \param{wxSeekMode }{mode = wxFromStart}}

 
 Seeks to the specified position.
 
 
 Seeks to the specified position.
 


@@ -254,7 +275,7 @@ The actual offset position achieved, or wxInvalidOffset on failure.
 
 \membersection{wxFile::SeekEnd}\label{wxfileseekend}
 
 
 \membersection{wxFile::SeekEnd}\label{wxfileseekend}
 

-\func{off\_t}{SeekEnd}{\param{off\_t }{ofs = 0}}
+\func{wxFileOffset}{SeekEnd}{\param{wxFileOffset }{ofs = 0}}

 
 Moves the file pointer to the specified number of bytes before the end of the file.
 
 
 Moves the file pointer to the specified number of bytes before the end of the file.
 


@@ -268,14 +289,14 @@ The actual offset position achieved, or wxInvalidOffset on failure.
 
 \membersection{wxFile::Tell}\label{wxfiletell}
 
 
 \membersection{wxFile::Tell}\label{wxfiletell}
 

-\constfunc{off\_t}{Tell}{\void}
+\constfunc{wxFileOffset}{Tell}{\void}

 
 Returns the current position or wxInvalidOffset if file is not opened or if another
 error occurred.
 
 \membersection{wxFile::Write}\label{wxfilewrite}
 
 
 Returns the current position or wxInvalidOffset if file is not opened or if another
 error occurred.
 
 \membersection{wxFile::Write}\label{wxfilewrite}
 

-\func{size\_t}{Write}{\param{const void*}{ buffer}, \param{off\_t}{ count}}
+\func{size\_t}{Write}{\param{const void*}{ buffer}, \param{wxFileOffset}{ count}}

 
 Writes the specified number of bytes from a buffer.
 
 
 Writes the specified number of bytes from a buffer.
 


@@ -295,6 +316,10 @@ the number of bytes actually written
 
 Writes the contents of the string to the file, returns true on success.
 
 
 Writes the contents of the string to the file, returns true on success.
 

-The second argument is only meaningful in Unicode build of wxWindows when
+The second argument is only meaningful in Unicode build of wxWidgets when

 {\it conv} is used to convert {\it s} to multibyte representation.
 
 {\it conv} is used to convert {\it s} to multibyte representation.
 

+Note that this method only works with {\tt NUL}-terminated strings, if you want
+to write data with embedded {\tt NUL}s to the file you should use the other 
+\helpref{Write() overload}{wxfilewrite}.
+