X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/b236c10f77e9ed0bc3c16d1cceb4a62f7048b4f9..302511a3ca8d831ee26c7dfc47c928e8fed8fef6:/docs/latex/wx/file.tex diff --git a/docs/latex/wx/file.tex b/docs/latex/wx/file.tex index 0972789d64..316ecf7efc 100644 --- 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 -%% License: wxWidgets license +%% License: wxWindows license %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% \section{\class{wxFile}}\label{wxfile} @@ -20,8 +20,8 @@ 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. +parameter or return them. If the platform supports it, wxFileOffset is a typedef +for a native 64 bit integer, otherwise a 32 bit integer is used for wxFileOffset. \wxheading{Derived from} @@ -31,6 +31,10 @@ None. +\wxheading{Library} + +\helpref{wxBase}{librarieslist} + \wxheading{Constants} wx/file.h defines the following constants: @@ -86,13 +90,14 @@ mode constants used with \helpref{Seek()}{wxfileseek}: \latexignore{\rtfignore{\wxheading{Members}}} + \membersection{wxFile::wxFile}\label{wxfilector} \func{}{wxFile}{\void} Default constructor. -\func{}{wxFile}{\param{const char*}{ filename}, \param{wxFile::OpenMode}{ mode = wxFile::read}} +\func{}{wxFile}{\param{const wxString\&}{ filename}, \param{wxFile::OpenMode}{ mode = wxFile::read}} Opens a file with the given mode. As there is no way to return whether the operation was successful or not from the constructor you should test the @@ -111,6 +116,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)} + \membersection{wxFile::\destruct{wxFile}}\label{wxfiledtor} \func{}{\destruct{wxFile}}{\void} @@ -119,13 +125,15 @@ Destructor will close the file. {\bf NB:} it is not virtual so you should not use wxFile polymorphically. + \membersection{wxFile::Access}\label{wxfileaccess} -\func{static bool}{Access}{\param{const char *}{ name}, \param{OpenMode}{ mode}} +\func{static bool}{Access}{\param{const wxString\&}{ name}, \param{OpenMode}{ mode}} This function verifies if we may access the given file in specified mode. Only values of wxFile::read or wxFile::write really make sense here. + \membersection{wxFile::Attach}\label{wxfileattach} \func{void}{Attach}{\param{int}{ fd}} @@ -137,19 +145,22 @@ have symbolic names of {\bf wxFile::fd\_stdin}, {\bf wxFile::fd\_stdout} and {\b The descriptor should be already opened and it will be closed by wxFile object. + \membersection{wxFile::Close}\label{wxfileclose} \func{void}{Close}{\void} Closes the file. + \membersection{wxFile::Create}\label{wxfilecreate} -\func{bool}{Create}{\param{const char*}{ filename}, \param{bool}{ overwrite = false}, \param{int }{access = wxS\_DEFAULT}} +\func{bool}{Create}{\param{const wxString\&}{ filename}, \param{bool}{ overwrite = false}, \param{int }{access = wxS\_DEFAULT}} Creates a file for writing. If the file already exists, setting {\bf overwrite} to true will ensure it is overwritten. + \membersection{wxFile::Detach}\label{wxfiledetach} \func{void}{Detach}{\void} @@ -157,12 +168,14 @@ will ensure it is overwritten. Get back a file descriptor from wxFile object - the caller is responsible for closing the file if this descriptor is opened. \helpref{IsOpened()}{wxfileisopened} will return false after call to Detach(). + \membersection{wxFile::fd}\label{wxfilefd} \constfunc{int}{fd}{\void} Returns the file descriptor associated with the file. + \membersection{wxFile::Eof}\label{wxfileeof} \constfunc{bool}{Eof}{\void} @@ -183,13 +196,15 @@ file into memory, you should write a loop which uses \helpref{Read}{wxfileread} repeatedly and tests its return condition instead of using Eof() as this will not work for special files under Unix. + \membersection{wxFile::Exists}\label{wxfileexists} -\func{static bool}{Exists}{\param{const char*}{ filename}} +\func{static bool}{Exists}{\param{const wxString\&}{ filename}} Returns true if the given name specifies an existing regular file (not a directory or a link) + \membersection{wxFile::Flush}\label{wxfileflush} \func{bool}{Flush}{\void} @@ -200,21 +215,42 @@ 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). + +\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} Returns true if the file has been opened. + \membersection{wxFile::Length}\label{wxfilelength} \constfunc{wxFileOffset}{Length}{\void} Returns the length of the file. + \membersection{wxFile::Open}\label{wxfileopen} -\func{bool}{Open}{\param{const char*}{ filename}, \param{wxFile::OpenMode}{ mode = wxFile::read}} +\func{bool}{Open}{\param{const wxString\&}{ filename}, \param{wxFile::OpenMode}{ mode = wxFile::read}} Opens the file, returning true if successful. @@ -224,6 +260,7 @@ Opens the file, returning true if successful. \docparam{mode}{The mode in which to open the file. May be one of {\bf wxFile::read}, {\bf wxFile::write} and {\bf wxFile::read\_write}.} + \membersection{wxFile::Read}\label{wxfileread} \func{size\_t}{Read}{\param{void*}{ buffer}, \param{size\_t}{ count}} @@ -240,6 +277,7 @@ Reads the specified number of bytes into a buffer, returning the actual number r The number of bytes read, or the symbol {\bf wxInvalidOffset} (-1) if there was an error. + \membersection{wxFile::Seek}\label{wxfileseek} \func{wxFileOffset}{Seek}{\param{wxFileOffset }{ofs}, \param{wxSeekMode }{mode = wxFromStart}} @@ -256,11 +294,14 @@ Seeks to the specified position. The actual offset position achieved, or wxInvalidOffset on failure. + \membersection{wxFile::SeekEnd}\label{wxfileseekend} \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 relative to the end of +the file. For example, \texttt{SeekEnd($-5$)} would position the pointer $5$ +bytes before the end. \wxheading{Parameters} @@ -270,6 +311,7 @@ Moves the file pointer to the specified number of bytes before the end of the fi The actual offset position achieved, or wxInvalidOffset on failure. + \membersection{wxFile::Tell}\label{wxfiletell} \constfunc{wxFileOffset}{Tell}{\void} @@ -277,9 +319,10 @@ The actual offset position achieved, or wxInvalidOffset on failure. 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{wxFileOffset}{ count}} +\func{size\_t}{Write}{\param{const void*}{ buffer}, \param{size\_t}{ count}} Writes the specified number of bytes from a buffer. @@ -293,9 +336,10 @@ Writes the specified number of bytes from a buffer. the number of bytes actually written + \membersection{wxFile::Write}\label{wxfilewrites} -\func{bool}{Write}{\param{const wxString\& }{s}, \param{wxMBConv\&}{ conv = wxConvUTF8}} +\func{bool}{Write}{\param{const wxString\& }{s}, \param{const wxMBConv\&}{ conv = wxConvUTF8}} Writes the contents of the string to the file, returns true on success.