wxFlickrPhoto Class Reference

A wrapper for flickr photo information (see http://flickr.com/services/api/misc.urls.html). More...

#include <wxFlickrData.h>

Inheritance diagram for wxFlickrPhoto:

List of all members.

Public Member Functions
	wxFlickrPhoto (const wxFlickrPhoto &photo)
	Copy constructor for deep copies.
	wxFlickrPhoto (TiXmlElement *pElement)
void	SetId (wxString sId)
wxString	GetId ()
void	SetServerId (wxString sServerId)
wxString	GetServerId ()
void	SetSecret (wxString sSecret)
wxString	GetSecret ()
void	SetSize (wxString sSize)
wxString	GetSize ()
void	SetOwner (wxString sOwner)
wxString	GetOwner ()
void	SetTitle (wxString sTitle)
wxString	GetTitle ()
void	SetPublic (bool bPublic)
bool	IsPublic ()
void	SetFriend (bool bFriend)
bool	IsFriend ()
void	SetFamily (bool bFamily)
bool	IsFamily ()
bool	Download (bool bReload=FALSE)
	Download this image from flickr.com.
bool	IsDownloaded ()
	Check if this image already is downloaded from flickr.
wxFlickrError	GetLastError ()
	Return the last error this object encountered (downloading failed, etc).
wxImage *	GetImage ()
	Get this image as wxImage.
wxString	GetURLString ()
	Convert flickr.com photo information to URL (see http://flickr.com/services/api/misc.urls.html).

---

Detailed Description

A wrapper for flickr photo information (see http://flickr.com/services/api/misc.urls.html).

This class may also hold a wxImage containing the actual image data. It also can be used for downloading.

---

Member Function Documentation

bool wxFlickrPhoto::Download (  bool  bReload = FALSE  )

Download this image from flickr.com. Call GetLastError() if download fails. Check IsDownloaded() to find out if it already has been downloaded. Parameters: bReload  If TRUE the image will be downloaded even if it already has been downloaded before, all old data will be overwritten. Returns: TRUE upon success. If FALSE is returned try to call GetLastError() to get some more information.

wxImage * wxFlickrPhoto::GetImage (   )

Get this image as wxImage. Returns: A wxImage pointer or NULL if IsDownloaded is FALSE.

wxFlickrError wxFlickrPhoto::GetLastError (   )

Return the last error this object encountered (downloading failed, etc). Returns: Some error information.

wxString wxFlickrPhoto::GetURLString (   )

Convert flickr.com photo information to URL (see http://flickr.com/services/api/misc.urls.html). Returns: The URL of this photo. If the URL could not be determined an empty wxURL is returned (try to call url.hasServer() to check if it is set).

bool wxFlickrPhoto::IsDownloaded (   )

Check if this image already is downloaded from flickr. Returns: TRUE if a valid image has been downloaded.

---

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

• wxFlickrData.h
• wxFlickrData.cpp

---