Phoenix Logo

phoenix_title wx.lib.agw.thumbnailctrl.Thumb

This is an auxiliary class, to handle single thumbnail information for every thumb.

Used internally.


class_hierarchy Class Hierarchy

Inheritance diagram for class Thumb:


method_summary Methods Summary

__init__ Default class constructor.
BreakCaption Breaks the caption in several lines of text (if needed).
GetBitmap Returns the associated bitmap.
GetCaption Returns the caption associated to a thumbnail.
GetCaptionLinesCount Returns the number of lines for the caption.
GetCreationDate Returns the file last modification date associated to a thumbnail.
GetFileName Returns the file name associated with this thumbnail.
GetFileSize Returns the file size associated to a thumbnail.
GetFullFileName Returns the full filename of the thumbnail.
GetId Returns the thumbnail identifier.
GetImage Returns the thumbnail image.
GetOriginalImage Returns the bitmap associated to a thumbnail, as a file name.
GetOriginalSize Returns a tuple containing the original image width and height, in pixels.
GetRotatedImage Returns a rotated image.
GetRotation Returns the thumbnail rotation, in radians.
SetBitmap Sets the thumbnail bitmap.
SetCaption Sets the thumbnail caption.
SetFileName Sets the file name associated with this thumbnail.
SetId Sets the thumbnail identifier.
SetImage Sets the thumbnail image.
SetRotatedImage Sets the image as rotated (fast).
SetRotation Sets the thumbnail rotation.

api Class API



class Thumb(object)

This is an auxiliary class, to handle single thumbnail information for every thumb.

Used internally.


Methods



__init__(self, parent, folder, filename, caption="", size=0, lastmod=0)

Default class constructor.

Parameters:
  • parent – the main ThumbnailCtrl window;
  • folder – the directory containing the images;
  • filename – a file containing an image;
  • caption – the thumbnail caption string;
  • size – the file size;
  • lastmod – the file last modification time.


BreakCaption(self, width)

Breaks the caption in several lines of text (if needed).

Parameters:width – the maximum width, in pixels, available for the caption text.


GetBitmap(self, width, height)

Returns the associated bitmap.

Parameters:
  • width – the associated bitmap width;
  • height – the associated bitmap height.


GetCaption(self, line)

Returns the caption associated to a thumbnail.

Parameters:line – the caption line we wish to retrieve (useful for multilines caption strings).


GetCaptionLinesCount(self, width)

Returns the number of lines for the caption.

Parameters:width – the maximum width, in pixels, available for the caption text.


GetCreationDate(self)

Returns the file last modification date associated to a thumbnail.



GetFileName(self)

Returns the file name associated with this thumbnail.



GetFileSize(self)

Returns the file size associated to a thumbnail.



GetFullFileName(self)

Returns the full filename of the thumbnail.



GetId(self)

Returns the thumbnail identifier.



GetImage(self)

Returns the thumbnail image.



GetOriginalImage(self)

Returns the bitmap associated to a thumbnail, as a file name.



GetOriginalSize(self)

Returns a tuple containing the original image width and height, in pixels.



GetRotatedImage(self)

Returns a rotated image.



GetRotation(self)

Returns the thumbnail rotation, in radians.



SetBitmap(self, bmp)

Sets the thumbnail bitmap.

Parameters:bmp – a wx.Bitmap object.


SetCaption(self, caption="")

Sets the thumbnail caption.

Parameters:caption – the thumbnail caption string.


SetFileName(self, filename)

Sets the file name associated with this thumbnail.

Parameters:filename – the file containing the image.


SetId(self, id=-1)

Sets the thumbnail identifier.

Parameters:id – an integer specifying the thumbnail identifier.


SetImage(self, image)

Sets the thumbnail image.

Parameters:image – a wx.Image object.


SetRotatedImage(self, image)

Sets the image as rotated (fast).

Parameters:image – the rotated image, an instance of wx.Image.


SetRotation(self, angle=0)

Sets the thumbnail rotation.

Parameters:angle – the thumbnail rotation, in radians.