implemented, tested and documented wxTextCtrl::SetMaxLength()

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

diff --git a/include/wx/textfile.h b/include/wx/textfile.h
index a078a518bf208a7eedb6aba4a4f5cd04f2439dd7..6d902976d2abe22d5d70ff3f413fa716714659c2 100644 (file)
--- a/include/wx/textfile.h
+++ b/include/wx/textfile.h
@@ -20,31 +20,33 @@
 
 #include "wx/defs.h"
 
-#if !wxUSE_FILE
-    #undef wxUSE_TEXTFILE
-    #define wxUSE_TEXTFILE 0
-#endif // wxUSE_FILE
-
-#if wxUSE_TEXTFILE
-
-#include "wx/string.h"
-#include "wx/file.h"
-#include "wx/dynarray.h"
-
 // ----------------------------------------------------------------------------
-// wxTextFile
+// constants
 // ----------------------------------------------------------------------------
 
+// NB: this is always defined, even if !wxUSE_TEXTFILE
+
 // the line termination type
 enum wxTextFileType
 {
     wxTextFileType_None,  // incomplete (the last line of the file only)
     wxTextFileType_Unix,  // line is terminated with 'LF' = 0xA = 10 = '\n'
     wxTextFileType_Dos,   //                         'CR' 'LF'
-    wxTextFileType_Mac    //                         'CR' = 0xD = 13 = '\r'
+    wxTextFileType_Mac,   //                         'CR' = 0xD = 13 = '\r'
+    wxTextFileType_Os2    //                         'CR' 'LF'
 };
 
-WX_DEFINE_ARRAY(wxTextFileType, ArrayFileType);
+#if wxUSE_TEXTFILE
+
+#include "wx/string.h"
+#include "wx/file.h"
+#include "wx/dynarray.h"
+
+// ----------------------------------------------------------------------------
+// wxTextFile
+// ----------------------------------------------------------------------------
+
+WX_DEFINE_EXPORTED_ARRAY(wxTextFileType, ArrayFileType);
 
 class WXDLLEXPORT wxTextFile
 {
@@ -72,10 +74,14 @@ public:
   // file operations
     // file exists?
   bool Exists() const;
+    // create the file if it doesn't already exist
+  bool Create();
+    // same as Create() but with (another) file name
+  bool Create(const wxString& strFile);
     // Open() also loads file in memory on success
-  bool Open();
+  bool Open(wxMBConv& conv = wxConvLibc);
     // same as Open() but with (another) file name
-  bool Open(const wxString& strFile);
+  bool Open(const wxString& strFile, wxMBConv& conv = wxConvLibc);
     // closes the file and frees memory, losing all changes
   bool Close();
     // is file currently opened?
@@ -93,7 +99,7 @@ public:
     // you're using "direct access" i.e. GetLine()
   size_t GetCurrentLine() const { return m_nCurLine; }
   void GoToLine(size_t n) { m_nCurLine = n; }
-  bool Eof() const { return m_nCurLine == m_aLines.Count() - 1; }
+  bool Eof() const { return (m_aLines.Count() == 0 || m_nCurLine == m_aLines.Count() - 1); }
 
     // these methods allow more "iterator-like" traversal of the list of
     // lines, i.e. you may write something like:
@@ -125,11 +131,12 @@ public:
                   wxTextFileType type = typeDefault)
     { m_aLines.Insert(str, n); m_aTypes.Insert(type, n); }
     // delete one line
-  void RemoveLine(size_t n) { m_aLines.Remove(n); m_aTypes.Remove(n); }
+  void RemoveLine(size_t n) { m_aLines.RemoveAt(n); m_aTypes.RemoveAt(n); }
 
   // change the file on disk (default argument means "don't change type")
   // possibly in another format
-  bool Write(wxTextFileType typeNew = wxTextFileType_None);
+  bool Write(wxTextFileType typeNew = wxTextFileType_None,
+             wxMBConv& conv = wxConvLibc);
 
   // dtor
   ~wxTextFile();
@@ -140,7 +147,7 @@ private:
   wxTextFile& operator=(const wxTextFile&);
 
   // read the file in memory (m_file is supposed to be just opened)
-  bool Read();
+  bool Read(wxMBConv& conv);
 
   wxFile        m_file;     // current file
 
@@ -179,6 +186,12 @@ private:
     // copy ctor/assignment operator not implemented
     wxTextFile(const wxTextFile&);
     wxTextFile& operator=(const wxTextFile&);
+
+    // suppress the gcc warning: 'class defines only private constructors and
+    // has no friends'
+#ifdef __GNUG__
+    friend class wxTextFileDummyFriend;
+#endif // gcc
 };
 
 #endif // wxUSE_TEXTFILE