X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/43c48e1e53d74cef62d15f08f015d9efeb45a0c1..97d13342cc2ac77e21c38115cc6ebecac930f92a:/interface/wx/textfile.h diff --git a/interface/wx/textfile.h b/interface/wx/textfile.h index fdeb78dd00..3299ab8ac6 100644 --- a/interface/wx/textfile.h +++ b/interface/wx/textfile.h @@ -7,7 +7,9 @@ ///////////////////////////////////////////////////////////////////////////// -/** The line termination type (kept wxTextFileType name for compability) */ +/** + The line termination type (kept wxTextFileType name for compability). +*/ enum wxTextFileType { wxTextFileType_None, //!< incomplete (the last line of the file only) @@ -17,7 +19,6 @@ enum wxTextFileType wxTextFileType_Os2 //!< line is terminated with 'CR' 'LF' }; - /** @class wxTextFile @@ -40,7 +41,7 @@ enum wxTextFileType - Create and open it: this is done with either wxTextFile::Create or wxTextFile::Open function which opens the file (name may be specified either as the argument to these functions or in the constructor), reads its contents in memory (in the - case of @c Open()) and closes it. + case of wxTextFile::Open()) and closes it. - Work with the lines in the file: this may be done either with "direct access" functions like wxTextFile::GetLineCount and wxTextFile::GetLine (@e operator[] does exactly the same but looks more like array addressing) @@ -53,10 +54,9 @@ enum wxTextFileType wxTextFile::Clear resets the file to empty. - Save your changes: notice that the changes you make to the file will @b not be saved automatically; calling wxTextFile::Close or doing nothing discards them! - To save the changes you must explicitly callwxTextFile::Write - here, you may + To save the changes you must explicitly call wxTextFile::Write - here, you may also change the line termination type if you wish. - @library{wxbase} @category{file} @@ -98,16 +98,22 @@ public: */ bool Close(); - //@{ /** - Creates the file with the given name or the name which was given in the - @ref wxTextFile() constructor. The array of file lines is initially empty. + Creates the file with the name which was given in the + wxTextFile(const wxString&) constructor. + The array of file lines is initially empty. + + It will fail if the file already exists, Open() should be used in this case. + */ + bool Create(); + + /** + Creates the file with the given name. + The array of file lines is initially empty. It will fail if the file already exists, Open() should be used in this case. */ - bool Create() const; - bool Create(const wxString& strFile) const; - //@} + bool Create(const wxString& strFile); /** Returns @true if the current line is the last one. @@ -138,7 +144,7 @@ public: compiling with the Apple Developer Tools) and @c wxTextFileType_Mac under Mac OS (including Mac OS X when compiling with CodeWarrior). */ - static const char* GetEOL(wxTextFileType type = typeDefault) const; + static const wxChar* GetEOL(wxTextFileType type = wxTextBuffer::typeDefault); /** This method together with GetNextLine() allows more "iterator-like" @@ -235,10 +241,9 @@ public: */ bool IsOpened() const; - //@{ /** - Open() opens the file with the given name or the name which was given in the - @ref wxTextFile() constructor and also loads file in memory on success. + Opens the file with the name which was given in the wxTextFile(const wxString&) + constructor and also loads file in memory on success. It will fail if the file does not exist, Create() should be used in this case. @@ -246,8 +251,16 @@ public: it is used to convert the file to wide character representation. */ bool Open(const wxMBConv& conv = wxConvAuto()) const; + + /** + Opens the file with the given name and also loads file in memory on success. + + It will fail if the file does not exist, Create() should be used in this case. + + The @a conv argument is only meaningful in Unicode build of wxWidgets when + it is used to convert the file to wide character representation. + */ bool Open(const wxString& strFile, const wxMBConv& conv = wxConvAuto()) const; - //@} /** Delete line number @a n from the file.