Correct wxID_SEPARATOR description in menu documentation.

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

diff --git a/interface/wx/textfile.h b/interface/wx/textfile.h
index 101b9debb1274f34d3f5692c3c887bd20e86a123..77c947945b15fb2c29918294d539de8b27a947eb 100644 (file)
--- a/interface/wx/textfile.h
+++ b/interface/wx/textfile.h
@@ -3,12 +3,13 @@
 // Purpose:     interface of wxTextFile
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Purpose:     interface of wxTextFile
 // Author:      wxWidgets team
 // RCS-ID:      $Id$

-// Licence:     wxWindows license
+// Licence:     wxWindows licence

 /////////////////////////////////////////////////////////////////////////////
 
 /////////////////////////////////////////////////////////////////////////////
 

+// TODO: document wxTextBuffer

 
 /**
 
 /**

-    The line termination type (kept wxTextFileType name for compability).
+    The line termination type.

 */
 enum wxTextFileType
 {
 */
 enum wxTextFileType
 {


@@ -54,10 +55,9 @@ enum wxTextFileType
       wxTextFile::Clear resets the file to empty.
     - Save your changes: notice that the changes you make to the file will @b not be
       saved automatically; calling wxTextFile::Close or doing nothing discards them!
       wxTextFile::Clear resets the file to empty.
     - Save your changes: notice that the changes you make to the file will @b not be
       saved automatically; calling wxTextFile::Close or doing nothing discards them!

-      To save the changes you must explicitly callwxTextFile::Write - here, you may
+      To save the changes you must explicitly call wxTextFile::Write - here, you may

       also change the line termination type if you wish.
 
       also change the line termination type if you wish.
 

-

     @library{wxbase}
     @category{file}
 
     @library{wxbase}
     @category{file}
 


@@ -66,6 +66,11 @@ enum wxTextFileType
 class wxTextFile
 {
 public:
 class wxTextFile
 {
 public:

+    /**
+        Default type for current platform determined at compile time.
+     */
+    static const wxTextFileType typeDefault;
+

     /**
         Default constructor, use Create() or Open() with a file name parameter to
         initialize the object.
     /**
         Default constructor, use Create() or Open() with a file name parameter to
         initialize the object.


@@ -85,8 +90,7 @@ public:
     /**
         Adds a line to the end of file.
     */
     /**
         Adds a line to the end of file.
     */

-    void AddLine(const wxString& str,
-                 wxTextFileType type = wxTextBuffer::typeDefault);
+    void AddLine(const wxString& str, wxTextFileType type = 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.


@@ -106,7 +110,7 @@ public:
 
         It will fail if the file already exists, Open() should be used in this case.
     */
 
         It will fail if the file already exists, Open() should be used in this case.
     */

-    bool Create() const;
+    bool Create();

 
     /**
         Creates the file with the given name.
 
     /**
         Creates the file with the given name.


@@ -114,7 +118,7 @@ public:
 
         It will fail if the file already exists, Open() should be used in this case.
     */
 
         It will fail if the file already exists, Open() should be used in this case.
     */

-    bool Create(const wxString& strFile) const;
+    bool Create(const wxString& strFile);

 
     /**
         Returns @true if the current line is the last one.
 
     /**
         Returns @true if the current line is the last one.


@@ -145,7 +149,7 @@ public:
         compiling with the Apple Developer Tools) and @c wxTextFileType_Mac under
         Mac OS (including Mac OS X when compiling with CodeWarrior).
     */
         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 = typeDefault);

 
     /**
         This method together with GetNextLine() allows more "iterator-like"
 
     /**
         This method together with GetNextLine() allows more "iterator-like"


@@ -235,17 +239,16 @@ 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 = wxTextBuffer::typeDefault);
+                    wxTextFileType type = typeDefault);

 
     /**
         Returns @true if the file is currently opened.
     */
     bool IsOpened() const;
 
 
     /**
         Returns @true if the file is currently opened.
     */
     bool IsOpened() const;
 

-    //@{

     /**
     /**

-        Open() opens the file with the given name or the name which was given in the
-        wxTextFile(const wxString&) constructor and also loads file in memory on success.
+        Opens the file with the name which was given in the 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.
 
 
         It will fail if the file does not exist, Create() should be used in this case.
 


@@ -253,8 +256,16 @@ public:
         it is used to convert the file to wide character representation.
     */
     bool Open(const wxMBConv& conv = wxConvAuto()) const;
         it is used to convert the file to wide character representation.
     */
     bool Open(const wxMBConv& conv = wxConvAuto()) const;

+
+    /**
+        Opens the file with the given name and also loads file in memory on success.
+
+        It will fail if the file does not exist, Create() should be used in this case.
+
+        The @a conv argument is only meaningful in Unicode build of wxWidgets when
+        it is used to convert the file to wide character representation.
+    */

     bool Open(const wxString& strFile, const wxMBConv& conv = wxConvAuto()) const;
     bool Open(const wxString& strFile, const wxMBConv& conv = wxConvAuto()) const;

-    //@}

 
     /**
         Delete line number @a n from the file.
 
     /**
         Delete line number @a n from the file.