PreferencesUIManager.py 39 KB

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