pen.h depends from brush.h in compat mode

[wxWidgets.git] / interface / txtstrm.h

diff --git a/interface/txtstrm.h b/interface/txtstrm.h
index e2aa84879773bec3a21e081fecd0edeb55732e1b..998dd280a98e58d2044ce5dc8e95186bbc317b29 100644 (file)
--- a/interface/txtstrm.h
+++ b/interface/txtstrm.h
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        txtstrm.h
 /////////////////////////////////////////////////////////////////////////////
 // Name:        txtstrm.h

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

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


@@ -9,70 +9,67 @@
 /**
     @class wxTextInputStream
     @wxheader{txtstrm.h}
 /**
     @class wxTextInputStream
     @wxheader{txtstrm.h}

-    
+

     This class provides functions that read text datas using an input stream.
     So, you can read @e text floats, integers.
     This class provides functions that read text datas using an input stream.
     So, you can read @e text floats, integers.

-    
+

     The wxTextInputStream correctly reads text files (or streams) in DOS, Macintosh
     and Unix formats and reports a single newline char as a line ending.
     The wxTextInputStream correctly reads text files (or streams) in DOS, Macintosh
     and Unix formats and reports a single newline char as a line ending.

-    
+

     Operator  is overloaded and you can use this class like a standard C++ iostream.
     Note, however, that the arguments are the fixed size types wxUint32, wxInt32 etc
     and on a typical 32-bit computer, none of these match to the "long" type
     (wxInt32
     is defined as int on 32-bit architectures) so that you cannot use long. To avoid
     problems (here and elsewhere), make use of wxInt32, wxUint32 and similar types.
     Operator  is overloaded and you can use this class like a standard C++ iostream.
     Note, however, that the arguments are the fixed size types wxUint32, wxInt32 etc
     and on a typical 32-bit computer, none of these match to the "long" type
     (wxInt32
     is defined as int on 32-bit architectures) so that you cannot use long. To avoid
     problems (here and elsewhere), make use of wxInt32, wxUint32 and similar types.

-    
+

     If you're scanning through a file using wxTextInputStream, you should check for
     EOF @b before
     reading the next item (word / number), because otherwise the last item may get
     If you're scanning through a file using wxTextInputStream, you should check for
     EOF @b before
     reading the next item (word / number), because otherwise the last item may get

-    lost. 
+    lost.

     You should however be prepared to receive an empty item (empty string / zero
     number) at the
     end of file, especially on Windows systems. This is unavoidable because most
     (but not all) files end
     with whitespace (i.e. usually a newline).
     You should however be prepared to receive an empty item (empty string / zero
     number) at the
     end of file, especially on Windows systems. This is unavoidable because most
     (but not all) files end
     with whitespace (i.e. usually a newline).

-    
+

     For example:
     For example:

-    
+

     @code
     wxFileInputStream input( "mytext.txt" );
       wxTextInputStream text( input );
       wxUint8 i1;
       float f2;
       wxString line;
     @code
     wxFileInputStream input( "mytext.txt" );
       wxTextInputStream text( input );
       wxUint8 i1;
       float f2;
       wxString line;

-    
+

       text  i1;       // read a 8 bit integer.
       text  i1  f2; // read a 8 bit integer followed by float.
       text  line;     // read a text line
     @endcode
       text  i1;       // read a 8 bit integer.
       text  i1  f2; // read a 8 bit integer followed by float.
       text  line;     // read a text line
     @endcode

-    
+

     @library{wxbase}
     @category{streams}
     @library{wxbase}
     @category{streams}

-    
-    @seealso
-    wxTextInputStream::SetStringSeparators
+
+    @see wxTextInputStream::SetStringSeparators

 */
 */

