added template wxScopedArray<> too

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

diff --git a/interface/wx/textfile.h b/interface/wx/textfile.h
index fdeb78dd00ee8c6e1e350901a1c22285abf3dbb2..865814685de0ae2456966a741b1c2c8e7a361605 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)
@@ -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)
@@ -98,16 +99,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() const;
-    bool Create(const wxString& strFile) const;
-    //@}
+    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 wxString& strFile);
 
     /**
         Returns @true if the current line is the last one.
@@ -138,7 +145,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"
@@ -238,7 +245,7 @@ public:
     //@{
     /**
         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.
+        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.