Amebis/wxWidgets
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

fix typo; distribute docs between Open() overloads for better rendering/better function descriptions

Browse Source 
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@59430 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Francesco Montorsi
2009-03-08 12:05:00 +00:00
parent 66fb9e1241
commit 482dce2a30
1 changed files with 12 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
interface/wx/textfile.h
View File

@@ -57,7 +57,6 @@ enum wxTextFileType
To save the changes you must explicitly call wxTextFile::Write - here, you may To save the changes you must explicitly call wxTextFile::Write - here, you may
also change the line termination type if you wish. also change the line termination type if you wish.
@library{wxbase} @library{wxbase}
@category{file} @category{file}
@@ -242,10 +241,9 @@ public:
*/ */
bool IsOpened() const; bool IsOpened() const;
//@{
/** /**
Open() opens the file with the given name or the name which was given in the Opens the file with the name which was given in the wxTextFile(const wxString&)
wxTextFile(const wxString&) constructor and also loads file in memory on success. 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. It will fail if the file does not exist, Create() should be used in this case.
@@ -253,8 +251,16 @@ public:
it is used to convert the file to wide character representation. it is used to convert the file to wide character representation.
*/ */
bool Open(const wxMBConv& conv = wxConvAuto()) const; bool Open(const wxMBConv& conv = wxConvAuto()) const;
/**
Opens the file with the given name 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 @a conv argument is only meaningful in Unicode build of wxWidgets when
it is used to convert the file to wide character representation.
*/
bool Open(const wxString& strFile, const wxMBConv& conv = wxConvAuto()) const; bool Open(const wxString& strFile, const wxMBConv& conv = wxConvAuto()) const;
//@}
/** /**
Delete line number @a n from the file. Delete line number @a n from the file.