X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/c6cf894ae2dc66126724a9aee8ba5c62f4d9572a..a70ab3b804b6c363f8bcbed0b4fce94b7fb03612:/interface/wx/textfile.h diff --git a/interface/wx/textfile.h b/interface/wx/textfile.h index 6d5b77183a..fdeb78dd00 100644 --- a/interface/wx/textfile.h +++ b/interface/wx/textfile.h @@ -11,9 +11,9 @@ enum wxTextFileType { wxTextFileType_None, //!< incomplete (the last line of the file only) - wxTextFileType_Unix, //!< line is terminated with 'LF' = 0xA = 10 = '\n' + wxTextFileType_Unix, //!< line is terminated with 'LF' = 0xA = 10 = '\\n' wxTextFileType_Dos, //!< line is terminated with 'CR' 'LF' - wxTextFileType_Mac, //!< line is terminated with 'CR' = 0xD = 13 = '\r' + wxTextFileType_Mac, //!< line is terminated with 'CR' = 0xD = 13 = '\\r' wxTextFileType_Os2 //!< line is terminated with 'CR' 'LF' }; @@ -85,23 +85,23 @@ 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. */ - void Clear() const; + void Clear(); /** Closes the file and frees memory, @b "losing all changes". Use Write() if you want to save them. */ - bool Close() const; + bool Close(); //@{ /** Creates the file with the given name or the name which was given in the - @ref ctor() constructor. The array of file lines is initially empty. + @ref wxTextFile() constructor. The array of file lines is initially empty. It will fail if the file already exists, Open() should be used in this case. */ @@ -154,7 +154,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 +174,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 +182,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,23 +197,23 @@ 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() and GetNextLine(). */ - void GoToLine(size_t n) const; + void GoToLine(size_t n); /** Guess the type of file (which is supposed to be opened). @@ -228,7 +228,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. @@ -238,7 +238,7 @@ public: //@{ /** Open() opens the file with the given name or the name which was given in the - @ref ctor() constructor and also loads file in memory on success. + @ref wxTextFile() 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. @@ -252,7 +252,7 @@ public: /** Delete line number @a n from the file. */ - void RemoveLine(size_t n) const; + void RemoveLine(size_t n); /** Change the file on disk. @@ -262,18 +262,18 @@ public: for example, DOS files to Unix. The @a conv argument is only meaningful in Unicode build of wxWidgets when - it is used to convert all lines to multibyte representation before writing them + it is used to convert all lines to multibyte representation before writing them to physical file. @return @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; };