mainwindow.py 36 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884
  1. """The Qt MainWindow for the QtConsole
  2. This is a tabbed pseudo-terminal of Jupyter sessions, with a menu bar for
  3. common actions.
  4. """
  5. # Copyright (c) Jupyter Development Team.
  6. # Distributed under the terms of the Modified BSD License.
  7. import sys
  8. import webbrowser
  9. from threading import Thread
  10. from jupyter_core.paths import jupyter_runtime_dir
  11. from pygments.styles import get_all_styles
  12. from qtpy import QtGui, QtCore, QtWidgets
  13. from qtconsole import styles
  14. from qtconsole.jupyter_widget import JupyterWidget
  15. from qtconsole.usage import gui_reference
  16. def background(f):
  17. """call a function in a simple thread, to prevent blocking"""
  18. t = Thread(target=f)
  19. t.start()
  20. return t
  21. class MainWindow(QtWidgets.QMainWindow):
  22. #---------------------------------------------------------------------------
  23. # 'object' interface
  24. #---------------------------------------------------------------------------
  25. def __init__(self, app,
  26. confirm_exit=True,
  27. new_frontend_factory=None, slave_frontend_factory=None,
  28. connection_frontend_factory=None,
  29. ):
  30. """ Create a tabbed MainWindow for managing FrontendWidgets
  31. Parameters
  32. ----------
  33. app : reference to QApplication parent
  34. confirm_exit : bool, optional
  35. Whether we should prompt on close of tabs
  36. new_frontend_factory : callable
  37. A callable that returns a new JupyterWidget instance, attached to
  38. its own running kernel.
  39. slave_frontend_factory : callable
  40. A callable that takes an existing JupyterWidget, and returns a new
  41. JupyterWidget instance, attached to the same kernel.
  42. """
  43. super(MainWindow, self).__init__()
  44. self._kernel_counter = 0
  45. self._external_kernel_counter = 0
  46. self._app = app
  47. self.confirm_exit = confirm_exit
  48. self.new_frontend_factory = new_frontend_factory
  49. self.slave_frontend_factory = slave_frontend_factory
  50. self.connection_frontend_factory = connection_frontend_factory
  51. self.tab_widget = QtWidgets.QTabWidget(self)
  52. self.tab_widget.setDocumentMode(True)
  53. self.tab_widget.setTabsClosable(True)
  54. self.tab_widget.tabCloseRequested[int].connect(self.close_tab)
  55. self.setCentralWidget(self.tab_widget)
  56. # hide tab bar at first, since we have no tabs:
  57. self.tab_widget.tabBar().setVisible(False)
  58. # prevent focus in tab bar
  59. self.tab_widget.setFocusPolicy(QtCore.Qt.NoFocus)
  60. def update_tab_bar_visibility(self):
  61. """ update visibility of the tabBar depending of the number of tab
  62. 0 or 1 tab, tabBar hidden
  63. 2+ tabs, tabBar visible
  64. send a self.close if number of tab ==0
  65. need to be called explicitly, or be connected to tabInserted/tabRemoved
  66. """
  67. if self.tab_widget.count() <= 1:
  68. self.tab_widget.tabBar().setVisible(False)
  69. else:
  70. self.tab_widget.tabBar().setVisible(True)
  71. if self.tab_widget.count()==0 :
  72. self.close()
  73. @property
  74. def next_kernel_id(self):
  75. """constantly increasing counter for kernel IDs"""
  76. c = self._kernel_counter
  77. self._kernel_counter += 1
  78. return c
  79. @property
  80. def next_external_kernel_id(self):
  81. """constantly increasing counter for external kernel IDs"""
  82. c = self._external_kernel_counter
  83. self._external_kernel_counter += 1
  84. return c
  85. @property
  86. def active_frontend(self):
  87. return self.tab_widget.currentWidget()
  88. def create_tab_with_new_frontend(self):
  89. """create a new frontend and attach it to a new tab"""
  90. widget = self.new_frontend_factory()
  91. self.add_tab_with_frontend(widget)
  92. def set_window_title(self):
  93. """Set the title of the console window"""
  94. old_title = self.windowTitle()
  95. title, ok = QtWidgets.QInputDialog.getText(self,
  96. "Rename Window",
  97. "New title:",
  98. text=old_title)
  99. if ok:
  100. self.setWindowTitle(title)
  101. def create_tab_with_existing_kernel(self):
  102. """create a new frontend attached to an external kernel in a new tab"""
  103. connection_file, file_type = QtWidgets.QFileDialog.getOpenFileName(self,
  104. "Connect to Existing Kernel",
  105. jupyter_runtime_dir(),
  106. "Connection file (*.json)")
  107. if not connection_file:
  108. return
  109. widget = self.connection_frontend_factory(connection_file)
  110. name = "external {}".format(self.next_external_kernel_id)
  111. self.add_tab_with_frontend(widget, name=name)
  112. def create_tab_with_current_kernel(self):
  113. """create a new frontend attached to the same kernel as the current tab"""
  114. current_widget = self.tab_widget.currentWidget()
  115. current_widget_index = self.tab_widget.indexOf(current_widget)
  116. current_widget_name = self.tab_widget.tabText(current_widget_index)
  117. widget = self.slave_frontend_factory(current_widget)
  118. if 'slave' in current_widget_name:
  119. # don't keep stacking slaves
  120. name = current_widget_name
  121. else:
  122. name = '(%s) slave' % current_widget_name
  123. self.add_tab_with_frontend(widget,name=name)
  124. def set_tab_title(self):
  125. """Set the title of the current tab"""
  126. old_title = self.tab_widget.tabText(self.tab_widget.currentIndex())
  127. title, ok = QtWidgets.QInputDialog.getText(self,
  128. "Rename Tab",
  129. "New title:",
  130. text=old_title)
  131. if ok:
  132. self.tab_widget.setTabText(self.tab_widget.currentIndex(), title)
  133. def close_tab(self,current_tab):
  134. """ Called when you need to try to close a tab.
  135. It takes the number of the tab to be closed as argument, or a reference
  136. to the widget inside this tab
  137. """
  138. # let's be sure "tab" and "closing widget" are respectively the index
  139. # of the tab to close and a reference to the frontend to close
  140. if type(current_tab) is not int :
  141. current_tab = self.tab_widget.indexOf(current_tab)
  142. closing_widget=self.tab_widget.widget(current_tab)
  143. # when trying to be closed, widget might re-send a request to be
  144. # closed again, but will be deleted when event will be processed. So
  145. # need to check that widget still exists and skip if not. One example
  146. # of this is when 'exit' is sent in a slave tab. 'exit' will be
  147. # re-sent by this function on the master widget, which ask all slave
  148. # widgets to exit
  149. if closing_widget is None:
  150. return
  151. #get a list of all slave widgets on the same kernel.
  152. slave_tabs = self.find_slave_widgets(closing_widget)
  153. keepkernel = None #Use the prompt by default
  154. if hasattr(closing_widget,'_keep_kernel_on_exit'): #set by exit magic
  155. keepkernel = closing_widget._keep_kernel_on_exit
  156. # If signal sent by exit magic (_keep_kernel_on_exit, exist and not None)
  157. # we set local slave tabs._hidden to True to avoid prompting for kernel
  158. # restart when they get the signal. and then "forward" the 'exit'
  159. # to the main window
  160. if keepkernel is not None:
  161. for tab in slave_tabs:
  162. tab._hidden = True
  163. if closing_widget in slave_tabs:
  164. try :
  165. self.find_master_tab(closing_widget).execute('exit')
  166. except AttributeError:
  167. self.log.info("Master already closed or not local, closing only current tab")
  168. self.tab_widget.removeTab(current_tab)
  169. self.update_tab_bar_visibility()
  170. return
  171. kernel_client = closing_widget.kernel_client
  172. kernel_manager = closing_widget.kernel_manager
  173. if keepkernel is None and not closing_widget._confirm_exit:
  174. # don't prompt, just terminate the kernel if we own it
  175. # or leave it alone if we don't
  176. keepkernel = closing_widget._existing
  177. if keepkernel is None: #show prompt
  178. if kernel_client and kernel_client.channels_running:
  179. title = self.window().windowTitle()
  180. cancel = QtWidgets.QMessageBox.Cancel
  181. okay = QtWidgets.QMessageBox.Ok
  182. if closing_widget._may_close:
  183. msg = "You are closing the tab : "+'"'+self.tab_widget.tabText(current_tab)+'"'
  184. info = "Would you like to quit the Kernel and close all attached Consoles as well?"
  185. justthis = QtWidgets.QPushButton("&No, just this Tab", self)
  186. justthis.setShortcut('N')
  187. closeall = QtWidgets.QPushButton("&Yes, close all", self)
  188. closeall.setShortcut('Y')
  189. # allow ctrl-d ctrl-d exit, like in terminal
  190. closeall.setShortcut('Ctrl+D')
  191. box = QtWidgets.QMessageBox(QtWidgets.QMessageBox.Question,
  192. title, msg)
  193. box.setInformativeText(info)
  194. box.addButton(cancel)
  195. box.addButton(justthis, QtWidgets.QMessageBox.NoRole)
  196. box.addButton(closeall, QtWidgets.QMessageBox.YesRole)
  197. box.setDefaultButton(closeall)
  198. box.setEscapeButton(cancel)
  199. pixmap = QtGui.QPixmap(self._app.icon.pixmap(QtCore.QSize(64,64)))
  200. box.setIconPixmap(pixmap)
  201. reply = box.exec_()
  202. if reply == 1: # close All
  203. for slave in slave_tabs:
  204. background(slave.kernel_client.stop_channels)
  205. self.tab_widget.removeTab(self.tab_widget.indexOf(slave))
  206. kernel_manager.shutdown_kernel()
  207. self.tab_widget.removeTab(current_tab)
  208. background(kernel_client.stop_channels)
  209. elif reply == 0: # close Console
  210. if not closing_widget._existing:
  211. # Have kernel: don't quit, just close the tab
  212. closing_widget.execute("exit True")
  213. self.tab_widget.removeTab(current_tab)
  214. background(kernel_client.stop_channels)
  215. else:
  216. reply = QtWidgets.QMessageBox.question(self, title,
  217. "Are you sure you want to close this Console?"+
  218. "\nThe Kernel and other Consoles will remain active.",
  219. okay|cancel,
  220. defaultButton=okay
  221. )
  222. if reply == okay:
  223. self.tab_widget.removeTab(current_tab)
  224. elif keepkernel: #close console but leave kernel running (no prompt)
  225. self.tab_widget.removeTab(current_tab)
  226. background(kernel_client.stop_channels)
  227. else: #close console and kernel (no prompt)
  228. self.tab_widget.removeTab(current_tab)
  229. if kernel_client and kernel_client.channels_running:
  230. for slave in slave_tabs:
  231. background(slave.kernel_client.stop_channels)
  232. self.tab_widget.removeTab(self.tab_widget.indexOf(slave))
  233. if kernel_manager:
  234. kernel_manager.shutdown_kernel()
  235. background(kernel_client.stop_channels)
  236. self.update_tab_bar_visibility()
  237. def add_tab_with_frontend(self,frontend,name=None):
  238. """ insert a tab with a given frontend in the tab bar, and give it a name
  239. """
  240. if not name:
  241. name = 'kernel %i' % self.next_kernel_id
  242. self.tab_widget.addTab(frontend,name)
  243. self.update_tab_bar_visibility()
  244. self.make_frontend_visible(frontend)
  245. frontend.exit_requested.connect(self.close_tab)
  246. def next_tab(self):
  247. self.tab_widget.setCurrentIndex((self.tab_widget.currentIndex()+1))
  248. def prev_tab(self):
  249. self.tab_widget.setCurrentIndex((self.tab_widget.currentIndex()-1))
  250. def make_frontend_visible(self,frontend):
  251. widget_index=self.tab_widget.indexOf(frontend)
  252. if widget_index > 0 :
  253. self.tab_widget.setCurrentIndex(widget_index)
  254. def find_master_tab(self,tab,as_list=False):
  255. """
  256. Try to return the frontend that owns the kernel attached to the given widget/tab.
  257. Only finds frontend owned by the current application. Selection
  258. based on port of the kernel might be inaccurate if several kernel
  259. on different ip use same port number.
  260. This function does the conversion tabNumber/widget if needed.
  261. Might return None if no master widget (non local kernel)
  262. Will crash if more than 1 masterWidget
  263. When asList set to True, always return a list of widget(s) owning
  264. the kernel. The list might be empty or containing several Widget.
  265. """
  266. #convert from/to int/richIpythonWidget if needed
  267. if isinstance(tab, int):
  268. tab = self.tab_widget.widget(tab)
  269. km=tab.kernel_client
  270. #build list of all widgets
  271. widget_list = [self.tab_widget.widget(i) for i in range(self.tab_widget.count())]
  272. # widget that are candidate to be the owner of the kernel does have all the same port of the curent widget
  273. # And should have a _may_close attribute
  274. filtered_widget_list = [ widget for widget in widget_list if
  275. widget.kernel_client.connection_file == km.connection_file and
  276. hasattr(widget,'_may_close') ]
  277. # the master widget is the one that may close the kernel
  278. master_widget= [ widget for widget in filtered_widget_list if widget._may_close]
  279. if as_list:
  280. return master_widget
  281. assert(len(master_widget)<=1 )
  282. if len(master_widget)==0:
  283. return None
  284. return master_widget[0]
  285. def find_slave_widgets(self,tab):
  286. """return all the frontends that do not own the kernel attached to the given widget/tab.
  287. Only find frontends owned by the current application. Selection
  288. based on connection file of the kernel.
  289. This function does the conversion tabNumber/widget if needed.
  290. """
  291. #convert from/to int/richIpythonWidget if needed
  292. if isinstance(tab, int):
  293. tab = self.tab_widget.widget(tab)
  294. km=tab.kernel_client
  295. #build list of all widgets
  296. widget_list = [self.tab_widget.widget(i) for i in range(self.tab_widget.count())]
  297. # widget that are candidate not to be the owner of the kernel does have all the same port of the curent widget
  298. filtered_widget_list = ( widget for widget in widget_list if
  299. widget.kernel_client.connection_file == km.connection_file)
  300. # Get a list of all widget owning the same kernel and removed it from
  301. # the previous cadidate. (better using sets ?)
  302. master_widget_list = self.find_master_tab(tab, as_list=True)
  303. slave_list = [widget for widget in filtered_widget_list if widget not in master_widget_list]
  304. return slave_list
  305. # Populate the menu bar with common actions and shortcuts
  306. def add_menu_action(self, menu, action, defer_shortcut=False):
  307. """Add action to menu as well as self
  308. So that when the menu bar is invisible, its actions are still available.
  309. If defer_shortcut is True, set the shortcut context to widget-only,
  310. where it will avoid conflict with shortcuts already bound to the
  311. widgets themselves.
  312. """
  313. menu.addAction(action)
  314. self.addAction(action)
  315. if defer_shortcut:
  316. action.setShortcutContext(QtCore.Qt.WidgetShortcut)
  317. def init_menu_bar(self):
  318. #create menu in the order they should appear in the menu bar
  319. self.init_file_menu()
  320. self.init_edit_menu()
  321. self.init_view_menu()
  322. self.init_kernel_menu()
  323. self.init_window_menu()
  324. self.init_help_menu()
  325. def init_file_menu(self):
  326. self.file_menu = self.menuBar().addMenu("&File")
  327. self.new_kernel_tab_act = QtWidgets.QAction("New Tab with &New kernel",
  328. self,
  329. shortcut="Ctrl+T",
  330. triggered=self.create_tab_with_new_frontend)
  331. self.add_menu_action(self.file_menu, self.new_kernel_tab_act)
  332. self.slave_kernel_tab_act = QtWidgets.QAction("New Tab with Sa&me kernel",
  333. self,
  334. shortcut="Ctrl+Shift+T",
  335. triggered=self.create_tab_with_current_kernel)
  336. self.add_menu_action(self.file_menu, self.slave_kernel_tab_act)
  337. self.existing_kernel_tab_act = QtWidgets.QAction("New Tab with &Existing kernel",
  338. self,
  339. shortcut="Alt+T",
  340. triggered=self.create_tab_with_existing_kernel)
  341. self.add_menu_action(self.file_menu, self.existing_kernel_tab_act)
  342. self.file_menu.addSeparator()
  343. self.close_action=QtWidgets.QAction("&Close Tab",
  344. self,
  345. shortcut=QtGui.QKeySequence.Close,
  346. triggered=self.close_active_frontend
  347. )
  348. self.add_menu_action(self.file_menu, self.close_action)
  349. self.export_action=QtWidgets.QAction("&Save to HTML/XHTML",
  350. self,
  351. shortcut=QtGui.QKeySequence.Save,
  352. triggered=self.export_action_active_frontend
  353. )
  354. self.add_menu_action(self.file_menu, self.export_action, True)
  355. self.file_menu.addSeparator()
  356. printkey = QtGui.QKeySequence(QtGui.QKeySequence.Print)
  357. if printkey.matches("Ctrl+P") and sys.platform != 'darwin':
  358. # Only override the default if there is a collision.
  359. # Qt ctrl = cmd on OSX, so the match gets a false positive on OSX.
  360. printkey = "Ctrl+Shift+P"
  361. self.print_action = QtWidgets.QAction("&Print",
  362. self,
  363. shortcut=printkey,
  364. triggered=self.print_action_active_frontend)
  365. self.add_menu_action(self.file_menu, self.print_action, True)
  366. if sys.platform != 'darwin':
  367. # OSX always has Quit in the Application menu, only add it
  368. # to the File menu elsewhere.
  369. self.file_menu.addSeparator()
  370. self.quit_action = QtWidgets.QAction("&Quit",
  371. self,
  372. shortcut=QtGui.QKeySequence.Quit,
  373. triggered=self.close,
  374. )
  375. self.add_menu_action(self.file_menu, self.quit_action)
  376. def init_edit_menu(self):
  377. self.edit_menu = self.menuBar().addMenu("&Edit")
  378. self.undo_action = QtWidgets.QAction("&Undo",
  379. self,
  380. shortcut=QtGui.QKeySequence.Undo,
  381. statusTip="Undo last action if possible",
  382. triggered=self.undo_active_frontend
  383. )
  384. self.add_menu_action(self.edit_menu, self.undo_action)
  385. self.redo_action = QtWidgets.QAction("&Redo",
  386. self,
  387. shortcut=QtGui.QKeySequence.Redo,
  388. statusTip="Redo last action if possible",
  389. triggered=self.redo_active_frontend)
  390. self.add_menu_action(self.edit_menu, self.redo_action)
  391. self.edit_menu.addSeparator()
  392. self.cut_action = QtWidgets.QAction("&Cut",
  393. self,
  394. shortcut=QtGui.QKeySequence.Cut,
  395. triggered=self.cut_active_frontend
  396. )
  397. self.add_menu_action(self.edit_menu, self.cut_action, True)
  398. self.copy_action = QtWidgets.QAction("&Copy",
  399. self,
  400. shortcut=QtGui.QKeySequence.Copy,
  401. triggered=self.copy_active_frontend
  402. )
  403. self.add_menu_action(self.edit_menu, self.copy_action, True)
  404. self.copy_raw_action = QtWidgets.QAction("Copy (&Raw Text)",
  405. self,
  406. shortcut="Ctrl+Shift+C",
  407. triggered=self.copy_raw_active_frontend
  408. )
  409. self.add_menu_action(self.edit_menu, self.copy_raw_action, True)
  410. self.paste_action = QtWidgets.QAction("&Paste",
  411. self,
  412. shortcut=QtGui.QKeySequence.Paste,
  413. triggered=self.paste_active_frontend
  414. )
  415. self.add_menu_action(self.edit_menu, self.paste_action, True)
  416. self.edit_menu.addSeparator()
  417. selectall = QtGui.QKeySequence(QtGui.QKeySequence.SelectAll)
  418. if selectall.matches("Ctrl+A") and sys.platform != 'darwin':
  419. # Only override the default if there is a collision.
  420. # Qt ctrl = cmd on OSX, so the match gets a false positive on OSX.
  421. selectall = "Ctrl+Shift+A"
  422. self.select_all_action = QtWidgets.QAction("Select Cell/&All",
  423. self,
  424. shortcut=selectall,
  425. triggered=self.select_all_active_frontend
  426. )
  427. self.add_menu_action(self.edit_menu, self.select_all_action, True)
  428. def init_view_menu(self):
  429. self.view_menu = self.menuBar().addMenu("&View")
  430. if sys.platform != 'darwin':
  431. # disable on OSX, where there is always a menu bar
  432. self.toggle_menu_bar_act = QtWidgets.QAction("Toggle &Menu Bar",
  433. self,
  434. shortcut="Ctrl+Shift+M",
  435. statusTip="Toggle visibility of menubar",
  436. triggered=self.toggle_menu_bar)
  437. self.add_menu_action(self.view_menu, self.toggle_menu_bar_act)
  438. fs_key = "Ctrl+Meta+F" if sys.platform == 'darwin' else "F11"
  439. self.full_screen_act = QtWidgets.QAction("&Full Screen",
  440. self,
  441. shortcut=fs_key,
  442. statusTip="Toggle between Fullscreen and Normal Size",
  443. triggered=self.toggleFullScreen)
  444. self.add_menu_action(self.view_menu, self.full_screen_act)
  445. self.view_menu.addSeparator()
  446. self.increase_font_size = QtWidgets.QAction("Zoom &In",
  447. self,
  448. shortcut=QtGui.QKeySequence.ZoomIn,
  449. triggered=self.increase_font_size_active_frontend
  450. )
  451. self.add_menu_action(self.view_menu, self.increase_font_size, True)
  452. self.decrease_font_size = QtWidgets.QAction("Zoom &Out",
  453. self,
  454. shortcut=QtGui.QKeySequence.ZoomOut,
  455. triggered=self.decrease_font_size_active_frontend
  456. )
  457. self.add_menu_action(self.view_menu, self.decrease_font_size, True)
  458. self.reset_font_size = QtWidgets.QAction("Zoom &Reset",
  459. self,
  460. shortcut="Ctrl+0",
  461. triggered=self.reset_font_size_active_frontend
  462. )
  463. self.add_menu_action(self.view_menu, self.reset_font_size, True)
  464. self.view_menu.addSeparator()
  465. self.clear_action = QtWidgets.QAction("&Clear Screen",
  466. self,
  467. shortcut='Ctrl+L',
  468. statusTip="Clear the console",
  469. triggered=self.clear_active_frontend)
  470. self.add_menu_action(self.view_menu, self.clear_action)
  471. self.pager_menu = self.view_menu.addMenu("&Pager")
  472. hsplit_action = QtWidgets.QAction(".. &Horizontal Split",
  473. self,
  474. triggered=lambda: self.set_paging_active_frontend('hsplit'))
  475. vsplit_action = QtWidgets.QAction(" : &Vertical Split",
  476. self,
  477. triggered=lambda: self.set_paging_active_frontend('vsplit'))
  478. inside_action = QtWidgets.QAction(" &Inside Pager",
  479. self,
  480. triggered=lambda: self.set_paging_active_frontend('inside'))
  481. self.pager_menu.addAction(hsplit_action)
  482. self.pager_menu.addAction(vsplit_action)
  483. self.pager_menu.addAction(inside_action)
  484. available_syntax_styles = self.get_available_syntax_styles()
  485. if len(available_syntax_styles) > 0:
  486. self.syntax_style_menu = self.view_menu.addMenu("&Syntax Style")
  487. style_group = QtWidgets.QActionGroup(self)
  488. for style in available_syntax_styles:
  489. action = QtWidgets.QAction("{}".format(style), self,
  490. triggered=lambda v,
  491. syntax_style=style:
  492. self.set_syntax_style(
  493. syntax_style=syntax_style))
  494. action.setCheckable(True)
  495. style_group.addAction(action)
  496. self.syntax_style_menu.addAction(action)
  497. if style == 'default':
  498. action.setChecked(True)
  499. self.syntax_style_menu.setDefaultAction(action)
  500. def init_kernel_menu(self):
  501. self.kernel_menu = self.menuBar().addMenu("&Kernel")
  502. # Qt on OSX maps Ctrl to Cmd, and Meta to Ctrl
  503. # keep the signal shortcuts to ctrl, rather than
  504. # platform-default like we do elsewhere.
  505. ctrl = "Meta" if sys.platform == 'darwin' else "Ctrl"
  506. self.interrupt_kernel_action = QtWidgets.QAction("&Interrupt current Kernel",
  507. self,
  508. triggered=self.interrupt_kernel_active_frontend,
  509. shortcut=ctrl+"+C",
  510. )
  511. self.add_menu_action(self.kernel_menu, self.interrupt_kernel_action)
  512. self.restart_kernel_action = QtWidgets.QAction("&Restart current Kernel",
  513. self,
  514. triggered=self.restart_kernel_active_frontend,
  515. shortcut=ctrl+"+.",
  516. )
  517. self.add_menu_action(self.kernel_menu, self.restart_kernel_action)
  518. self.kernel_menu.addSeparator()
  519. self.confirm_restart_kernel_action = QtWidgets.QAction("&Confirm kernel restart",
  520. self,
  521. checkable=True,
  522. checked=self.active_frontend.confirm_restart,
  523. triggered=self.toggle_confirm_restart_active_frontend
  524. )
  525. self.add_menu_action(self.kernel_menu, self.confirm_restart_kernel_action)
  526. self.tab_widget.currentChanged.connect(self.update_restart_checkbox)
  527. def init_window_menu(self):
  528. self.window_menu = self.menuBar().addMenu("&Window")
  529. if sys.platform == 'darwin':
  530. # add min/maximize actions to OSX, which lacks default bindings.
  531. self.minimizeAct = QtWidgets.QAction("Mini&mize",
  532. self,
  533. shortcut="Ctrl+m",
  534. statusTip="Minimize the window/Restore Normal Size",
  535. triggered=self.toggleMinimized)
  536. # maximize is called 'Zoom' on OSX for some reason
  537. self.maximizeAct = QtWidgets.QAction("&Zoom",
  538. self,
  539. shortcut="Ctrl+Shift+M",
  540. statusTip="Maximize the window/Restore Normal Size",
  541. triggered=self.toggleMaximized)
  542. self.add_menu_action(self.window_menu, self.minimizeAct)
  543. self.add_menu_action(self.window_menu, self.maximizeAct)
  544. self.window_menu.addSeparator()
  545. prev_key = "Ctrl+Alt+Left" if sys.platform == 'darwin' else "Ctrl+PgUp"
  546. self.prev_tab_act = QtWidgets.QAction("Pre&vious Tab",
  547. self,
  548. shortcut=prev_key,
  549. statusTip="Select previous tab",
  550. triggered=self.prev_tab)
  551. self.add_menu_action(self.window_menu, self.prev_tab_act)
  552. next_key = "Ctrl+Alt+Right" if sys.platform == 'darwin' else "Ctrl+PgDown"
  553. self.next_tab_act = QtWidgets.QAction("Ne&xt Tab",
  554. self,
  555. shortcut=next_key,
  556. statusTip="Select next tab",
  557. triggered=self.next_tab)
  558. self.add_menu_action(self.window_menu, self.next_tab_act)
  559. self.rename_window_act = QtWidgets.QAction("Rename &Window",
  560. self,
  561. shortcut="Alt+R",
  562. statusTip="Rename window",
  563. triggered=self.set_window_title)
  564. self.add_menu_action(self.window_menu, self.rename_window_act)
  565. self.rename_current_tab_act = QtWidgets.QAction("&Rename Current Tab",
  566. self,
  567. shortcut="Ctrl+R",
  568. statusTip="Rename current tab",
  569. triggered=self.set_tab_title)
  570. self.add_menu_action(self.window_menu, self.rename_current_tab_act)
  571. def init_help_menu(self):
  572. # please keep the Help menu in Mac Os even if empty. It will
  573. # automatically contain a search field to search inside menus and
  574. # please keep it spelled in English, as long as Qt Doesn't support
  575. # a QAction.MenuRole like HelpMenuRole otherwise it will lose
  576. # this search field functionality
  577. self.help_menu = self.menuBar().addMenu("&Help")
  578. # Help Menu
  579. self.help_action = QtWidgets.QAction("Show &QtConsole help", self,
  580. triggered=self._show_help)
  581. self.online_help_action = QtWidgets.QAction("Open online &help", self,
  582. triggered=self._open_online_help)
  583. self.add_menu_action(self.help_menu, self.help_action)
  584. self.add_menu_action(self.help_menu, self.online_help_action)
  585. def _set_active_frontend_focus(self):
  586. # this is a hack, self.active_frontend._control seems to be
  587. # a private member. Unfortunately this is the only method
  588. # to set focus reliably
  589. QtCore.QTimer.singleShot(200, self.active_frontend._control.setFocus)
  590. # minimize/maximize/fullscreen actions:
  591. def toggle_menu_bar(self):
  592. menu_bar = self.menuBar()
  593. if menu_bar.isVisible():
  594. menu_bar.setVisible(False)
  595. else:
  596. menu_bar.setVisible(True)
  597. def toggleMinimized(self):
  598. if not self.isMinimized():
  599. self.showMinimized()
  600. else:
  601. self.showNormal()
  602. def _show_help(self):
  603. self.active_frontend._page(gui_reference)
  604. def _open_online_help(self):
  605. webbrowser.open("https://qtconsole.readthedocs.io", new=1, autoraise=True)
  606. def toggleMaximized(self):
  607. if not self.isMaximized():
  608. self.showMaximized()
  609. else:
  610. self.showNormal()
  611. # Min/Max imizing while in full screen give a bug
  612. # when going out of full screen, at least on OSX
  613. def toggleFullScreen(self):
  614. if not self.isFullScreen():
  615. self.showFullScreen()
  616. if sys.platform == 'darwin':
  617. self.maximizeAct.setEnabled(False)
  618. self.minimizeAct.setEnabled(False)
  619. else:
  620. self.showNormal()
  621. if sys.platform == 'darwin':
  622. self.maximizeAct.setEnabled(True)
  623. self.minimizeAct.setEnabled(True)
  624. def set_paging_active_frontend(self, paging):
  625. self.active_frontend._set_paging(paging)
  626. def get_available_syntax_styles(self):
  627. """Get a list with the syntax styles available."""
  628. styles = list(get_all_styles())
  629. return sorted(styles)
  630. def set_syntax_style(self, syntax_style):
  631. """Set up syntax style for the current console."""
  632. if syntax_style=='bw':
  633. colors='nocolor'
  634. elif styles.dark_style(syntax_style):
  635. colors='linux'
  636. else:
  637. colors='lightbg'
  638. self.active_frontend.syntax_style = syntax_style
  639. style_sheet = styles.sheet_from_template(syntax_style, colors)
  640. self.active_frontend.style_sheet = style_sheet
  641. self.active_frontend._syntax_style_changed()
  642. self.active_frontend._style_sheet_changed()
  643. self.active_frontend.reset(clear=True)
  644. self.active_frontend._execute("%colors linux", True)
  645. def close_active_frontend(self):
  646. self.close_tab(self.active_frontend)
  647. def restart_kernel_active_frontend(self):
  648. self.active_frontend.request_restart_kernel()
  649. def interrupt_kernel_active_frontend(self):
  650. self.active_frontend.request_interrupt_kernel()
  651. def toggle_confirm_restart_active_frontend(self):
  652. widget = self.active_frontend
  653. widget.confirm_restart = not widget.confirm_restart
  654. self.confirm_restart_kernel_action.setChecked(widget.confirm_restart)
  655. def update_restart_checkbox(self):
  656. if self.active_frontend is None:
  657. return
  658. widget = self.active_frontend
  659. self.confirm_restart_kernel_action.setChecked(widget.confirm_restart)
  660. def clear_active_frontend(self):
  661. self.active_frontend.clear()
  662. def cut_active_frontend(self):
  663. widget = self.active_frontend
  664. if widget.can_cut():
  665. widget.cut()
  666. def copy_active_frontend(self):
  667. widget = self.active_frontend
  668. widget.copy()
  669. def copy_raw_active_frontend(self):
  670. self.active_frontend._copy_raw_action.trigger()
  671. def paste_active_frontend(self):
  672. widget = self.active_frontend
  673. if widget.can_paste():
  674. widget.paste()
  675. def undo_active_frontend(self):
  676. self.active_frontend.undo()
  677. def redo_active_frontend(self):
  678. self.active_frontend.redo()
  679. def print_action_active_frontend(self):
  680. self.active_frontend.print_action.trigger()
  681. def export_action_active_frontend(self):
  682. self.active_frontend.export_action.trigger()
  683. def select_all_active_frontend(self):
  684. self.active_frontend.select_all_action.trigger()
  685. def increase_font_size_active_frontend(self):
  686. self.active_frontend.increase_font_size.trigger()
  687. def decrease_font_size_active_frontend(self):
  688. self.active_frontend.decrease_font_size.trigger()
  689. def reset_font_size_active_frontend(self):
  690. self.active_frontend.reset_font_size.trigger()
  691. #---------------------------------------------------------------------------
  692. # QWidget interface
  693. #---------------------------------------------------------------------------
  694. def closeEvent(self, event):
  695. """ Forward the close event to every tabs contained by the windows
  696. """
  697. if self.tab_widget.count() == 0:
  698. # no tabs, just close
  699. event.accept()
  700. return
  701. # Do Not loop on the widget count as it change while closing
  702. title = self.window().windowTitle()
  703. cancel = QtWidgets.QMessageBox.Cancel
  704. okay = QtWidgets.QMessageBox.Ok
  705. accept_role = QtWidgets.QMessageBox.AcceptRole
  706. if self.confirm_exit:
  707. if self.tab_widget.count() > 1:
  708. msg = "Close all tabs, stop all kernels, and Quit?"
  709. else:
  710. msg = "Close console, stop kernel, and Quit?"
  711. info = "Kernels not started here (e.g. notebooks) will be left alone."
  712. closeall = QtWidgets.QPushButton("&Quit", self)
  713. closeall.setShortcut('Q')
  714. box = QtWidgets.QMessageBox(QtWidgets.QMessageBox.Question,
  715. title, msg)
  716. box.setInformativeText(info)
  717. box.addButton(cancel)
  718. box.addButton(closeall, QtWidgets.QMessageBox.YesRole)
  719. box.setDefaultButton(closeall)
  720. box.setEscapeButton(cancel)
  721. pixmap = QtGui.QPixmap(self._app.icon.pixmap(QtCore.QSize(64,64)))
  722. box.setIconPixmap(pixmap)
  723. reply = box.exec_()
  724. else:
  725. reply = okay
  726. if reply == cancel:
  727. event.ignore()
  728. return
  729. if reply == okay or reply == accept_role:
  730. while self.tab_widget.count() >= 1:
  731. # prevent further confirmations:
  732. widget = self.active_frontend
  733. widget._confirm_exit = False
  734. self.close_tab(widget)
  735. event.accept()