1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
|
.. 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
.. currentmodule:: wx.lib.agw.thumbnailctrl
.. highlight:: python
.. _wx.lib.agw.thumbnailctrl.ThumbnailCtrl:
==========================================================================================================================================
|phoenix_title| **wx.lib.agw.thumbnailctrl.ThumbnailCtrl**
==========================================================================================================================================
:class:`ThumbnailCtrl` is a widget that can be used to display a series of images in
a "thumbnail" format.
|
|class_hierarchy| Class Hierarchy
=================================
.. raw:: html
<div id="toggleBlock" onclick="return toggleVisibility(this)" class="closed" style="cursor:pointer;">
<img id="toggleBlock-trigger" src="_static/images/closed.png"/>
Inheritance diagram for class <strong>ThumbnailCtrl</strong>:
</div>
<div id="toggleBlock-summary" style="display:block;"></div>
<div id="toggleBlock-content" style="display:none;">
<p class="graphviz">
<center><img src="_static/images/inheritance/wx.lib.agw.thumbnailctrl.ThumbnailCtrl_inheritance.png" alt="Inheritance diagram of ThumbnailCtrl" usemap="#dummy" class="inheritance"/></center>
<script type="text/javascript">toggleVisibilityOnLoad(document.getElementById('toggleBlock'))</script>
<map id="dummy" name="dummy"> <area shape="rect" id="node1" href="wx.lib.agw.thumbnailctrl.ThumbnailCtrl.html" title="wx.lib.agw.thumbnailctrl.ThumbnailCtrl" alt="" coords="5,392,284,421"/> <area shape="rect" id="node2" href="wx.Panel.html" title="wx.Panel" alt="" coords="105,315,185,344"/> <area shape="rect" id="node3" href="wx.Window.html" title="wx.Window" alt="" coords="96,237,193,267"/> <area shape="rect" id="node4" href="wx.WindowBase.html" title="wx.WindowBase" alt="" coords="80,160,209,189"/> <area shape="rect" id="node5" href="wx.EvtHandler.html" title="wx.EvtHandler" alt="" coords="86,83,203,112"/> <area shape="rect" id="node6" href="wx.Object.html" title="wx.Object" alt="" coords="41,5,128,35"/> <area shape="rect" id="node7" href="wx.Trackable.html" title="wx.Trackable" alt="" coords="153,5,259,35"/> </map>
</p>
</div>
|
|appearance| Control Appearance
===============================
|
.. figure:: _static/images/widgets/fullsize/wxmsw/wx.lib.agw.thumbnailctrl.thumbnailctrl.png
:alt: wxMSW
:figclass: floatleft
**wxMSW**
.. figure:: _static/images/widgets/fullsize/wxmac/../no_appearance.png
:alt: wxMAC
:figclass: floatright
**wxMAC**
.. figure:: _static/images/widgets/fullsize/wxgtk/../no_appearance.png
:alt: wxGTK
:figclass: floatcenter
**wxGTK**
|
|super_classes| Known Superclasses
==================================
:class:`wx.Panel`
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.lib.agw.thumbnailctrl.ThumbnailCtrl.__init__` Default class constructor.
:meth:`~wx.lib.agw.thumbnailctrl.ThumbnailCtrl.DeleteFiles` Deletes the selected thumbnails and their associated files.
:meth:`~wx.lib.agw.thumbnailctrl.ThumbnailCtrl.GetShowComboBox` Returns whether the folder combobox is shown.
:meth:`~wx.lib.agw.thumbnailctrl.ThumbnailCtrl.GetShowDir` Returns the working directory with images.
:meth:`~wx.lib.agw.thumbnailctrl.ThumbnailCtrl.ListDirectory` Returns list of file info objects for files of particular extensions.
:meth:`~wx.lib.agw.thumbnailctrl.ThumbnailCtrl.OnComboBox` Handles the ``wx.EVT_COMBOBOX`` for the folder combobox.
:meth:`~wx.lib.agw.thumbnailctrl.ThumbnailCtrl.OnThumbChar`
:meth:`~wx.lib.agw.thumbnailctrl.ThumbnailCtrl.RecreateComboBox` Recreates the folder combobox every time a new directory is explored.
:meth:`~wx.lib.agw.thumbnailctrl.ThumbnailCtrl.SetBackgroundColour` Set the background color of the widget.
:meth:`~wx.lib.agw.thumbnailctrl.ThumbnailCtrl.ShowComboBox` Shows/Hide the top folder :class:`ComboBox`.
:meth:`~wx.lib.agw.thumbnailctrl.ThumbnailCtrl.ShowDir` Shows thumbnails for a particular folder.
:meth:`~wx.lib.agw.thumbnailctrl.ThumbnailCtrl.ShowFileNames` Sets whether the user wants to show file names under the thumbnails or not.
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: ThumbnailCtrl(wx.Panel)
:class:`ThumbnailCtrl` is a widget that can be used to display a series of images in
a "thumbnail" format.
.. method:: __init__(self, parent, id=wx.ID_ANY, pos=wx.DefaultPosition, size=wx.DefaultSize, thumboutline=THUMB_OUTLINE_IMAGE, thumbfilter=None, imagehandler=PILImageHandler)
Default class constructor.
:param `parent`: parent window. Must not be ``None``;
:param `id`: window identifier. A value of -1 indicates a default value;
:param `pos`: the control position. A value of (-1, -1) indicates a default position,
chosen by either the windowing system or wxPython, depending on platform;
:param `size`: the control size. A value of (-1, -1) indicates a default size,
chosen by either the windowing system or wxPython, depending on platform;
:param `thumboutline`: outline style for :class:`ThumbnailCtrl`, which may be:
=========================== ======= ==================================
Outline Flag Value Description
=========================== ======= ==================================
``THUMB_OUTLINE_NONE`` 0 No outline is drawn on selection
``THUMB_OUTLINE_FULL`` 1 Full outline (image+caption) is drawn on selection
``THUMB_OUTLINE_RECT`` 2 Only thumbnail bounding rectangle is drawn on selection (default)
``THUMB_OUTLINE_IMAGE`` 4 Only image bounding rectangle is drawn.
=========================== ======= ==================================
:param `thumbfilter`: filter for image/video/audio files. Ignored.
:param `imagehandler`: can be :class:`PILImageHandler` if PIL is installed (faster), or
:class:`NativeImageHandler` which only uses wxPython image methods.
.. method:: DeleteFiles(self, thumbs)
Deletes the selected thumbnails and their associated files.
.. warning:: This method deletes the original files too.
:param `thumbs`: List of indexes to thumbnails.
.. method:: GetShowComboBox(self)
Returns whether the folder combobox is shown.
.. method:: GetShowDir(self)
Returns the working directory with images.
.. method:: ListDirectory(self, directory, fileExtList)
Returns list of file info objects for files of particular extensions.
:param `directory`: the folder containing the images to thumbnail;
:param `fileExtList`: a Python list of file extensions to consider.
.. method:: OnComboBox(self, event)
Handles the ``wx.EVT_COMBOBOX`` for the folder combobox.
:param `event`: a :class:`CommandEvent` event to be processed.
.. method:: OnThumbChar(self, ev)
.. method:: RecreateComboBox(self, newdir)
Recreates the folder combobox every time a new directory is explored.
:param `newdir`: the new folder to be explored.
.. method:: SetBackgroundColour(self, colour)
Set the background color of the widget.
:param `colour`: the color to which the background is set.
.. method:: ShowComboBox(self, show=True)
Shows/Hide the top folder :class:`ComboBox`.
:param `show`: ``True`` to show the combobox, ``False`` otherwise.
.. method:: ShowDir(self, folder)
Shows thumbnails for a particular folder.
:param `folder`: a directory containing the images to thumbnail;
.. method:: ShowFileNames(self, show=True)
Sets whether the user wants to show file names under the thumbnails or not.
:param `show`: ``True`` to show file names under the thumbnails, ``False`` otherwise.
|
