GData.PicasaWebQuery¶

Subclasses:: None

Methods¶

Inherited:: GData.Query (27), GObject.Object (37)
Structs:: GObject.ObjectClass (5)

class	`new` (q)
class	`new_with_limits` (q, start_index, max_results)
	`get_bounding_box` ()
	`get_image_size` ()
	`get_location` ()
	`get_tag` ()
	`get_thumbnail_size` ()
	`get_visibility` ()
	`set_bounding_box` (north, east, south, west)
	`set_image_size` (image_size)
	`set_location` (location)
	`set_tag` (tag)
	`set_thumbnail_size` (thumbnail_size)
	`set_visibility` (visibility)

Virtual Methods¶

Inherited:: GData.Query (1), GObject.Object (7)

Properties¶

Inherited:: GData.Query (11)

Name	Type	Flags	Short Description
`image-size`	`str`	r/w	A comma-separated list of image sizes (width in pixels) to return.
`location`	`str`	r/w	A location to search for photos, e.g. “London”.
`tag`	`str`	r/w	A tag which returned results must contain.
`thumbnail-size`	`str`	r/w	A comma-separated list of thumbnail width (in pixels) to return.
`visibility`	`int`	r/w	Specifies which albums should be listed, in terms of their visibility.

Signals¶

Inherited:: GObject.Object (1)

Fields¶

Inherited:: GObject.Object (1)

Name	Type	Access	Description
parent	`GData.Query`	r

Class Details¶

class GData.PicasaWebQuery(**kwargs)¶

Bases:: GData.Query
Abstract:: No
Structure:: GData.PicasaWebQueryClass

All the fields in the GData.PicasaWebQuery structure are private and should never be accessed directly.

New in version 0.4.0.

classmethod new(q)¶

Parameters:: q (str or None) – a query string, or None
Returns:: a new GData.PicasaWebQuery
Return type:: GData.PicasaWebQuery

Creates a new GData.PicasaWebQuery with its GData.Query :q property set to q.

Note that when querying for albums with GData.PicasaWebService.query_all_albums(), the q parameter cannot be used.

New in version 0.4.0.

classmethod new_with_limits(q, start_index, max_results)¶

Parameters:

q (str or None) – a query string, or None
start_index (int) – the index of the first result to include, or 0
max_results (int) – the maximum number of results to include, or 0

Returns:

a new GData.PicasaWebQuery

Return type:

GData.PicasaWebQuery

Creates a GData.PicasaWebQuery with its GData.Query :q property set to q, returning max_results starting from the start_index th result.

Note that when querying for albums with GData.PicasaWebService.query_all_albums(), the q parameter cannot be used.

This is useful for paging through results, but the result set between separate queries may change. So, if you use this to request the next ten results after a previous query, it may include some of the previously returned results if their order changed, or omit ones that would have otherwise been found in a earlier but larger query.

New in version 0.6.0.

get_bounding_box()¶

Returns:

north:: return location for the latitude of the top of the box, or None
east:: return location for the longitude of the right of the box, or None
south:: return location for the latitude of the south of the box, or None
west:: return location for the longitude of the left of the box, or None

Return type:

(north: float, east: float, south: float, west: float)

Gets the latitudes and longitudes of a bounding box, inside which all the results must lie.

New in version 0.4.0.

get_image_size()¶

Returns:: the currently set desired image size for retrieval, or None
Return type:: str

Gets the GData.PicasaWebQuery :image-size property.

New in version 0.4.0.

get_location()¶

Returns:: a location which returned objects must be near, or None
Return type:: str

Gets the GData.PicasaWebQuery :location property.

New in version 0.4.0.

get_tag()¶

Returns:: a tag which retrieved objects must have, or None
Return type:: str

Gets the GData.PicasaWebQuery :tag property.

New in version 0.4.0.

get_thumbnail_size()¶

Returns:: a comma-separated list of thumbnail sizes to retrieve, or None
Return type:: str

Gets the GData.PicasaWebQuery :thumbnail-size property.

New in version 0.4.0.

get_visibility()¶

Returns:: the visibility of the objects to retrieve, or 0 to retrieve all objects
Return type:: GData.PicasaWebVisibility

Gets the GData.PicasaWebQuery :visibility property.

New in version 0.4.0.

set_bounding_box(north, east, south, west)¶

Parameters:

north (float) – latitude of the top of the box
east (float) – longitude of the right of the box
south (float) – latitude of the bottom of the box
west (float) – longitude of the left of the box

Sets a bounding box, inside which all the returned results must lie.

Set north, east, south and west to 0 to unset the property.

New in version 0.4.0.

set_image_size(image_size)¶

Parameters:: image_size (str or None) – the desired size of the image to be retrieved, or None

Sets the GData.PicasaWebQuery :image-size property to image_size. Valid sizes are described in the

online documentation. Set image_size to None to unset the property.

New in version 0.4.0.

set_location(location)¶

Parameters:: location (str or None) – a location which returned objects must be near, or None

Sets the GData.PicasaWebQuery :location property to location.

Set location to None to unset the property.

New in version 0.4.0.

set_tag(tag)¶

Parameters:: tag (str or None) – a tag which retrieved objects must have, or None

Sets the GData.PicasaWebQuery :tag property to tag.

Set tag to None to unset the property.

New in version 0.4.0.

set_thumbnail_size(thumbnail_size)¶

Parameters:: thumbnail_size (str or None) – a comma-separated list of thumbnail sizes to retrieve, or None

Sets the GData.PicasaWebQuery :thumbnail-size property to thumbnail_size.

Set thumbnail_size to None to unset the property.

New in version 0.4.0.

set_visibility(visibility)¶

Parameters:: visibility (GData.PicasaWebVisibility) – the visibility of the objects to retrieve, or 0 to retrieve all objects

Sets the GData.PicasaWebQuery :visibility property to visibility.

New in version 0.4.0.

Property Details¶

GData.PicasaWebQuery.props.image_size¶

Name:: image-size
Type:: str
Default Value:: None
Flags:: READABLE, WRITABLE

A comma-separated list of image sizes (width in pixels) to return. Only certain sizes are allowed, and whether the image should be cropped or scaled can be specified; for more information, see the

online documentation.

New in version 0.4.0.

GData.PicasaWebQuery.props.location¶

Name:: location
Type:: str
Default Value:: None
Flags:: READABLE, WRITABLE

A location to search for photos, e.g. “London”.

New in version 0.4.0.

GData.PicasaWebQuery.props.tag¶

Name:: tag
Type:: str
Default Value:: None
Flags:: READABLE, WRITABLE

A tag which returned results must contain.

New in version 0.4.0.

GData.PicasaWebQuery.props.thumbnail_size¶

Name:: thumbnail-size
Type:: str
Default Value:: None
Flags:: READABLE, WRITABLE

A comma-separated list of thumbnail widths (in pixels) to return. Only certain sizes are allowed, and whether the thumbnail should be cropped or scaled can be specified; for more information, see the

online documentation.

New in version 0.4.0.

GData.PicasaWebQuery.props.visibility¶

Name:: visibility
Type:: int
Default Value:: 0
Flags:: READABLE, WRITABLE

Specifies which albums should be listed, in terms of their visibility (GData.PicasaWebAlbum :visibility).

Set the property to 0 to list all albums, regardless of their visibility. Otherwise, use values from GData.PicasaWebVisibility.

For more information, see the online documentation.

New in version 0.4.0.