Added dnd classes, data object classes, changed clipboard class doc,

cured filefn.cpp wxFileNameFromPath bug, some tweaks to HelpGen


git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@1395 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Julian Smart
1999-01-13 14:23:31 +00:00
parent 3827499741
commit dface61ccb
24 changed files with 698 additions and 99 deletions

View File

@@ -16,6 +16,7 @@ limitation for the small files like configuration files or programs sources
which are well handled by wxTextFile.
The typical things you may do with wxTextFile in order are:
\begin{itemize}\itemsep=0pt
\item Create and open it: this is done with \helpref{Open}{wxtextfileopen}
function which opens the file (name may be specified either as Open argument or
@@ -27,7 +28,7 @@ access" functions like \helpref{GetLineCount}{wxtextfilegetlinecount} and
but looks more like array addressing) or with "sequential access" functions
which include \helpref{GetFirstLine}{wxtextfilegetfirstline}/
\helpref{GetNextLine}{wxtextfilegetnextline} and also
\helpref{GetLastLine}{getlastline}/\helpref{GetPrevLine}{wxtextfilegetprevline}.
\helpref{GetLastLine}{wxtextfilegetlastline}/\helpref{GetPrevLine}{wxtextfilegetprevline}.
For the sequential access functions the current line number is maintained: it is
returned by \helpref{GetCurrentLine}{wxtextfilegetcurrentline} and may be
changed with \helpref{GoToLine}{wxtextfilegotoline}.
@@ -70,57 +71,67 @@ enum wxTextFileType
Default constructor, use Open(string) to initialize the object.
\membersection{wxTextFile::wxTextFile}\label{wxtextfilector}
\constfunc{}{wxTextFile}{\param{const wxString\& }{strFile}}
Constructor does not load the file into memory, use Open() to do it.
\membersection{wxTextFile::Exists}\label{wxtextfileexists}
\constfunc{bool}{Exists}{\void}
Return TRUE if file exists - the name of the file should have been specified
in the constructor before calling Exists().
\membersection{wxTextFile::Open}\label{wxtextfileopen}
\constfunc{bool}{Open}{\void}
Open() opens the file with the name which was given in the \helpref{constructor}{wxtextfilector}
and also loads file in memory on success.
\membersection{wxTextFile::Open}\label{wxtextfileopenname}
\constfunc{bool}{Open}{\param{const wxString\& }{strFile}}
Same as \helpref{Open()}{wxtextfileopen} but allows to specify the file name
(must be used if the default constructor was used to create the object).
\membersection{wxTextFile::Close}\label{wxtextfileclose}
\constfunc{bool}{Close}{\void}
Closes the file and frees memory, {\bf losing all changes}. Use \helpref{Write()}{wxtextfilewrite}
if you want to save them.
\membersection{wxTextFile::IsOpened}\label{wxtextfileisopened}
\constfunc{bool}{IsOpened}{\void}
Returns TRUE if the file is currently opened.
\membersection{wxTextFile::GetLineCount}\label{wxtextfilegetlinecount}
\constfunc{size\_t}{GetLineCount}{\void}
Get the number of lines in the file.
\membersection{wxTextFile::GetLine}\label{wxtextfilegetline}
\constfunc{wxString\&}{GetLine}{\param{size\_t }{n}}
Retrieves the line number {\it n} from the file. The returned line may be
modified but you shouldn't add line terminator at the end - this will be done
by wxTextFile.
\membersection{wxTextFile::operator[]}\label{wxtextfileoperator[]}
\membersection{wxTextFile::operator[]}\label{wxtextfileoperatorarray}
\constfunc{wxString\&}{operator[]}{\param{size\_t }{n}}
The same as \helpref{GetLine}{wxtextfilegetline}.
\membersection{wxTextFile::GetCurrentLine}\label{wxtextfilegetcurrentline}
\constfunc{size\_t}{GetCurrentLine}{\void}
Returns the current line: it has meaning only when you're using
@@ -130,17 +141,20 @@ GetLastLine() also change the value of the current line, as well as
GoToLine().
\membersection{wxTextFile::GoToLine}\label{wxtextfilegotoline}
\constfunc{void}{GoToLine}{\param{size\_t }{n}}
Changes the value returned by \helpref{GetCurrentLine}{wxtextfilegetcurrentline}
and used by \helpref{GetFirstLine()}{wxtextfilegetfirstline}()/\helpref{GetNextLine()}{wxtextfilegetnextline}.
\membersection{wxTextFile::Eof}\label{wxtextfileeof}
\constfunc{bool}{Eof}{\void}
Returns TRUE if the current line is the last one.
\membersection{wxTextFile::GetFirstLine}\label{wxtextfilegetfirstline}
\constfunc{wxString\&}{GetFirstLine}{\void}
This method together with \helpref{GetNextLine()}{wxtextfilegetnextline}
@@ -155,27 +169,32 @@ for ( str = GetFirstLine(); !Eof(); str = GetNextLine() )
\end{verbatim}
\membersection{wxTextFile::GetNextLine}\label{wxtextfilegetnextline}
\func{wxString\&}{GetNextLine}{\void}
Gets the next line (see \helpref{GetFirstLine}{wxtextfilegetfirstline} for
the example).
\membersection{wxTextFile::GetPrevLine}\label{wxtextfilegetprevline}
\func{wxString\&}{GetPrevLine}{\void}
Gets the previous line in the file.
\membersection{wxTextFile::GetLastLine}\label{wxtextfilegetlastline}
\func{wxString\&}{GetLastLine}{\void}
Gets the last line of the file.
\membersection{wxTextFile::GetLineType}\label{wxtextfilegetlinetype}
\constfunc{wxTextFileType}{GetLineType}{\param{size\_t }{n}}
Get the type of the line (see also \helpref{GetEOL}{wxtextfilegeteol})
\membersection{wxTextFile::GuessType}\label{wxtextfileguesstype}
\constfunc{wxTextFileType}{GuessType}{\void}
Guess the type of file (which is supposed to be opened). If sufficiently
@@ -183,26 +202,31 @@ many lines of the file are in DOS/Unix/Mac format, the corresponding value will
be returned. If the detection mechanism fails wxTextFileType\_None is returned.
\membersection{wxTextFile::GetName}\label{wxtextfilegetname}
\constfunc{const char*}{GetName}{\void}
Get the name of the file.
\membersection{wxTextFile::AddLine}\label{wxtextfileaddline}
\constfunc{void}{AddLine}{\param{const wxString\& }{str}, \param{wxTextFileType }{type = typeDefault}}
Adds a line to the end of file.
\membersection{wxTextFile::InsertLine}\label{wxtextfileinsertline}
\constfunc{void}{InsertLine}{\param{const wxString\& }{str}, \param{size\_t }{n}, \param{wxTextFileType }{type = typeDefault}}
Insert a line before the line number {\it n}.
\membersection{wxTextFile::RemoveLine}\label{wxtextfileremoveline}
\constfunc{void}{RemoveLine}{\param{size\_t }{n}}
Delete one line from the file.
\membersection{wxTextFile::Write}\label{wxtextfilewrite}
\constfunc{bool}{Write}{\param{wxTextFileType }{typeNew = wxTextFileType\_None}}
Change the file on disk. The {\it typeNew} parameter allows to change the
@@ -210,6 +234,7 @@ file format (default argument means "don't change type") and may be used to
convert, for example, DOS files to Unix.
\membersection{wxTextFile::GetEOL}\label{wxtextfilegeteol}
\constfunc{static const char*}{GetEOL}{\param{wxTextFileType }{type = typeDefault}}
Get the line termination string corresponding to given constant. {\it typeDefault} is
@@ -218,6 +243,8 @@ platform, i.e. it will be wxTextFileType\_Dos under Windows, wxTextFileType\_Uni
Unix and wxTextFileType\_Mac under Mac.
\membersection{wxTextFile::\destruct{wxTextFile}}\label{wxtextfiledtor}
\constfunc{}{\destruct{wxTextFile}}{\void}
Destructor does nothing.