G@ddZddlmZddlZddlZddlmZddlmZddl m Z m Z m Z m Z mZddlmZddlmZmZmZmZmZmZdd lmZdd lmZdd lmZmZdd lm Z m!Z!m"Z"dd l#m$Z$m%Z%ddl&m'Z'ddl(m)Z)ddl*m+Z+m,Z,ddl-m.Z.m/Z/m0Z0ddl1m2Z2m3Z3m4Z4ddl5m6Z6m7Z7ddl8m9Z9ej:e;Z<GddZ=GddZ>Gddee%e$Z?dZ@e;dkr e@dSdS)z Main plugin widget. SpyderDockablePlugin plugins must provide a WIDGET_CLASS attribute that is a subclass of PluginMainWidget. ) OrderedDictN)Optional)PYQT5) QByteArrayQSizeQtSignalSlot)QIcon) QApplication QHBoxLayout QSizePolicy QToolButton QVBoxLayoutQWidget)SpyderAPIError)_)MainCornerWidgetSpyderWindowWidget)MainWidgetMenuOptionsMenuSectionsPluginMainWidgetMenus)SpyderToolbarMixinSpyderWidgetMixin)MainWidgetToolbar)qbytearray_to_str)create_waitspinnerset_menu_icons)ACTION_REGISTRYTOOLBAR_REGISTRY MENU_REGISTRY)APP_STYLESHEETPANES_TABBAR_STYLESHEETPANES_TOOLBAR_STYLESHEET) DockTitleBarSpyderDockWidget)TabsceZdZdZdZdZdZdS)PluginMainWidgetWidgets corner_widgetmain_toolbar_widgetoptions_button_widgetspinner_widgetN)__name__ __module__ __qualname__ CornerWidget MainToolbarOptionsToolButtonSpinner>lib/python3.11/site-packages/spyder/api/widgets/main_widget.pyr)r)2s#"L'K/GGGr6r)ceZdZdZdZdZdZdS)PluginMainWidgetActions close_pane dock_pane undock_panelock_unlock_positionN)r.r/r0 ClosePaneDockPane UndockPaneLockUnlockPositionr5r6r7r9r99s%IHJ/r6r9ceZdZdZdZ dZ eZ eZ eZ ee Z ee Z ee Z eZ edefZ d3fd ZdZdZee dZee d Zfd Zfd Zd Z d4d eedeefdZd3dZdZdZ dZ!dZ"d5dZ#dZ$dZ%dZ&dZ'dZ(dZ)dZ*d3dZ+dZ,d Z-d!Z.d"Z/d#Z0d$Z1ed%Z2ed6d&Z3d3d'Z4d(Z5d)Z6ed*Z7d+Z8d,Z9d-Z:d.Z;d/Zd2Z?xZ@S)7PluginMainWidgetay Spyder plugin main widget class. This class handles both a dockwidget pane and a floating window widget (undocked pane). Notes ----- All Spyder dockable plugins define a main widget that must subclass this. This widget is a subclass of QMainWindow that consists of a single, central widget and a set of toolbars that are stacked above or below that widget. The toolbars are not moveable nor floatable and must occupy the entire horizontal space available for the plugin. This mean that toolbars must be stacked vertically and cannot be placed horizontally next to each other. FNr5ctr$t||n+tj||t j||d|_||_||_||_d|_ d|_ d|_ d|_ d|_ d|_d|_||_d|_t%|_t%|_d|_d|_t/|_d|_|jrt7d||_t9|t:j|_d|j_ tC|tEd |_#d |j#_ tIj%|j#|j#j |j|j&tC|tEd  |_'d |j'_ tIj%|j'|j'j |j|j&|j'(tRj*tRj+|,tZj.tEd |_/d|_0d|_1te|_3te|_4tk|_6|j47|j0d|j1d|j48d|j67dddd|j68d|j37dddd|j38d|j69|j#d|j69|j'd|j4:|j6|j3:|j4ddS)N)parent class_parent)rFF)sizerE)rEname main_cornerzMain widget toolbar)rEtitle main_toolbarzMain widget corner toolbar)corner_toolbarz Options menu)rKri'stretch);rsuper__init__rr_is_tab_name_plugin_parent_default_margins is_visible dock_action undock_action close_action_toolbars_already_rendered _is_maximized PLUGIN_NAMEtoggle_view_actionr _toolbars_auxiliary_toolbars windowwidget dockwidgetr _icon_spinnerENABLE_SPINNERrrr)r1_corner_widgetIDrr _main_toolbarr register_reference CONTEXT_NAME_corner_toolbar setSizePolicyrMinimum Expanding create_menurOptions _options_menu _margin_left _margin_rightr _main_layout_toolbars_layoutr _main_toolbar_layoutsetContentsMargins setSpacing addWidget addLayout)selfrIpluginrE __class__s r7rRzPluginMainWidget.__init__s  B GG  F  @ @ @ @  T6 * * *  &t& A A A A    $! */'" #'$#.== !WW    E.BtDDDDM.(5   "/.)**   !/+   2 5  d/ 1 1 1 1011   #4+  $"6"9  d/ 1 1 1 **;+>+6+@ B B B!-- ! )N##.  'MM + $/MM! 00  q$"4a 9 9 9 ((+++ !44Q1a@@@ !,,Q/// ,,Q1a888 $$Q''' !++D,>+NNN !++D,@!+LLL ''(ABBB ##D$91#EEEEEr6ct}|rR|D]O}d_|jjt ttj td d_ jr%tjjtj j jj jj j t,jt2jtdtd dj_t2jtd td  d j_t2j td td  dj!_"t2j#tdtd dj$_%dj&z'fdtPj)d_*jj"j%jfD])}+|j,tZj.*j /j,j,j01j2tfj4dkr'j,j51j,fdjsN6jjdjt tn8'dS)zR Setup default actions, create options menu, and connect signals. Trq tooloptions)texticonDockz Dock the panedock)rIrtipr triggeredUnlock position'Unlock to move pane to another positiondrag_dock_widgetUndockzUndock the paneundockClosezClose the paner:z switch to c.|SN toggle_view)checkedr|s r7z)PluginMainWidget._setup..xsD$4$4W$=$=r6r)rIrtoggledcontextshortcut_context)sectiondarwinc"t|dS)NF)r)menus r7rz)PluginMainWidget._setup..stU0K0Kr6corner)toolbarrN)9 findChildrenr'rSsetCornerWidgetrg setStyleSheetstrr#create_toolbuttonr)r3r create_icon_options_buttonrfadd_corner_widgetr4reri setVisiblerl setPopupModer InstantPopup create_actionr9r? close_windowrYrAr=lock_unlock_actionr@ create_windowrZr> close_dockr[rT get_titlerWidgetWithChildrenShortcutr_add_item_to_menurrrBottomsetMenu aboutToShowconnect_update_actionssysplatform aboutToHideadd_item_to_toolbarr$setWindowTitle)r|childrenchilditems` r7_setupzPluginMainWidget._setup1s= $$T**  !  # %%d&9:::#11#6M2N2NOOO#55 # 59!!-00 6       " "'/      # 5      %%$,&6777 ''DL(8999 ))+*BCCC --(16/""!!&))' .  #'"4"4(;$%%;<<!!"455/ #5# # "//(38#$$!!(++( 0  !..(27"##!!,//o /  #'"4"4 *!!====1 #5# # ,d.@&(8:  D  ! !"+2 "     $$T%7888 &..t/CDDD <8 # #   * 2 2 .KKK M M M | M  $ $#,  %      - -c2J.K.K L L L DNN,,-----r6c|jdu}|j||j||j||j| t jdkr? t| tj dn#t$rYnwxYw| dS)z' Refresh Options menu. NrT)rbrZrr[rrYrrrget_menurrqKeyErrorupdate_actions)r|show_dock_actionss r7rz PluginMainWidget._update_actionss!-5 %%&7888 $$%6777 **+<=== ##(9$9::: <8 # # MM"7"?@@$HHHH     s-B22 B?>B?c|j||r tjtjdStjdS)zK Actions to perform when a plugin is undocked to be moved. N)rZ setDisabledr setOverrideCursorrClosedHandCursorrestoreOverrideCursor)r| top_levels r7_on_top_level_changez%PluginMainWidget._on_top_level_changesT &&y111  1  *2+> ? ? ? ? ?  . 0 0 0 0 0r6c&|r|jtd|j|ddD]/}t |j|}|td0dS|jtd|j|ddD]/}t |j|}|td0dS) zH Actions to perform when the title bar is shown/hidden. z Lock position lock_open) setToolTip setStatusTipz!Lock pane to the current positionrrrN)rsetTextrsetIconrgetattr)r|visible method_namemethods r7_on_title_bar_shownz$PluginMainWidget._on_title_bar_showns2  E  # + +Ao,>,> ? ? ?  # + +D,<,<[,I,I J J J= ? ?  !8+FFq<==>>>> ? ?  # + +A.?,@,@ A A A  # + +  !344 6 6 6= E E  !8+FFqBCCDDDD E Er6c|j|dt|j||jd|jd|ddS)z? Set layout of the main widget of this plugin. i@BrOrN)rur{rQ setLayoutrxrsrtry)r|layoutr~s r7rzPluginMainWidget.setLayoutsv ##FG#<<< $+,,,!!$"3Q8JANNN!r6cr|t|dSr)on_closerQ closeEvent)r|eventr~s r7rzPluginMainWidget.closeEvents.  5!!!!!r6c|jS)z+ Return the parent plugin. )rUr|s r7 get_pluginzPluginMainWidget.get_plugins |r6rr}cZ||jn|}||jn|}tj|||S)z( Return action by name. )r^rkr get_reference)r|rIrr}s r7 get_actionzPluginMainWidget.get_actions; &,^!!'.$##G,T67CCCr6c<|j||dS)ae Add widget to corner, that is to the left of the last added widget. Parameters ---------- widget_id: str Unique name of the widget. widget: QWidget Any QWidget to add in the corner widget. before: QWidget Insert the widget before this widget. Notes ----- By default widgets are added to the left of the last corner widget. The central widget provides an options menu button and a spinner so any additional widgets will be placed to the left of the spinner, if visible. N)rg add_widget)r| widget_idwidgetbefores r7rz"PluginMainWidget.add_corner_widgets#* &&y&99999r6c6|j|S)z Return the a widget inside the corner widget by name. Parameters ---------- name: str Unique name of the widget. )rg get_widgetr|rIs r7get_corner_widgetz"PluginMainWidget.get_corner_widgets"--d333r6cJ|jr|jdSdS)z/ Start default status spinner. N)rfrestartrs r7 start_spinnerzPluginMainWidget.start_spinners3   " M   ! ! ! ! ! " "r6cJ|jr|jdSdS)z. Stop default status spinner. N)rfrestoprs r7 stop_spinnerzPluginMainWidget.stop_spinners3   ! M    ! !r6ct|}||_tj|||j|j||j|<|j||S)a[ Create and add an auxiliary toolbar to the top of the plugin. Parameters ---------- toolbar_id: str Unique toolbar string identifier. Returns ------- SpyderPluginToolbar The auxiliary toolbar that was created and added to the plugin interface. )rE) rrhr rjr^rkrarvrz)r| toolbar_idrs r7create_toolbarzPluginMainWidget.create_toolbar!sm$4000 + Z!143D F F F07 , ''000r6ct|dd}|t|_||jvr"td|t |||}t j|||j|j |<| d| |||j|<|S)a Override SpyderMenuMixin method to use a different menu class. Parameters ---------- menu_id: str Unique toolbar string identifier. title: str Toolbar localized title. icon: QIcon or None Icon to use for the menu. Returns ------- MainWidgetMenu The main widget menu. _menusNzMenu name "{}" already in use!)rErKmenu_idT) rrrrformatrr!rjr^rk menuActionsetIconVisibleInMenur)r|rrKrmenusrs r7rpzPluginMainWidget.create_menu;s$h-- =%--DK dk ! ! 077@@ THHH( '4+T-> @ @ @   OO   2 24 8 8 8 LL   # G r6c|jS)z= Return the main options menu of the widget. )rrrs r7get_options_menuz!PluginMainWidget.get_options_menubs !!r6c|jS)zD Return the main options menu button of the widget. )rrs r7get_options_menu_buttonz(PluginMainWidget.get_options_menu_buttonhs ##r6c|jS)z Return the main toolbar of the plugin. Returns ------- QToolBar The main toolbar of the widget that contains the options button. )rirs r7get_main_toolbarz!PluginMainWidget.get_main_toolbarns !!r6c|jS)z Return the auxiliary toolbars of the plugin. Returns ------- OrderedDict A dictionary of wirh toolbar IDs as keys and auxiliary toolbars as values. )rars r7get_auxiliary_toolbarsz'PluginMainWidget.get_auxiliary_toolbarsys ''r6cd||_|jt||dS)z Set the icon size of the plugin's toolbars. Parameters ---------- iconsize: int An integer corresponding to the size in pixels to which the icons of the plugin's toolbars need to be set. N) _icon_sizeri set_icon_sizer)r| icon_sizes r7rzPluginMainWidget.set_icon_sizes2$ ((y))D)DEEEEEr6c|}|r|||dSdS)z= Show a status message in the Spyder widget. N) statusBar isVisible showMessage)r|messagetimeout status_bars r7show_status_messagez$PluginMainWidget.show_status_messagesM^^%%    ! ! 5  " "7G 4 4 4 4 4 5 5r6c|S)z Get the widget to give focus to. Returns ------- QWidget QWidget to give focus to. Notes ----- This is applied when the plugin's dockwidget is raised to the top. r5rs r7get_focus_widgetz!PluginMainWidget.get_focus_widgets  r6c|}|j||_||||||dS|j|jdS)z0 Update central widget margins. N)rrWgetContentsMarginsrx)r|marginrs r7update_marginszPluginMainWidget.update_marginssm  ($*$=$=$?$?D !    % %ffff E E E E E %F %t'< = = = =r6c|j|j}n|j|j}ndS||dS)z> Update title of dockwidget or plugin window. N)rcrbundocked_windowrr)r|rs r7 update_titlezPluginMainWidget.update_titlesQ ? &_FF   *)FF Fdnn../////r6c||_dS)z0 Set widget name (plugin.NAME). NrTrs r7set_namezPluginMainWidget.set_name r6c|jS)z3 Return widget name (plugin.NAME). rrs r7get_namezPluginMainWidget.get_name zr6c||_dS)z" Set widget icon. Nrd)r|rs r7set_iconzPluginMainWidget.set_iconrr6c|jS)z% Return widget icon. r rs r7get_iconzPluginMainWidget.get_iconrr6c|j|j|jD]\}}|dS)z Render all the toolbars of the widget. Notes ----- This action can only be performed once. N)ri_renderrlraitems)r|__rs r7render_toolbarsz PluginMainWidget.render_toolbarssm ""$$$ $$&&&399;;  KB OO      r6ctdt|x|_}|jj|j|tj | || | | ||||dd}|rf |t't+|dn#t.$rYnwxYw|jr4|jd|jd||||dS)zG Create a QMainWindow instance containing this widget. zUndocking pluginwindow_geometryr)defaultzutf-8FN)loggerdebugrrb sig_closedrr setAttributerWA_DeleteOnClosesetCentralWidget setWindowIconr#rrresizerHget_confrestoreGeometryrfromHexrencode Exceptionrc setFloatingr set_ancestorrshow)r|windowgeometrys r7rzPluginMainWidget.create_windows  '(((&8%=%==F $,,T->??? B/000%%%T]]__---dnn../// diikk"""==!2B=??   &&LL((X)=)=g)F)FGG     ? . O ' ' . . . O & &u - - - &!!!  sAE-- E:9E:cftd|jx|j}|dt ||r|dd|j|_|j|jd|_|j d|j d|j |j ||j ||j d|j |dSdS|dddS)a Close QMainWindow instance that contains this widget. Parameters ---------- save_undocked : bool, optional True if the undocked state needs to be saved. The default is False. Returns ------- None. z&Docking plugin back to the main windowNr*undocked_on_window_closeTF)r,r-rb saveGeometryset_confr _PluginMainWidget__unsafe_window deleteLatercloserZrr[rcsig_update_ancestor_requestedemitrswitch_to_plugin setWidgetrraise_r)r| save_undockedr=s r7rzPluginMainWidget.close_windows  =>>>   ((5577H MM+->x-H-H I I I @ 8$???$(#4D  , , . . .   # # % % % $D    * *5 1 1 1   ) )% 0 0 0*277999!!22444))$///**4000&&((($$&&&&& +* MM4e < < < < Panes`. Parameters ---------- checked: bool Is the entry in `View > Panes` checked or not? Notes ----- If you need to attach some functionality when this changes, use sig_toggle_view_changed. For an example, please see `spyder/plugins/ipythonconsole/plugin.py` NT)rJF) rcrbrr;rIrXhider_ isCheckedrM setCheckedsig_toggle_view_changedrF)r|rs r7rzPluginMainWidget.toggle_viewcs   F   (   D  1 1 1  $ O " " " O " " $ $ $"DOO O " " "#DO  " , , . .' 9 9   d # # #  # . .w 7 7 7   e $ $ $ $))'22222r6c|}t||x|_}||jjdz|||j|j |j |j |j |j ||jfS)z= Add to parent QMainWindow as a dock widget. _dw)rr&rc setObjectNamer~r.rHvisibilityChangedrrStopLevelChangedrsig_title_bar_shownrLOCATION)r| mainwindowrKrs r7create_dockwidgetz"PluginMainWidget.create_dockwidgets   !1%!D!DD$ 4>2U:;;; t &&t'=>>> $$T%>???  (()ABBBdm$$r6c0|ddS)z' Close the dockwidget. FNrrs r7rzPluginMainWidget.close_docks r6ct|jtr|jdS|jdS)z< Show/hide title bar to move/lock position. N) isinstancerctitleBarWidgetr%remove_title_bar set_title_barrs r7r=z%PluginMainWidget.lock_unlock_positionsX do4466 E E , O , , . . . . . O ) ) + + + + +r6c|jS)z!Get dockwidget's maximized state.)r]rs r7get_maximized_statez$PluginMainWidget.get_maximized_states !!r6c,||_||j_dS)z Set internal attribute that holds dockwidget's maximized state. Parameters ---------- state: bool True if the plugin is maximized, False otherwise. N)r]rU _ismaximized)r|states r7set_maximized_statez$PluginMainWidget.set_maximized_states#%* !!!r6c td)zX Return the title that will be displayed on dockwidget or window title. z)PluginMainWidget must define `get_title`!)NotImplementedErrorrs r7rzPluginMainWidget.get_titles""MNNNr6cdS)zW Needed to update the ancestor/parent of child widgets when undocking. Nr5)r|ancestors r7r:zPluginMainWidget.set_ancestors  r6c@tt|d)zR Create widget actions, add to menu and other setup requirements. z must define a `setup` method!rotypers r7setupzPluginMainWidget.setups("Dzz 9 9 9;; ;r6cBtdt|d)z Update the state of exposed actions. Exposed actions are actions created by the self.create_action method. zJA PluginMainWidget subclass must define an `update_actions` method! Hint: z" should implement `update_actions`rsrs r7rzPluginMainWidget.update_actionss: " L!$ZZ L L LMM Mr6cdS)z~ Perform actions before the widget is closed. This method **must** only operate on local attributes. Nr5rs r7rzPluginMainWidget.on_closes r6r)NN)rN)F)Ar.r/r0__doc__rfrkr sig_free_memory_requestedsig_quit_requestedsig_restart_requestedboolsig_redirect_stdio_requesteddictsig_exception_occurredrXrEobjectsig_unmaximize_plugin_requestedrRrrr rrrrrrrrrrrrrrprrrrrrrrrrrr!r#r(rrrSrrarr=rirmrr:rurr __classcell__)r~s@r7rCrC@sX*N$L!'  #FHH$*6$<< $VD\\8%fTll %+FHH! '-fR&&;&;#aFaFaFaFaFaFJg.g.g.R, T$ZZ 1 1Z 1 T$ZZEEZE("""""  9=+/DD D#C=DDDD::::. 4 4 4"""!!!4%%%%N""" $$$ " " " ( ( ( F F F555    > > > > 0 0 0      $ TVV$$ V$L TVV,=,=,= V,=\!!!!@%3%3%3N%%%& TVV   V ,,,""" * * * OOO    ;;;MMM       r6rCcBddlm}m}m}ddlm}|}|}t d|}dd|_||}| || || | |\}} | | ||tt ||dS)Nr)r QTableWidget QMainWindow) qapplicationtestcdS)Nz Test titler5)xs r7rzrun_test..slr6r)qtpy.QtWidgetsr rrspyder.utils.qthelpersrrCrrrzrrra addDockWidgetrrr"r;exec_) r rrrappmainrrrlocations r7run_testrs&EEEEEEEEEE433333 ,..C ;==D fd + +F222F MMOOO []]F \\^^$$$ V --d33ND(x&&&s>**+++IIKKKIIKKKKKr6__main__)Arx collectionsrloggingrtypingrqtpyr qtpy.QtCorerrrr r qtpy.QtGuir rr r rrrrspyder.api.exceptionsrspyder.api.translationsr$spyder.api.widgets.auxiliary_widgetsrrspyder.api.widgets.menusrrrspyder.api.widgets.mixinsrrspyder.api.widgets.toolbarsrspyder.py3compatrrrrspyder.utils.registriesrr r!spyder.utils.stylesheetr"r#r$spyder.widgets.dockr%r&spyder.widgets.tabsr' getLoggerr.r,r)r9rCrr5r6r7rs+$##### ;;;;;;;;;;;;;;????????????????100000%%%%%%FFFFFFFF==========KKKKKKKK999999......EEEEEEEE6666666666GGGGGGGGGG>>>>>>>>$$$$$$  8 $ $00000000d d d d d w 13Ed d d N. z HJJJJJr6