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
|
.. wxPython Phoenix documentation
This file was generated by Phoenix's sphinx generator and associated
tools, do not edit by hand.
Copyright: (c) 2011-2018 by Total Control Software
License: wxWindows License
.. include:: headings.inc
.. currentmodule:: wx.lib.filebrowsebutton
.. highlight:: python
.. _wx.lib.filebrowsebutton.FileBrowseButton:
==========================================================================================================================================
|phoenix_title| **wx.lib.filebrowsebutton.FileBrowseButton**
==========================================================================================================================================
A control to allow the user to type in a filename or browse with
the standard file dialog to select file
|
|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>FileBrowseButton</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.filebrowsebutton.FileBrowseButton_inheritance.png" alt="Inheritance diagram of FileBrowseButton" usemap="#dummy" class="inheritance"/></center>
</div>
<script type="text/javascript">toggleVisibilityOnLoad(document.getElementById('toggleBlock'))</script>
<map id="dummy" name="dummy"> <area shape="rect" id="node1" href="wx.Panel.html" title="wx.Panel" alt="" coords="106,315,181,344"/> <area shape="rect" id="node6" href="wx.lib.filebrowsebutton.FileBrowseButton.html" title="wx.lib.filebrowsebutton.FileBrowseButton" alt="" coords="5,392,283,421"/> <area shape="rect" id="node2" href="wx.Window.html" title="wx.Window" alt="" coords="99,237,188,267"/> <area shape="rect" id="node3" href="wx.Trackable.html" title="wx.Trackable" alt="" coords="36,5,137,35"/> <area shape="rect" id="node4" href="wx.EvtHandler.html" title="wx.EvtHandler" alt="" coords="88,83,199,112"/> <area shape="rect" id="node7" href="wx.WindowBase.html" title="wx.WindowBase" alt="" coords="83,160,204,189"/> <area shape="rect" id="node5" href="wx.Object.html" title="wx.Object" alt="" coords="161,5,243,35"/> </map>
</p>
|
|sub_classes| Known Subclasses
==============================
:class:`wx.lib.filebrowsebutton.DirBrowseButton`, :class:`wx.lib.filebrowsebutton.FileBrowseButtonWithHistory`
|
|super_classes| Known Superclasses
==================================
:class:`wx.Panel`
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.lib.filebrowsebutton.FileBrowseButton.__init__` :param labelText: Text for label to left of text field
:meth:`~wx.lib.filebrowsebutton.FileBrowseButton.createBrowseButton` Create the browse-button control
:meth:`~wx.lib.filebrowsebutton.FileBrowseButton.createDialog` Setup the graphic representation of the dialog
:meth:`~wx.lib.filebrowsebutton.FileBrowseButton.createLabel` Create the label/caption
:meth:`~wx.lib.filebrowsebutton.FileBrowseButton.createTextControl` Create the text control
:meth:`~wx.lib.filebrowsebutton.FileBrowseButton.GetLabel` Retrieve the label's current text
:meth:`~wx.lib.filebrowsebutton.FileBrowseButton.GetValue` retrieve current value of text control
:meth:`~wx.lib.filebrowsebutton.FileBrowseButton.OnBrowse` Going to browse for file...
:meth:`~wx.lib.filebrowsebutton.FileBrowseButton.OnChanged`
:meth:`~wx.lib.filebrowsebutton.FileBrowseButton.SetBackgroundColour`
:meth:`~wx.lib.filebrowsebutton.FileBrowseButton.SetLabel` Set the label's current text
:meth:`~wx.lib.filebrowsebutton.FileBrowseButton.SetValue` set current value of text control
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: FileBrowseButton(wx.Panel)
A control to allow the user to type in a filename or browse with
the standard file dialog to select file
.. method:: __init__ (self, parent, id= -1, pos = wx.DefaultPosition, size = wx.DefaultSize, style = wx.TAB_TRAVERSAL, labelText= "File Entry:", buttonText= "Browse", toolTip= "Type filename or click browse to choose file", dialogTitle = "Choose a file", startDirectory = ".", initialValue = "", fileMask = "\*.\*", fileMode = wx.FD_OPEN, changeCallback= lambda x:x, labelWidth = 0, name = 'fileBrowseButton', )
:param labelText: Text for label to left of text field
:param buttonText: Text for button which launches the file dialog
:param toolTip: Help text
:param dialogTitle: Title used in file dialog
:param startDirectory: Default directory for file dialog startup
:param fileMask: File mask (glob pattern, such as *.*) to use in file dialog
:param fileMode: wx.FD_OPEN or wx.FD_SAVE, indicates type of file dialog to use
:param changeCallback: Optional callback called for all changes in value of the control
:param labelWidth: Width of the label
.. method:: createBrowseButton( self)
Create the browse-button control
.. method:: createDialog( self, parent, id, pos, size, style, name )
Setup the graphic representation of the dialog
.. method:: createLabel( self )
Create the label/caption
.. method:: createTextControl( self)
Create the text control
.. method:: GetLabel( self )
Retrieve the label's current text
.. method:: GetValue (self)
retrieve current value of text control
.. method:: OnBrowse (self, event = None)
Going to browse for file...
.. method:: OnChanged(self, evt)
.. method:: SetBackgroundColour(self,color)
.. method:: SetLabel( self, value )
Set the label's current text
.. method:: SetValue (self, value, callBack=1)
set current value of text control
|
