addind nonowned window implementation

[wxWidgets.git] / interface / ffile.h

diff --git a/interface/ffile.h b/interface/ffile.h
index a0d29e9e6d6feaf56f106a4f0cf0e49016fde321..4f97fa6aea8e95173d35cbbfaa2bafe49539d52b 100644 (file)
--- a/interface/ffile.h
+++ b/interface/ffile.h
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        ffile.h
 /////////////////////////////////////////////////////////////////////////////
 // Name:        ffile.h

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

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


@@ -9,53 +9,48 @@
 /**
     @class wxFFile
     @wxheader{ffile.h}
 /**
     @class wxFFile
     @wxheader{ffile.h}

-    
+

     wxFFile implements buffered file I/O. This is a very small class designed to
     minimize the overhead of using it - in fact, there is hardly any overhead at
     all, but using it brings you automatic error checking and hides differences
     between platforms and compilers. It wraps inside it a @c FILE * handle used
     by standard C IO library (also known as @c stdio).
     wxFFile implements buffered file I/O. This is a very small class designed to
     minimize the overhead of using it - in fact, there is hardly any overhead at
     all, but using it brings you automatic error checking and hides differences
     between platforms and compilers. It wraps inside it a @c FILE * handle used
     by standard C IO library (also known as @c stdio).

-    
+

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

-    
-    @seealso
-    wxFFile::IsOpened
+
+    @see wxFFile::IsOpened

 */
 */

