minor corrections: document typeDefault, remove text copied from the header (closes #10740)
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@60351 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
@@ -6,9 +6,10 @@
|
|||||||
// Licence: wxWindows license
|
// Licence: wxWindows license
|
||||||
/////////////////////////////////////////////////////////////////////////////
|
/////////////////////////////////////////////////////////////////////////////
|
||||||
|
|
||||||
|
// TODO: document wxTextBuffer
|
||||||
|
|
||||||
/**
|
/**
|
||||||
The line termination type (kept wxTextFileType name for compability).
|
The line termination type.
|
||||||
*/
|
*/
|
||||||
enum wxTextFileType
|
enum wxTextFileType
|
||||||
{
|
{
|
||||||
@@ -65,6 +66,11 @@ enum wxTextFileType
|
|||||||
class wxTextFile
|
class wxTextFile
|
||||||
{
|
{
|
||||||
public:
|
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
|
Default constructor, use Create() or Open() with a file name parameter to
|
||||||
initialize the object.
|
initialize the object.
|
||||||
@@ -84,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,
|
void AddLine(const wxString& str, wxTextFileType type = typeDefault);
|
||||||
wxTextFileType type = wxTextBuffer::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.
|
||||||
@@ -144,7 +149,7 @@ public:
|
|||||||
compiling with the Apple Developer Tools) and @c wxTextFileType_Mac under
|
compiling with the Apple Developer Tools) and @c wxTextFileType_Mac under
|
||||||
Mac OS (including Mac OS X when compiling with CodeWarrior).
|
Mac OS (including Mac OS X when compiling with CodeWarrior).
|
||||||
*/
|
*/
|
||||||
static const wxChar* GetEOL(wxTextFileType type = wxTextBuffer::typeDefault);
|
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"
|
||||||
@@ -234,7 +239,7 @@ public:
|
|||||||
Insert a line before the line number @a n.
|
Insert a line before the line number @a n.
|
||||||
*/
|
*/
|
||||||
void InsertLine(const wxString& str, size_t n,
|
void InsertLine(const wxString& str, size_t n,
|
||||||
wxTextFileType type = wxTextBuffer::typeDefault);
|
wxTextFileType type = typeDefault);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
Returns @true if the file is currently opened.
|
Returns @true if the file is currently opened.
|
||||||
|
Reference in New Issue
Block a user