adjusted indentation with astyle; added Id keyword
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@52383 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
@@ -9,14 +9,14 @@
|
||||
/**
|
||||
@class wxTextFile
|
||||
@wxheader{textfile.h}
|
||||
|
||||
|
||||
The wxTextFile is a simple class which allows to work with text files on line by
|
||||
line basis. It also understands the differences in line termination characters
|
||||
under different platforms and will not do anything bad to files with "non
|
||||
native" line termination sequences - in fact, it can be also used to modify the
|
||||
text files and change the line termination characters from one type (say DOS) to
|
||||
another (say Unix).
|
||||
|
||||
|
||||
One word of warning: the class is not at all optimized for big files and thus
|
||||
it will load the file entirely into memory when opened. Of course, you should
|
||||
not
|
||||
@@ -24,42 +24,42 @@
|
||||
surely too big for this class). On the other hand, it is not a serious
|
||||
limitation for small files like configuration files or program sources
|
||||
which are well handled by wxTextFile.
|
||||
|
||||
|
||||
The typical things you may do with wxTextFile in order are:
|
||||
|
||||
Create and open it: this is done with either
|
||||
wxTextFile::Create or wxTextFile::Open
|
||||
|
||||
Create and open it: this is done with either
|
||||
wxTextFile::Create or wxTextFile::Open
|
||||
function which opens the file (name may be specified either as the argument to
|
||||
these functions or in the constructor), reads its contents in memory (in the
|
||||
case of @c Open()) and closes it.
|
||||
Work with the lines in the file: this may be done either with "direct
|
||||
access" functions like wxTextFile::GetLineCount and
|
||||
access" functions like wxTextFile::GetLineCount and
|
||||
wxTextFile::GetLine (@e operator[] does exactly the same
|
||||
but looks more like array addressing) or with "sequential access" functions
|
||||
which include wxTextFile::GetFirstLine/
|
||||
wxTextFile::GetNextLine and also
|
||||
wxTextFile::GetNextLine and also
|
||||
wxTextFile::GetLastLine/wxTextFile::GetPrevLine.
|
||||
For the sequential access functions the current line number is maintained: it is
|
||||
returned by wxTextFile::GetCurrentLine and may be
|
||||
changed with wxTextFile::GoToLine.
|
||||
Add/remove lines to the file: wxTextFile::AddLine and
|
||||
wxTextFile::InsertLine add new lines while
|
||||
Add/remove lines to the file: wxTextFile::AddLine and
|
||||
wxTextFile::InsertLine add new lines while
|
||||
wxTextFile::RemoveLine deletes the existing ones.
|
||||
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 call
|
||||
nothing discards them! To save the changes you must explicitly call
|
||||
wxTextFile::Write - here, you may also change the line
|
||||
termination type if you wish.
|
||||
|
||||
|
||||
|
||||
|
||||
@library{wxbase}
|
||||
@category{file}
|
||||
|
||||
|
||||
@seealso
|
||||
wxFile
|
||||
*/
|
||||
class wxTextFile
|
||||
class wxTextFile
|
||||
{
|
||||
public:
|
||||
/**
|
||||
@@ -84,7 +84,7 @@ public:
|
||||
void Clear();
|
||||
|
||||
/**
|
||||
Closes the file and frees memory, @b losing all changes. Use Write()
|
||||
Closes the file and frees memory, @b losing all changes. Use Write()
|
||||
if you want to save them.
|
||||
*/
|
||||
bool Close();
|
||||
@@ -99,7 +99,7 @@ public:
|
||||
be used in this case.
|
||||
*/
|
||||
bool Create();
|
||||
bool Create(const wxString& strFile);
|
||||
bool Create(const wxString& strFile);
|
||||
//@}
|
||||
|
||||
/**
|
||||
@@ -134,14 +134,14 @@ public:
|
||||
#define static const char* GetEOL(wxTextFileType type = typeDefault) /* implementation is private */
|
||||
|
||||
/**
|
||||
This method together with GetNextLine()
|
||||
This method together with GetNextLine()
|
||||
allows more "iterator-like" traversal of the list of lines, i.e. you may
|
||||
write something like:
|
||||
*/
|
||||
wxString GetFirstLine();
|
||||
|
||||
/**
|
||||
Gets the last line of the file. Together with
|
||||
Gets the last line of the file. Together with
|
||||
GetPrevLine() it allows to enumerate the lines
|
||||
in the file from the end to the beginning like this:
|
||||
*/
|
||||
@@ -170,7 +170,7 @@ public:
|
||||
const char* GetName();
|
||||
|
||||
/**
|
||||
Gets the next line (see GetFirstLine() for
|
||||
Gets the next line (see GetFirstLine() for
|
||||
the example).
|
||||
*/
|
||||
wxString GetNextLine();
|
||||
@@ -181,7 +181,7 @@ public:
|
||||
wxString GetPrevLine();
|
||||
|
||||
/**
|
||||
Changes the value returned by GetCurrentLine()
|
||||
Changes the value returned by GetCurrentLine()
|
||||
and used by wxTextFile::GetFirstLine/GetNextLine().
|
||||
*/
|
||||
void GoToLine(size_t n);
|
||||
@@ -206,18 +206,18 @@ public:
|
||||
|
||||
//@{
|
||||
/**
|
||||
)
|
||||
)
|
||||
|
||||
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,
|
||||
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.
|
||||
*/
|
||||
bool Open();
|
||||
bool Open(const wxString& strFile);
|
||||
bool Open(const wxString& strFile);
|
||||
//@}
|
||||
|
||||
/**
|
||||
@@ -226,7 +226,7 @@ public:
|
||||
void RemoveLine(size_t n);
|
||||
|
||||
/**
|
||||
)
|
||||
)
|
||||
|
||||
Change the file on disk. The @e typeNew parameter allows you to change the
|
||||
file format (default argument means "don't change type") and may be used to
|
||||
|
Reference in New Issue
Block a user