-class wxFFile 
+class wxFFile

 {
 public:
     //@{
     /**
         Opens a file with the given file pointer, which has already been opened.
 {
 public:
     //@{
     /**
         Opens a file with the given file pointer, which has already been opened.

-        
-        @param filename 
-        The filename.
-        
-        @param mode 
-        The mode in which to open the file using standard C strings.
-        Note that you should use "b" flag if you use binary files under Windows
-        or the results might be unexpected due to automatic newline conversion done
-        for the text files.
-        
-        @param fp 
-        An existing file descriptor, such as stderr.
+
+        @param filename
+            The filename.
+        @param mode
+            The mode in which to open the file using standard C strings.
+            Note that you should use "b" flag if you use binary files under Windows
+            or the results might be unexpected due to automatic newline conversion done
+            for the text files.
+        @param fp
+            An existing file descriptor, such as stderr.

     */
     wxFFile();
     */
     wxFFile();

-        wxFFile(const wxString& filename, const wxString& mode = "r");
-        wxFFile(FILE* fp);
+    wxFFile(const wxString& filename, const wxString& mode = "r");
+    wxFFile(FILE* fp);

     //@}
 
     /**
         Destructor will close the file.
     //@}
 
     /**
         Destructor will close the file.

-        

         NB: it is not virtual so you should @e not derive from wxFFile!
     */
     ~wxFFile();
 
     /**
         Attaches an existing file pointer to the wxFFile object.
         NB: it is not virtual so you should @e not derive from wxFFile!
     */
     ~wxFFile();
 
     /**
         Attaches an existing file pointer to the wxFFile object.

-        

         The descriptor should be already opened and it will be closed by wxFFile
         object.
     */
         The descriptor should be already opened and it will be closed by wxFFile
         object.
     */


@@ -75,28 +70,25 @@ public:
 
     /**
         Returns @true if the an attempt has been made to read @e past
 
     /**
         Returns @true if the an attempt has been made to read @e past

-        the end of the file. 
-        
+        the end of the file.

         Note that the behaviour of the file descriptor based class
         wxFile is different as wxFile::Eof
         will return @true here as soon as the last byte of the file has been
         read.
         Note that the behaviour of the file descriptor based class
         wxFile is different as wxFile::Eof
         will return @true here as soon as the last byte of the file has been
         read.

-        

         Also note that this method may only be called for opened files and may crash if
         the file is not opened.
         Also note that this method may only be called for opened files and may crash if
         the file is not opened.

-        
-        @sa IsOpened()
+
+        @see IsOpened()

     */
     */

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

 
     /**
         Returns @true if an error has occurred on this file, similar to the standard
         @c ferror() function.
 
     /**
         Returns @true if an error has occurred on this file, similar to the standard
         @c ferror() function.

-        

         Please note that this method may only be called for opened files and may crash
         if the file is not opened.
         Please note that this method may only be called for opened files and may crash
         if the file is not opened.

-        
-        @sa IsOpened()
+
+        @see IsOpened()

     */
 
 
     */
 
 


@@ -108,69 +100,64 @@ public:
     /**
         Returns the type of the file. Possible return values are:
     */
     /**
         Returns the type of the file. Possible return values are:
     */

-    wxFileKind GetKind();
+    wxFileKind GetKind() const;

 
     /**
         Returns @true if the file is opened. Most of the methods of this class may
         only
         be used for an opened file.
     */
 
     /**
         Returns @true if the file is opened. Most of the methods of this class may
         only
         be used for an opened file.
     */

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

 
     /**
         Returns the length of the file.
     */
 
     /**
         Returns the length of the file.
     */

-    wxFileOffset Length();
+    wxFileOffset Length() const;

 
     /**
         Opens the file, returning @true if successful.
 
     /**
         Opens the file, returning @true if successful.

-        
-        @param filename 
-        The filename.
-        
-        @param mode 
-        The mode in which to open the file.
+
+        @param filename
+            The filename.
+        @param mode
+            The mode in which to open the file.

     */
     bool Open(const wxString& filename, const wxString& mode = "r");
 
     /**
         Reads the specified number of bytes into a buffer, returning the actual number
         read.
     */
     bool Open(const wxString& filename, const wxString& mode = "r");
 
     /**
         Reads the specified number of bytes into a buffer, returning the actual number
         read.

-        
-        @param buffer 
-        A buffer to receive the data.
-        
-        @param count 
-        The number of bytes to read.
-        
+
+        @param buffer
+            A buffer to receive the data.
+        @param count
+            The number of bytes to read.
+

         @returns The number of bytes read.
     */
     size_t Read(void* buffer, size_t count);
 
     /**
         )
         @returns The number of bytes read.
     */
     size_t Read(void* buffer, size_t count);
 
     /**
         )

-        

         Reads the entire contents of the file into a string.
         Reads the entire contents of the file into a string.

-        
-        @param str 
-        String to read data into.
-        
-        @param conv 
-        Conversion object to use in Unicode build; by default supposes
-        that file contents is encoded in UTF-8.
-        
+
+        @param str
+            String to read data into.
+        @param conv
+            Conversion object to use in Unicode build; by default supposes
+            that file contents is encoded in UTF-8.
+

         @returns @true if file was read successfully, @false otherwise.
     */
         @returns @true if file was read successfully, @false otherwise.
     */

-    bool ReadAll(wxString * str);
+    bool ReadAll(wxString* str);

 
     /**
         Seeks to the specified position and returns @true on success.
 
     /**
         Seeks to the specified position and returns @true on success.

-        
-        @param ofs 
-        Offset to seek to.
-        
-        @param mode 
-        One of wxFromStart, wxFromEnd, wxFromCurrent.
+
+        @param ofs
+            Offset to seek to.
+        @param mode
+            One of wxFromStart, wxFromEnd, wxFromCurrent.

     */
     bool Seek(wxFileOffset ofs, wxSeekMode mode = wxFromStart);
 
     */
     bool Seek(wxFileOffset ofs, wxSeekMode mode = wxFromStart);
 


@@ -178,29 +165,28 @@ public:
         Moves the file pointer to the specified number of bytes before the end of the
         file
         and returns @true on success.
         Moves the file pointer to the specified number of bytes before the end of the
         file
         and returns @true on success.

-        
-        @param ofs 
-        Number of bytes before the end of the file.
+
+        @param ofs
+            Number of bytes before the end of the file.

     */
     bool SeekEnd(wxFileOffset ofs = 0);
 
     /**
         Returns the current position.
     */
     */
     bool SeekEnd(wxFileOffset ofs = 0);
 
     /**
         Returns the current position.
     */

-    wxFileOffset Tell();
+    wxFileOffset Tell() const;

 
     /**
         )
 
     /**
         )

-        

         Writes the contents of the string to the file, returns @true on success.
         Writes the contents of the string to the file, returns @true on success.

-        

         The second argument is only meaningful in Unicode build of wxWidgets when
         The second argument is only meaningful in Unicode build of wxWidgets when

-        @e conv is used to convert @e s to multibyte representation.
+        @e conv is used to convert @a s to multibyte representation.

     */
     bool Write(const wxString& s);
 
     /**
         Returns the file pointer associated with the file.
     */
     */
     bool Write(const wxString& s);
 
     /**
         Returns the file pointer associated with the file.
     */

-#define FILE * fp()     /* implementation is private */
+    FILE* fp() const;

 };
 };

+