Rename wxWebRequestEvent::GetResponseFileName() to GetDataFile()

This is shorter and doesn't imply that just the name (and not the full
path) is being returned.

Also rename wxWebResponse::GetFileName() to GetDataFile() for the same
reasons and for consistency. And document this previously undocumented
method.
This commit is contained in:
Vadim Zeitlin
2021-01-12 03:34:40 +01:00
parent d0f56b1d04
commit 20a3317839
6 changed files with 24 additions and 17 deletions

View File

@@ -164,7 +164,7 @@ public:
The data is written to a file on disk as it is received.
This file can be later read from using wxWebResponse::GetStream()
or otherwise processed using wxWebRequestEvent::GetResponseFileName().
or otherwise processed using wxWebRequestEvent::GetDataFile().
*/
Storage_File,
@@ -550,6 +550,13 @@ public:
*/
wxString GetSuggestedFileName() const;
/**
Returns the full path of the file to which data is being saved.
This is only valid when storage mode is @c Storage_File.
*/
wxString GetDataFile() const;
/**
Returns all response data as a string.
@@ -737,7 +744,7 @@ public:
move the file to a location of your choice if you want to process the
contents outside the event handler.
*/
const wxString& GetResponseFileName() const;
const wxString& GetDataFile() const;
/**
Only for @c wxEVT_WEBREQUEST_DATA events. The buffer is only valid