X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/0004982c831f56c65c390fb617711ff52595c2f3..4e878f44abee3e03cf981772e9c623f0c16408c9:/interface/wx/textfile.h diff --git a/interface/wx/textfile.h b/interface/wx/textfile.h index f156227a47..eec73ae071 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) @@ -85,7 +86,7 @@ public: Adds a line to the end of file. */ void AddLine(const wxString& str, - wxTextFileType type = typeDefault) const; + wxTextFileType type = wxTextBuffer::typeDefault); /** Delete all lines from the file, set current line number to 0. @@ -154,7 +155,7 @@ public: // do something with the last line in str @endcode */ - wxString GetFirstLine() const; + wxString& GetFirstLine(); /** Gets the last line of the file. @@ -174,7 +175,7 @@ public: // do something with the first line in str @endcode */ - wxString GetLastLine(); + wxString& GetLastLine(); /** Retrieves the line number @a n from the file. @@ -182,7 +183,7 @@ public: The returned line may be modified but you shouldn't add line terminator at the end - this will be done by wxTextFile. */ - wxString GetLine(size_t n) const; + wxString& GetLine(size_t n) const; /** Get the number of lines in the file. @@ -197,17 +198,17 @@ public: /** Get the name of the file. */ - const char* GetName() const; + const wxString& GetName() const; /** Gets the next line (see GetFirstLine() for the example). */ - wxString GetNextLine(); + wxString& GetNextLine(); /** Gets the previous line in the file. */ - wxString GetPrevLine(); + wxString& GetPrevLine(); /** Changes the value returned by GetCurrentLine() and used by GetFirstLine() @@ -228,7 +229,7 @@ public: Insert a line before the line number @a n. */ void InsertLine(const wxString& str, size_t n, - wxTextFileType type = typeDefault) const; + wxTextFileType type = wxTextBuffer::typeDefault); /** Returns @true if the file is currently opened. @@ -269,11 +270,11 @@ public: @true if operation succeeded, @false if it failed. */ bool Write(wxTextFileType typeNew = wxTextFileType_None, - const wxMBConv& conv = wxConvAuto()) const; + const wxMBConv& conv = wxConvAuto()); /** The same as GetLine(). */ - wxString operator[](size_t n) const; + wxString& operator[](size_t n) const; };