X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/59b9603aa67e4734acb3e11cd76d5b7b2d5ad935..a8bda512079352ba81933e278d9ccdb8ef7a9866:/interface/wx/textfile.h diff --git a/interface/wx/textfile.h b/interface/wx/textfile.h index eec73ae071..77c947945b 100644 --- a/interface/wx/textfile.h +++ b/interface/wx/textfile.h @@ -3,12 +3,13 @@ // Purpose: interface of wxTextFile // Author: wxWidgets team // RCS-ID: $Id$ -// Licence: wxWindows license +// Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// +// TODO: document wxTextBuffer /** - The line termination type (kept wxTextFileType name for compability). + The line termination type. */ enum wxTextFileType { @@ -54,10 +55,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} @@ -66,6 +66,11 @@ enum wxTextFileType class wxTextFile { public: + /** + Default type for current platform determined at compile time. + */ + static const wxTextFileType typeDefault; + /** Default constructor, use Create() or Open() with a file name parameter to initialize the object. @@ -85,8 +90,7 @@ public: /** Adds a line to the end of file. */ - void AddLine(const wxString& str, - wxTextFileType type = wxTextBuffer::typeDefault); + void AddLine(const wxString& str, wxTextFileType type = typeDefault); /** Delete all lines from the file, set current line number to 0. @@ -99,16 +103,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. @@ -139,7 +149,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 = typeDefault); /** This method together with GetNextLine() allows more "iterator-like" @@ -229,17 +239,16 @@ public: Insert a line before the line number @a n. */ void InsertLine(const wxString& str, size_t n, - wxTextFileType type = wxTextBuffer::typeDefault); + wxTextFileType type = typeDefault); /** Returns @true if the file is currently opened. */ 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. @@ -247,8 +256,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.