-class wxTextInputStream 
+class wxTextInputStream

 {
 public:
     /**
         )
 {
 public:
     /**
         )

-        

         Constructs a text stream associated to the given input stream.
         
         Constructs a text stream associated to the given input stream.
         

-        @param stream 
-        The underlying input stream.
-        
-        @param sep 
-        The initial string separator characters.
-        
-        @param conv 
-        In Unicode build only: The encoding converter used to convert the bytes in the
-          underlying input stream to characters.
+        @param stream
+            The underlying input stream.
+        @param sep
+            The initial string separator characters.
+        @param conv
+            In Unicode build only: The encoding converter used to convert the bytes in
+        the
+              underlying input stream to characters.

     */
     wxTextInputStream(wxInputStream& stream,
     */
     wxTextInputStream(wxInputStream& stream,

-                      const wxString& sep=" \t");
+                      const wxString& sep = " \t");

 
     /**
         Destroys the wxTextInputStream object.
 
     /**
         Destroys the wxTextInputStream object.


@@ -86,40 +83,35 @@ public:
 
     /**
         Reads a unsigned 16 bit integer from the stream.
 
     /**
         Reads a unsigned 16 bit integer from the stream.

-        

         See wxTextInputStream::Read8 for the
         See wxTextInputStream::Read8 for the

-        description of the @e base parameter.
+        description of the @a base parameter.

     */
     wxUint16 Read16(int base = 10);
 
     /**
         Reads a signed 16 bit integer from the stream.
     */
     wxUint16 Read16(int base = 10);
 
     /**
         Reads a signed 16 bit integer from the stream.

-        

         See wxTextInputStream::Read8 for the
         See wxTextInputStream::Read8 for the

-        description of the @e base parameter.
+        description of the @a base parameter.

     */
     wxInt16 Read16S(int base = 10);
 
     /**
         Reads a 32 bit unsigned integer from the stream.
     */
     wxInt16 Read16S(int base = 10);
 
     /**
         Reads a 32 bit unsigned integer from the stream.

-        

         See wxTextInputStream::Read8 for the
         See wxTextInputStream::Read8 for the

-        description of the @e base parameter.
+        description of the @a base parameter.

     */
     wxUint32 Read32(int base = 10);
 
     /**
         Reads a 32 bit signed integer from the stream.
     */
     wxUint32 Read32(int base = 10);
 
     /**
         Reads a 32 bit signed integer from the stream.

-        

         See wxTextInputStream::Read8 for the
         See wxTextInputStream::Read8 for the

-        description of the @e base parameter.
+        description of the @a base parameter.

     */
     wxInt32 Read32S(int base = 10);
 
     /**
         Reads a single unsigned byte from the stream, given in base @e base.
     */
     wxInt32 Read32S(int base = 10);
 
     /**
         Reads a single unsigned byte from the stream, given in base @e base.

-        
-        The value of @e base must be comprised between 2 and 36, inclusive, or
+        The value of @a base must be comprised between 2 and 36, inclusive, or

         be a special value 0 which means that the usual rules of @c C numbers are
         applied: if the number starts with @c 0x it is considered to be in base
         16, if it starts with @c 0 - in base 8 and in base 10 otherwise. Note
         be a special value 0 which means that the usual rules of @c C numbers are
         applied: if the number starts with @c 0x it is considered to be in base
         16, if it starts with @c 0 - in base 8 and in base 10 otherwise. Note


@@ -131,9 +123,8 @@ public:
 
     /**
         Reads a single signed byte from the stream.
 
     /**
         Reads a single signed byte from the stream.

-        

         See wxTextInputStream::Read8 for the
         See wxTextInputStream::Read8 for the

-        description of the @e base parameter.
+        description of the @a base parameter.

     */
     wxInt8 Read8S(int base = 10);
 
     */
     wxInt8 Read8S(int base = 10);
 


@@ -149,9 +140,8 @@ public:
     wxString ReadLine();
 
     /**
     wxString ReadLine();
 
     /**

-        @b NB: This method is deprecated, use ReadLine() 
+        @b NB: This method is deprecated, use ReadLine()

         or ReadWord() instead.
         or ReadWord() instead.

-        

         Same as ReadLine().
     */
     wxString ReadString();
         Same as ReadLine().
     */
     wxString ReadString();


@@ -160,61 +150,59 @@ public:
         Reads a word (a sequence of characters until the next separator) from the
         input stream.
         
         Reads a word (a sequence of characters until the next separator) from the
         input stream.
         

-        @sa SetStringSeparators()
+        @see SetStringSeparators()

     */
     wxString ReadWord();
 
     /**
     */
     wxString ReadWord();
 
     /**

-        Sets the characters which are used to define the word boundaries in 
+        Sets the characters which are used to define the word boundaries in

         ReadWord().
         ReadWord().

-        

         The default separators are the space and @c TAB characters.
     */
     void SetStringSeparators(const wxString& sep);
 };
 
 
         The default separators are the space and @c TAB characters.
     */
     void SetStringSeparators(const wxString& sep);
 };
 
 

