#include <wx/webrequest.h>
A web request event sent during or after server communication.
Public Member Functions | |
wxWebRequest::State | GetState () const |
Return the current state of the request. More... | |
const wxWebRequest & | GetRequest () const |
Returns a reference to the wxWebRequest object which initiated this event. More... | |
const wxWebResponse & | GetResponse () const |
The response with the state set to State_Complete or empty response object for other events. More... | |
const wxString & | GetErrorDescription () const |
A textual error description for a client side error in case of State_Failed . More... | |
const wxString & | GetDataFile () const |
Returns the full path of a temporary file containing the response data when the state is State_Completed and storage is Storage_File . More... | |
const void * | GetDataBuffer () const |
Only for wxEVT_WEBREQUEST_DATA events. More... | |
size_t | GetDataSize () const |
Only for wxEVT_WEBREQUEST_DATA events. More... | |
![]() | |
wxEvent (int id=0, wxEventType eventType=wxEVT_NULL) | |
Constructor. More... | |
virtual wxEvent * | Clone () const =0 |
Returns a copy of the event. More... | |
wxObject * | GetEventObject () const |
Returns the object (usually a window) associated with the event, if any. More... | |
wxEventType | GetEventType () const |
Returns the identifier of the given event type, such as wxEVT_BUTTON . More... | |
virtual wxEventCategory | GetEventCategory () const |
Returns a generic category for this event. More... | |
int | GetId () const |
Returns the identifier associated with this event, such as a button command id. More... | |
wxObject * | GetEventUserData () const |
Return the user data associated with a dynamically connected event handler. More... | |
bool | GetSkipped () const |
Returns true if the event handler should be skipped, false otherwise. More... | |
long | GetTimestamp () const |
Gets the timestamp for the event. More... | |
bool | IsCommandEvent () const |
Returns true if the event is or is derived from wxCommandEvent else it returns false. More... | |
void | ResumePropagation (int propagationLevel) |
Sets the propagation level to the given value (for example returned from an earlier call to wxEvent::StopPropagation). More... | |
void | SetEventObject (wxObject *object) |
Sets the originating object. More... | |
void | SetEventType (wxEventType type) |
Sets the event type. More... | |
void | SetId (int id) |
Sets the identifier associated with this event, such as a button command id. More... | |
void | SetTimestamp (long timeStamp=0) |
Sets the timestamp for the event. More... | |
bool | ShouldPropagate () const |
Test if this event should be propagated or not, i.e. if the propagation level is currently greater than 0. More... | |
void | Skip (bool skip=true) |
This method can be used inside an event handler to control whether further event handlers bound to this event will be called after the current one returns. More... | |
int | StopPropagation () |
Stop the event from propagating to its parent window. More... | |
![]() | |
wxObject () | |
Default ctor; initializes to NULL the internal reference data. More... | |
wxObject (const wxObject &other) | |
Copy ctor. More... | |
virtual | ~wxObject () |
Destructor. More... | |
virtual wxClassInfo * | GetClassInfo () const |
This virtual function is redefined for every class that requires run-time type information, when using the wxDECLARE_CLASS macro (or similar). More... | |
wxObjectRefData * | GetRefData () const |
Returns the wxObject::m_refData pointer, i.e. the data referenced by this object. More... | |
bool | IsKindOf (const wxClassInfo *info) const |
Determines whether this class is a subclass of (or the same class as) the given class. More... | |
bool | IsSameAs (const wxObject &obj) const |
Returns true if this object has the same data pointer as obj. More... | |
void | Ref (const wxObject &clone) |
Makes this object refer to the data in clone. More... | |
void | SetRefData (wxObjectRefData *data) |
Sets the wxObject::m_refData pointer. More... | |
void | UnRef () |
Decrements the reference count in the associated data, and if it is zero, deletes the data. More... | |
void | UnShare () |
This is the same of AllocExclusive() but this method is public. More... | |
void | operator delete (void *buf) |
The delete operator is defined for debugging versions of the library only, when the identifier __WXDEBUG__ is defined. More... | |
void * | operator new (size_t size, const wxString &filename=NULL, int lineNum=0) |
The new operator is defined for debugging versions of the library only, when the identifier __WXDEBUG__ is defined. More... | |
Additional Inherited Members | |
![]() | |
void | AllocExclusive () |
Ensure that this object's data is not shared with any other object. More... | |
virtual wxObjectRefData * | CreateRefData () const |
Creates a new instance of the wxObjectRefData-derived class specific to this object and returns it. More... | |
virtual wxObjectRefData * | CloneRefData (const wxObjectRefData *data) const |
Creates a new instance of the wxObjectRefData-derived class specific to this object and initializes it copying data. More... | |
![]() | |
int | m_propagationLevel |
Indicates how many levels the event can propagate. More... | |
![]() | |
wxObjectRefData * | m_refData |
Pointer to an object which is the object's reference-counted data. More... | |
const void* wxWebRequestEvent::GetDataBuffer | ( | ) | const |
Only for wxEVT_WEBREQUEST_DATA
events.
The buffer is only valid inside the event handler.
const wxString& wxWebRequestEvent::GetDataFile | ( | ) | const |
Returns the full path of a temporary file containing the response data when the state is State_Completed
and storage is Storage_File
.
The file will be removed after the event handlers are called. You can move the file to a location of your choice if you want to process the contents outside the event handler.
size_t wxWebRequestEvent::GetDataSize | ( | ) | const |
Only for wxEVT_WEBREQUEST_DATA
events.
The buffer is only valid inside the event handler.
const wxString& wxWebRequestEvent::GetErrorDescription | ( | ) | const |
A textual error description for a client side error in case of State_Failed
.
const wxWebRequest& wxWebRequestEvent::GetRequest | ( | ) | const |
Returns a reference to the wxWebRequest
object which initiated this event.
const wxWebResponse& wxWebRequestEvent::GetResponse | ( | ) | const |
The response with the state set to State_Complete
or empty response object for other events.
wxWebRequest::State wxWebRequestEvent::GetState | ( | ) | const |
Return the current state of the request.