document wxFSVolume (fixes #3977)

[wxWidgets.git] / interface / wx / textfile.h

diff --git a/interface/wx/textfile.h b/interface/wx/textfile.h
index 60b7d4e2e666bf8710b12d68a88863abb738c0c0..eec73ae0713b6825c47f9cde6d1560804dedea3c 100644 (file)
--- 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)
 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'
 };
 
     wxTextFileType_Os2    //!< line is terminated with 'CR' 'LF'
 };
 

-

 /**
     @class wxTextFile
 
 /**
     @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
     - 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)
     - 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,
         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.
 
     /**
         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
     */
         // do something with the last line in str
         @endcode
     */

-    wxString GetFirstLine() const;
+    wxString& GetFirstLine();

 
     /**
         Gets the last line of the file.
 
     /**
         Gets the last line of the file.


@@ -174,7 +175,7 @@ public:
         // do something with the first line in str
         @endcode
     */
         // do something with the first line in str
         @endcode
     */

-    wxString GetLastLine();
+    wxString& GetLastLine();

 
     /**
         Retrieves the line number @a n from the file.
 
     /**
         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.
     */
         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.
 
     /**
         Get the number of lines in the file.


@@ -197,17 +198,17 @@ public:
     /**
         Get the name of the file.
     */
     /**
         Get the name of the file.
     */

-    const char* GetName() const;
+    const wxString& GetName() const;

 
     /**
         Gets the next line (see GetFirstLine() for the example).
     */
 
     /**
         Gets the next line (see GetFirstLine() for the example).
     */

-    wxString GetNextLine();
+    wxString& GetNextLine();

 
     /**
         Gets the previous line in the file.
     */
 
     /**
         Gets the previous line in the file.
     */

-    wxString GetPrevLine();
+    wxString& GetPrevLine();

 
     /**
         Changes the value returned by GetCurrentLine() and used by GetFirstLine()
 
     /**
         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,
         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.
 
     /**
         Returns @true if the file is currently opened.


@@ -274,6 +275,6 @@ public:
     /**
         The same as GetLine().
     */
     /**
         The same as GetLine().
     */

-    wxString operator[](size_t n) const;
+    wxString& operator[](size_t n) const;

 };
 
 };