mac paths updated

[wxWidgets.git] / interface / textfile.h

diff --git a/interface/textfile.h b/interface/textfile.h
index 1d192506517ac2a0fd9c6cb6da7434a1d3a3ed13..ca8b2d8da1cd70506c46baa939ed7b9497e57991 100644 (file)
--- a/interface/textfile.h
+++ b/interface/textfile.h
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        textfile.h
 /////////////////////////////////////////////////////////////////////////////
 // Name:        textfile.h

-// Purpose:     documentation for wxTextFile class
+// Purpose:     interface of wxTextFile

 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license


@@ -56,8 +56,7 @@
     @library{wxbase}
     @category{file}
 
     @library{wxbase}
     @category{file}
 

-    @seealso
-    wxFile
+    @see wxFile

 */
 class wxTextFile
 {
 */
 class wxTextFile
 {


@@ -65,53 +64,52 @@ public:
     /**
         Constructor does not load the file into memory, use Open() to do it.
     */
     /**
         Constructor does not load the file into memory, use Open() to do it.
     */

-    wxTextFile(const wxString& strFile);
+    wxTextFile(const wxString& strFile) const;

 
     /**
         Destructor does nothing.
     */
 
     /**
         Destructor does nothing.
     */

-    ~wxTextFile();
+    ~wxTextFile() const;

 
     /**
         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);
+                 wxTextFileType type = typeDefault) const;

 
     /**
         Delete all lines from the file, set current line number to 0.
     */
 
     /**
         Delete all lines from the file, set current line number to 0.
     */

-    void Clear();
+    void Clear() const;

 
     /**
         Closes the file and frees memory, @b losing all changes. Use Write()
         if you want to save them.
     */
 
     /**
         Closes the file and frees memory, @b losing all changes. Use Write()
         if you want to save them.
     */

-    bool Close();
+    bool Close() const;

 
     //@{
     /**
         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.
 
     //@{
     /**
         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.

-        

         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();
-    bool Create(const wxString& strFile);
+    bool Create() const;
+    const bool Create(const wxString& strFile) const;

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

-#define bool Eof()     /* implementation is private */
+    bool Eof() const;

 
     /**
         Return @true if file exists - the name of the file should have been specified
         in the constructor before calling Exists().
     */
 
     /**
         Return @true if file exists - the name of the file should have been specified
         in the constructor before calling Exists().
     */

-    bool Exists();
+    bool Exists() const;

 
     /**
         Returns the current line: it has meaning only when you're using
 
     /**
         Returns the current line: it has meaning only when you're using


@@ -120,7 +118,7 @@ public:
         GetLastLine() also change the value of the current line, as well as
         GoToLine().
     */
         GetLastLine() also change the value of the current line, as well as
         GoToLine().
     */

-    size_t GetCurrentLine();
+    size_t GetCurrentLine() const;

 
     /**
         Get the line termination string corresponding to given constant. @e typeDefault
 
     /**
         Get the line termination string corresponding to given constant. @e typeDefault


@@ -131,14 +129,14 @@ public:
         Apple Developer Tools) and wxTextFileType_Mac under Mac OS (including
         Mac OS X when compiling with CodeWarrior).
     */
         Apple Developer Tools) and wxTextFileType_Mac under Mac OS (including
         Mac OS X when compiling with CodeWarrior).
     */

-#define static const char* GetEOL(wxTextFileType type = typeDefault)     /* implementation is private */
+    static const char* GetEOL(wxTextFileType type = typeDefault) const;

 
     /**
         This method together with GetNextLine()
         allows more "iterator-like" traversal of the list of lines, i.e. you may
         write something like:
     */
 
     /**
         This method together with GetNextLine()
         allows more "iterator-like" traversal of the list of lines, i.e. you may
         write something like:
     */

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

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


@@ -148,26 +146,26 @@ public:
     wxString GetLastLine();
 
     /**
     wxString GetLastLine();
 
     /**

-        Retrieves the line number @e n from the file. The returned line may be
+        Retrieves the line number @a n from the file. The returned line may be

         modified but you shouldn't add line terminator at the end - this will be done
         by wxTextFile.
     */
         modified but you shouldn't add line terminator at the end - this will be done
         by wxTextFile.
     */

-    wxString GetLine(size_t n);
+    wxString GetLine(size_t n) const;

 
     /**
         Get the number of lines in the file.
     */
 
     /**
         Get the number of lines in the file.
     */

-    size_t GetLineCount();
+    size_t GetLineCount() const;

 
     /**
         Get the type of the line (see also wxTextFile::GetEOL)
     */
 
     /**
         Get the type of the line (see also wxTextFile::GetEOL)
     */

-    wxTextFileType GetLineType(size_t n);
+    wxTextFileType GetLineType(size_t n) const;

 
     /**
         Get the name of the file.
     */
 
     /**
         Get the name of the file.
     */

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

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


@@ -184,64 +182,60 @@ public:
         Changes the value returned by GetCurrentLine()
         and used by wxTextFile::GetFirstLine/GetNextLine().
     */
         Changes the value returned by GetCurrentLine()
         and used by wxTextFile::GetFirstLine/GetNextLine().
     */

-    void GoToLine(size_t n);
+    void GoToLine(size_t n) const;

 
     /**
         Guess the type of file (which is supposed to be opened). If sufficiently
         many lines of the file are in DOS/Unix/Mac format, the corresponding value will
         be returned. If the detection mechanism fails wxTextFileType_None is returned.
     */
 
     /**
         Guess the type of file (which is supposed to be opened). If sufficiently
         many lines of the file are in DOS/Unix/Mac format, the corresponding value will
         be returned. If the detection mechanism fails wxTextFileType_None is returned.
     */

-    wxTextFileType GuessType();
+    wxTextFileType GuessType() const;

 
     /**
         Insert a line before the line number @e n.
     */
     void InsertLine(const wxString& str, size_t n,
 
     /**
         Insert a line before the line number @e n.
     */
     void InsertLine(const wxString& str, size_t n,

-                    wxTextFileType type = typeDefault);
+                    wxTextFileType type = typeDefault) const;

 
     /**
         Returns @true if the file is currently opened.
     */
 
     /**
         Returns @true if the file is currently opened.
     */

-    bool IsOpened();
+    bool IsOpened() const;

 
     //@{
     /**
         )
 
     //@{
     /**
         )

-        

         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. It will fail if the file does not exist,
         Create() should be used in this case.
         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. It will fail if the file does not exist,
         Create() should be used in this case.

-        

         The @e conv argument is only meaningful in Unicode build of wxWidgets when
         it is used to convert the file to wide character representation.
     */
         The @e conv argument is only meaningful in Unicode build of wxWidgets when
         it is used to convert the file to wide character representation.
     */

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

     //@}
 
     /**
     //@}
 
     /**

-        Delete line number @e n from the file.
+        Delete line number @a n from the file.

     */
     */

-    void RemoveLine(size_t n);
+    void RemoveLine(size_t n) const;

 
     /**
         )
 
     /**
         )

-        
-        Change the file on disk. The @e typeNew parameter allows you to change the
+        Change the file on disk. The @a typeNew parameter allows you to change the

         file format (default argument means "don't change type") and may be used to
         convert, for example, DOS files to Unix.
         file format (default argument means "don't change type") and may be used to
         convert, for example, DOS files to Unix.

-        

         The @e conv argument is only meaningful in Unicode build of wxWidgets when
         it is used to convert all lines to multibyte representation before writing them
         them to physical file.
         The @e conv argument is only meaningful in Unicode build of wxWidgets when
         it is used to convert all lines to multibyte representation before writing them
         them to physical file.

-        

         Returns @true if operation succeeded, @false if it failed.
     */
         Returns @true if operation succeeded, @false if it failed.
     */

-    bool Write(wxTextFileType typeNew = wxTextFileType_None);
+    bool Write(wxTextFileType typeNew = wxTextFileType_None) const;

 
     /**
         The same as GetLine().
     */
 
     /**
         The same as GetLine().
     */

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

 };
 };

+