PreferencesUIManager.py 42 KB

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