Add wxGetFileType and IsSeekable

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@31924 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Michael Wetherell
2005-02-11 12:39:03 +00:00
parent af44de02ae
commit 3c70014d96
21 changed files with 453 additions and 73 deletions

View File

@@ -145,6 +145,24 @@ if the file is not opened.
Flushes the file and returns \true on success.
\membersection{wxFFile::GetFileType}\label{wxffilegetfiletype}
\constfunc{wxFileTypeEnum}{GetFileType}{\void}
Returns the type of the file. Possible return values are:
\begin{verbatim}
enum wxFileTypeEnum
{
wxFILE_TYPE_UNKNOWN,
wxFILE_TYPE_DISK, // a file supporting seeking to arbitrary offsets
wxFILE_TYPE_TERMINAL, // a tty
wxFILE_TYPE_PIPE // a pipe
};
\end{verbatim}
\membersection{wxFFile::IsOpened}\label{wxffileisopened}
\constfunc{bool}{IsOpened}{\void}

View File

@@ -200,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).
\membersection{wxFile::GetFileType}\label{wxfilegetfiletype}
\constfunc{wxFileTypeEnum}{GetFileType}{\void}
Returns the type of the file. Possible return values are:
\begin{verbatim}
enum wxFileTypeEnum
{
wxFILE_TYPE_UNKNOWN,
wxFILE_TYPE_DISK, // a file supporting seeking to arbitrary offsets
wxFILE_TYPE_TERMINAL, // a tty
wxFILE_TYPE_PIPE // a pipe
};
\end{verbatim}
\membersection{wxFile::IsOpened}\label{wxfileisopened}
\constfunc{bool}{IsOpened}{\void}

View File

@@ -108,6 +108,7 @@ the corresponding topic.
\helpref{wxGetElapsedTime}{wxgetelapsedtime}\\
\helpref{wxGetEmailAddress}{wxgetemailaddress}\\
\helpref{wxGetEnv}{wxgetenv}\\
\helpref{wxGetFileType}{wxgetfiletype}\\
\helpref{wxGetFontFromUser}{wxgetfontfromuser}\\
\helpref{wxGetFreeMemory}{wxgetfreememory}\\
\helpref{wxGetFullHostName}{wxgetfullhostname}\\
@@ -1015,6 +1016,30 @@ Mac OS and generic Unix provided the system has {\tt statfs()} function.
This function first appeared in wxWidgets 2.3.2.
\membersection{::wxGetFileType}\label{wxgetfiletype}
\func{wxFileTypeEnum}{wxGetFileType}{\param{int }{fd}}
\func{wxFileTypeEnum}{wxGetFileType}{\param{FILE *}{fp}}
Returns the type of an open file. Possible return values are:
\begin{verbatim}
enum wxFileTypeEnum
{
wxFILE_TYPE_UNKNOWN,
wxFILE_TYPE_DISK, // a file supporting seeking to arbitrary offsets
wxFILE_TYPE_TERMINAL, // a tty
wxFILE_TYPE_PIPE // a pipe
};
\end{verbatim}
\wxheading{Include files}
<wx/filefn.h>
\membersection{::wxGetOSDirectory}\label{wxgetosdirectory}
\func{wxString}{wxGetOSDirectory}{\void}

View File

@@ -94,6 +94,13 @@ Returns true if no error occurred on the stream.
\helpref{GetLastError}{wxstreambasegetlasterror}
\membersection{wxStreamBase::IsSeekable}\label{wxstreambaseisok}
\constfunc{bool}{IsSeekable}{\void}
Returns true if the streams supports seeking to arbitrary offsets.
\membersection{wxStreamBase::OnSysRead}\label{wxstreambaseonsysread}
\func{size\_t}{OnSysRead}{\param{void*}{ buffer}, \param{size\_t}{ bufsize}}