X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/e2c4ccaf8a7f03658a29ec4f4f2b71c95827e4ff..b5fe7ca67bf3121959a0b5a59afd00c1708f2f03:/interface/wx/textfile.h diff --git a/interface/wx/textfile.h b/interface/wx/textfile.h index 101b9debb1..3299ab8ac6 100644 --- a/interface/wx/textfile.h +++ b/interface/wx/textfile.h @@ -54,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} @@ -106,7 +105,7 @@ public: It will fail if the file already exists, Open() should be used in this case. */ - bool Create() const; + bool Create(); /** Creates the file with the given name. @@ -114,7 +113,7 @@ public: It will fail if the file already exists, Open() should be used in this case. */ - bool Create(const wxString& strFile) const; + bool Create(const wxString& strFile); /** Returns @true if the current line is the last one. @@ -145,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" @@ -242,10 +241,9 @@ public: */ bool IsOpened() const; - //@{ /** - Open() opens the file with the given name or the name which was given in the - wxTextFile(const wxString&) 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. @@ -253,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.