PreferencesUIManager.py 42 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763
  1. import os
  2. from typing import Any, Dict
  3. from PyQt5 import QtGui, QtCore, QtWidgets
  4. from PyQt5.QtCore import QSettings
  5. from defaults import FlatCAMDefaults
  6. import logging
  7. import gettext
  8. import FlatCAMTranslation as fcTranslate
  9. import builtins
  10. from flatcamGUI.preferences.OptionUI import OptionUI
  11. fcTranslate.apply_language('strings')
  12. if '_' not in builtins.__dict__:
  13. _ = gettext.gettext
  14. settings = QSettings("Open Source", "FlatCAM")
  15. if settings.contains("machinist"):
  16. machinist_setting = settings.value('machinist', type=int)
  17. else:
  18. machinist_setting = 0
  19. log = logging.getLogger('PreferencesUIManager')
  20. class PreferencesUIManager:
  21. def __init__(self, defaults: FlatCAMDefaults, data_path: str, ui, inform):
  22. """
  23. Class that control the Preferences Tab
  24. :param defaults: a dictionary storage where all the application settings are stored
  25. :param data_path: a path to the file where all the preferences are stored for persistence
  26. :param ui: reference to the FlatCAMGUI class which constructs the UI
  27. :param inform: a pyqtSignal used to display information in the StatusBar of the GUI
  28. """
  29. self.defaults = defaults
  30. self.data_path = data_path
  31. self.ui = ui
  32. self.inform = inform
  33. self.ignore_tab_close_event = False
  34. # if Preferences are changed in the Edit -> Preferences tab the value will be set to True
  35. self.preferences_changed_flag = False
  36. # when adding entries here read the comments in the method found below named:
  37. # def new_object(self, kind, name, initialize, active=True, fit=True, plot=True)
  38. self.defaults_form_fields = {
  39. # Excellon Advanced Options
  40. "excellon_offset": self.ui.excellon_defaults_form.excellon_adv_opt_group.offset_entry,
  41. "excellon_toolchangexy": self.ui.excellon_defaults_form.excellon_adv_opt_group.toolchangexy_entry,
  42. "excellon_startz": self.ui.excellon_defaults_form.excellon_adv_opt_group.estartz_entry,
  43. "excellon_feedrate_rapid": self.ui.excellon_defaults_form.excellon_adv_opt_group.feedrate_rapid_entry,
  44. "excellon_z_pdepth": self.ui.excellon_defaults_form.excellon_adv_opt_group.pdepth_entry,
  45. "excellon_feedrate_probe": self.ui.excellon_defaults_form.excellon_adv_opt_group.feedrate_probe_entry,
  46. "excellon_spindledir": self.ui.excellon_defaults_form.excellon_adv_opt_group.spindledir_radio,
  47. "excellon_f_plunge": self.ui.excellon_defaults_form.excellon_adv_opt_group.fplunge_cb,
  48. "excellon_f_retract": self.ui.excellon_defaults_form.excellon_adv_opt_group.fretract_cb,
  49. # Excellon Export
  50. "excellon_exp_units": self.ui.excellon_defaults_form.excellon_exp_group.excellon_units_radio,
  51. "excellon_exp_format": self.ui.excellon_defaults_form.excellon_exp_group.format_radio,
  52. "excellon_exp_integer": self.ui.excellon_defaults_form.excellon_exp_group.format_whole_entry,
  53. "excellon_exp_decimals": self.ui.excellon_defaults_form.excellon_exp_group.format_dec_entry,
  54. "excellon_exp_zeros": self.ui.excellon_defaults_form.excellon_exp_group.zeros_radio,
  55. "excellon_exp_slot_type": self.ui.excellon_defaults_form.excellon_exp_group.slot_type_radio,
  56. # Excellon Editor
  57. "excellon_editor_sel_limit": self.ui.excellon_defaults_form.excellon_editor_group.sel_limit_entry,
  58. "excellon_editor_newdia": self.ui.excellon_defaults_form.excellon_editor_group.addtool_entry,
  59. "excellon_editor_array_size": self.ui.excellon_defaults_form.excellon_editor_group.drill_array_size_entry,
  60. "excellon_editor_lin_dir": self.ui.excellon_defaults_form.excellon_editor_group.drill_axis_radio,
  61. "excellon_editor_lin_pitch": self.ui.excellon_defaults_form.excellon_editor_group.drill_pitch_entry,
  62. "excellon_editor_lin_angle": self.ui.excellon_defaults_form.excellon_editor_group.drill_angle_entry,
  63. "excellon_editor_circ_dir": self.ui.excellon_defaults_form.excellon_editor_group.drill_circular_dir_radio,
  64. "excellon_editor_circ_angle":
  65. self.ui.excellon_defaults_form.excellon_editor_group.drill_circular_angle_entry,
  66. # Excellon Slots
  67. "excellon_editor_slot_direction":
  68. self.ui.excellon_defaults_form.excellon_editor_group.slot_axis_radio,
  69. "excellon_editor_slot_angle":
  70. self.ui.excellon_defaults_form.excellon_editor_group.slot_angle_spinner,
  71. "excellon_editor_slot_length":
  72. self.ui.excellon_defaults_form.excellon_editor_group.slot_length_entry,
  73. # Excellon Slots
  74. "excellon_editor_slot_array_size":
  75. self.ui.excellon_defaults_form.excellon_editor_group.slot_array_size_entry,
  76. "excellon_editor_slot_lin_dir": self.ui.excellon_defaults_form.excellon_editor_group.slot_array_axis_radio,
  77. "excellon_editor_slot_lin_pitch":
  78. self.ui.excellon_defaults_form.excellon_editor_group.slot_array_pitch_entry,
  79. "excellon_editor_slot_lin_angle":
  80. self.ui.excellon_defaults_form.excellon_editor_group.slot_array_angle_entry,
  81. "excellon_editor_slot_circ_dir":
  82. self.ui.excellon_defaults_form.excellon_editor_group.slot_array_circular_dir_radio,
  83. "excellon_editor_slot_circ_angle":
  84. self.ui.excellon_defaults_form.excellon_editor_group.slot_array_circular_angle_entry,
  85. # NCC Tool
  86. "tools_ncctools": self.ui.tools_defaults_form.tools_ncc_group.ncc_tool_dia_entry,
  87. "tools_nccorder": self.ui.tools_defaults_form.tools_ncc_group.ncc_order_radio,
  88. "tools_nccoverlap": self.ui.tools_defaults_form.tools_ncc_group.ncc_overlap_entry,
  89. "tools_nccmargin": self.ui.tools_defaults_form.tools_ncc_group.ncc_margin_entry,
  90. "tools_nccmethod": self.ui.tools_defaults_form.tools_ncc_group.ncc_method_combo,
  91. "tools_nccconnect": self.ui.tools_defaults_form.tools_ncc_group.ncc_connect_cb,
  92. "tools_ncccontour": self.ui.tools_defaults_form.tools_ncc_group.ncc_contour_cb,
  93. "tools_nccrest": self.ui.tools_defaults_form.tools_ncc_group.ncc_rest_cb,
  94. "tools_ncc_offset_choice": self.ui.tools_defaults_form.tools_ncc_group.ncc_choice_offset_cb,
  95. "tools_ncc_offset_value": self.ui.tools_defaults_form.tools_ncc_group.ncc_offset_spinner,
  96. "tools_nccref": self.ui.tools_defaults_form.tools_ncc_group.select_combo,
  97. "tools_ncc_area_shape": self.ui.tools_defaults_form.tools_ncc_group.area_shape_radio,
  98. "tools_ncc_plotting": self.ui.tools_defaults_form.tools_ncc_group.ncc_plotting_radio,
  99. "tools_nccmilling_type": self.ui.tools_defaults_form.tools_ncc_group.milling_type_radio,
  100. "tools_ncctool_type": self.ui.tools_defaults_form.tools_ncc_group.tool_type_radio,
  101. "tools_ncccutz": self.ui.tools_defaults_form.tools_ncc_group.cutz_entry,
  102. "tools_ncctipdia": self.ui.tools_defaults_form.tools_ncc_group.tipdia_entry,
  103. "tools_ncctipangle": self.ui.tools_defaults_form.tools_ncc_group.tipangle_entry,
  104. "tools_nccnewdia": self.ui.tools_defaults_form.tools_ncc_group.newdia_entry,
  105. # CutOut Tool
  106. "tools_cutouttooldia": self.ui.tools_defaults_form.tools_cutout_group.cutout_tooldia_entry,
  107. "tools_cutoutkind": self.ui.tools_defaults_form.tools_cutout_group.obj_kind_combo,
  108. "tools_cutoutmargin": self.ui.tools_defaults_form.tools_cutout_group.cutout_margin_entry,
  109. "tools_cutout_z": self.ui.tools_defaults_form.tools_cutout_group.cutz_entry,
  110. "tools_cutout_depthperpass": self.ui.tools_defaults_form.tools_cutout_group.maxdepth_entry,
  111. "tools_cutout_mdepth": self.ui.tools_defaults_form.tools_cutout_group.mpass_cb,
  112. "tools_cutoutgapsize": self.ui.tools_defaults_form.tools_cutout_group.cutout_gap_entry,
  113. "tools_gaps_ff": self.ui.tools_defaults_form.tools_cutout_group.gaps_combo,
  114. "tools_cutout_convexshape": self.ui.tools_defaults_form.tools_cutout_group.convex_box,
  115. # Paint Area Tool
  116. "tools_painttooldia": self.ui.tools_defaults_form.tools_paint_group.painttooldia_entry,
  117. "tools_paintorder": self.ui.tools_defaults_form.tools_paint_group.paint_order_radio,
  118. "tools_paintoverlap": self.ui.tools_defaults_form.tools_paint_group.paintoverlap_entry,
  119. "tools_paintmargin": self.ui.tools_defaults_form.tools_paint_group.paintmargin_entry,
  120. "tools_paintmethod": self.ui.tools_defaults_form.tools_paint_group.paintmethod_combo,
  121. "tools_selectmethod": self.ui.tools_defaults_form.tools_paint_group.selectmethod_combo,
  122. "tools_paint_area_shape": self.ui.tools_defaults_form.tools_paint_group.area_shape_radio,
  123. "tools_pathconnect": self.ui.tools_defaults_form.tools_paint_group.pathconnect_cb,
  124. "tools_paintcontour": self.ui.tools_defaults_form.tools_paint_group.contour_cb,
  125. "tools_paint_plotting": self.ui.tools_defaults_form.tools_paint_group.paint_plotting_radio,
  126. "tools_paintrest": self.ui.tools_defaults_form.tools_paint_group.rest_cb,
  127. "tools_painttool_type": self.ui.tools_defaults_form.tools_paint_group.tool_type_radio,
  128. "tools_paintcutz": self.ui.tools_defaults_form.tools_paint_group.cutz_entry,
  129. "tools_painttipdia": self.ui.tools_defaults_form.tools_paint_group.tipdia_entry,
  130. "tools_painttipangle": self.ui.tools_defaults_form.tools_paint_group.tipangle_entry,
  131. "tools_paintnewdia": self.ui.tools_defaults_form.tools_paint_group.newdia_entry,
  132. # 2-sided Tool
  133. "tools_2sided_mirror_axis": self.ui.tools_defaults_form.tools_2sided_group.mirror_axis_radio,
  134. "tools_2sided_axis_loc": self.ui.tools_defaults_form.tools_2sided_group.axis_location_radio,
  135. "tools_2sided_drilldia": self.ui.tools_defaults_form.tools_2sided_group.drill_dia_entry,
  136. "tools_2sided_allign_axis": self.ui.tools_defaults_form.tools_2sided_group.align_axis_radio,
  137. # Film Tool
  138. "tools_film_type": self.ui.tools_defaults_form.tools_film_group.film_type_radio,
  139. "tools_film_boundary": self.ui.tools_defaults_form.tools_film_group.film_boundary_entry,
  140. "tools_film_scale_stroke": self.ui.tools_defaults_form.tools_film_group.film_scale_stroke_entry,
  141. "tools_film_color": self.ui.tools_defaults_form.tools_film_group.film_color_entry,
  142. "tools_film_scale_cb": self.ui.tools_defaults_form.tools_film_group.film_scale_cb,
  143. "tools_film_scale_x_entry": self.ui.tools_defaults_form.tools_film_group.film_scalex_entry,
  144. "tools_film_scale_y_entry": self.ui.tools_defaults_form.tools_film_group.film_scaley_entry,
  145. "tools_film_skew_cb": self.ui.tools_defaults_form.tools_film_group.film_skew_cb,
  146. "tools_film_skew_x_entry": self.ui.tools_defaults_form.tools_film_group.film_skewx_entry,
  147. "tools_film_skew_y_entry": self.ui.tools_defaults_form.tools_film_group.film_skewy_entry,
  148. "tools_film_skew_ref_radio": self.ui.tools_defaults_form.tools_film_group.film_skew_reference,
  149. "tools_film_mirror_cb": self.ui.tools_defaults_form.tools_film_group.film_mirror_cb,
  150. "tools_film_mirror_axis_radio": self.ui.tools_defaults_form.tools_film_group.film_mirror_axis,
  151. "tools_film_file_type_radio": self.ui.tools_defaults_form.tools_film_group.file_type_radio,
  152. "tools_film_orientation": self.ui.tools_defaults_form.tools_film_group.orientation_radio,
  153. "tools_film_pagesize": self.ui.tools_defaults_form.tools_film_group.pagesize_combo,
  154. # Panelize Tool
  155. "tools_panelize_spacing_columns": self.ui.tools_defaults_form.tools_panelize_group.pspacing_columns,
  156. "tools_panelize_spacing_rows": self.ui.tools_defaults_form.tools_panelize_group.pspacing_rows,
  157. "tools_panelize_columns": self.ui.tools_defaults_form.tools_panelize_group.pcolumns,
  158. "tools_panelize_rows": self.ui.tools_defaults_form.tools_panelize_group.prows,
  159. "tools_panelize_constrain": self.ui.tools_defaults_form.tools_panelize_group.pconstrain_cb,
  160. "tools_panelize_constrainx": self.ui.tools_defaults_form.tools_panelize_group.px_width_entry,
  161. "tools_panelize_constrainy": self.ui.tools_defaults_form.tools_panelize_group.py_height_entry,
  162. "tools_panelize_panel_type": self.ui.tools_defaults_form.tools_panelize_group.panel_type_radio,
  163. # Calculators Tool
  164. "tools_calc_vshape_tip_dia": self.ui.tools_defaults_form.tools_calculators_group.tip_dia_entry,
  165. "tools_calc_vshape_tip_angle": self.ui.tools_defaults_form.tools_calculators_group.tip_angle_entry,
  166. "tools_calc_vshape_cut_z": self.ui.tools_defaults_form.tools_calculators_group.cut_z_entry,
  167. "tools_calc_electro_length": self.ui.tools_defaults_form.tools_calculators_group.pcblength_entry,
  168. "tools_calc_electro_width": self.ui.tools_defaults_form.tools_calculators_group.pcbwidth_entry,
  169. "tools_calc_electro_cdensity": self.ui.tools_defaults_form.tools_calculators_group.cdensity_entry,
  170. "tools_calc_electro_growth": self.ui.tools_defaults_form.tools_calculators_group.growth_entry,
  171. # Transformations Tool
  172. "tools_transform_rotate": self.ui.tools_defaults_form.tools_transform_group.rotate_entry,
  173. "tools_transform_skew_x": self.ui.tools_defaults_form.tools_transform_group.skewx_entry,
  174. "tools_transform_skew_y": self.ui.tools_defaults_form.tools_transform_group.skewy_entry,
  175. "tools_transform_scale_x": self.ui.tools_defaults_form.tools_transform_group.scalex_entry,
  176. "tools_transform_scale_y": self.ui.tools_defaults_form.tools_transform_group.scaley_entry,
  177. "tools_transform_scale_link": self.ui.tools_defaults_form.tools_transform_group.link_cb,
  178. "tools_transform_scale_reference": self.ui.tools_defaults_form.tools_transform_group.reference_cb,
  179. "tools_transform_offset_x": self.ui.tools_defaults_form.tools_transform_group.offx_entry,
  180. "tools_transform_offset_y": self.ui.tools_defaults_form.tools_transform_group.offy_entry,
  181. "tools_transform_mirror_reference": self.ui.tools_defaults_form.tools_transform_group.mirror_reference_cb,
  182. "tools_transform_mirror_point": self.ui.tools_defaults_form.tools_transform_group.flip_ref_entry,
  183. "tools_transform_buffer_dis": self.ui.tools_defaults_form.tools_transform_group.buffer_entry,
  184. "tools_transform_buffer_factor": self.ui.tools_defaults_form.tools_transform_group.buffer_factor_entry,
  185. "tools_transform_buffer_corner": self.ui.tools_defaults_form.tools_transform_group.buffer_rounded_cb,
  186. # SolderPaste Dispensing Tool
  187. "tools_solderpaste_tools": self.ui.tools_defaults_form.tools_solderpaste_group.nozzle_tool_dia_entry,
  188. "tools_solderpaste_new": self.ui.tools_defaults_form.tools_solderpaste_group.addtool_entry,
  189. "tools_solderpaste_z_start": self.ui.tools_defaults_form.tools_solderpaste_group.z_start_entry,
  190. "tools_solderpaste_z_dispense": self.ui.tools_defaults_form.tools_solderpaste_group.z_dispense_entry,
  191. "tools_solderpaste_z_stop": self.ui.tools_defaults_form.tools_solderpaste_group.z_stop_entry,
  192. "tools_solderpaste_z_travel": self.ui.tools_defaults_form.tools_solderpaste_group.z_travel_entry,
  193. "tools_solderpaste_z_toolchange": self.ui.tools_defaults_form.tools_solderpaste_group.z_toolchange_entry,
  194. "tools_solderpaste_xy_toolchange": self.ui.tools_defaults_form.tools_solderpaste_group.xy_toolchange_entry,
  195. "tools_solderpaste_frxy": self.ui.tools_defaults_form.tools_solderpaste_group.frxy_entry,
  196. "tools_solderpaste_frz": self.ui.tools_defaults_form.tools_solderpaste_group.frz_entry,
  197. "tools_solderpaste_frz_dispense": self.ui.tools_defaults_form.tools_solderpaste_group.frz_dispense_entry,
  198. "tools_solderpaste_speedfwd": self.ui.tools_defaults_form.tools_solderpaste_group.speedfwd_entry,
  199. "tools_solderpaste_dwellfwd": self.ui.tools_defaults_form.tools_solderpaste_group.dwellfwd_entry,
  200. "tools_solderpaste_speedrev": self.ui.tools_defaults_form.tools_solderpaste_group.speedrev_entry,
  201. "tools_solderpaste_dwellrev": self.ui.tools_defaults_form.tools_solderpaste_group.dwellrev_entry,
  202. "tools_solderpaste_pp": self.ui.tools_defaults_form.tools_solderpaste_group.pp_combo,
  203. "tools_sub_close_paths": self.ui.tools_defaults_form.tools_sub_group.close_paths_cb,
  204. # #######################################################################################################
  205. # ########################################## TOOLS 2 ####################################################
  206. # #######################################################################################################
  207. # Optimal Tool
  208. "tools_opt_precision": self.ui.tools2_defaults_form.tools2_optimal_group.precision_sp,
  209. # Check Rules Tool
  210. "tools_cr_trace_size": self.ui.tools2_defaults_form.tools2_checkrules_group.trace_size_cb,
  211. "tools_cr_trace_size_val": self.ui.tools2_defaults_form.tools2_checkrules_group.trace_size_entry,
  212. "tools_cr_c2c": self.ui.tools2_defaults_form.tools2_checkrules_group.clearance_copper2copper_cb,
  213. "tools_cr_c2c_val": self.ui.tools2_defaults_form.tools2_checkrules_group.clearance_copper2copper_entry,
  214. "tools_cr_c2o": self.ui.tools2_defaults_form.tools2_checkrules_group.clearance_copper2ol_cb,
  215. "tools_cr_c2o_val": self.ui.tools2_defaults_form.tools2_checkrules_group.clearance_copper2ol_entry,
  216. "tools_cr_s2s": self.ui.tools2_defaults_form.tools2_checkrules_group.clearance_silk2silk_cb,
  217. "tools_cr_s2s_val": self.ui.tools2_defaults_form.tools2_checkrules_group.clearance_silk2silk_entry,
  218. "tools_cr_s2sm": self.ui.tools2_defaults_form.tools2_checkrules_group.clearance_silk2sm_cb,
  219. "tools_cr_s2sm_val": self.ui.tools2_defaults_form.tools2_checkrules_group.clearance_silk2sm_entry,
  220. "tools_cr_s2o": self.ui.tools2_defaults_form.tools2_checkrules_group.clearance_silk2ol_cb,
  221. "tools_cr_s2o_val": self.ui.tools2_defaults_form.tools2_checkrules_group.clearance_silk2ol_entry,
  222. "tools_cr_sm2sm": self.ui.tools2_defaults_form.tools2_checkrules_group.clearance_sm2sm_cb,
  223. "tools_cr_sm2sm_val": self.ui.tools2_defaults_form.tools2_checkrules_group.clearance_sm2sm_entry,
  224. "tools_cr_ri": self.ui.tools2_defaults_form.tools2_checkrules_group.ring_integrity_cb,
  225. "tools_cr_ri_val": self.ui.tools2_defaults_form.tools2_checkrules_group.ring_integrity_entry,
  226. "tools_cr_h2h": self.ui.tools2_defaults_form.tools2_checkrules_group.clearance_d2d_cb,
  227. "tools_cr_h2h_val": self.ui.tools2_defaults_form.tools2_checkrules_group.clearance_d2d_entry,
  228. "tools_cr_dh": self.ui.tools2_defaults_form.tools2_checkrules_group.drill_size_cb,
  229. "tools_cr_dh_val": self.ui.tools2_defaults_form.tools2_checkrules_group.drill_size_entry,
  230. # QRCode Tool
  231. "tools_qrcode_version": self.ui.tools2_defaults_form.tools2_qrcode_group.version_entry,
  232. "tools_qrcode_error": self.ui.tools2_defaults_form.tools2_qrcode_group.error_radio,
  233. "tools_qrcode_box_size": self.ui.tools2_defaults_form.tools2_qrcode_group.bsize_entry,
  234. "tools_qrcode_border_size": self.ui.tools2_defaults_form.tools2_qrcode_group.border_size_entry,
  235. "tools_qrcode_qrdata": self.ui.tools2_defaults_form.tools2_qrcode_group.text_data,
  236. "tools_qrcode_polarity": self.ui.tools2_defaults_form.tools2_qrcode_group.pol_radio,
  237. "tools_qrcode_rounded": self.ui.tools2_defaults_form.tools2_qrcode_group.bb_radio,
  238. "tools_qrcode_fill_color": self.ui.tools2_defaults_form.tools2_qrcode_group.fill_color_entry,
  239. "tools_qrcode_back_color": self.ui.tools2_defaults_form.tools2_qrcode_group.back_color_entry,
  240. "tools_qrcode_sel_limit": self.ui.tools2_defaults_form.tools2_qrcode_group.sel_limit_entry,
  241. # Copper Thieving Tool
  242. "tools_copper_thieving_clearance": self.ui.tools2_defaults_form.tools2_cfill_group.clearance_entry,
  243. "tools_copper_thieving_margin": self.ui.tools2_defaults_form.tools2_cfill_group.margin_entry,
  244. "tools_copper_thieving_reference": self.ui.tools2_defaults_form.tools2_cfill_group.reference_radio,
  245. "tools_copper_thieving_box_type": self.ui.tools2_defaults_form.tools2_cfill_group.bbox_type_radio,
  246. "tools_copper_thieving_circle_steps": self.ui.tools2_defaults_form.tools2_cfill_group.circlesteps_entry,
  247. "tools_copper_thieving_fill_type": self.ui.tools2_defaults_form.tools2_cfill_group.fill_type_radio,
  248. "tools_copper_thieving_dots_dia": self.ui.tools2_defaults_form.tools2_cfill_group.dot_dia_entry,
  249. "tools_copper_thieving_dots_spacing": self.ui.tools2_defaults_form.tools2_cfill_group.dot_spacing_entry,
  250. "tools_copper_thieving_squares_size": self.ui.tools2_defaults_form.tools2_cfill_group.square_size_entry,
  251. "tools_copper_thieving_squares_spacing":
  252. self.ui.tools2_defaults_form.tools2_cfill_group.squares_spacing_entry,
  253. "tools_copper_thieving_lines_size": self.ui.tools2_defaults_form.tools2_cfill_group.line_size_entry,
  254. "tools_copper_thieving_lines_spacing": self.ui.tools2_defaults_form.tools2_cfill_group.lines_spacing_entry,
  255. "tools_copper_thieving_rb_margin": self.ui.tools2_defaults_form.tools2_cfill_group.rb_margin_entry,
  256. "tools_copper_thieving_rb_thickness": self.ui.tools2_defaults_form.tools2_cfill_group.rb_thickness_entry,
  257. "tools_copper_thieving_mask_clearance": self.ui.tools2_defaults_form.tools2_cfill_group.clearance_ppm_entry,
  258. # Fiducials Tool
  259. "tools_fiducials_dia": self.ui.tools2_defaults_form.tools2_fiducials_group.dia_entry,
  260. "tools_fiducials_margin": self.ui.tools2_defaults_form.tools2_fiducials_group.margin_entry,
  261. "tools_fiducials_mode": self.ui.tools2_defaults_form.tools2_fiducials_group.mode_radio,
  262. "tools_fiducials_second_pos": self.ui.tools2_defaults_form.tools2_fiducials_group.pos_radio,
  263. "tools_fiducials_type": self.ui.tools2_defaults_form.tools2_fiducials_group.fid_type_radio,
  264. "tools_fiducials_line_thickness": self.ui.tools2_defaults_form.tools2_fiducials_group.line_thickness_entry,
  265. # Calibration Tool
  266. "tools_cal_calsource": self.ui.tools2_defaults_form.tools2_cal_group.cal_source_radio,
  267. "tools_cal_travelz": self.ui.tools2_defaults_form.tools2_cal_group.travelz_entry,
  268. "tools_cal_verz": self.ui.tools2_defaults_form.tools2_cal_group.verz_entry,
  269. "tools_cal_zeroz": self.ui.tools2_defaults_form.tools2_cal_group.zeroz_cb,
  270. "tools_cal_toolchangez": self.ui.tools2_defaults_form.tools2_cal_group.toolchangez_entry,
  271. "tools_cal_toolchange_xy": self.ui.tools2_defaults_form.tools2_cal_group.toolchange_xy_entry,
  272. "tools_cal_sec_point": self.ui.tools2_defaults_form.tools2_cal_group.second_point_radio,
  273. # Extract Drills Tool
  274. "tools_edrills_hole_type": self.ui.tools2_defaults_form.tools2_edrills_group.hole_size_radio,
  275. "tools_edrills_hole_fixed_dia": self.ui.tools2_defaults_form.tools2_edrills_group.dia_entry,
  276. "tools_edrills_hole_prop_factor": self.ui.tools2_defaults_form.tools2_edrills_group.factor_entry,
  277. "tools_edrills_circular_ring": self.ui.tools2_defaults_form.tools2_edrills_group.circular_ring_entry,
  278. "tools_edrills_oblong_ring": self.ui.tools2_defaults_form.tools2_edrills_group.oblong_ring_entry,
  279. "tools_edrills_square_ring": self.ui.tools2_defaults_form.tools2_edrills_group.square_ring_entry,
  280. "tools_edrills_rectangular_ring": self.ui.tools2_defaults_form.tools2_edrills_group.rectangular_ring_entry,
  281. "tools_edrills_others_ring": self.ui.tools2_defaults_form.tools2_edrills_group.other_ring_entry,
  282. "tools_edrills_circular": self.ui.tools2_defaults_form.tools2_edrills_group.circular_cb,
  283. "tools_edrills_oblong": self.ui.tools2_defaults_form.tools2_edrills_group.oblong_cb,
  284. "tools_edrills_square": self.ui.tools2_defaults_form.tools2_edrills_group.square_cb,
  285. "tools_edrills_rectangular": self.ui.tools2_defaults_form.tools2_edrills_group.rectangular_cb,
  286. "tools_edrills_others": self.ui.tools2_defaults_form.tools2_edrills_group.other_cb,
  287. # Punch Gerber Tool
  288. "tools_punch_hole_type": self.ui.tools2_defaults_form.tools2_punch_group.hole_size_radio,
  289. "tools_punch_hole_fixed_dia": self.ui.tools2_defaults_form.tools2_punch_group.dia_entry,
  290. "tools_punch_hole_prop_factor": self.ui.tools2_defaults_form.tools2_punch_group.factor_entry,
  291. "tools_punch_circular_ring": self.ui.tools2_defaults_form.tools2_punch_group.circular_ring_entry,
  292. "tools_punch_oblong_ring": self.ui.tools2_defaults_form.tools2_punch_group.oblong_ring_entry,
  293. "tools_punch_square_ring": self.ui.tools2_defaults_form.tools2_punch_group.square_ring_entry,
  294. "tools_punch_rectangular_ring": self.ui.tools2_defaults_form.tools2_punch_group.rectangular_ring_entry,
  295. "tools_punch_others_ring": self.ui.tools2_defaults_form.tools2_punch_group.other_ring_entry,
  296. "tools_punch_circular": self.ui.tools2_defaults_form.tools2_punch_group.circular_cb,
  297. "tools_punch_oblong": self.ui.tools2_defaults_form.tools2_punch_group.oblong_cb,
  298. "tools_punch_square": self.ui.tools2_defaults_form.tools2_punch_group.square_cb,
  299. "tools_punch_rectangular": self.ui.tools2_defaults_form.tools2_punch_group.rectangular_cb,
  300. "tools_punch_others": self.ui.tools2_defaults_form.tools2_punch_group.other_cb,
  301. # Invert Gerber Tool
  302. "tools_invert_margin": self.ui.tools2_defaults_form.tools2_invert_group.margin_entry,
  303. "tools_invert_join_style": self.ui.tools2_defaults_form.tools2_invert_group.join_radio,
  304. # Utilities
  305. # File associations
  306. "fa_excellon": self.ui.util_defaults_form.fa_excellon_group.exc_list_text,
  307. "fa_gcode": self.ui.util_defaults_form.fa_gcode_group.gco_list_text,
  308. # "fa_geometry": self.ui.util_defaults_form.fa_geometry_group.close_paths_cb,
  309. "fa_gerber": self.ui.util_defaults_form.fa_gerber_group.grb_list_text,
  310. "util_autocomplete_keywords": self.ui.util_defaults_form.kw_group.kw_list_text,
  311. }
  312. self.sections = [
  313. ui.general_defaults_form,
  314. ui.gerber_defaults_form,
  315. ui.excellon_defaults_form,
  316. ui.geometry_defaults_form,
  317. ui.cncjob_defaults_form,
  318. ui.tools_defaults_form,
  319. ui.tools2_defaults_form,
  320. ui.util_defaults_form
  321. ]
  322. def get_form_fields(self) -> Dict[str, Any]:
  323. result = {}
  324. result.update(self.defaults_form_fields)
  325. result.update(self._option_field_dict())
  326. return result
  327. def get_form_field(self, option: str) -> Any:
  328. return self.get_form_fields()[option]
  329. def option_dict(self) -> Dict[str, OptionUI]:
  330. result = {}
  331. for section in self.sections:
  332. sectionoptions = section.option_dict()
  333. result.update(sectionoptions)
  334. return result
  335. def _option_field_dict(self):
  336. result = {k: v.get_field() for k, v in self.option_dict().items()}
  337. return result
  338. def defaults_read_form(self):
  339. """
  340. Will read all the values in the Preferences GUI and update the defaults dictionary.
  341. :return: None
  342. """
  343. for option in self.get_form_fields():
  344. if option in self.defaults:
  345. try:
  346. self.defaults[option] = self.get_form_field(option=option).get_value()
  347. except Exception as e:
  348. log.debug("App.defaults_read_form() --> %s" % str(e))
  349. def defaults_write_form(self, factor=None, fl_units=None, source_dict=None):
  350. """
  351. Will set the values for all the GUI elements in Preferences GUI based on the values found in the
  352. self.defaults dictionary.
  353. :param factor: will apply a factor to the values that written in the GUI elements
  354. :param fl_units: current measuring units in FlatCAM: Metric or Inch
  355. :param source_dict: the repository of options, usually is the self.defaults
  356. :return: None
  357. """
  358. options_storage = self.defaults if source_dict is None else source_dict
  359. for option in options_storage:
  360. if source_dict:
  361. self.defaults_write_form_field(option, factor=factor, units=fl_units, defaults_dict=source_dict)
  362. else:
  363. self.defaults_write_form_field(option, factor=factor, units=fl_units)
  364. def defaults_write_form_field(self, field, factor=None, units=None, defaults_dict=None):
  365. """
  366. Basically it is the worker in the self.defaults_write_form()
  367. :param field: the GUI element in Preferences GUI to be updated
  368. :param factor: factor to be applied to the field parameter
  369. :param units: current FlatCAM measuring units
  370. :param defaults_dict: the defaults storage
  371. :return: None, it updates GUI elements
  372. """
  373. def_dict = self.defaults if defaults_dict is None else defaults_dict
  374. try:
  375. value = def_dict[field]
  376. log.debug("value is " + str(value) + " and factor is "+str(factor))
  377. if factor is not None:
  378. value *= factor
  379. form_field = self.get_form_field(option=field)
  380. if units is None:
  381. form_field.set_value(value)
  382. elif (units == 'IN' or units == 'MM') and (field == 'global_gridx' or field == 'global_gridy'):
  383. form_field.set_value(value)
  384. except KeyError:
  385. pass
  386. except AttributeError:
  387. log.debug(field)
  388. def show_preferences_gui(self):
  389. """
  390. Called to initialize and show the Preferences GUI
  391. :return: None
  392. """
  393. # FIXME this should be done in __init__
  394. for section in self.sections:
  395. tab = section.build_tab()
  396. tab.setObjectName(section.get_tab_id())
  397. self.ui.pref_tab_area.addTab(tab, section.get_tab_label())
  398. # Initialize the color box's color in Preferences -> Global -> Colo
  399. self.__init_color_pickers()
  400. # Button handlers
  401. self.ui.pref_save_button.clicked.connect(lambda: self.on_save_button(save_to_file=True))
  402. self.ui.pref_apply_button.clicked.connect(lambda: self.on_save_button(save_to_file=False))
  403. self.ui.pref_close_button.clicked.connect(self.on_pref_close_button)
  404. self.ui.pref_defaults_button.clicked.connect(self.on_restore_defaults_preferences)
  405. log.debug("Finished Preferences GUI form initialization.")
  406. def __init_color_pickers(self):
  407. # Init the Tool Film color
  408. self.ui.tools_defaults_form.tools_film_group.film_color_entry.set_value(
  409. self.defaults['tools_film_color'])
  410. self.ui.tools_defaults_form.tools_film_group.film_color_button.setStyleSheet(
  411. "background-color:%s;"
  412. "border-color: dimgray" % str(self.defaults['tools_film_color'])[:7]
  413. )
  414. # Init the Tool QRCode colors
  415. self.ui.tools2_defaults_form.tools2_qrcode_group.fill_color_entry.set_value(
  416. self.defaults['tools_qrcode_fill_color'])
  417. self.ui.tools2_defaults_form.tools2_qrcode_group.fill_color_button.setStyleSheet(
  418. "background-color:%s;"
  419. "border-color: dimgray" % str(self.defaults['tools_qrcode_fill_color'])[:7])
  420. self.ui.tools2_defaults_form.tools2_qrcode_group.back_color_entry.set_value(
  421. self.defaults['tools_qrcode_back_color'])
  422. self.ui.tools2_defaults_form.tools2_qrcode_group.back_color_button.setStyleSheet(
  423. "background-color:%s;"
  424. "border-color: dimgray" % str(self.defaults['tools_qrcode_back_color'])[:7])
  425. def on_save_button(self, save_to_file=True):
  426. log.debug("on_save_button() --> Applying preferences to file.")
  427. # Preferences saved, update flag
  428. self.preferences_changed_flag = False
  429. # Preferences save, update the color of the Preferences Tab text
  430. for idx in range(self.ui.plot_tab_area.count()):
  431. if self.ui.plot_tab_area.tabText(idx) == _("Preferences"):
  432. self.ui.plot_tab_area.tabBar.setTabTextColor(idx, QtGui.QColor('black'))
  433. # restore the default stylesheet by setting a blank one
  434. self.ui.pref_apply_button.setStyleSheet("")
  435. self.inform.emit('%s' % _("Preferences applied."))
  436. # make sure we update the self.current_defaults dict used to undo changes to self.defaults
  437. self.defaults.current_defaults.update(self.defaults)
  438. # deal with theme change
  439. theme_settings = QtCore.QSettings("Open Source", "FlatCAM")
  440. if theme_settings.contains("theme"):
  441. theme = theme_settings.value('theme', type=str)
  442. else:
  443. theme = 'white'
  444. should_restart = False
  445. val = self.get_form_field("global_theme").get_value()
  446. if val != theme:
  447. msgbox = QtWidgets.QMessageBox()
  448. msgbox.setText(_("Are you sure you want to continue?"))
  449. msgbox.setWindowTitle(_("Application restart"))
  450. msgbox.setWindowIcon(QtGui.QIcon(self.ui.app.resource_location + '/warning.png'))
  451. bt_yes = msgbox.addButton(_('Yes'), QtWidgets.QMessageBox.YesRole)
  452. msgbox.addButton(_('Cancel'), QtWidgets.QMessageBox.NoRole)
  453. msgbox.setDefaultButton(bt_yes)
  454. msgbox.exec_()
  455. response = msgbox.clickedButton()
  456. if response == bt_yes:
  457. theme_settings.setValue('theme', val)
  458. # This will write the setting to the platform specific storage.
  459. del theme_settings
  460. should_restart = True
  461. else:
  462. self.ui.general_defaults_form.general_gui_group.theme_radio.set_value(theme)
  463. if save_to_file or should_restart is True:
  464. self.save_defaults(silent=False)
  465. # load the defaults so they are updated into the app
  466. self.defaults.load(filename=os.path.join(self.data_path, 'current_defaults.FlatConfig'))
  467. # Re-fresh project options
  468. self.ui.app.on_options_app2project()
  469. settgs = QSettings("Open Source", "FlatCAM")
  470. # save the notebook font size
  471. fsize = self.get_form_field("notebook_font_size").get_value()
  472. settgs.setValue('notebook_font_size', fsize)
  473. # save the axis font size
  474. g_fsize = self.get_form_field("axis_font_size").get_value()
  475. settgs.setValue('axis_font_size', g_fsize)
  476. # save the textbox font size
  477. tb_fsize = self.get_form_field("textbox_font_size").get_value()
  478. settgs.setValue('textbox_font_size', tb_fsize)
  479. settgs.setValue(
  480. 'machinist',
  481. 1 if self.get_form_field("global_machinist_setting").get_value() else 0
  482. )
  483. # This will write the setting to the platform specific storage.
  484. del settgs
  485. if save_to_file:
  486. # close the tab and delete it
  487. for idx in range(self.ui.plot_tab_area.count()):
  488. if self.ui.plot_tab_area.tabText(idx) == _("Preferences"):
  489. self.ui.plot_tab_area.tabBar.setTabTextColor(idx, QtGui.QColor('black'))
  490. self.ui.plot_tab_area.closeTab(idx)
  491. break
  492. if should_restart is True:
  493. self.ui.app.on_app_restart()
  494. def on_pref_close_button(self):
  495. # Preferences saved, update flag
  496. self.preferences_changed_flag = False
  497. self.ignore_tab_close_event = True
  498. try:
  499. self.get_form_field("units").activated_custom.disconnect()
  500. except (TypeError, AttributeError):
  501. pass
  502. self.defaults_write_form(source_dict=self.defaults.current_defaults)
  503. self.get_form_field("units").activated_custom.connect(
  504. lambda: self.ui.app.on_toggle_units(no_pref=False))
  505. self.defaults.update(self.defaults.current_defaults)
  506. # Preferences save, update the color of the Preferences Tab text
  507. for idx in range(self.ui.plot_tab_area.count()):
  508. if self.ui.plot_tab_area.tabText(idx) == _("Preferences"):
  509. self.ui.plot_tab_area.tabBar.setTabTextColor(idx, QtGui.QColor('black'))
  510. self.ui.plot_tab_area.closeTab(idx)
  511. break
  512. self.inform.emit('%s' % _("Preferences closed without saving."))
  513. self.ignore_tab_close_event = False
  514. def on_restore_defaults_preferences(self):
  515. """
  516. Loads the application's factory default settings into ``self.defaults``.
  517. :return: None
  518. """
  519. log.debug("on_restore_defaults_preferences()")
  520. self.defaults.reset_to_factory_defaults()
  521. self.on_preferences_edited()
  522. self.inform.emit('[success] %s' % _("Preferences default values are restored."))
  523. def save_defaults(self, silent=False, data_path=None, first_time=False):
  524. """
  525. Saves application default options
  526. ``self.defaults`` to current_defaults.FlatConfig file.
  527. Save the toolbars visibility status to the preferences file (current_defaults.FlatConfig) to be
  528. used at the next launch of the application.
  529. :param silent: Whether to display a message in status bar or not; boolean
  530. :param data_path: The path where to save the preferences file (current_defaults.FlatConfig)
  531. When the application is portable it should be a mobile location.
  532. :param first_time: Boolean. If True will execute some code when the app is run first time
  533. :return: None
  534. """
  535. self.defaults.report_usage("save_defaults")
  536. if data_path is None:
  537. data_path = self.data_path
  538. self.defaults.propagate_defaults()
  539. if first_time is False:
  540. self.save_toolbar_view()
  541. # Save the options to disk
  542. filename = os.path.join(data_path, "current_defaults.FlatConfig")
  543. try:
  544. self.defaults.write(filename=filename)
  545. except Exception as e:
  546. log.error("save_defaults() --> Failed to write defaults to file %s" % str(e))
  547. self.inform.emit('[ERROR_NOTCL] %s %s' % (_("Failed to write defaults to file."), str(filename)))
  548. return
  549. if not silent:
  550. self.inform.emit('[success] %s' % _("Preferences saved."))
  551. # update the autosave timer
  552. self.ui.app.save_project_auto_update()
  553. def save_toolbar_view(self):
  554. """
  555. Will save the toolbar view state to the defaults
  556. :return: None
  557. """
  558. # Save the toolbar view
  559. tb_status = 0
  560. if self.ui.toolbarfile.isVisible():
  561. tb_status += 1
  562. if self.ui.toolbargeo.isVisible():
  563. tb_status += 2
  564. if self.ui.toolbarview.isVisible():
  565. tb_status += 4
  566. if self.ui.toolbartools.isVisible():
  567. tb_status += 8
  568. if self.ui.exc_edit_toolbar.isVisible():
  569. tb_status += 16
  570. if self.ui.geo_edit_toolbar.isVisible():
  571. tb_status += 32
  572. if self.ui.grb_edit_toolbar.isVisible():
  573. tb_status += 64
  574. if self.ui.snap_toolbar.isVisible():
  575. tb_status += 128
  576. if self.ui.toolbarshell.isVisible():
  577. tb_status += 256
  578. self.defaults["global_toolbar_view"] = tb_status
  579. def on_preferences_edited(self):
  580. """
  581. Executed when a preference was changed in the Edit -> Preferences tab.
  582. Will color the Preferences tab text to Red color.
  583. :return:
  584. """
  585. if self.preferences_changed_flag is False:
  586. self.inform.emit('[WARNING_NOTCL] %s' % _("Preferences edited but not saved."))
  587. for idx in range(self.ui.plot_tab_area.count()):
  588. if self.ui.plot_tab_area.tabText(idx) == _("Preferences"):
  589. self.ui.plot_tab_area.tabBar.setTabTextColor(idx, QtGui.QColor('red'))
  590. self.ui.pref_apply_button.setStyleSheet("QPushButton {color: red;}")
  591. self.preferences_changed_flag = True
  592. def on_close_preferences_tab(self):
  593. if self.ignore_tab_close_event:
  594. return
  595. # disconnect
  596. for idx in range(self.ui.pref_tab_area.count()):
  597. for tb in self.ui.pref_tab_area.widget(idx).findChildren(QtCore.QObject):
  598. try:
  599. tb.textEdited.disconnect(self.on_preferences_edited)
  600. except (TypeError, AttributeError):
  601. pass
  602. try:
  603. tb.modificationChanged.disconnect(self.on_preferences_edited)
  604. except (TypeError, AttributeError):
  605. pass
  606. try:
  607. tb.toggled.disconnect(self.on_preferences_edited)
  608. except (TypeError, AttributeError):
  609. pass
  610. try:
  611. tb.valueChanged.disconnect(self.on_preferences_edited)
  612. except (TypeError, AttributeError):
  613. pass
  614. try:
  615. tb.currentIndexChanged.disconnect(self.on_preferences_edited)
  616. except (TypeError, AttributeError):
  617. pass
  618. # Prompt user to save
  619. if self.preferences_changed_flag is True:
  620. msgbox = QtWidgets.QMessageBox()
  621. msgbox.setText(_("One or more values are changed.\n"
  622. "Do you want to save the Preferences?"))
  623. msgbox.setWindowTitle(_("Save Preferences"))
  624. msgbox.setWindowIcon(QtGui.QIcon(self.ui.app.resource_location + '/save_as.png'))
  625. bt_yes = msgbox.addButton(_('Yes'), QtWidgets.QMessageBox.YesRole)
  626. msgbox.addButton(_('No'), QtWidgets.QMessageBox.NoRole)
  627. msgbox.setDefaultButton(bt_yes)
  628. msgbox.exec_()
  629. response = msgbox.clickedButton()
  630. if response == bt_yes:
  631. self.on_save_button(save_to_file=True)
  632. self.inform.emit('[success] %s' % _("Preferences saved."))
  633. else:
  634. self.preferences_changed_flag = False
  635. self.inform.emit('')
  636. return