+

 /**
     @class wxTextOutputStream
     @wxheader{txtstrm.h}
 /**
     @class wxTextOutputStream
     @wxheader{txtstrm.h}

-    
+

     This class provides functions that write text datas using an output stream.
     So, you can write @e text floats, integers.
     This class provides functions that write text datas using an output stream.
     So, you can write @e text floats, integers.

-    
+

     You can also simulate the C++ cout class:
     You can also simulate the C++ cout class:

-    
+

     @code
     wxFFileOutputStream output( stderr );
       wxTextOutputStream cout( output );
     @code
     wxFFileOutputStream output( stderr );
       wxTextOutputStream cout( output );

-    
+

       cout  "This is a text line"  endl;
       cout  1234;
       cout  1.23456;
     @endcode
       cout  "This is a text line"  endl;
       cout  1234;
       cout  1.23456;
     @endcode

-    
+

     The wxTextOutputStream writes text files (or streams) on DOS, Macintosh
     and Unix in their native formats (concerning the line ending).
     The wxTextOutputStream writes text files (or streams) on DOS, Macintosh
     and Unix in their native formats (concerning the line ending).

-    
+

     @library{wxbase}
     @category{streams}
 */
     @library{wxbase}
     @category{streams}
 */

-class wxTextOutputStream 
+class wxTextOutputStream

 {
 public:
     /**
         )
 {
 public:
     /**
         )

-        

         Constructs a text stream object associated to the given output stream.
         
         Constructs a text stream object associated to the given output stream.
         

-        @param stream 
-        The output stream.
-        
-        @param mode 
-        The end-of-line mode. One of wxEOL_NATIVE, wxEOL_DOS, wxEOL_MAC and wxEOL_UNIX.
-        
-        @param conv 
-        In Unicode build only: The object used to convert
-        Unicode text into ASCII characters written to the output stream.
+        @param stream
+            The output stream.
+        @param mode
+            The end-of-line mode. One of wxEOL_NATIVE, wxEOL_DOS, wxEOL_MAC and
+        wxEOL_UNIX.
+        @param conv
+            In Unicode build only: The object used to convert
+            Unicode text into ASCII characters written to the output stream.

     */
     wxTextOutputStream(wxOutputStream& stream,
                        wxEOL mode = wxEOL_NATIVE);
     */
     wxTextOutputStream(wxOutputStream& stream,
                        wxEOL mode = wxEOL_NATIVE);


@@ -242,29 +230,30 @@ public:
     void SetMode(wxEOL mode = wxEOL_NATIVE);
 
     /**
     void SetMode(wxEOL mode = wxEOL_NATIVE);
 
     /**

-        Writes the 16 bit integer @e i16 to the stream.
+        Writes the 16 bit integer @a i16 to the stream.

     */
     void Write16(wxUint16 i16);
 
     /**
     */
     void Write16(wxUint16 i16);
 
     /**

-        Writes the 32 bit integer @e i32 to the stream.
+        Writes the 32 bit integer @a i32 to the stream.

     */
     void Write32(wxUint32 i32);
 
     /**
     */
     void Write32(wxUint32 i32);
 
     /**

-        Writes the single byte @e i8 to the stream.
+        Writes the single byte @a i8 to the stream.

     */
     void Write8(wxUint8 i8);
 
     /**
     */
     void Write8(wxUint8 i8);
 
     /**

-        Writes the double @e f to the stream using the IEEE format.
+        Writes the double @a f to the stream using the IEEE format.

     */
     virtual void WriteDouble(double f);
 
     /**
     */
     virtual void WriteDouble(double f);
 
     /**

-        Writes @e string as a line. Depending on the end-of-line mode the end of
+        Writes @a string as a line. Depending on the end-of-line mode the end of

         line ('\n') characters in the string are converted to the correct
         line ending terminator.
     */
     virtual void WriteString(const wxString& string);
 };
         line ('\n') characters in the string are converted to the correct
         line ending terminator.
     */
     virtual void WriteString(const wxString& string);
 };

+