wxFlickrEvent Class Reference

The wxFlickrAPI.wxFlickrClient and its components will annouce what is happening (an request has finished, an error occured, etc) by posting one of these events into the wxWidgets event system. More...

#include <wxFlickrEvent.h>

List of all members.

Public Types
enum	Type {   Unknown, Error, GotFrob, GotToken,   GotPhotoList, GotEmptySuccess, GotSomeData }
	Event type identifiers. More...
Public Member Functions
	wxFlickrEvent (const wxFlickrEvent &event)
	Copy constructor for deep copies.
virtual wxEvent *	Clone () const
	Provide a deep copy of this object (needed for the wxWidgets event system).
void	SetData (wxFlickrData *pData)
	Set the data associated with this event.
wxFlickrData *	GetData ()
	Get the data associated with this event.
void	SetType (Type iType)
	Set the type of this event.
Type	GetType ()
	Get the type of this event.
Protected Attributes
wxFlickrData *	m_pData
wxFlickrEvent::Type	m_iType

---

Detailed Description

The wxFlickrAPI.wxFlickrClient and its components will annouce what is happening (an request has finished, an error occured, etc) by posting one of these events into the wxWidgets event system.

Make sure to catch these events with a function that, for instance, can be defined in using the EVT_FLICKR macro in your event table declaration. It should look like this: void OnFlickrEvent(wxFlickrEvent& event);

---

Member Enumeration Documentation

enum wxFlickrEvent::Type

Event type identifiers. Enumerator: Unknown  An unknown event. Error  An error occured. GetData will return a wxFlickrError pointer. GotFrob  A frob was received. GetData will return an AuthData pointer. GotToken  A token was received. GetData will return an AuthData pointer. GotPhotoList  A list of photos was received. GetData will return a PhotosData pointer. GotEmptySuccess  An empty success nota has been received. GetData will return NULL. GotSomeData  Some data was received (a list of tags, some photo info or whatever). GetData will return a wxFlickrData pointer.

---

Member Function Documentation

wxFlickrData * wxFlickrEvent::GetData (   )

Get the data associated with this event. The type of data varies with the wxFlickrEvent.Type. Returns: A pointer to the data associated with this event. You will want to delete it after using it.

wxFlickrEvent::Type wxFlickrEvent::GetType (   )

Get the type of this event. Parameters: iType  The type of this event.

void wxFlickrEvent::SetData (  wxFlickrData *  pData  )

Set the data associated with this event. The type of data varies with the wxFlickrEvent.Type. Make sure to set a correct pointer here. Parameters: pData  A pointer to some data. The type of data should be determined by the wxFlickrEvent.Type of this event.

void wxFlickrEvent::SetType (  wxFlickrEvent::Type  iType  )

Set the type of this event. Parameters: iType  A valid event type.

---

The documentation for this class was generated from the following files:

• wxFlickrEvent.h
• wxFlickrEvent.cpp

---