-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathclass_button_builder_1_1_button_builder.html
344 lines (330 loc) · 16.2 KB
/
class_button_builder_1_1_button_builder.html
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
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.12.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>SimulFCImage: ButtonBuilder.ButtonBuilder Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<script type="text/javascript" src="clipboard.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="cookie.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">SimulFCImage<span id="projectnumber"> Final</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.12.0 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
$(function() { codefold.init(0); });
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search',false);
$(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
$(function(){ initResizable(false); });
/* @license-end */
</script>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><b>ButtonBuilder</b></li><li class="navelem"><a class="el" href="class_button_builder_1_1_button_builder.html">ButtonBuilder</a></li> </ul>
</div>
</div><!-- top -->
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="class_button_builder_1_1_button_builder-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">ButtonBuilder.ButtonBuilder Class Reference</div></div>
</div><!--header-->
<div class="contents">
<div class="dynheader">
Inheritance diagram for ButtonBuilder.ButtonBuilder:</div>
<div class="dyncontent">
<div class="center">
<img src="class_button_builder_1_1_button_builder.png" alt=""/>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:ab2b548172e26c60c26627825401ee150" id="r_ab2b548172e26c60c26627825401ee150"><td class="memItemLeft" align="right" valign="top">None </td><td class="memItemRight" valign="bottom"><a class="el" href="#ab2b548172e26c60c26627825401ee150">reset</a> (self)</td></tr>
<tr class="separator:ab2b548172e26c60c26627825401ee150"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a600de6ac8f67de954d9531e83d21d677" id="r_a600de6ac8f67de954d9531e83d21d677"><td class="memItemLeft" align="right" valign="top">None </td><td class="memItemRight" valign="bottom"><a class="el" href="#a600de6ac8f67de954d9531e83d21d677">set_font</a> (self)</td></tr>
<tr class="separator:a600de6ac8f67de954d9531e83d21d677"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3def199024c087718b72c14758fae3a5" id="r_a3def199024c087718b72c14758fae3a5"><td class="memItemLeft" align="right" valign="top">None </td><td class="memItemRight" valign="bottom"><a class="el" href="#a3def199024c087718b72c14758fae3a5">set_frame</a> (self, tk.Frame frame)</td></tr>
<tr class="separator:a3def199024c087718b72c14758fae3a5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3524aa8e164ef9df587eac5277edacfa" id="r_a3524aa8e164ef9df587eac5277edacfa"><td class="memItemLeft" align="right" valign="top">None </td><td class="memItemRight" valign="bottom"><a class="el" href="#a3524aa8e164ef9df587eac5277edacfa">set_text</a> (self, str text)</td></tr>
<tr class="separator:a3524aa8e164ef9df587eac5277edacfa"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a62defac9a3353cf7a88578956ce73114" id="r_a62defac9a3353cf7a88578956ce73114"><td class="memItemLeft" align="right" valign="top">None </td><td class="memItemRight" valign="bottom"><a class="el" href="#a62defac9a3353cf7a88578956ce73114">set_position</a> (self, str side, int|tuple padx, int|tuple pady, str anchor)</td></tr>
<tr class="separator:a62defac9a3353cf7a88578956ce73114"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6fd453d267ae1872363c7a62309ede40" id="r_a6fd453d267ae1872363c7a62309ede40"><td class="memItemLeft" align="right" valign="top">None </td><td class="memItemRight" valign="bottom"><a class="el" href="#a6fd453d267ae1872363c7a62309ede40">set_status</a> (self, str state)</td></tr>
<tr class="separator:a6fd453d267ae1872363c7a62309ede40"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a61bad732f6f8cb4e3bf6b45c92bb86a7" id="r_a61bad732f6f8cb4e3bf6b45c92bb86a7"><td class="memItemLeft" align="right" valign="top">None </td><td class="memItemRight" valign="bottom"><a class="el" href="#a61bad732f6f8cb4e3bf6b45c92bb86a7">set_command</a> (self, any command)</td></tr>
<tr class="separator:a61bad732f6f8cb4e3bf6b45c92bb86a7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9fbad3185c0af8686b0a65a4af6dca9e" id="r_a9fbad3185c0af8686b0a65a4af6dca9e"><td class="memItemLeft" align="right" valign="top">ttk.Button </td><td class="memItemRight" valign="bottom"><a class="el" href="#a9fbad3185c0af8686b0a65a4af6dca9e">get_widget</a> (self)</td></tr>
<tr class="separator:a9fbad3185c0af8686b0a65a4af6dca9e"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><pre class="fragment">Class which implement the interface IWidgetBuilder, and allow to create a button widget of the tkinter class
Author : Lakhdar Gibril
</pre> </div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a9fbad3185c0af8686b0a65a4af6dca9e" name="a9fbad3185c0af8686b0a65a4af6dca9e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9fbad3185c0af8686b0a65a4af6dca9e">◆ </a></span>get_widget()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"> ttk.Button ButtonBuilder.ButtonBuilder.get_widget </td>
<td>(</td>
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>self</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<pre class="fragment">Method which allow to return the button widget
@return : a ttk.Button object
@author : Lakhdar Gibril
</pre>
</div>
</div>
<a id="ab2b548172e26c60c26627825401ee150" name="ab2b548172e26c60c26627825401ee150"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab2b548172e26c60c26627825401ee150">◆ </a></span>reset()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"> None ButtonBuilder.ButtonBuilder.reset </td>
<td>(</td>
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>self</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<pre class="fragment">Method which allow to reset all the Button widget data
Author : Lakhdar Gibril
</pre>
</div>
</div>
<a id="a61bad732f6f8cb4e3bf6b45c92bb86a7" name="a61bad732f6f8cb4e3bf6b45c92bb86a7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a61bad732f6f8cb4e3bf6b45c92bb86a7">◆ </a></span>set_command()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"> None ButtonBuilder.ButtonBuilder.set_command </td>
<td>(</td>
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>self</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">any</td> <td class="paramname"><span class="paramname"><em>command</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<pre class="fragment">Allow to set a function to the button if needed
@args :
- command (any) : the function to add for the button widget
Author : Lakhdar Gibril
</pre>
</div>
</div>
<a id="a600de6ac8f67de954d9531e83d21d677" name="a600de6ac8f67de954d9531e83d21d677"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a600de6ac8f67de954d9531e83d21d677">◆ </a></span>set_font()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"> None ButtonBuilder.ButtonBuilder.set_font </td>
<td>(</td>
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>self</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<pre class="fragment">Method which put a default font to the Button widget
Author : Lakhdar Gibril
</pre>
</div>
</div>
<a id="a3def199024c087718b72c14758fae3a5" name="a3def199024c087718b72c14758fae3a5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3def199024c087718b72c14758fae3a5">◆ </a></span>set_frame()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"> None ButtonBuilder.ButtonBuilder.set_frame </td>
<td>(</td>
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>self</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">tk.Frame</td> <td class="paramname"><span class="paramname"><em>frame</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<pre class="fragment">Method which allow to dispose the Button widget in the wanted frame
@args :
- frame (tk.Frame) : the frame for the widget to put it in
Author : Lakhdar Gibril
</pre>
</div>
</div>
<a id="a62defac9a3353cf7a88578956ce73114" name="a62defac9a3353cf7a88578956ce73114"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a62defac9a3353cf7a88578956ce73114">◆ </a></span>set_position()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"> None ButtonBuilder.ButtonBuilder.set_position </td>
<td>(</td>
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>self</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">str</td> <td class="paramname"><span class="paramname"><em>side</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int | tuple</td> <td class="paramname"><span class="paramname"><em>padx</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int | tuple</td> <td class="paramname"><span class="paramname"><em>pady</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">str</td> <td class="paramname"><span class="paramname"><em>anchor</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<pre class="fragment">Packs the Button widget into a specific position within its parent frame.
Args:
- side (str): The side of the frame to place the widget.
Possible values are "TOP", "LEFT", "RIGHT", or "BOTTOM".
- padx (int | tuple, optional): Horizontal padding around the widget.
- pady (int | tuple, optional): Vertical padding around the widget.
- anchor (str, optional): Alignment of the widget relative to the packing side.
This parameter is not currently used in the method.
Author: Lakhdar Gibril
</pre>
</div>
</div>
<a id="a6fd453d267ae1872363c7a62309ede40" name="a6fd453d267ae1872363c7a62309ede40"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6fd453d267ae1872363c7a62309ede40">◆ </a></span>set_status()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"> None ButtonBuilder.ButtonBuilder.set_status </td>
<td>(</td>
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>self</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">str</td> <td class="paramname"><span class="paramname"><em>state</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<pre class="fragment">Method which allow to set the state of the Button widget
Args:
- state (str): the state of a button which can be 'disable' or 'enable'
Author : Lakhdar Gibril
</pre>
</div>
</div>
<a id="a3524aa8e164ef9df587eac5277edacfa" name="a3524aa8e164ef9df587eac5277edacfa"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3524aa8e164ef9df587eac5277edacfa">◆ </a></span>set_text()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"> None ButtonBuilder.ButtonBuilder.set_text </td>
<td>(</td>
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>self</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">str</td> <td class="paramname"><span class="paramname"><em>text</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<pre class="fragment">Method which allow to set a text value to the widget
@args :
- text (str) : the text value to add to the widget
@author : Lakhdar Gibril
</pre>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>Builder/Builders/<b>ButtonBuilder.py</b></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.12.0
</small></address>
</div><!-- doc-content -->
</body>
</html>