PreferencesUIManager.py 41 KB

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