.. wxPython Phoenix documentation This file was generated by Phoenix's sphinx generator and associated tools, do not edit by hand. Copyright: (c) 2011-2020 by Total Control Software License: wxWindows License .. include:: headings.inc .. module:: wx.lib.agw.thumbnailctrl .. currentmodule:: wx.lib.agw.thumbnailctrl .. highlight:: python .. _wx.lib.agw.thumbnailctrl: ========================================================================================================================================== |phoenix_title| **wx.lib.agw.thumbnailctrl** ========================================================================================================================================== :class:`~wx.lib.agw.thumbnailctrl.ThumbnailCtrl` is a widget that can be used to display a series of images in a "thumbnail" format. Description =========== :class:`ThumbnailCtrl` is a widget that can be used to display a series of images in a "thumbnail" format; it mimics, for example, the windows explorer behavior when you select the "view thumbnails" option. Basically, by specifying a folder that contains some image files, the files in the folder are displayed as miniature versions of the actual images in a :class:`ScrolledWindow`. The code is partly based on `wxVillaLib`, a wxWidgets implementation of this control. However, :class:`ThumbnailCtrl` wouldn't have been so fast and complete without the suggestions and hints from Peter Damoc. So, if he accepts the mention, this control is his as much as mine. :class:`ThumbnailCtrl` is more of a demo application than a widget. The :class:`ScrolledThumbnail` is a freestanding widget, accepting a list of :class:`Thumb` objects which represent files and which returns a thumbnail on request. :class:`Thumb` can be extended by the user to provide thumbnails for other data types, such as text, audio, video, or PDF files. Usage ===== Usage example:: import os import wx import wx.lib.agw.thumbnailctrl as TC class MyFrame(wx.Frame): def __init__(self, parent): wx.Frame.__init__(self, parent, -1, "ThumbnailCtrl Demo") panel = wx.Panel(self) sizer = wx.BoxSizer(wx.VERTICAL) thumbnail = TC.ThumbnailCtrl(panel, imagehandler=TC.NativeImageHandler) sizer.Add(thumbnail, 1, wx.EXPAND | wx.ALL, 10) thumbnail.ShowDir(os.getcwd()) panel.SetSizer(sizer) # our normal wxApp-derived class, as usual app = wx.App(0) frame = MyFrame(None) app.SetTopWindow(frame) frame.Show() app.MainLoop() Methods and Settings ==================== With :class:`ThumbnailCtrl` you can: - Create different thumbnail outlines (none, images only, full, etc...); - Highlight thumbnails on mouse hovering; - Show/hide file names below thumbnails; - Change thumbnail caption font; - Zoom in/out thumbnails (done via ``Ctrl`` key + mouse wheel or with ``+`` and ``-`` chars, with zoom factor value customizable); - Rotate thumbnails with these specifications: a) ``d`` key rotates 90 degrees clockwise; b) ``s`` key rotates 90 degrees counter-clockwise; c) ``a`` key rotates 180 degrees. - Delete files/thumbnails (via the ``del`` key); - Drag and drop thumbnails from :class:`ThumbnailCtrl` to whatever application you want; - Use local (when at least one thumbnail is selected) or global (no need for thumbnail selection) popup menus; - Show/hide a :class:`ComboBox` at the top of :class:`ThumbnailCtrl`: this combobox contains working directory information and it has history entries; - possibility to show tooltips on thumbnails, which display file information (like file name, size, last modification date and thumbnail size). .. note:: Using highlight thumbnails on mouse hovering may be slow on slower computers. Window Styles ============= `No particular window styles are available for this class.` Events Processing ================= This class processes the following events: ================================== ================================================== Event Name Description ================================== ================================================== ``EVT_THUMBNAILS_DCLICK`` The user has double-clicked on a thumbnail. ``EVT_THUMBNAILS_POINTED`` The mouse cursor is hovering over a thumbnail. ``EVT_THUMBNAILS_SEL_CHANGED`` The user has changed the selected thumbnail. ``EVT_THUMBNAILS_THUMB_CHANGED`` The thumbnail of an image has changed. Used internally. ``EVT_THUMBNAILS_CHAR`` A key was typed in the widget ================================== ================================================== License And Version =================== :class:`ThumbnailCtrl` is distributed under the wxPython license. Latest revision: Michael Eager @ 26 Sep 2020 Version 1.0 |function_summary| Functions Summary ==================================== ================================================================================ ================================================================================ :func:`~wx.lib.agw.thumbnailctrl.opj` Convert paths to the platform-specific separator. ================================================================================ ================================================================================ | |class_summary| Classes Summary =============================== ================================================================================ ================================================================================ `~wx.lib.agw.thumbnailctrl.ScrolledTextDialog` :class:`ScrolledTextDialog` is a dialog widget which displays a scrolled `~wx.lib.agw.thumbnailctrl.ThumbnailCtrl` :class:`ThumbnailCtrl` is a widget that can be used to display a series of images in ================================================================================ ================================================================================ | .. toctree:: :maxdepth: 1 :hidden: wx.lib.agw.thumbnailctrl.ScrolledTextDialog wx.lib.agw.thumbnailctrl.ThumbnailCtrl Functions ------------ .. function:: opj(path) Convert paths to the platform-specific separator. :param `path`: the path to convert.